Skip to main content

Customize email templates

You can customize the email messages sent from your Identity as a Service account from the Email Templates page. Identity as a Service processes the email body as a Mustache template, which allows you to use variables in your emails. For more information about template syntax options, see the Mustache documentation.

Email template descriptions​

The following is a list of Identity as a Service email templates. Some templates are only available to Managed Service Provider Accounts.

  • Account Expiring—Email that is sent to Tenant accounts that are about to expire. The emails are sent 14, 28, and 56 days before the account expiry date. This email is available only for Managed Service Provider Accounts.
  • Entrust Token Activation—Email that is sent to users when an Entrust Soft Token has been assigned to them. It contains instructions on how to activate the token.
  • Face Biometric Activation—Email that is sent to users when a face biometric has been assigned to them. It contains instructions on how to activate the face biometric.
  • Google Token Activation—Email that is sent to users when a Google Token has been assigned to them. It contains instructions on how to activate the token.
  • Grid Export—Email that is sent to users that contains their grid card.
  • Grid Export Password—Email that is sent to users that contains their grid card password if the grid card has been encrypted.
  • Magic Link Authentication—Email that is sent to a user when they need to complete authentication with a Magic Link.
  • Magic Link Password Reset—Email that is sent to a user when they need to complete password reset.
  • Magic Link Registration—Email that is sent to a user when they need to complete registration.
  • Mobile Flash Pass Activation—Email that is sent to users when a Mobile Flash Pass has been assigned to them. It contains instructions on how to activate the Mobile Flash Pass.
  • One Time Password Email—Email that is sent that contains a user's One Time Password (OTP) to authenticate to Identity as a Service.
  • Password Email—Email that is sent to a user containing their new password.
  • Password Expired—Email that is sent to a user when their password has expired.
  • Password Expiring—Email that is sent to a user when their password is soon to expire.
  • Password Status Email—Email that is sent to a user when their password is locked, unlocked, or an unlock attempt occurred.
  • Schedule Usage Report—Email that is sent when your Scheduled Usage Report is ready and your account has been configured to send Usage Reports. A Usage Report provides an update on entitlement usage. For example, if a Tenant account has an entitlement of 100 users and uses 50 users, an email is delivered to provide an update on the entitlement usage. This email is available only for Managed Service Provider Accounts. For more information, see Manage Usage Reports in the Service Provider Help.
  • Smart Credential Activation—Email that is sent to users when a Mobile Smart Credential has been assigned to them. It contains instructions on how to activate the smart credential.
  • SMS/Voice Entitlement—Email that is sent to Tenant accounts when their account SMS/Voice entitlements are nearing expiration or have expired. The emails are sent 14, 28, and 56 days before the entitlement end date and on the end date of the entitlement. This email is available only for Managed Service Provider Accounts.
  • Trial Account Locked—Email that is sent to Tenant accounts when the trial period has completed without their account being converted to a Production account. The emails are sent 1, 3, and 7 days before the account is locked and on the day account has been locked. This email is available only for Managed Service Provider Accounts.
  • Production Account Locked—Email that is sent to Tenant accounts when the Production account is locked. The emails are sent 1, 3, and 7 days before the account is locked and on the day account has been locked. This email is available only for Managed Service Provider Accounts.
  • User Authenticator Notification—Email that is sent to users when their authenticator has been changed.
  • User Contact Notification—Email that is sent to users when their account contact information has been changed.
  • User Verification—Email that is sent to users when they are required to verify.
  • Welcome Subscriber—Email that is sent when a new Tenant account is created. It contains the detail of the new account and how to access it. This email is available only for Managed Service Provider Accounts.

Customizing emails​

If you have a role with the Email Templates permission, you can modify the email templates to customize emails sent from Identity as a Service. You can:

  • Update the Subject of the email.
  • Change the Service Name.
  • Change the Date/Time syntax.
  • Update the Support Text.
  • Update the Authenticator Name and Authentication App Links for Entrust Soft Token, Google Authenticator, and Entrust Smart Credential.
  • Fully customize the email template HTML by editing the Body of the email. The email templates are parsed with the Mustache template engine to allow you to personalize the emails with context-specific variables.
note

Trial accounts that use the IDaaS email server cannot customize the email body. To customize the email body on a trial account, you must configure a custom email server. For more information, see Manage mail servers.

Modify email templates​

note

Trial accounts that use the IDaaS email server cannot edit the email body. To edit the email body on a trial account, configure a custom email server. For more information, see Manage mail servers.

  1. Click > Customization > Email Templates. The Email Templates page appears.

  2. To change the Subject and Language of the email:

    1. Click the Email Templates tab.
    2. Select the email template from Template drop-down list.
    3. From the Language drop-down list, select the language of the template you want to edit.
    4. Edit the text in the Subject field.
    5. Click Save.

  3. To change the Variables, do the following:

    1. Click the Variables tab.

    2. Edit the following fields, as required:

      • Service Name—This is the name of your Service. By default it is Entrust Identity as a Service.

      • Sender Name—This is the name of the sender of the email. If not set, your company name is used.

      • Date/Time Syntax—This is the date and time format used in emails. For more information on date and time patterns, see the Java SimpleDateFormat documentation.

      • Support Text—This is support contact information for your users.

      • Change the Authenticator Name (Entrust Soft Token, Google Authenticator, and Smart Credential only).

        note

        If you change the Google Authenticator name, the name is changed throughout with the exception of the Audit files. If you want the change to be applied to multiple languages, you must apply the change to the email template for each language.

      • Change the Authenticator App Links (Entrust Soft Token, Google Authenticator, and Smart Credential only)

    3. Click Save.

    note

    When making changes to email templates, update the template for each language.

  4. To customize the email body, do the following:

    1. Click the Email Templates tab.
    2. Select the template from the Template drop-down list.
    3. In the Body field, edit the contents as required.
    4. Click Legend at the bottom of the page to see a description of each variable.
    5. Click Preview to review your email template customizations.
      • In the Preview dialog box, use the Toggle button to switch between the preview and the source.
      • Click Close to close the Preview dialog box.
    note

    To revert to the default settings, click Reset.

    ::: 6. Click Save.