← Back to plugin index

mTAN OTP Checks Settings
Description
Settings for mTAN OTP Checks.
Type name
MtanOtpCheck
Class
com.airlock.iam.flow.shared.application.configuration.mtan.MtanOtpCheckConfig
May be used by
Default mTAN Token Registration Flow Default mTAN Token Edit Flow mTAN Transaction Approval Step mTAN Authentication Step mTAN Public Self-Service Approval Step mTAN Verification Step mTAN Self-Service Approval Step Legacy mTAN Registration Flow
Properties
Basic mTAN Settings (basicSettings)
Description
Basic mTAN configuration settings.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Basic mTAN Settings
OTP Generator (otpGenerator)
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
Max Wrong OTP Checks (maxWrongOtpChecks)
Description
The number of times a user may retry after a wrong OTP is entered before the flow is aborted. If set to zero (the default), only one attempt is possible for each OTP. This is more secure but may increase costs (if sending an SMS is costly) and negatively affects usability.
Setting this value to n means that the user has n+1 tries in total. This should not be confused with the limit of failed attempts before the user is locked, which is configured globally for each flow type.
Attributes
Integer
Optional
Default value
0
Max OTP Resends (maxOtpResends)
Description
Maximum number of times an OTP token may be requested to be resent during one authentication process. Authentication is aborted if this limit is exceeded. Token retransmissions are disabled if this value is 0. Restricting this value to a small number prevents the abusive use of SMS delivery.
Attributes
Integer
Optional
Default value
0
Resend Same OTP (resendSameOtp)
Description
If token resends are enabled, this property sets whether the OTP token should be resent or whether a new OTP should be generated for each retransmission. Setting this property to true is less secure but helps avoiding erroneous user input when the initial OTP is received before retransmission.
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
Last Token Automatically Selected (lastTokenAutomaticallySelected)
Description
Controls whether the last used mTAN token is selected by default instead of presenting a selection to the user.
Attributes
Boolean
Optional
Default value
false
Auto Select Single Number (autoSelectSingleNumber)
Description
Controls whether the verification starts automatically or if a single number choice is presented as a selection to the client.
Attributes
Boolean
Optional
Default value
true
YAML Template (with default values) 

type: MtanOtpCheck
id: MtanOtpCheck-xxxxxx
displayName: 
comment: 
properties:
  autoSelectSingleNumber: true
  basicSettings:
  lastTokenAutomaticallySelected: false
  maxOtpResends: 0
  maxWrongOtpChecks: 0
  otpCaseSensitive: true
  otpGenerator:
  otpValidity: 300
  resendSameOtp: false