Dynamic Boolean Custom Claim
Description
A custom boolean claim whose value is determined by whether the value of a String Provider matches a specific regex.
May be used by
Properties
String Provider (
stringProvider) Description
Value provider used to get a string value to be matched against the regular expression below.
Note: If the string value provider returns null, it is interpreted as an empty string. In case the Regex matches empty strings, the value would be true.
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
Regex (
regex) Description
The regex used to match the String from the String Provider. A match results in a boolean value of true; otherwise, false.
Attributes
RegEx
Mandatory
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
YAML Template (with default values)
type: CustomDynamicBooleanClaim
id: CustomDynamicBooleanClaim-xxxxxx
displayName:
comment:
properties:
claimCondition:
claimName:
regex:
stringProvider: