Skip to main content
POST
Create Provider

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_id
string
required

Body

application/vnd.api+json

Request body for registering a new external-login provider.

Accepts EITHER a flat body OR a full JSON:API envelope.

extra="forbid" makes the endpoint reject unknown fields (e.g. a smuggled client_secret_ciphertext) with 422 rather than silently ignoring them. The before-validator strips the JSON:API envelope so data / type wrapper keys never reach the forbid check.

client_secret is required on create and write-only — it is never returned in read responses.

client_id
string
required
client_secret
string
required
write-only
display_name
string
required
provider_kind
string
required
authorize_url
string | null
claim_map
Claim Map · object | null
discovery_url
string | null
enabled
boolean
default:true
issuer
string | null
jwks_uri
string | null
scopes
string[] | null
slug
string | null
token_url
string | null
userinfo_url
string | null

Response

Successful Response

data
JsonApiResource[ExternalProviderAttributes] · object
required
included
any[] | null
meta
Meta · object | null