← Back to plugin index

Generic Token Controller
Description
Generic Token Controller which allows a customized UI. Use this plugin if you need to manage a custom token in the Adminapp or if you need other functionality than the provided Token Controllers offer.
Type name
GenericTokenController
Class
com.airlock.iam.admin.application.configuration.generic.GenericTokenControllerConfig
May be used by
User Group Configuration Users Configuration
Properties
ID (id)
Description

Unique identifier for the token controller. Serves as token type ID in the REST interface.

This is also the "auth method" that is set on the user as active/next authentication method, i.e. it must match the "Authentication Method ID" of corresponding authentication flow steps.

Finally, this ID also determines the name (label) of this token controller in the Adminapp UI, as defined by the resource key 'user.auth-methods.type.generic.<id>', as well as the label for "auth method" specific lock reasons defined by the resource key 'user.account-state.LockReason.TooManyAuthAtts.<id>'.

Please note that the length of this ID must not be longer than 22 characters in order to comply with the default DB schema restrictions for column lock_reason.
Attributes
String
Mandatory
Validation RegEx: [a-zA-Z0-9_]+
Example
EMAILOTP
Example
DEVICE_TOKEN
Example
securid
User Interface (ui)
Description
Defines the graphical UI of this token controller in the Adminapp. If configured, the token controller is displayed as separate tab on the user management tab sheet using the configured ID. Otherwise, the token controller can only be used via the REST API.
Attributes
Plugin-Link
Optional
Assignable plugins
Generic Token Controller UI
Token Endpoint (tokenEndpoint)
Description
Configures the REST endpoint for this token. The configuration defines the persistency and which token data is provided for the generic REST endpoint.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Generic Token Endpoint
Token Event Type (tokenEventType)
Description
Type of events published on changes to the token data:
  • NONE: no events are published (default)
  • EMAIL: Events of type "Email Address Changed", "Email Address Added" and "Email Address Deleted" are published
  • DEVICE_TOKEN: Events of type "Device Token Deleted" are published
Attributes
Enum
Optional
Default value
NONE
Allowed As Active Auth Method (allowedAsActiveAuthMethod)
Description
Whether or not this token can be chosen as active authentication method.
Attributes
Boolean
Optional
Default value
true
Allowed As New Auth Method (allowedAsNewAuthMethod)
Description
Whether or not this token can be chosen as new authentication method.
Attributes
Boolean
Optional
Default value
true
Allowed For Auth Method Migration (allowedForAuthMethodMigration)
Description
Whether or not this token can be chosen for an authentication method migration.
Attributes
Boolean
Optional
Default value
true
Auto Order On Auth Method Add (autoOrderOnAuthMethodAdd)
Description
If enabled, an activation order is automatically placed when this authentication method is added to a user.
Attributes
Boolean
Optional
Default value
false
Auto Order On User Create (autoOrderOnUserCreate)
Description
If enabled, an activation order is automatically placed when the user is created.
Attributes
Boolean
Optional
Default value
false
YAML Template (with default values) 

type: GenericTokenController
id: GenericTokenController-xxxxxx
displayName: 
comment: 
properties:
  allowedAsActiveAuthMethod: true
  allowedAsNewAuthMethod: true
  allowedForAuthMethodMigration: true
  autoOrderOnAuthMethodAdd: false
  autoOrderOnUserCreate: false
  id:
  tokenEndpoint:
  tokenEventType: NONE
  ui: