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
connectionsand, 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 |
|---|---|---|
connections | Connection[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
Connection
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/connections/{connection}. |
uid | string | cnx_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | ConnectionSpec | Desired state. Required. |
status | ConnectionStatus | 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. |
ConnectionSpec
| Field | Type | What it is |
|---|---|---|
provider | string | The provider this is an installation of; unset for Web Push. |
external_id | string | The provider's id of the installation, for example a GitHub App installation id. Unset for Web Push. |
web_push | WebPushConfig | Web Push assertion configuration. Mutually exclusive with provider and external_id. The Connection kind cannot change after creation. |
github_user | GitHubUserConfig | GitHub 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. |
oauth2 | Oauth2ConnectionConfig | Generic OAuth 2.0 authorization. Mutually exclusive with web_push and github_user. Requires an oauth2 ConnectionProvider. |
ConnectionStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
state | ConnectionState | The installation's lifecycle state. Output only. One of pending, active, suspended, removed. |
account | ExternalAccount | The third-party account the provider is installed on. Output only. |
repository_selection | RepositorySelection | Whether the installation covers every repository or a selection. Output only. One of all, selected. |
permissions | map<string, string> | The permissions the account granted, for example {"contents": "read"}. Output only. |
events | string[] | The webhook events the installation delivers. Output only. |
install_time | timestamp | When the provider says the installation was created. Output only. |
suspend_time | timestamp | When the provider suspended the installation. Output only. |
verify_time | timestamp | When the status was last read back from the provider. Output only. |
authorization | GitHubUserAuthorization | Current 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_authorization | Oauth2Authorization | Observed generic OAuth 2.0 authorization metadata; contains no token. Output only. |
WebPushConfig
| Field | Type | What it is |
|---|---|---|
key | string | Enabled, generated SIGN/ec_p256_sha256 Key in the Connection organization. Required. |
contact | string | Operator contact, a mailto: or HTTPS URI; used as the JWT subject. Required. |
GitHubUserConfig
| Field | Type | What it is |
|---|---|---|
provider | string | App provider whose OAuth client issued the authorization. Required. |
login | string | Expected verified GitHub login; never inferred from untrusted input alone. Required. |
Oauth2ConnectionConfig
| Field | Type | What it is |
|---|---|---|
external_account_id | string | Non-secret account identifier associated with the external authorization. |
provider_metadata | map<string, string> | Non-secret provider metadata captured from callbacks or supplied by the caller. Secret-bearing keys are rejected. |
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. |
ExternalAccount
| Field | Type | What it is |
|---|---|---|
external_id | string | The provider's id of the account. Output only. |
login | string | The account's login, for example SylphxAI. Output only. |
kind | ExternalAccountKind | Whether the account is a person or an organization. Output only. One of user, organization. |
GitHubUserAuthorization
| Field | Type | What it is |
|---|---|---|
authorization_id | string | Opaque attempt identity; a new begin invalidates the preceding attempt. Output only. |
user_code | string | Human code entered while signed in as the expected user. Output only. |
verification_uri | string | https://github.com/login/device; the operator approves the App here. Output only. |
expire_time | timestamp | Begin again after this ceremony expires. Output only. |
next_poll_time | timestamp | Earliest time CompleteConnectionAuthorization may poll GitHub. Output only. |
Oauth2Authorization
| Field | Type | What it is |
|---|---|---|
refresh_token_configured | bool | Whether a sealed refresh token is stored in Broker custody. Output only. |
access_token_expire_time | timestamp | When the cached access token expires, if one is present. Output only. |
last_refresh_time | timestamp | When the sealed credentials were last refreshed from the provider. Output only. |
requires_reauthorization | bool | Whether the provider refused refresh and operator reauthorization is needed. Output only. |
refresh_error | string | Non-secret failure reason when reauthorization is required. Output only. |
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/connections" \
-H "Authorization: Bearer $SYLPHX_API_KEY"