← Back to plugin index

String Value Provider Custom Claim
Description
A custom string value claim that contains the values of the specified String Provider.

This custom claim allows providing flow information into JWT tokens as a custom claim.

Type name
CustomStringValueProviderClaim
Class
com.airlock.iam.oauth2.application.configuration.claims.CustomStringValueProviderClaimConfig
May be used by
JWT Access Token Format OIDC ID Token Claims OAuth 2.0 Static Client OAuth 2.0 Static Client
License-Tags
OAuthServer
Properties
String Provider (stringProvider)
Description
String value that is included in the claim.

Note: No claim is added if the string value provider returns null.

Attributes
Plugin-Link
Mandatory
Assignable plugins
Changed Email Address Provider Display Language String Provider Fallback String Value Provider Generic Session Attribute String Provider HTTP Request Cookie Value Provider HTTP Request Header Value Provider Identity Value Provider OAuth 2.0/OIDC Authorization Request Parameter Value Provider OAuth2 Access Token String Value Provider Realm String Provider Static String Value Provider String Context Data Value Provider String From Map Value Provider Template-based String Provider Ticket String Provider Transforming String Value Provider Translated String Provider User Principal Name Provider mTAN Registration Label Provider mTAN Registration Number Provider
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: CustomStringValueProviderClaim
id: CustomStringValueProviderClaim-xxxxxx
displayName: 
comment: 
properties:
  claimCondition:
  claimName:
  stringProvider: