← Back to plugin index

mTAN Message Provider

Description
Generic provider for mTAN messages.
Type name
GenericMtanMessageProvider
Class
com.airlock.iam.flow.shared.application.configuration.message.GenericMtanMessageProviderConfig
May be used by
Properties
Resource Key (resourceKey)
Description
Resource key to select the localized template to display the data. The localized template can contain variables (e.g. ${town}) and supports the same formatting options (including shrinking of values to fit to limited size) as are available for Transaction Approval messages. The template must contain the variable ${TOKEN} which will be replaced by the OTP token.
Attributes
String
Mandatory
Example
self-service.user-data-edit.approval.mtan
Example
password-reset.factors.mtan.message
Example
mtan-registration.verification.message
Value Providers (valueProviders)
Description
List of value map providers that are used to replace the variables in the localized template. The values providers are called in the configured order and their values are added to a map. Later providers can overwrite values from earlier providers. If no value providers are configured, the localized template should not contain any variables, since all of them would be replaced by empty strings. The OTP token for the ${TOKEN} variable is always added to the map and doesn't have to be configured here.
Attributes
Plugin-List
Optional
Assignable plugins
Maximum Message Length (maxLength)
Description
Defines the maximum length for the mTAN message. If the message cannot be fit into this length (potentially after shrinking values), an exception is thrown.
Attributes
Integer
Optional
Default value
160
YAML Template (with default values)

type: GenericMtanMessageProvider
id: GenericMtanMessageProvider-xxxxxx
displayName: 
comment: 
properties:
  maxLength: 160
  resourceKey:
  valueProviders: