← Back to plugin index

mTAN Self-Services (Legacy)
Description
The settings for managing mTAN tokens.
Type name
MtanSelfServicesLegacy
Class
com.airlock.iam.selfservice.application.configuration.mtan.MtanSelfServicesLegacyConfig
May be used by
User Self-Service Settings
Properties
mTAN Settings (mtanSettings)
Description
General settings for SMS/mTAN handling.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Basic mTAN Settings
Message Template Key (messageTemplateKey)
Description
Key of the message template in the string resource files to enable language-specific messages to be sent to the user. The string $TOKEN$ in the message template is mandatory and is replaced by the token.
Attributes
String
Optional
Default value
sms-authenticator.default-message
OTP Generator (tokenGenerator)
Description
The string generator plugin to generate the one time password (OTP) token.
Attributes
Plugin-Link
Optional
Assignable plugins
Dynamic Active Directory String Generator Pattern-based Random String Generator
Case-Sensitive OTP Check (otpCaseSensitive)
Description
If enabled, the case of characters is respected when checking OTP tokens.
Attributes
Boolean
Optional
Default value
true
Allow Phone Number Change (allowPhoneNumberChange)
Description
If enabled, the user may change an already registered mobile phone number by starting the registration process for mobile phone numbers. If disabled (the default), changing an already registered number is not possible.
Attributes
Boolean
Optional
Default value
false
OTP Validity [s] (otpValidity)
Description
Determines how long the OTP is valid (in seconds).
Attributes
Integer
Optional
Default value
300
Normalized Number Validation Regex (phoneNumberValidationRegex)
Description
Regular expression to restrict phone numbers (e.g. to a specific country or internal company numbers).
If configured, the normalized phone number is matched against this regular expression.
Attributes
RegEx
Optional
YAML Template (with default values) 

type: MtanSelfServicesLegacy
id: MtanSelfServicesLegacy-xxxxxx
displayName: 
comment: 
properties:
  allowPhoneNumberChange: false
  messageTemplateKey: sms-authenticator.default-message
  mtanSettings:
  otpCaseSensitive: true
  otpValidity: 300
  phoneNumberValidationRegex:
  tokenGenerator: