← Back to plugin index

ID Token Claim
Description
The configured claim is requested to be added to the default claims in the ID Token returned from the authorization server.

Note that the authorization server may not support requesting the configured claim (or requesting claims at all).

Type name
IdTokenClaim
Class
com.airlock.iam.oauth2.application.configuration.IdTokenClaimConfig
May be used by
OIDC Flow Client OIDC Discovery Flow Client
Properties
Claim (claim)
Description
The claim to request to be included in the ID Token.
Attributes
String
Mandatory
Example
sub
Example
acr
Example
auth_time
Values (values)
Description
Requests that the claim be returned with a particular value. The value must be a valid value for the claim being requested.

If multiple values are configured, the request indicates that the claim should be returned with one of the given values. The values in the request appear in order of preference.

If not configured, the claim is requested without a restriction on its value.
Attributes
String-List
Optional
Requirement (requirement)
Description
The client indicates whether the claim being requested is an essential or a voluntary claim.
  • Essential: the claim is necessary to ensure a smooth authorization experience for the specific task requested by the end-user.
  • Voluntary: the claim is useful but not essential for the specific task requested by the end-user
Note that even if a claim is requested as 'essential', the authorization server is not obligated to return it.
Attributes
Enum
Optional
Default value
ESSENTIAL
YAML Template (with default values) 

type: IdTokenClaim
id: IdTokenClaim-xxxxxx
displayName: 
comment: 
properties:
  claim:
  requirement: ESSENTIAL
  values: