← Back to plugin index

Basic mTAN Settings
Description
The basic settings for mTAN.
Type name
BasicMtanSettings
Class
com.airlock.iam.common.application.configuration.mtan.BasicMtanSettings
May be used by
Apply mTAN Registration Change mTAN Token Edit Step mTAN Token Insertion Handler SMS Identity Verification Step Default mTAN Deletion Flow Delete mTAN Number Initiation Step mTAN Self-Services (Legacy) mTAN Number List Select mTAN Token Step Apply mTAN Edit Change mTAN Number Item Definition SMS Event Subscriber (Loginapp) Apply mTAN Deletion mTAN OTP Checks Settings mTAN Number Deletion Possible SMS Event Subscriber (Adminapp) mTAN Number Registration Possible mTAN Token Registration Step
Properties
mTAN Handler (mtanHandler)
Description
An mTAN handler retrieves and updates mTAN number tokens.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Credential Data mTAN Handler Token Data mTAN Handler
SMS Gateway (smsGateway)
Description
The SMS gateway used to send messages.
Attributes
Plugin-Link
Mandatory
Assignable plugins
ASP SMS Gateway Dummy SMS Gateway Email SMS Gateway Failover SMS Gateway HTTP SMS Gateway Kannel SMS Gateway Null SMS Gateway Number-based Selection SMS Gateway SMPP SMS Gateway SMS Finder Gateway Swisscom REST SMS Gateway Swissphone SMS Gateway True Senses SMS Gateway UCP SMS Gateway eCall SMS Gateway (v1)
Originator (originator)
Description

Originator of the SMS messages.

There may be restrictions on the originator imposed by the SMS gateway service and by local law.

The format of the originator must be one of:

  • Numeric characters only, optionally prefixed with a plus sign '+', at most 16 characters
  • Alphanumeric characters, at most 11 characters
Furthermore, the characters that are allowed may depend on your SMS gateway provider.
Attributes
String
Mandatory
Example
Airlock
Default Country Code (defaultCountryCode)
Description
Default country code to be used if a phone number does not contain a country code. It is only used when sending messages to the user.
Attributes
String
Optional
Length <= 3
Length >= 1
Default value
41
Suggested values
41, 39, 49, 423
Use Flash Messages (useFlashMessages)
Description

If enabled, SMS messages are sent as flash SMS by default. A flash message is shown directly on the mobile phone display.

If the per-user setting is set, it takes precedence as long as a value is set for a user. If it is empty or not set, this default value is used.

Note: This has to be supported by the SMS gateway. Some recipients might not be able to receive flash messages.

Attributes
Boolean
Optional
Default value
false
Visible Phone Number Digits (visiblePhoneNumberDigits)
Description

Defines the number of phone number digits visible in log statements and in selection options sent to the user.

If the value is zero, all digits are masked, if it is large enough, all digits are visible. Example: if set to 3, logged number looks like ********965.

The default is 100, i.e. showing all digits.

Attributes
Integer
Optional
Default value
100
YAML Template (with default values) 

type: BasicMtanSettings
id: BasicMtanSettings-xxxxxx
displayName: 
comment: 
properties:
  defaultCountryCode: 41
  mtanHandler:
  originator:
  smsGateway:
  useFlashMessages: false
  visiblePhoneNumberDigits: 100