Skip to main content

IdPConfigPayload

$schemauri

A URL to the JSON Schema for this object.

Example: https://example.com/schemas/IdPConfigPayload.json
clientIdstringrequired

OAuth client ID registered at the IdP

clientSecretstring

OAuth client secret; omit or send empty to preserve the stored value

displayNamestringrequired

Human-friendly label for the admin UI

emailClaimstring

Override for the email claim (default: email)

enabledbooleanrequired

If false, public /start endpoint returns 404 even when the config exists

issuerURLstringrequired

OIDC discovery base URL (no trailing slash)

nameClaimstring

Override for the display name claim (default: name)

redirectURLstringrequired

Absolute callback URL registered at the IdP (typically /v1/identity/oidc/callback)

scopesstring[]nullable

Requested scopes; defaults to openid email profile

subClaimstring

Override for the subject claim (default: sub)

IdPConfigPayload
{
  "$schema": "https://example.com/schemas/IdPConfigPayload.json",
  "clientId": "string",
  "clientSecret": "string",
  "displayName": "string",
  "emailClaim": "string",
  "enabled": true,
  "issuerURL": "string",
  "nameClaim": "string",
  "redirectURL": "string",
  "scopes": "Unknown Type: array,null",
  "subClaim": "string"
}