PingID Administration Guide

Email customizations - general

Several PingID services send out emails to users.

The email sources are shown in the following table.

Email address source Reference

RADIUS

See Multiple Attribute Mapping Rules in the General Parameters table of PingID RADIUS PCV parameters reference guide

PingID API

See the Add User section of PingID API - AddUser

AD FS

See Email Attribute in step 4 of Configuring advanced settings

Azure AD

See step 4e of Configuring PingID MFA for Microsoft Azure AD Conditional Access

PingID for PingFed

See Email Attribute in step 5 of Configuring a PingID Adapter instance

PingOne SSO stand alone

https://docs.pingidentity.com/bundle/pingone/page/fml1564020492091-2.htmlConnecting to an identity repository]

Four email customizations are available:

  1. Customize the email "From" address to change the default address of noreply@pingidentity.com to noreply@yourdomain.com.

  2. Customize the email "Replyto" address to change the default address of noreply@pingidentity.com to noreply@yourdomain.com.

  3. Customize the email "Subject" line.

    To change items 1 to 3 above, sign on to the Ping Identity Support Portal and open a case.

  4. Customize the email message body. PingID supplies templates to customize the body of notification mails. To download the templates, see PingID email templates. Download the .zip file and extract it. The included readme.txt file contains a directory list of templates.

Email templates

The downloaded .zip file contains HTML templates for all PingID notification emails. You can view the files as-is in a web browser.

The HTML templates all use variables (replacement macros), some of which are mandatory and some are optional. The Templates variables and usage table lists each variable. NOTE: If you include images in any of the templates, they must be URL references to publicly available assets. Ping does not host the images used in templates.

After you finish editing your template, contact PingID Customer Support to upload the template.

About the table:

  1. Variables are marked as follows:

    • M - mandatory

    • O - optional

    • Blank - irrelevant.

  2. Variables all take the form $[.parmname]{variable_name}````. Mandatory variables must appear in your edited template.

  3. The table shows the variables visible in the templates. All of the templates have undisplayed variables. The footnotes following the table list the undisplayed values.

  4. The variable ${service-provider} is optional for all files except Download and Pair PinglD.html. For New Email Authentication Request.html, it is also currently visible.

Templates variables and usage
Template File Variables Template usage

${org-name}

${one-time-passcode}

${service-provider}

${activation-code}

${current-year}

User Paired New Device of Specific Type

Pairing

Remarks

webauthn_platform_android.html(1)

M

O

O

Web: Android biometric

webauthn_platform_iphone.html (1)

M

O

O

Web: iPhone FaceID

webauthn_platform_macintosh.html (1)

M

O

O

Web: Mac Touch ID

webauthn_platform_windows.html (1)

M

O

O

Web: Windows Hello

webauthn_platform.html (1)

M

O

O

Web: Other biometric

webauthn.html(1)

M

O

O

Web: Security key

android.html (2)

M

O

O

Android device app

authenticatorAppEmailTemplate.html(1)

M

O

O

Authenticator app

desktop.html (3)

M

O

O

Desktop app

email.html (3)

M

O

O

Authentication by email response

iphone.html (2)

M

O

O

iPhone device app

oathTokenEmailTemplate.html (1)

M

O

O

Authentication by OATH hardware token

sms.html(3)

M

O

O

Authentication by SMS response

voice.html (3)

M

O

O

Authentication by voice response

yubikey.html (1)

M

O

O

Authentication using a YubiKey

Download and Pair PinglD.html(4)

M

When user clicks Get Download Link during registration

QR image required

Email Authentication Pairing.html(5)

M

O

O

Pairing code delivery is used when user clicks the Receive passcodes via email button during registration

One-time passcode sent by email

New Email Authentication Request.html (5)

M

O (Visible)

O

One-time passcode delivery during authentication

One-time passcode sent by the service provider

Notes to the table:

  1. These files have the following additional optional undisplayed variables

    • ${cloudfront-url}: Image

    • ${fraud-link}: Report fraud button

  2. These files have the following additional optional undisplayed variables

    • ${cloudfront-url}: Image

    • ${device-name}

    • ${device-details}

    • ${fraud-link}: Report fraud button

  3. These files have the following additional optional undisplayed variables

    • ${cloudfront-url}: Image

    • ${device-details}

    • ${fraud-link}: Report fraud button

  4. The Download and Pair PinglD.html file has the following additional optional undisplayed variables:

    • ${download-link-for-iphone-ipad}: iOS download link

    • ${download-link-for-android}: Android download link

    • ${no-scan-pairing-link}: Link to Finish Pairing PingID button image

    • ${qrcode-image}: Link to QR code image

  5. These files have the following additional optional undisplayed variable:

    • ${download-link-for-android}: Android download link