mTAN Token Import Handler
Description
Handles the import of mTAN tokens. It reads all mTAN tokens from the provided list of tokens. For each item in the list, it updates the corresponding mTAN item if there already exists a token with the same phone number for the given user. If no such item exists, it creates a new item. The handler assumes that all mTAN items of the user are contained in the list, i.e., already existing items with a phone number that is not contained in the provided list are deleted. Already existing items that have no phone number are deleted as well. If the list is empty, the handler does not change any existing items.
May be used by
Properties
Mtan Settings (
mtanSettings) Description
Defines settings concerning mTAN. In particular, it provides access to the configured MtanHandler to read and write mTAN tokens. Furthermore, it provides phone number normalization settings. All imported phone numbers are normalized according to these settings while existing phone numbers in storage are assumed to be normalized according to these same settings already.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Only Import For New Users (
onlyImportForNewUsers) Description
If enabled, existing values in the DB are not updated with values read from the file.
Attributes
Boolean
Optional
Default value
false
Normalize Phone Numbers (
normalizePhoneNumbers) Description
If enabled, the phone number entered by the user is normalized before being stored. Normalizing means that it is transformed into the international form like "+41761234567"
A default country code (see separate property) must be specified if this feature is enabled.
A default country code (see separate property) must be specified if this feature is enabled.
Attributes
Boolean
Optional
Default value
true
YAML Template (with default values)
type: MtanTokenImportHandler
id: MtanTokenImportHandler-xxxxxx
displayName:
comment:
properties:
mtanSettings:
normalizePhoneNumbers: true
onlyImportForNewUsers: false