← Back to plugin index

User Roles Custom Claim
Description
A custom claim introducing a JSON Array containing the user's persistent roles in the response.

If a role transformation is configured in the Authorization Server, this claim will contain the transformed roles.

Type name
CustomUserRoleClaim
Class
com.airlock.iam.oauth2.application.configuration.claims.CustomUserRoleClaimConfig
May be used by
JWT Access Token Format Claim Set Custom Claim OIDC ID Token Claims OAuth 2.0 Static Client OAuth 2.0 Static Client OIDC UserInfo Endpoint
License-Tags
OAuthServer
Properties
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: CustomUserRoleClaim
id: CustomUserRoleClaim-xxxxxx
displayName: 
comment: 
properties:
  claimCondition:
  claimName: