← Back to plugin index

OAuth 2.0 Custom Session Attribute

Description
Configuration of an OAuth 2.0 custom session attribute.

An OAuth 2.0 session can have various custom attributes that are defined as a name-value pair.

Type name
OAuth2CustomSessionAttribute
Class
com.airlock.iam.oauth2.application.configuration.session.OAuth2CustomSessionAttributeConfig
May be used by
License-Tags
OAuthServer
Properties
Name (name)
Description
Name of the OAuth 2.0 custom session attribute.
Attributes
String
Mandatory
Length <= 50
Value Pattern (valuePattern)
Description
An optional regular expression to validate the value.
Attributes
RegEx
Optional
Default value
.{1,200}
Updatable (updatable)
Description
Whether the value of this OAuth 2.0 custom session attribute can be updated after being set once. If unchecked, the OAuth 2.0 custom session attribute can only be created once but never be updated nor deleted.
Attributes
Boolean
Optional
Default value
true
YAML Template (with default values)

type: OAuth2CustomSessionAttribute
id: OAuth2CustomSessionAttribute-xxxxxx
displayName: 
comment: 
properties:
  name:
  updatable: true
  valuePattern: .{1,200}