← Back to plugin index

Airlock 2FA Message Provider
Description
Generic message provider for Airlock 2FA.
Type name
GenericAirlock2FAMessageProvider
Class
com.airlock.iam.flow.shared.application.configuration.message.GenericAirlock2FAMessageProviderConfig
May be used by
Airlock 2FA Authentication Step Airlock 2FA Authentication Step Airlock 2FA Public Self-Service Approval Step Airlock 2FA Usernameless Authentication Step Airlock 2FA Transaction Approval Step Airlock 2FA Self-Service Approval Step
License-Tags
Airlock2FA
Properties
Title Translation Key (titleTranslationKey)
Description

This key identifies the message template that is used to generate the message title. The title is displayed in the Airlock 2FA mobile app after the word "Approve", e.g. "Login" or "Password Reset".

It is displayed for One-Touch, Online QR Code and Usernameless QR Code factors.

It is ignored for Offline QR Code. Because of technical limitations, the title of Offline QR Codes is always the default title from Futurae.

The string resource key itself may also contain variables, e.g. 'airlock2fa.message.${type}.title'. Variables are replaced with the corresponding values available in the current context, such as the configured "Value Providers" or the data of the triggering event. For more information about formatting, consult the customer documentation.

Attributes
String
Mandatory
Example
self-service.user-data-edit.approval.airlock-2fa.title
Example
password-reset.factors.airlock-2fa.title
Example
airlock2fa.one-touch.authentication-title
Information Items (informationItems)
Description
Configures the various contextual information that will be displayed on the Airlock 2FA app of a user when a message approval is started. Note that for readability reasons it is not recommended to provide more than three entries of such contextual information.

These information items are displayed for One-Touch, Online QR Code, Offline QR Code and Usernameless QR Code factors.

Attributes
Plugin-List
Optional
Assignable plugins
Airlock 2FA Information Item
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.
Attributes
Plugin-List
Optional
Assignable plugins
Additional Password Check Attribute Map Airlock 2FA Authentication Data Map Airlock 2FA Login ID Parameter Authentication Data Map Conditional Value Map Provider Context Data Map Edited Context Data Map Generic Session Attribute Value Map Provider HTTP Request Information Map OAuth 2.0 Credential Context Data Map OAuth 2.0 Tokens Map Roles Provider SSI Verification Data Provider SSO Ticket Context Data Provider Script Execution Result Value Map Provider Transaction Approval Parameters Map Transforming Value Map Provider User Identity Map User Passwords Map User Statistics Map Value Provider Map mTAN Token Flow Value Map
YAML Template (with default values) 

type: GenericAirlock2FAMessageProvider
id: GenericAirlock2FAMessageProvider-xxxxxx
displayName: 
comment: 
properties:
  informationItems:
  titleTranslationKey:
  valueProviders: