Skip to content
Console
On this page

Connection providers

A ConnectionProvider is a third-party integration an org operates, for example the *Sylphx* GitHub App owned by `sylphx-platform`.

A ConnectionProvider is a third-party integration an org operates, for example the Sylphx GitHub App owned by sylphx-platform. Its signing key lives in Sylphx Keys and only the credential service uses it; its webhook secret lives in Sylphx Secrets.

Service Sylphx Connections · Resource type connections.sylphx.com/ConnectionProvider · Name pattern orgs/{org}/connection_providers/{connection_provider} · Shape spec_status

Fields

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

MethodCallWhat it does
POSTbegin_registrationBegins an expiring, one-use GitHub manifest registration ceremony. Open registration_url to POST the bound, prefilled manifest to GitHub. github_organization selects organization ownership. The state-authorized callback is GET /v1/connections/github-manifest:callback?state=...&code=... and returns only provider metadata and an installation URL.
POSTcreateCreates a connection provider, such as an OAuth 2.0 client configuration.
POSTbegin_oauth2_authorizationBegins an expiring hosted OAuth 2.0 authorization ceremony for an OAuth 2.0 ConnectionProvider. Returns an authorization_url carrying an expiring one-use state token handled by GET /v1/connections/oauth2:callback.
POSTadoptAdopts an existing GitHub App whose non-exportable custody already exists. The server observes public SPKI metadata and verifies signed GET /app before atomically registering the SIGN Key and provider. No private key is accepted.
GETgetGets a connection provider.
GETlistLists an org's connection providers.
PATCHupdateUpdates a connection provider.
DELETEdeleteDeletes a connection provider; force forgets its local connections only.

begin_registration

Begins an expiring, one-use GitHub manifest registration ceremony. Open registration_url to POST the bound, prefilled manifest to GitHub. github_organization selects organization ownership. The state-authorized callback is GET /v1/connections/github-manifest:callback?state=...&code=... and returns only provider metadata and an installation URL.

POST https://api.sylphx.com/v1/orgs/acme/connection_providers:beginRegistration · scope connections:admin · effect write · Request, response and examples

create

Creates a connection provider, such as an OAuth 2.0 client configuration.

POST https://api.sylphx.com/v1/orgs/acme/connection_providers · scope connections:admin · effect write · validate_only · Request, response and examples

begin_oauth2_authorization

Begins an expiring hosted OAuth 2.0 authorization ceremony for an OAuth 2.0 ConnectionProvider. Returns an authorization_url carrying an expiring one-use state token handled by GET /v1/connections/oauth2:callback.

POST https://api.sylphx.com/v1/orgs/acme/connection_providers/connection-provider:beginOauth2Authorization · scope connections:write · effect write · Request, response and examples

adopt

Adopts an existing GitHub App whose non-exportable custody already exists. The server observes public SPKI metadata and verifies signed GET /app before atomically registering the SIGN Key and provider. No private key is accepted.

POST https://api.sylphx.com/v1/orgs/acme/connection_providers:adopt · scope connections:admin · effect write · Request, response and examples

get

Gets a connection provider.

GET https://api.sylphx.com/v1/orgs/acme/connection_providers/connection-provider · scope connections:read · effect read · Request, response and examples

list

Lists an org's connection providers.

GET https://api.sylphx.com/v1/orgs/acme/connection_providers · scope connections:read · effect read · paginated · Request, response and examples

update

Updates a connection provider.

PATCH https://api.sylphx.com/v1/orgs/acme/connection_providers/connection-provider · scope connections:admin · effect write · Request, response and examples

delete

Deletes a connection provider; force forgets its local connections only.

DELETE https://api.sylphx.com/v1/orgs/acme/connection_providers/connection-provider · scope connections:admin · effect destructive · Request, response and examples