ClaimIncludeInAllScopes

boolean

Specifies whether to include the claim in all scopes. If the value is set to ‘false’ for a claim, the claim is only included in the scopes that explicitly list it.

Default:false

ClaimIncludeInScopes

array

Specifies the scopes IDs in which the claim is included

UpdateClaimEnabled

boolean

Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the ‘/userinfo’ endpoint.

ClaimEnabled

boolean

Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the ‘/userinfo’ endpoint.

Default:true

Claim

object
idstring(uuid)required

The ID of the claim

namestringrequired

The name of the claim

>= 1 characters

valuestringrequired

Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.

>= 1 characters

include_in_tokenbooleanrequired

Specifies whether to include claim in the token. If the value is set to ‘false’ for a claim, the client instead uses the access token to get claims from the ‘/userinfo’ endpoint.

Default:false

include_in_all_scopesbooleanrequired

Specifies whether to include the claim in all scopes. If the value is set to ‘false’ for a claim, the claim is only included in the scopes that explicitly list it.

Default:false

include_in_scopesarray[string](uuid)required

Specifies the scopes IDs in which the claim is included

enabledbooleanrequired

Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the ‘/userinfo’ endpoint.

Default:true

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example