PUT /api/configs/id-token
O auth2

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.

application/json

Body Required

  • enabledExtendedClaims array[string]

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

    Values are custom_data, identities, sso_identities, roles, organizations, organization_data, or organization_roles.

Responses

  • 200 application/json

    The updated ID token claims configuration.

    Hide response attribute Show response attribute object
    • enabledExtendedClaims array[string]

      Values are custom_data, identities, sso_identities, roles, organizations, organization_data, or organization_roles.
  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    The tenant's subscription plan does not support this feature.

PUT /api/configs/id-token 
curl \
 --request PUT 'https://[tenant_id].logto.app/api/configs/id-token' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"enabledExtendedClaims":["custom_data"]}'
Request examples 
{
  "enabledExtendedClaims": [
    "custom_data"
  ]
}
Response examples (200) 
{
  "enabledExtendedClaims": [
    "custom_data"
  ]
}