Skip to content
Console
On this page

List connections

Lists an org's connections.

Lists an org's connections.

  • Path GET https://api.sylphx.com/v1/orgs/acme/connections
  • Scope connections:read
  • Effect read — nothing is written.
  • Collection connections
  • Query page_size, page_token, filter, order_by
  • Pagination the answer carries connections 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
connectionsConnection[]The page.
next_page_tokenstringThe token of the next page; empty on the last page.

Connection

FieldTypeWhat it is
namestringorgs/{org}/connections/{connection}.
uidstringcnx_<cell><ulid>. Output only.
metaResourceMetaResource metadata.
specConnectionSpecDesired state. Required.
statusConnectionStatusObserved 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.

ConnectionSpec

FieldTypeWhat it is
providerstringThe provider this is an installation of; unset for Web Push.
external_idstringThe provider's id of the installation, for example a GitHub App installation id. Unset for Web Push.
web_pushWebPushConfigWeb Push assertion configuration. Mutually exclusive with provider and external_id. The Connection kind cannot change after creation.
github_userGitHubUserConfigGitHub user authorization. Mutually exclusive with all other kinds. Device authorization keeps credentials sealed inside Broker, bound to the Connection name and version, for user actions only.
oauth2Oauth2ConnectionConfigGeneric OAuth 2.0 authorization. Mutually exclusive with web_push and github_user. Requires an oauth2 ConnectionProvider.

ConnectionStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
stateConnectionStateThe installation's lifecycle state. Output only. One of pending, active, suspended, removed.
accountExternalAccountThe third-party account the provider is installed on. Output only.
repository_selectionRepositorySelectionWhether the installation covers every repository or a selection. Output only. One of all, selected.
permissionsmap<string, string>The permissions the account granted, for example {"contents": "read"}. Output only.
eventsstring[]The webhook events the installation delivers. Output only.
install_timetimestampWhen the provider says the installation was created. Output only.
suspend_timetimestampWhen the provider suspended the installation. Output only.
verify_timetimestampWhen the status was last read back from the provider. Output only.
authorizationGitHubUserAuthorizationCurrent device ceremony, present only while the Connection is authorizing. Contains no device code or token. Use a fresh Idempotency-Key for each poll. Output only.
oauth2_authorizationOauth2AuthorizationObserved generic OAuth 2.0 authorization metadata; contains no token. Output only.

WebPushConfig

FieldTypeWhat it is
keystringEnabled, generated SIGN/ec_p256_sha256 Key in the Connection organization. Required.
contactstringOperator contact, a mailto: or HTTPS URI; used as the JWT subject. Required.

GitHubUserConfig

FieldTypeWhat it is
providerstringApp provider whose OAuth client issued the authorization. Required.
loginstringExpected verified GitHub login; never inferred from untrusted input alone. Required.

Oauth2ConnectionConfig

FieldTypeWhat it is
external_account_idstringNon-secret account identifier associated with the external authorization.
provider_metadatamap<string, string>Non-secret provider metadata captured from callbacks or supplied by the caller. Secret-bearing keys are rejected.

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.

ExternalAccount

FieldTypeWhat it is
external_idstringThe provider's id of the account. Output only.
loginstringThe account's login, for example SylphxAI. Output only.
kindExternalAccountKindWhether the account is a person or an organization. Output only. One of user, organization.

GitHubUserAuthorization

FieldTypeWhat it is
authorization_idstringOpaque attempt identity; a new begin invalidates the preceding attempt. Output only.
user_codestringHuman code entered while signed in as the expected user. Output only.
verification_uristringhttps://github.com/login/device; the operator approves the App here. Output only.
expire_timetimestampBegin again after this ceremony expires. Output only.
next_poll_timetimestampEarliest time CompleteConnectionAuthorization may poll GitHub. Output only.

Oauth2Authorization

FieldTypeWhat it is
refresh_token_configuredboolWhether a sealed refresh token is stored in Broker custody. Output only.
access_token_expire_timetimestampWhen the cached access token expires, if one is present. Output only.
last_refresh_timetimestampWhen the sealed credentials were last refreshed from the provider. Output only.
requires_reauthorizationboolWhether the provider refused refresh and operator reauthorization is needed. Output only.
refresh_errorstringNon-secret failure reason when reauthorization is required. Output only.

Errors

Every error arrives in the body Errors describes.

Examples

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