Configs

Upsert ID token claims configuration

Create or update the ID token extended claims configuration for the tenant. This controls which extended claims are included in ID tokens when the corresponding scopes are requested.

put/api/configs/id-token

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/configs/id-token
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Request body

enabledExtendedClaimsstring[]

An array of extended claims to include in ID tokens. Possible values: custom_data, identities, sso_identities, roles, organizations, organization_data, organization_roles.

Response

The updated ID token claims configuration.

enabledExtendedClaimsstring[]

Changes

No recorded changes to this operation across all 8 revisions of this API.