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_providersand, when there is more,next_page_token
Request
| Field | Type | What it is |
|---|---|---|
parent | string | The org to list in. Required. |
page_size | int32 | At most this many; default 50, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
filter | string | AIP-160 filter over labels and filterable fields. |
order_by | string | AIP-132 ordering over filterable fields. |
Response
| Field | Type | What it is |
|---|---|---|
connection_providers | ConnectionProvider[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
ConnectionProvider
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/connection_providers/{connection_provider}. |
uid | string | cnp_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | ConnectionProviderSpec | Desired state. Required. |
status | ConnectionProviderStatus | Observed state. Output only. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong 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_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
ConnectionProviderSpec
| Field | Type | What it is |
|---|---|---|
github_app | GitHubAppConfig | A GitHub App. One of the config group. |
sharing_grants | ProviderSharingGrant[] | 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. |
oauth2 | Oauth2Config | A generic OAuth 2.0 client configuration. One of the config group. |
ConnectionProviderStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
kind | string | The provider's plugin kind, for example github_app or oauth2. Output only. |
connection_count | int32 | How many active Connections the provider has. Output only. |
client_secret_configured | bool | Whether an OAuth 2.0 client secret is stored in custody. Output only. |
GitHubAppConfig
| Field | Type | What it is |
|---|---|---|
app_id | int64 | The App's numeric id. Required. |
slug | string | The App's slug, for example sylphx. Required. |
client_id | string | The App's OAuth client id. |
signing_key | string | The imported, non-exportable SIGN Key (RS256) that signs App assertions; only the credential service may use it. Required. |
webhook_secret | string | The Secret holding the webhook secret that verifies deliveries. |
ProviderSharingGrant
| Field | Type | What it is |
|---|---|---|
organization | string | The recipient, orgs/{org}; wildcards are not accepted. Required. |
external_ids | string[] | Exact provider installation ids. For GitHub these are canonical positive decimal installation ids. An empty list grants nothing. Required. |
Oauth2Config
| Field | Type | What it is |
|---|---|---|
authorize_url | string | Authorization endpoint HTTPS URL. Required. |
token_url | string | Authorization-code exchange endpoint HTTPS URL. Required. |
refresh_url | string | Refresh endpoint HTTPS URL; defaults to token_url when empty. |
client_id | string | Provider-issued OAuth client identifier. Required. |
client_secret | string | Write-only OAuth client secret sealed at rest and never returned. Never returned again. |
scopes | string[] | Default OAuth scopes requested during authorization. |
extra_authorize_params | map<string, string> | Static query parameters appended to authorize_url. Reserved keys (state, redirect_uri) are rejected. |
redirect_uri | string | Optional redirect_uri override sent on authorize and token requests; defaults to the hosted callback URL. |
token_method | Oauth2TokenMethod | HTTP transport for code exchange and refresh requests. One of form_post, query_get. |
client_auth | Oauth2ClientAuth | How client credentials are sent to token and refresh endpoints. One of body_or_query, basic. |
authorize_code_param | string | Query parameter carrying the authorization code on redirect callbacks; defaults to code. |
token_code_param | string | Parameter key carrying the authorization code on token exchange requests; defaults to code. |
exchange_grant_type | string | Grant type value sent during authorization-code exchange; defaults to authorization_code. |
client_id_param | string | Parameter key for client_id on token and refresh requests when not using HTTP Basic authentication; defaults to client_id. |
client_secret_param | string | Parameter key for client_secret on token and refresh requests when not using HTTP Basic authentication; defaults to client_secret. |
callback_metadata_params | string[] | Non-secret query parameter keys copied from the redirect callback into Connection.spec.oauth2.provider_metadata. |
post_authorize_redirect_uri | string | Optional HTTPS URL redirected to after hosted callback completion. |
authorize_client_id_param | string | Query parameter key for client_id in authorize_url; defaults to client_id. |
Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
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"