OTP SMS Sender node
The OTP SMS Sender node uses an email-to-SMS gateway provider to send an SMS message containing a generated one-time password (OTP) to the user.
The node sends an email to an address formed by joining the following values together:
-
The user’s telephone number, obtained by querying a specified profile attribute, for example,
telephoneNumber
. -
The
@
character. -
The email-to-SMS gateway domain, obtained by querying the profile attribute specified by the Mobile Carrier Attribute Name property.
For example, if configured to use the TextMagic email-to-SMS service,
the node might send an email through the specified SMTP server to the address: 18005550187@textmagic.com
.
Compatibility
Product | Compatible? |
---|---|
Advanced Identity Cloud |
Yes |
PingAM (self-managed) |
Yes |
Ping Identity Platform (self-managed) |
Yes |
Inputs
This node requires the following input from the shared state:
-
The authenticating user’s ID. The node queries the user’s entry for a telephone number.
Implement an Attribute Collector node node before this node to obtain the user’s ID.
-
The OTP stored in the
oneTimePassword
transient state property.Implement the HOTP Generator node before this node in the journey to obtain the OTP.
Configuration
Property | Usage | ||
---|---|---|---|
Mail Server Host Name (required) |
The hostname of the SMTP email server. |
||
Mail Server Host Port |
The outgoing mail server port. Common ports are 25, 465 for SSL/TLS, or 587 for StartTLS. |
||
Mail Server Authentication Username |
The username PingOne Advanced Identity Cloud uses to connect to the mail server. |
||
Mail Server Authentication Password |
The password PingOne Advanced Identity Cloud uses to connect to the mail server.
|
||
Mail Server Secret Label Identifier |
An identifier used to create a secret label for mapping to a secret in a secret store. PingOne Advanced Identity Cloud uses this identifier to create a specific secret label for this node. The secret label takes the form
If you set a Mail Server Secret Label Identifier and PingOne Advanced Identity Cloud finds a matching secret in a secret store, the Mail Server Authentication Password is ignored. |
||
Email From Address (required) |
The email address from which the OTP will appear to have been sent. |
||
Mobile Phone Number Attribute Name |
The attribute in the user profile that contains the mobile phone number to which the SMS with the OTP is sent. Default: |
||
Mobile Carrier Attribute Name |
The attribute in the user profile that contains the mobile carrier domain for sending SMS messages. By default, an PingOne Advanced Identity Cloud user profile doesn’t have an attribute for the mobile carrier domain. You can customize the user profile by adding a new attribute to it, then populate that attribute with users' SMS messaging domains. All mobile carriers and bulk SMS messaging services have associated SMS messaging domains.
For example, Verizon uses If you leave the Mobile Carrier Attribute Name property empty, PingOne Advanced Identity Cloud defaults to sending SMS messages
using |
||
The subject of the message |
Click Add to add a new message subject. Enter the locale, such as |
||
The content of the message |
Click Add to add the content of the message. Enter the locale, such as |
||
Mail Server Secure Connection |
Set the connection method to the mail server. If you set a secure method here, PingOne Advanced Identity Cloud must trust the server certificate of the mail server. The possible values for this property are:
Default: |
||
Gateway Implementation Class |
The class the node uses to send SMS and email messages. Default: |
Errors
The node throws an IdRepoException
and an SSOException
error if it’s unable to obtain the user’s telephone number.
Outcomes
Single outcome path.
Implement an OTP Collector Decision node after this node to continue the authentication journey.