← Back to plugin index

MTAN/SMS Authenticator
Description
This authenticator sends an SMS with a one-time password (OTP) to the user's mobile phone. If this OTP is correctly provided back to IAM, the authentication step is successfully completed.
Type name
SmsAuthenticator
Class
com.airlock.iam.core.misc.impl.authen.mtan.SmsAuthenticator
May be used by
Administrators Configuration Meta Authenticator Meta Authenticator Meta Authenticator Persister Password Service Authenticator-based One-Shot Target Application User to Authenticator Mapping Authentication Method Identifier Mapping Fallback Authenticator Selection Authenticator Main Authenticator Auth Method-based Authenticator Selector Credential-based Authenticator Selector Credential to Authenticator Mapping Radius Authentication Service Roles-to-Authenticator Mapping Role-based Authenticator Selector User-based Authenticator Selector
Properties
mTAN Settings (mtanSettings)
Description
Defines the settings for handling mTAN.
Attributes
Plugin-Link
Mandatory
Assignable plugins
MTAN/SMS Settings
Choose Last Number Automatically (chooseLastNumberAutomatically)
Description
If enabled, the number used for the last successful login attempt is chosen automatically without any user interaction.
Attributes
Boolean
Optional
Default value
false
Send SMS in Stealth Mode (sendSmsInStealthMode)
Description

Send SMS messages in stealth mode for existing users even if first factor was wrong and the user is not locked. The number of sent SMS per user is limited to the maximum allowed first factor attempts (see Main Authenticator).

Attributes
Boolean
Optional
Default value
false
Message Template (messageTemplate)
Description

Message template used to create the message text sent to the user. Use Shift-Return to insert line breaks.

This template is only used, if no language-specific template is configured in the mTAN Settings.

Special Variables:

  • The string $TOKEN$ in the message template is mandatory and is replaced by the token.
  • ${Now,...} contains the current timestamp and can be used for both date and time display in the SMS. Since this represents a Date object, it can be formatted directly using MessageFormat, for example ${Now,date,short} displays a short date using the user's locale, e.g. 09.01.12. A specific date format can be specified in a SimpleDateFormat compatible form, e.g. ${Now,date,dd.MM.yyyy HH:mm.ss} resulting in 09.01.2012 17:32.19.
Attributes
String
Optional
Multi-line-text
Default value
$TOKEN$
Example
Please insert the following code: $TOKEN$.
Example
Current time: ${Now,date,HH:mm}; Token = $TOKEN$
String Resources File (stringResourcesFile)
Description

Specifies the prefix of the file(s) containing the language dependent string resources. Example: If the value of this property is strings, the language dependent files must be strings_de.properties, strings_en.properties, etc.

Attributes
String
Optional
Default value
strings
Default Language (defaultLanguage)
Description

Default language to be used for login message if the display language could not be determined. This is only used for translating the language-specific message template.

Attributes
String
Optional
Default value
de
YAML Template (with default values) 

type: SmsAuthenticator
id: SmsAuthenticator-xxxxxx
displayName: 
comment: 
properties:
  chooseLastNumberAutomatically: false
  defaultLanguage: de
  messageTemplate: $TOKEN$
  mtanSettings:
  sendSmsInStealthMode: false
  stringResourcesFile: strings