Airlock 2FA Token Controller
Description
Plugin to manage a user's Airlock 2FA account.
May be used by
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
Optional
Validation RegEx: [a-zA-Z0-9_]+
Default value
AIRLOCK_2FA
Example
AIRLOCK_2FA
Example
AIRLOCK_2FA_CUSTOM
Airlock 2FA Settings (
airlock2faSettings) Description
Settings of Airlock 2FA.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Create Activation Letters (
createActivationLetters) Description
Settings for creating device activation letters. If not configured, activation letters cannot be created.
Attributes
Plugin-Link
Optional
Assignable plugins
Order Activation Letters (
orderActivationLetters) Description
Settings for ordering a device activation letter. If not configured, activation letters cannot be ordered.
Attributes
Plugin-Link
Optional
Assignable plugins
Create Shipment Letters (
createShipmentLetters) Description
Settings for hardware token shipment letters. If not configured, shipment letter cannot be created.
Attributes
Plugin-Link
Optional
Assignable plugins
Assign Hardware Tokens to Multiple Users (
shareHardwareTokensAmongUsers) Description
If checked, a hardware token can be assigned to multiple users.
Once a hardware token is assigned to a user, it is only available within the corresponding Futurae service.
Attributes
Boolean
Optional
Default value
false
YAML Template (with default values)
type: Airlock2FATokenController
id: Airlock2FATokenController-xxxxxx
displayName:
comment:
properties:
airlock2faSettings:
createActivationLetters:
createShipmentLetters:
id: AIRLOCK_2FA
orderActivationLetters:
shareHardwareTokensAmongUsers: false