← Back to plugin index

Matrix Token Controller

Description
Credential controller to manage matrix cards in the admintool.
Type name
MatrixTokenController
Class
com.airlock.iam.admin.application.configuration.matrixcard.MatrixTokenController
May be used by
License-Tags
Matrixcard
Properties
Identifier (identifier)
Description
Identifier for the credential. This is used as value in the authentication method field in the persistence layer. Make sure this value is the same (for the same credential) in all Airlock IAM components.

Make sure the identifier is unique among all configured credential controllers.

The identifier is also used as key to translate the display name of this credential controller. The key is assembled as follows: edituserpage.cred.XYZ.title (where XYZ is the identifier).

Attributes
String
Optional
Default value
MATRIX
Suggested values
MATRIX, GRIDCARD, TAN, TOKENLIST
Auto Order (autoOrder)
Description
Set this flag to true to automatically order a matrix card when it is added to a user.
Attributes
Boolean
Optional
Default value
false
Auto Order For New Users (autoOrderForNewUsers)
Description
Set this flag to true to automatically order a matrix card if the user is created.
Attributes
Boolean
Optional
Default value
false
May Be Selected As Auth Method (mayBeSelectedAsAuthMethod)
Description
Set this flag to false to prevent this credential from being selected as active authentication method.
Attributes
Boolean
Optional
Default value
true
May Be Selected As Next Auth Method (mayBeSelectedAsNextAuthMethod)
Description
Set this flag to false to prevent this credential from being selected as the next (migration) authentication method.
Attributes
Boolean
Optional
License-Tags
TokenSelfService
Default value
true
Token List Persister (tokenListPersister)
Description
The token list persister used to read and write matrix card data from some persistence layer (e.g. a database or directory).
Attributes
Plugin-Link
Mandatory
Assignable plugins
Validity Days (validityDays)
Description
The number of days a token list is considered valid for. This number is used to calculate the expiration date of a token list based on the token list generation date.

Make sure to use the same value here as in other Airlock IAM components.

If this property is not defined, no token list expiry date is displayed.

Attributes
Integer
Optional
Matrix Card Generator (matrixCardGenerator)
Description
If specified, matrix cards can be generated from the admintool.
Attributes
Plugin-Link
Optional
Assignable plugins
YAML Template (with default values)

type: MatrixTokenController
id: MatrixTokenController-xxxxxx
displayName: 
comment: 
properties:
  autoOrder: false
  autoOrderForNewUsers: false
  identifier: MATRIX
  matrixCardGenerator:
  mayBeSelectedAsAuthMethod: true
  mayBeSelectedAsNextAuthMethod: true
  tokenListPersister:
  validityDays: