← Back to plugin index

Airlock 2FA Push Event Subscriber (Adminapp)
Description
An event subscriber that sends an in-app notification to every Airlock 2FA device the user has enrolled when the configured event occurs.
Type name
AdminappAirlock2FAPushNotificationEventSubscriber
Class
com.airlock.iam.admin.application.configuration.event.AdminappAirlock2FAPushNotificationEventSubscriberConfig
May be used by
Adminapp Event Settings
License-Tags
Airlock2FA
Properties
Airlock 2FA Settings (airlock2faSettings)
Description
The global Airlock 2FA settings, providing access to the Futurae server and the Airlock 2FA user repository.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Airlock 2FA Settings
Payload Entries (payloadEntries)
Description
The information items (key/value pairs) that make up the in-app notification sent to the Airlock 2FA user when the event occurs. The following syntax can be used to include data in the template.
  • ${contextDataName} for the value of contextDataName in the context-data of the managed user.
  • ${event.createdAt,date,format} for the date/time at which the event was created, where "format" is a date pattern like "yyyy-MM-dd HH:mm:ss".
Depending on the event and on the conditions in which the event originated, the following variables may also be available:
  • event.createdAt
  • event.data.addedRoles (list of strings)
  • event.data.airlock2FAAccountId
  • event.data.airlock2FADeviceId
  • event.data.activeAuthenticationMethod
  • event.data.contextDataChanged.%s.newValue (where "%s" is replaced by the context-data field name).
  • event.data.contextDataChanged.%s.oldValue (where "%s" is replaced by the context-data field name).
  • event.data.crontoDeviceId
  • event.data.delegation.newPermissions (list of strings)
  • event.data.delegation.oldPermissions (list of strings)
  • event.data.delegation.permissions (list of strings)
  • event.data.delegation.realm
  • event.data.delegation.role
  • event.data.fidoCredentialId
  • event.data.lockReason
  • event.data.mtanNewPhoneNumber
  • event.data.mtanNumberId
  • event.data.mtanOldPhoneNumber
  • event.data.newEmailAddress
  • event.data.newRealm
  • event.data.newRoles (list of strings)
  • event.data.oldEmailAddress
  • event.data.oldRealm
  • event.data.oldRoles (list of strings)
  • event.data.previousAuthenticationMethod
  • event.data.removedRoles (list of strings)
  • event.data.userId
  • event.id
  • event.metadata.requestIp
  • event.metadata.userAgent
  • event.source.adminId
Variables that are not defined are replaced by an empty string. The Airlock IAM documentation provides further information about the availability of specific variables.
Attributes
Plugin-List
Mandatory
Assignable plugins
Airlock 2FA Information Item
Language Context Data Name (languageContextDataName)
Description
The context data field whose value is to be used as the recipient's message language. If the provided value is blank or invalid, the default language will be used.
Attributes
Plugin-Link
Optional
Assignable plugins
String Context Data Item Name
Default Language (defaultLanguage)
Description
The default language code used when no (or no valid) information about the current language is present. The code must resolve to a locale that's available on the server. Use a lowercase ISO-639 two-letter language code, optionally followed by "_" and an uppercase ISO-3166 two-letter country code.
Attributes
String
Optional
Default value
de
Suggested values
de, fr, en, en_GB, de_CH
Event (event)
Description
The general Adminapp event about which the subscriber should be notified.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Airlock 2FA Device Deleted Authentication Method Changed Context Data Changed Cronto Device Deleted Cronto Letter Ordered Delegation Created Delegation Deleted Delegation Permissions Changed Device Token Deleted Email Address Added Email Address Changed Email Address Deleted FIDO Credential Deleted MTAN Token Deleted MTAN Token Phone Number Changed MTAN Token Registered Password Changed Password Letter Ordered User Created User Deleted User Locked User Realm Changed User Roles Changed User Unlocked
YAML Template (with default values) 

type: AdminappAirlock2FAPushNotificationEventSubscriber
id: AdminappAirlock2FAPushNotificationEventSubscriber-xxxxxx
displayName: 
comment: 
properties:
  airlock2faSettings:
  defaultLanguage: de
  event:
  languageContextDataName:
  payloadEntries: