← Back to plugin index

SMS Notifier
Description
Configuration of an SMSNotifier which sends an notification SMS message to a user.
Type name
SmsNotifier
Class
com.airlock.iam.core.misc.impl.notification.SmsNotifier
May be used by
Vasco OTP Token Controller
Properties
SMS Gateway (smsGateway)
Description
SMS gateway to send the notification SMS.
Attributes
Plugin-Link
Mandatory
Assignable plugins
ASP SMS Gateway Dummy SMS Gateway Email SMS Gateway Failover SMS Gateway HTTP SMS Gateway Kannel SMS Gateway Null SMS Gateway Number-based Selection SMS Gateway SMPP SMS Gateway SMS Finder Gateway Swisscom REST SMS Gateway Swissphone SMS Gateway True Senses SMS Gateway UCP SMS Gateway eCall SMS Gateway (v1)
User Persister (userPersister)
Description
The user persister plug-in used to load the phone number of an user.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Active Directory Connector Cipher User Persister Combining Extended User Persister Combining User Persister Database User Persister Dummy Extended User Persister LDAP Connector LDAP User Persister Property User Persister
Originator (originatorName)
Description
The originator name is displayed as the sender of the sms on the recipients phone.
Attributes
String
Mandatory
Mobile Number Context Data Field (mobileNumberContextDataField)
Description
Context data field in which the mobile number is stored in.
Attributes
String
Mandatory
Message Body (smsBody)
Description
The template used as body. This text may contain specific variable strings defined one plugin level higher (e.g. $USERNAME$) or context data variables (e.g. ${givenname}).
Attributes
String
Mandatory
Multi-line-text
Example
Hi $USERNAME$, this sms notifies you about something.
Example
Hi Mr/Ms ${givenname}, this sms notifies you about something.
Example
Hi Mr/Ms ${givenname}, your username is $USERNAME$.
YAML Template (with default values) 

type: SmsNotifier
id: SmsNotifier-xxxxxx
displayName: 
comment: 
properties:
  mobileNumberContextDataField:
  originatorName:
  smsBody:
  smsGateway:
  userPersister: