PingOne

Delivery methods and variables

Delivery methods define the format of the message, and include details such as the subject, message content, and variables that you can use in the message content. Variables can represent things like a user name or one-time password. Some variables are optional and some are mandatory.

SMS

Notifications are sent as an SMS (short message service) text message.

Sender ID

You can configure a sender ID to be used instead of a telephone number for commercial use or to comply with regulations requiring SMSs to be sent as transactional and not promotional. For more information, see Configuring an SMS/Voice sender account with PingOne.

New message

The content of the message. Use up to 660 characters.

Variables

The required variable is ${otp}. It must be included in the message content.The predefined optional variable is $\{user.username}. It can be included in the message content. The optional variable $\{user.username} is relevant only for the Strong Authentication, Device Pairing, and Transaction templates.

On some templates, the initiator of the flow might provide dynamic variables that can be included in the message as well. For more information, see Dynamic variables in the PingOne Platform API Reference.

Email

Notifications are sent as a standard email message. You can replace the PingOne email service with your organization’s SMTP server. See Configuring a custom SMTP email notification server.

PingOne sends emails from dedicated IP pools, which ensures the high reputation, increased reliability and deliverability rate of PingOne emails. End users can whitelist these IP addresses to reduce the likelihood of potential issues with grey-listing or content blocking of PingOne services.
From Name

The name of the sender’s email account that sends email notifications.

From Address

The email address of the sender’s account that sends email notifications.

Reply-To Name

The name of the sender’s email account to send replies.

Reply-To Address

The email address to send replies to the sender.

  • If you configure the environment to use the PingOne email service, you can only configure trusted email addresses in the From Address and Reply-To Address of the email notification template. See Configuring trusted email addresses.

  • If you configure the environment to use a custom email service, you can add any email (trusted or not-trusted) in the From Address and Reply-To Address of the email notification template.

    • It is the customer’s responsibility to check that the email is trusted in their mail server.

    • If the environment is configured to use a custom email service, and you later reconfigure it to use the PingOne email service without removing non-trusted email addresses from the email notification template, depending on the environment definitions, the default environment email address will be either a trusted From Address, or it will be the PingOne email service’s address.

  • The Reply-To Address for email notification templates is optional. If the Reply-To Address has a value, the From Address is mandatory .
Subject

The subject line of the email message.

New email

The content that appears in the message body. Use plain text or HTML.

Variables

The required variable is ${otp}. It must be included in the subject or message body.The predefined optional variable is $\{user.username}. It can be included in the subject or message body. The optional variable $\{user.username} is relevant only for the Strong Authentication, Device Pairing, and Transaction templates.

On some templates, the initiator of the flow might provide dynamic variables that can be included in the message as well. For more information, see Dynamic variables in the PingOne Platform API Reference.

Push

Notifications are sent as push notifications to the end user’s device.

Title

The title of the push notification, up to 200 characters.

Push category

Select a category to control the type of banner that is displayed to the user:

  • Banner buttons: The default banner - contains both Approve and Deny buttons.

  • No banner buttons: When the user clicks the banner, they are taken to an application that contains the necessary approval controls.

  • Approve & open app: When the Approve button is clicked, authentication is completed and the user is taken to the relevant application.

To use the non-default banners, you must implement them in your application code, using the PingOne SDK.
New push

The content that appears in the body of the notification.

Variables

No required variables.The predefined optional variable is $\{user.username}. It can be included in the title or message body. The optional variable $\{user.username} is relevant only for the Strong Authentication, Device Pairing, and Transaction templates.

On some templates, the initiator of the flow might provide dynamic variables that can be included in the message as well. For more information, see Dynamic variables in the PingOne Platform API Reference.

Voice

Notifications are sent to the end user’s device as voice messages.

A voice notification consists of a voice and a locale. For example selecting Man voice and en_GB locale, results in notifications that are spoken in a male voice with an English accent.

You can add a voice from the voice dropdown, or select Custom to add a custom voice (see Editing a notification template). If PingOne or your provider do not support the voice in combination with the selected language or locale, PingOne selects an alternative voice that is supported.

Voice type

Specify the type of voice that the end user will hear. Voice types are vendor specific, and the closest-matching voice is selected, based on the vendor-compatible options available, as follows:

  • Man or Woman: Select the most applicable voice, based on the gender selected and the user’s locale that is defined.

  • Best applicable: Select the most applicable voice, based on the user’s locale.

  • Custom (Twilio only): Specify the voice that you want to use.PingOne supports Man, Woman, and Polly voices only. For a list of relevant voices, see Text-to-Speech (TTS).

To enhance stability, Ping Identity uses more than one voice call provider. Therefore the voice type used might vary between different authentication requests.
Message

The content of the voice message.

Variables

The required variable is ${otp}. It must be included in the message.The predefined optional variable is $\{user.username}. It can be included in the message. The optional variable $\{user.username} is relevant only for the Strong Authentication, Device Pairing, and Transaction templates.

On some templates, the initiator of the flow might provide dynamic variables that can be included in the message as well. For more information, see Dynamic variables in the PingOne Platform API Reference.
Elements

The following operational elements can be embedded in voice messages:

  • <pause1sec>: Pauses the message narration for 1 second.

    The <pause1sec> element cannot be modified. To pause for more than one second, add multiple <pause1sec> elements in succession. For example, [.codeph]<pause1sec><pause1sec><pause1sec> pauses the message narration for three seconds.

  • <sayCharValue> .. </sayCharValue>: Reads the character name of each character of the enclosed string separately.

  • <repeatMessage val=x> .. </repeatMessage>: Narrates the enclosed text <val> number of times.

In the following message example, ${otp} is assigned the value "123456", and ${email} is assigned the value "joe@bxz.com":

Hello <pause1sec> your authentication code is <sayCharValue>${otp}</​sayCharValue> <repeatMessage val=2>I repeat your code is <sayCharValue>${otp}</​sayCharValue></​repeatMessage> <pause1sec> Mail <sayCharValue>${email}</​sayCharValue> for help

The narrated message on the voice call sounds like:

HELLO <1 second silence> YOUR AUTHENTICATION CODE IS ONE TWO THREE FOUR FIVE SIX I REPEAT YOUR CODE IS ONE TWO THREE FOUR FIVE SIX I REPEAT YOUR CODE IS ONE TWO THREE FOUR FIVE SIX <1 second silence> MAIL JAY OH EE AT BEE EX ZEE DOT SEE OH EM FOR HELP