On this page
Connections
A Connection is a third-party relationship: a provider installation, or Web Push assertion configuration backed by a generated Sylphx Keys…
A Connection is a third-party relationship: a provider installation, or Web Push assertion configuration backed by a generated Sylphx Keys key. The Connections controller validates its configuration before it is Ready.
Service Sylphx Connections · Resource type connections.sylphx.com/Connection · Name pattern orgs/{org}/connections/{connection} · Shape spec_status
Fields
| 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. |
Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a connection. |
GET | list | Lists an org's connections. |
POST | begin_authorization | Begins GitHub device authorization for a new or existing user Connection. The operator opens verification_uri and enters user_code once. Broker keeps the device code and all resulting tokens; clients never supply credentials. Reauthorization preserves the Connection's provider and expected login. |
POST | complete_authorization | Polls one authorization attempt no earlier than next_poll_time. Only an explicit pending response allows another provider poll. Unknown outcomes require a new authorization; successful credentials are sealed and committed before the Connection becomes active. A completed attempt is safe to replay. |
POST | import_oauth2_credentials | Imports existing OAuth 2.0 credentials into sealed Broker custody for a Connection without returning any secret token. |
POST | create | Records an installation; the controller confirms it with the provider. |
PATCH | update | Updates a connection's metadata. |
DELETE | delete | Forgets a connection. The installation itself is removed at the provider. |
get
Gets a connection.
GET https://api.sylphx.com/v1/orgs/acme/connections/connection · scope connections:read · effect read · Request, response and examples
list
Lists an org's connections.
GET https://api.sylphx.com/v1/orgs/acme/connections · scope connections:read · effect read · paginated · Request, response and examples
begin_authorization
Begins GitHub device authorization for a new or existing user Connection. The operator opens verification_uri and enters user_code once. Broker keeps the device code and all resulting tokens; clients never supply credentials. Reauthorization preserves the Connection's provider and expected login.
POST https://api.sylphx.com/v1/orgs/acme/connections/connection:beginAuthorization · scope connections:write · effect write · long-running · Request, response and examples
complete_authorization
Polls one authorization attempt no earlier than next_poll_time. Only an explicit pending response allows another provider poll. Unknown outcomes require a new authorization; successful credentials are sealed and committed before the Connection becomes active. A completed attempt is safe to replay.
POST https://api.sylphx.com/v1/orgs/acme/connections/connection:completeAuthorization · scope connections:write · effect write · long-running · Request, response and examples
import_oauth2_credentials
Imports existing OAuth 2.0 credentials into sealed Broker custody for a Connection without returning any secret token.
POST https://api.sylphx.com/v1/orgs/acme/connections/connection:importOauth2Credentials · scope connections:write · effect write · long-running · Request, response and examples
create
Records an installation; the controller confirms it with the provider.
POST https://api.sylphx.com/v1/orgs/acme/connections · scope connections:write · effect write · long-running · Request, response and examples
update
Updates a connection's metadata.
PATCH https://api.sylphx.com/v1/orgs/acme/connections/connection · scope connections:write · effect write · long-running · Request, response and examples
delete
Forgets a connection. The installation itself is removed at the provider.
DELETE https://api.sylphx.com/v1/orgs/acme/connections/connection · scope connections:write · effect destructive · long-running · Request, response and examples