← Back to plugin index

mTAN Number Item Definition
Description

Item to edit or register an mTAN number. By default, all numbers that can be normalized are accepted, but additional configurable validators can further restrict the number. Once validated, the normalized number is kept in the session to be verified and persisted later in the flow.

In protected self-service flows, the dedicated "mTAN Token Edit Step" or "mTAN Token Registration Step" are the preferred way to edit or register mTAN tokens, respectively.

Type name
MtanNumberItemDefinition
Class
com.airlock.iam.flow.shared.application.configuration.item.mtan.MtanNumberItemDefinitionConfig
May be used by
User Data Edit Step User Data Registration Step Email Verification Step Phone Number Verification Step
Properties
Key (key)
Description
The key under which the client is expected to provide the number.
Attributes
String
Optional
Default value
mtanNumber
Required (required)
Description
Specifies whether this item is required for the step to validate successfully. If required, the number must be registered or changed. An optional number cannot be deleted. To delete an mTAN number, use a "Delete mTAN Number Initiation Step" or the pre-configured "Default mTAN Deletion Flow".
Attributes
Boolean
Optional
Default value
true
Maximum Input Length (maximumInputLength)
Description
Maximum length of the entered phone number, before normalization.
Attributes
Integer
Optional
Default value
30
Input Purpose (inputPurpose)
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
Validators On Normalized (validatorsOnNormalized)
Description
Validators for the normalized mTAN number. E.g. to restrict the number to certain area codes.

No validator can be configured for the raw input of the phone number. The input is always required to be normalizable by IAM, otherwise a validation error is returned. Normalization requires the number to start with "0" or the plus sign ("+") followed by digits and separation characters like white-space, dashes and parentheses. Normalized numbers always start with a plus sign, followed by digits only.

Attributes
Plugin-List
Optional
Assignable plugins
Email Address Validator Phone Number Validator Regex String Validator
mTAN Settings (mtanSettings)
Description
Defines the required settings for mTAN.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Basic mTAN Settings
YAML Template (with default values) 

type: MtanNumberItemDefinition
id: MtanNumberItemDefinition-xxxxxx
displayName: 
comment: 
properties:
  inputPurpose:
  key: mtanNumber
  maximumInputLength: 30
  mtanSettings:
  required: true
  validatorsOnNormalized: