← Back to plugin index

Default mTAN Token Registration Flow
Description

Simple configuration for an mTAN token registration self-service flow.

The following steps are automatically generated:

  • A mTAN Token Registration Step (step ID "register-mtan") to register the mTAN number and optionally also a label.
  • An mTAN Verification Step to verify the new number by sending and verifying an OTP
  • An Apply Changes Step

The access condition for the flow is always an mTAN Number Registration Possible.

If more advanced features are needed, a Custom Protected Self-Service Flow can be configured.

Type name
DefaultMtanTokenRegistrationFlow
Class
com.airlock.iam.selfservice.application.configuration.flow.DefaultMtanTokenRegistrationFlowConfig
May be used by
Protected Self-Service Flows
Properties
Flow ID (flowId)
Description
Unique ID for this flow, which is used for selecting or referencing a flow.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Flow ID
Authorization Condition (authorizationCondition)
Description
Precondition that must be fulfilled for the user to be authorized to access this flow without further authentication. Note the difference to the "Access Condition":
  • Access Condition: This condition determines whether a user is allowed to access a service at all. If this condition is not fulfilled, there is nothing that can be done (at least not immediately). Typical examples include having a certain authentication token, or a certain static role. This condition is always checked before the Authorization Condition and if it fails, the REST response has status 403 with error code PRECONDITION_NOT_FULFILLED.
  • Authorization Condition: This condition determines whether the user is currently authorized to access a service. It is expected that completing another authentication flow (step-up) would enable the user to then fulfill the condition. The typical authorization condition checks whether the user has obtained a certain tag (or combination of tags). If the condition fails, the REST response has status 403 with error code NOT_AUTHORIZED.
Attributes
Plugin-Link
Optional
Assignable plugins
Account Linking Required Red Flag Condition Active Authentication Method Airlock 2FA Device Deletion Possible Airlock 2FA was used for login (Transaction Approval only) Always False Always True Boolean Condition Cronto Activation Possible Cronto Activation Required Cronto Device Removal Possible Cronto Letter Order Condition Cronto was used for login (Transaction Approval only) CrontoSign Swiss Push Activation Possible Email OTP was used for login (Transaction Approval only) FIDO Credential Removal Possible FIDO was used for login (Transaction Approval only) First Usage of Device Has Cronto Account Has Cronto Device Has Device Token Has Email Address Has FIDO Credential Has Matching Role Has Matrix Card Has OATH OTP Token Has Password Has Suitable Airlock 2FA Device Has Tag Has Vasco OTP Token Has mTAN Activation Letter Has mTAN Token IdP-Initiated SSO Flow On SP Logical AND Logical NOT Logical OR Matching Username Never Migrate Possible New Device Condition Next Authentication Method-based Migration Condition OAuth 2.0 Authorization Code Grant In Progress OIDC prompt=none Condition Password Letter Order Interval Condition Public Self-Service Allowed Condition Red Flag Raised Request Has SSO Ticket Step Activated String Regex Condition User Attribute Is Unique User Identified User Represented Condition Vasco Activation Possible mTAN Number Changed mTAN Number Deletion Possible mTAN Number Registration Possible mTAN was used for login (Transaction Approval only)
mTAN Settings (mtanSettings)
Description
Defines the settings for mTAN.
Attributes
Plugin-Link
Mandatory
Assignable plugins
mTAN OTP Check Settings (based on mTAN Settings) mTAN OTP Checks Settings
Label Registration (labelRegistration)
Description
If enabled, the label can also be set in this flow.
Attributes
Boolean
Optional
Default value
true
Message Provider (messageProvider)
Description
Creates the message for the verification SMS.
Attributes
Plugin-Link
Mandatory
Assignable plugins
mTAN Message Provider
mTAN Number Field Input Purpose (mtanNumberInputPurpose)
Description

The input purpose allows labeling data items using standardized values (see https://www.w3.org/TR/WCAG22/#input-purposes).

It is rendered using the HTML attribute "autocomplete". Browsers can use this to automatically fill input fields with data that was previously entered in other fields with the same purpose.

Note that the input purpose provided here will be used in the default Loginapp UI components and is available to custom single-page applications via the REST endpoints */info/retrieve.

If the Loginapp UI is used with configuration-based 'Customized Step UIs', the input purpose has to be defined on the UI elements ('Input UI Element', 'Drop-Down UI Element', 'Date UI Element').

Attributes
String
Optional
Suggested values
tel, tel-national, tel-local
mTAN Label Field Input Purpose (mtanLabelInputPurpose)
Description

The input purpose allows labeling data items using standardized values (see https://www.w3.org/TR/WCAG22/#input-purposes).

It is rendered using the HTML attribute "autocomplete". Browsers can use this to automatically fill input fields with data that was previously entered in other fields with the same purpose.

Note that the input purpose provided here will be used in the default Loginapp UI components and is available to custom single-page applications via the REST endpoints */info/retrieve.

If the Loginapp UI is used with configuration-based 'Customized Step UIs', the input purpose has to be defined on the UI elements ('Input UI Element', 'Drop-Down UI Element', 'Date UI Element').

Attributes
String
Optional
YAML Template (with default values) 

type: DefaultMtanTokenRegistrationFlow
id: DefaultMtanTokenRegistrationFlow-xxxxxx
displayName: 
comment: 
properties:
  authorizationCondition:
  flowId:
  labelRegistration: true
  messageProvider:
  mtanLabelInputPurpose:
  mtanNumberInputPurpose:
  mtanSettings: