SynqDocs
Management APICustom sign-in providers

Add a sign-in provider of the brand’s own

An OpenID Connect issuer (`type: oidc`, discovered from `issuer`) or an OAuth 2.0 server (`type: oauth2`, at the `endpoints` you name), through your own app there, whose `redirect_uri` the answer names. Every URL is https on the public internet (422 `provider_url_unsafe`), and Synq reaches the provider only from its own server. Synq asks the provider first, so nothing it refuses is kept: it reads the discovery document (422 `provider_discovery_failed`) and tries the app's id and secret at the token endpoint (422 `connection_rejected`, 503 while it can't be reached). Sign-ins use state, PKCE (S256) and, for OpenID Connect, a nonce and the ID token's signature, as with Synq's providers. Its email addresses are unverified unless `email_authoritative`. It is off until `POST …/enable`. At most 20 per brand (409 `conflict`); an id the brand has is 409 `sign_in_provider_exists`. Needs `org.connections.edit` and a plan with `auth.custom_providers`, Scale and up (403 `plan_feature_unavailable`, naming the plan that has it). A person needs a sign-in at Synq from the last 5 minutes whose time Synq proved (send them to sign in with `max_age=300`), else 403 `fresh_sign_in_required`; an API key never does. Recorded as `brand.updated` with `provider` and each setting under `custom_sign_in_provider.`, never the secret.

POST/v1/orgs/{org}/brands/{brand}/custom-sign-in-providers

An OpenID Connect issuer (type: oidc, discovered from issuer) or an OAuth 2.0 server (type: oauth2, at the endpoints you name), through your own app there, whose redirect_uri the answer names. Every URL is https on the public internet (422 provider_url_unsafe), and Synq reaches the provider only from its own server. Synq asks the provider first, so nothing it refuses is kept: it reads the discovery document (422 provider_discovery_failed) and tries the app's id and secret at the token endpoint (422 connection_rejected, 503 while it can't be reached). Sign-ins use state, PKCE (S256) and, for OpenID Connect, a nonce and the ID token's signature, as with Synq's providers. Its email addresses are unverified unless email_authoritative. It is off until POST …/enable. At most 20 per brand (409 conflict); an id the brand has is 409 sign_in_provider_exists. Needs org.connections.edit and a plan with auth.custom_providers, Scale and up (403 plan_feature_unavailable, naming the plan that has it). A person needs a sign-in at Synq from the last 5 minutes whose time Synq proved (send them to sign in with max_age=300), else 403 fresh_sign_in_required; an API key never does. Recorded as brand.updated with provider and each setting under custom_sign_in_provider., never the secret.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string

The org's id

Match^org_[0-9a-hjkmnp-tv-z]{26}$
brand*string

The brand's id

Match^brd_[0-9a-hjkmnp-tv-z]{26}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/brands/brd_01h455vb4pex5vsknk084sn02q/custom-sign-in-providers" \  -H "Authorization: Bearer $SYNQ_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "client_id": "app_01h455vb4pex5vsknk084sn02q",    "client_secret": "string",    "token_endpoint_auth_method": "client_secret_basic",    "id": "custom-acme-guild",    "type": "oidc",    "name": "Acme Guild",    "icon": "string",    "issuer": "https://id.acme-guild.example",    "endpoints": {      "authorization": "string",      "token": "string",      "userinfo": "string"    },    "scopes": [      "string"    ],    "claims": {      "subject": "string",      "name": "Acme",      "handle": "string",      "picture": "string",      "email": "ana@acme.example",      "email_verified": "string"    },    "email_authoritative": true,    "use": "sign_in",    "keep_tokens": true,    "kept_claims": [      "string"    ]  }'
{  "id": "custom-acme-guild",  "type": "oidc",  "name": "Acme",  "icon": "string",  "issuer": "string",  "endpoints": {    "authorization": "string",    "token": "string",    "userinfo": "string"  },  "app": {    "client_id": "app_01h455vb4pex5vsknk084sn02q",    "token_endpoint_auth_method": "client_secret_basic",    "updated_at": "2026-10-21T12:00:00.000Z"  },  "redirect_uri": "https://acme.auth.synq.build/federation/custom-acme-guild/callback",  "scopes": [    "string"  ],  "claims": {    "subject": "string",    "name": "Acme",    "handle": "string",    "picture": "string",    "email": "ana@acme.example",    "email_verified": "string"  },  "email_authoritative": true,  "use": "sign_in",  "keep_tokens": true,  "kept_claims": [    "string"  ],  "offered": true,  "created_at": "2026-10-21T12:00:00.000Z"}