← Back to plugin index

SMS Event Subscriber (Loginapp)

Description
An event subscriber that sends an SMS to notify a user.
Type name
LoginappSmsEventSubscriber
Class
com.airlock.iam.login.application.configuration.event.LoginappSmsEventSubscriberConfig
May be used by
Properties
SMS Settings (smsSettings)
Description
Settings to send a SMS to the notified user.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Phone Number Providers (phoneNumberProviders)
Description
Provides the phone numbers to which the notification will be sent.
Attributes
Plugin-List
Mandatory
Assignable plugins
Message Resource Key (messageResourceKey)
Description
The resource key under which the localized template for the sms message can be found. The following syntax can be used to include data in the template.
  • ${valueMapKey} for the value of valueMapKey provided by any of the configured Value Map Providers.
  • ${event.createdAt,date,format} to include 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.airlock2FAAccountId
  • event.data.airlock2FADeviceId
  • event.data.activeAuthenticationMethod
  • event.data.authenticationMethods
  • event.data.browser
  • event.data.city
  • 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.countryCode
  • event.data.crontoDeviceId
  • event.data.device
  • event.data.deviceTokenId
  • event.data.fidoCredentialId
  • event.data.fidoPublicKeyCredentialId
  • event.data.oauth2.authorizationServerId
  • event.data.fidoRelyingPartyId
  • event.data.lockReason
  • event.data.mtanNewPhoneNumber
  • event.data.mtanNumberId
  • event.data.mtanOldPhoneNumber
  • event.data.newEmailAddress
  • event.data.newRealm
  • event.data.oauth2.acceptedScopes
  • event.data.oauth2.alwaysGrantedScopes
  • event.data.oauth2.clientId
  • event.data.oauth2.deniedScopes
  • event.data.oldEmailAddress
  • event.data.oldRealm
  • event.data.operatingSystem
  • event.data.previousAuthenticationMethod
  • event.data.stepResult.attributes.<attribute-name> (where <attribute-name> ist the name of the additional attribute, could be nested.)
  • event.data.stepResult.errorCode
  • event.data.stepResult.nextAction
  • event.data.stepResult.type
  • event.data.userId
  • event.id
  • event.metadata.requestIp
  • event.metadata.userAgent
  • event.source.applicationId
  • event.source.configurationContext
  • event.source.flowId
  • event.source.stepId
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
String
Optional
Default value
sms.notification.message
YAML Template (with default values)

type: LoginappSmsEventSubscriber
id: LoginappSmsEventSubscriber-xxxxxx
displayName: 
comment: 
properties:
  event:
  language:
  messageResourceKey: sms.notification.message
  phoneNumberProviders:
  smsSettings:
  valueMapProviders: