Skip to main content
POST
Create or update an external auth provider

Authorizations

x-tenant-api-key
string
header
required

Tenant API key for authentication

Body

application/json
provider_id
string
required

Unique identifier for this provider

Required string length: 1 - 100
display_name
string
required

Human-readable name

Required string length: 1 - 255
issuer
string<uri>
required

OIDC issuer URL (must use HTTPS)

jwks_uri
string<uri>
required

JSON Web Key Set endpoint (must use HTTPS)

allowed_audiences
string[]
required

Valid audience values for tokens

Minimum array length: 1
auto_create_users
boolean
default:true

Whether to auto-create users on first token exchange

default_membership_tier
string
default:ORDINARY

Tier assigned to auto-created users

user_id_claim
string
default:sub

JWT claim containing the user's external ID

email_claim
string
default:email

JWT claim containing the user's email

name_claim
string
default:name

JWT claim containing the user's display name

is_active
boolean
default:true

Whether this provider is active

Response

Provider created or updated

id
string<uuid>
provider_id
string

Unique identifier for this provider

display_name
string

Human-readable name

issuer
string<uri>

OIDC issuer URL

jwks_uri
string<uri>

JSON Web Key Set endpoint

allowed_audiences
string[]

Valid audience values for tokens

auto_create_users
boolean

Whether to auto-create users on first token exchange

default_membership_tier
string

Tier assigned to auto-created users

is_active
boolean

Whether this provider is active

created_at
string<date-time>
updated_at
string<date-time>