Documentation

 

 

Introduction

Use this guide to customize the verbiage or logo on the One-time Registration Code (OTP) email sent out to end-users for Multi-Factor Authentication.

Applies to
SecureAuth IdP VersionOS Version
8.0+
  • Windows Server 2008
  • Windows Server 2008 R2
  • Windows Server 2012
  • Windows Server 2012 R2
SecureAuth IdP Configuration Steps

Select the SecureAuth IdP version number, and then select instructions for customizing email verbiage or the logo to appear on the OTP email 

Overview

 

1. In the Advanced Settings section on the Overview tab, click Content and Localization

Email Settings

 

2. In the Verbiage Editor section, in emailtemplate_DearControl, enter the salutation to appear in the email (e.g. Dear) or leave the field empty to start the email with the recipient's name

3. In emailtemplate_MsgControl1, modify the freeform text that appears in the body of the message

4. In emailtemplate_MsgControl2, optionally modify the text that precedes the auto-generated passcode in the email

5. In emailtemplate_MsgControl3, modify the text that explains where to enter the passcode

6. In emailtemplate_Signature1, enter freeform text to appear in the email footer – e.g. the company name

7. In emailtemplate_Signature2, optionally enter freeform text to appear in the email footer – e.g. company phone number

8. In emailtemplate_Signature3, optionally enter freeform text to appear in the email footer – e.g. company website URL

9. In emailtemplate_Signature4, optionally enter freeform text to appear in the email footer – e.g. company slogan

Click Save once the configuration is complete and before leaving the Email Settings page to avoid losing changes

Sample SecureAuth IdP OTP Email

Numbers in red (1 - 8) in the sample email correlate to Verbiage Editor fields identified in the table below

Number in Sample EmailVerbiage Editor Field
1emailtemplate_DearControl
2emailtemplate_MsgControl1
3emailtemplate_MsgControl2
4emailtemplate_MsgControl3
5emailtemplate_Signature1
6emailtemplate_Signature2
7emailtemplate_Signature3
8emailtemplate_Signature4
Overview

 

1. In the Advanced Settings section on the Overview tab, click Email Settings

Email Settings

 

2. In the Email Settings section, under Email, click Choose File

3. Browse to find the logo, select it for uploading, and click Open

The logo must be created in the GIFJPEG, or PNG format

In SecureAuth IdP version 9.0.2+, the Show passcode in subject line checkbox appears to the right of the Subject field

See OTP Email Configuration Guide for information about using this option and configuring the OTP email

Click Save once the configuration is complete and before leaving the Email Settings page to avoid losing changes

Overview

 

1. In the Advanced Settings section on the Overview tab, click Content and Localization

Email Settings

 

2. In the Verbiage Editor section, in emailtemplate_DearControl, enter the salutation to appear in the email (e.g. Dear) or leave the field empty to start the email with the recipient's name

3. In emailtemplate_MsgControl1, modify the freeform text that appears in the body of the message

4. In emailtemplate_MsgControl2, optionally modify the text that precedes the auto-generated registration code in the email

5. In emailtemplate_MsgControl3, modify the text that explains where to enter the registration code

6. In emailtemplate_EmailSignature1, enter freeform text to appear in the email footer – e.g. the company name

7. In emailtemplate_EmailSignature2, optionally enter freeform text to appear in the email footer – e.g. company phone number

8. In emailtemplate_EmailSignature3, optionally enter freeform text to appear in the email footer – e.g. company website URL

9. In emailtemplate_EmailSignature4, optionally enter freeform text to appear in the email footer – e.g. company slogan

Click Save once the configuration is complete and before leaving the Email Settings page to avoid losing changes

Sample SecureAuth IdP OTP Email

Numbers in red (1 - 8) in the sample email correlate to Verbiage Editor fields identified in the table below

Number in Sample EmailVerbiage Editor Field
1emailtemplate_DearControl
2emailtemplate_MsgControl1
3emailtemplate_MsgControl2
4emailtemplate_MsgControl3
5emailtemplate_Signature1
6emailtemplate_Signature2
7emailtemplate_Signature3
8emailtemplate_Signature4

Before the logo can be applied to the email message

  • The logo must be created in the GIFJPEG, or PNG format
  • The logo must be placed in D:\SecureAuth\<SecureAuth Realm#>\Images – in which <SecureAuth Realm#> is the SecureAuth IdP realm on which the email logo will be used
Overview

 

1. In the Advanced Settings section on the Overview tab, click Email Settings

Email Settings

 

2. In the Email Settings section, under Email, click Choose File

3. Browse to find the logo, select it for uploading, and click Open

Click Save once the configuration is complete and before leaving the Email Settings page to avoid losing changes

Overview

 

1. In the Advanced Settings section on the Overview tab, click Content and Localization

Email Settings

 

2. In the Verbiage Editor section, in emailtemplate_DearControl, enter the salutation to appear in the email (e.g. Dear) or leave the field empty to start the email with the recipient's name

3. In emailtemplate_MsgControl1, modify the freeform text that appears in the body of the message

4. In emailtemplate_MsgControl2, optionally modify the text that precedes the auto-generated registration code in the email

5. In emailtemplate_MsgControl3, modify the text that explains where to enter the registration code

6. In emailtemplate_Signature1, enter freeform text to appear in the email footer – e.g. the company name

7. In emailtemplate_Signature2, optionally enter freeform text to appear in the email footer – e.g. company phone number

8. In emailtemplate_Signature3, optionally enter freeform text to appear in the email footer – e.g. company website URL

9. In emailtemplate_Signature4, optionally enter freeform text to appear in the email footer – e.g. company slogan

Click Save once the configuration is complete and before leaving the Email Settings page to avoid losing changes

Sample SecureAuth IdP OTP Email

Numbers in red (1 - 8) in the sample email correlate to Verbiage Editor fields identified in the table below

Number in Sample EmailVerbiage Editor Field
1emailtemplate_DearControl
2emailtemplate_MsgControl1
3emailtemplate_MsgControl2
4emailtemplate_MsgControl3
5emailtemplate_Signature1
6emailtemplate_Signature2
7emailtemplate_Signature3
8emailtemplate_Signature4

Before the logo can be applied to the email message

  • The logo must be created in the GIFJPEG, or PNG format
  • The logo must be placed in D:\SecureAuth\<SecureAuth Realm#>\Images – in which <SecureAuth Realm#> is the SecureAuth IdP realm on which the email logo will be used
Overview

 

1. In the Email Settings section, under Email, Browse to find the logo, select it for uploading, and click Open

Click Save once the configuration is complete and before leaving the Overview page to avoid losing changes