← Back to plugin index

UserInfo Claim
Description
The configured claim is requested to be added to any claims that are requested using scope values from the UserInfo Endpoint. If no UserInfo claims are configured, the claims being requested from the UserInfo Endpoint are only those requested using scope values.
Type name
UserInfoClaim
Class
com.airlock.iam.oauth2.application.configuration.UserInfoClaimConfig
May be used by
OIDC Flow Client OIDC Discovery Flow Client
Properties
Claim (claim)
Description
The claim to request to be returned from the UserInfo Endpoint.
Attributes
String
Mandatory
Example
given_name
Example
nickname
Example
email
Example
email_verified
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: UserInfoClaim
id: UserInfoClaim-xxxxxx
displayName: 
comment: 
properties:
  claim:
  requirement: ESSENTIAL
  values: