← Back to plugin index

Custom Claim (OAuth 2.0 Token Exchange)
Description
Sets the configured claim to the configured value. Beware that claims with a "Registered Claim Name" (see RFC7519) are not allowed.
Type name
OAuth2TokenExchangeJwtCustomClaim
Class
com.airlock.iam.oauth2.application.configuration.tokenexchange.rules.jwt.OAuth2TokenExchangeJwtCustomClaimConfig
May be used by
JWT Token Exchange Rule
License-Tags
OAuthTokenExchange
Properties
Claim Name (claimName)
Description
The claim name. Claims with a "Registered Claim Name" see RFC7519 are not allowed.
Attributes
String
Mandatory
Example
username
Example
claim1
Claim Value (claimValue)
Description
The claim value.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Audience From Request Parameter (OAuth 2.0 Token Exchange) Audience From Subject Token (OAuth 2.0 Token Exchange) Claim From Subject Token (OAuth 2.0 Token Exchange) Client ID From Subject Token (OAuth 2.0 Token Exchange) Client ID Of Authenticated Client (OAuth 2.0 Token Exchange) Static String (OAuth 2.0 Token Exchange) Static String-Array (OAuth 2.0 Token Exchange) String From Actor Token (OAuth 2.0 Token Exchange) String From Subject Token (OAuth 2.0 Token Exchange) String-Array From Actor Token (OAuth 2.0 Token Exchange) String-Array From Subject Token (OAuth 2.0 Token Exchange) Subject From Subject Token (OAuth 2.0 Token Exchange)
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: OAuth2TokenExchangeJwtCustomClaim
id: OAuth2TokenExchangeJwtCustomClaim-xxxxxx
displayName: 
comment: 
properties:
  claimCondition:
  claimName:
  claimValue: