Skip to content
Console
On this page

List connection providers

Lists an org's connection providers.

Lists an org's connection providers.

  • Path GET https://api.sylphx.com/v1/orgs/acme/connection_providers
  • Scope connections:read
  • Effect read — nothing is written.
  • Collection connection_providers
  • Query page_size, page_token, filter, order_by
  • Pagination the answer carries connection_providers and, when there is more, next_page_token

Request

FieldTypeWhat it is
parentstringThe org to list in. Required.
page_sizeint32At most this many; default 50, clamped to 1000.
page_tokenstringnext_page_token of the previous page.
filterstringAIP-160 filter over labels and filterable fields.
order_bystringAIP-132 ordering over filterable fields.

Response

FieldTypeWhat it is
connection_providersConnectionProvider[]The page.
next_page_tokenstringThe token of the next page; empty on the last page.

ConnectionProvider

FieldTypeWhat it is
namestringorgs/{org}/connection_providers/{connection_provider}.
uidstringcnp_<cell><ulid>. Output only.
metaResourceMetaResource metadata.
specConnectionProviderSpecDesired state. Required.
statusConnectionProviderStatusObserved state. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

ConnectionProviderSpec

FieldTypeWhat it is
github_appGitHubAppConfigA GitHub App. One of the config group.
sharing_grantsProviderSharingGrant[]Organizations allowed to use specific installations of this provider. Removing a grant prevents subsequent Broker exchanges. Signing custody remains in the provider's organization and is never copied to a recipient.
oauth2Oauth2ConfigA generic OAuth 2.0 client configuration. One of the config group.

ConnectionProviderStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
kindstringThe provider's plugin kind, for example github_app or oauth2. Output only.
connection_countint32How many active Connections the provider has. Output only.
client_secret_configuredboolWhether an OAuth 2.0 client secret is stored in custody. Output only.

GitHubAppConfig

FieldTypeWhat it is
app_idint64The App's numeric id. Required.
slugstringThe App's slug, for example sylphx. Required.
client_idstringThe App's OAuth client id.
signing_keystringThe imported, non-exportable SIGN Key (RS256) that signs App assertions; only the credential service may use it. Required.
webhook_secretstringThe Secret holding the webhook secret that verifies deliveries.

ProviderSharingGrant

FieldTypeWhat it is
organizationstringThe recipient, orgs/{org}; wildcards are not accepted. Required.
external_idsstring[]Exact provider installation ids. For GitHub these are canonical positive decimal installation ids. An empty list grants nothing. Required.

Oauth2Config

FieldTypeWhat it is
authorize_urlstringAuthorization endpoint HTTPS URL. Required.
token_urlstringAuthorization-code exchange endpoint HTTPS URL. Required.
refresh_urlstringRefresh endpoint HTTPS URL; defaults to token_url when empty.
client_idstringProvider-issued OAuth client identifier. Required.
client_secretstringWrite-only OAuth client secret sealed at rest and never returned. Never returned again.
scopesstring[]Default OAuth scopes requested during authorization.
extra_authorize_paramsmap<string, string>Static query parameters appended to authorize_url. Reserved keys (state, redirect_uri) are rejected.
redirect_uristringOptional redirect_uri override sent on authorize and token requests; defaults to the hosted callback URL.
token_methodOauth2TokenMethodHTTP transport for code exchange and refresh requests. One of form_post, query_get.
client_authOauth2ClientAuthHow client credentials are sent to token and refresh endpoints. One of body_or_query, basic.
authorize_code_paramstringQuery parameter carrying the authorization code on redirect callbacks; defaults to code.
token_code_paramstringParameter key carrying the authorization code on token exchange requests; defaults to code.
exchange_grant_typestringGrant type value sent during authorization-code exchange; defaults to authorization_code.
client_id_paramstringParameter key for client_id on token and refresh requests when not using HTTP Basic authentication; defaults to client_id.
client_secret_paramstringParameter key for client_secret on token and refresh requests when not using HTTP Basic authentication; defaults to client_secret.
callback_metadata_paramsstring[]Non-secret query parameter keys copied from the redirect callback into Connection.spec.oauth2.provider_metadata.
post_authorize_redirect_uristringOptional HTTPS URL redirected to after hosted callback completion.
authorize_client_id_paramstringQuery parameter key for client_id in authorize_url; defaults to client_id.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

Errors

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/connection_providers" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"