← Back to plugin index

mTAN Label Item Definition
Description

Item to register a label for an mTAN number. The label is saved in the flow session and later persisted together with the (potentially verified) mTAN number. Note that the credential mTAN handler does not support labels.

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
MtanLabelItemDefinition
Class
com.airlock.iam.flow.shared.application.configuration.item.mtan.MtanLabelItemDefinitionConfig
May be used by
User Data Edit Step User Data Registration Step
Properties
Key (key)
Description
The key under which the client is expected to provide the label.
Attributes
String
Optional
Default value
mtanLabel
Required (required)
Description
Specifies whether this item is required for the step to validate successfully. An optional label may be deleted.
Attributes
Boolean
Optional
Default value
false
Maximum Length (maximumLength)
Description
Maximum length of the label.
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
Validators (validators)
Description
Validators for the label.
Attributes
Plugin-List
Optional
Assignable plugins
Email Address Validator Phone Number Validator Regex String Validator
YAML Template (with default values) 

type: MtanLabelItemDefinition
id: MtanLabelItemDefinition-xxxxxx
displayName: 
comment: 
properties:
  inputPurpose:
  key: mtanLabel
  maximumLength: 30
  required: false
  validators: