← Back to plugin index

Claim Set Custom Claim
Description
A custom claim introducing a JSON Object in the response.
Type name
CustomClaimSetClaim
Class
com.airlock.iam.oauth2.application.configuration.claims.CustomClaimSetClaimConfig
May be used by
JWT Access Token Format OIDC ID Token Claims OAuth 2.0 Static Client OAuth 2.0 Static Client OIDC UserInfo Endpoint
License-Tags
OAuthServer
Properties
Custom Claims (customClaims)
Description
Custom claims to include in the object.
Attributes
Plugin-List
Mandatory
Assignable plugins
Claim Set Custom Claim Client ID Custom Claim Context Data String Custom Claim Formatted Date And Time Context Data Custom Claim Formatted LocalDate Context Data Custom Claim Session ID Custom Claim Static Boolean Custom Claim Static String Custom Claim String Format Custom Claim User Roles Custom Claim Username Custom Claim
Claim Name (claimName)
Description
The name (JSON key) of the claim.

Attention: If a custom claim with this same claim name already exists, it will result in a runtime error.

Using a registered claim name (see RFC 7519) might cause the claim to be ignored or an exception to be thrown.
Attributes
String
Mandatory
Example
firstname
Example
street
Example
zip
Example
country
Example
roles
Claim Condition (claimCondition)
Description

This custom claim will only be added to the issued token if the configured condition is satisfied.

If no condition is configured, the custom claim will always be added.

Attributes
Plugin-Link
Optional
Assignable plugins
And Claim Condition Not Claim Condition Or Claim Condition Required Scopes Claim Condition
YAML Template (with default values) 

type: CustomClaimSetClaim
id: CustomClaimSetClaim-xxxxxx
displayName: 
comment: 
properties:
  claimCondition:
  claimName:
  customClaims: