← Back to plugin index

Formatted Date And Time Context Data Custom Claim
Description
A custom claim containing a Date and Time value (from the context data of the user) formatted as string.

Type name
CustomContextDataDateAsStringClaim
Class
com.airlock.iam.oauth2.application.configuration.claims.CustomContextDataDateAsStringClaimConfig
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
Context Data (contextDataName)
Description
The name of the date and time context data element to be returned in this claim.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Date And Time Context Data Item Name
Pattern (pattern)
Description
The pattern to format the date value with.
Attributes
String
Optional
Default value
yyyy-MM-dd
Suggested values
yyyy-MM-dd, dd.MM.yyyy, MM/dd/yyyy, dd-MMM-yyyy HH:mm:ss, yyyy-MM-dd HH:mm:ss
Timezone (timezone)
Description

The timezone that should be used when formatting the date value. If nothing is configured the timezone of the server is taken.

See for more examples.

Attributes
String
Optional
Suggested values
Europe/Zurich, US/Pacific, CET, GMT, UTC
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: CustomContextDataDateAsStringClaim
id: CustomContextDataDateAsStringClaim-xxxxxx
displayName: 
comment: 
properties:
  claimCondition:
  claimName:
  contextDataName:
  pattern: yyyy-MM-dd
  timezone: