How To: Customize the Password Reset or Forgot Username Email Notifications

Version Affected: All

 

Overview

SecureAuth Identity Platform sends several types of automated emails to users, such as password reset and forgot username emails. This article covers how to customize each one, since the fields involved differ by email type:

• Method 1 - Password Reset emails
• Method 2 - Forgot Username emails

In this article

• Method 1: Customize Password Reset Emails
• Method 2: Change the Sender Address for Forgot Username Emails

Method 1: Customize Password Reset Emails

1. Open the Admin Console and go to the realm.
2. Click the Overview tab.
3. Scroll all the way down and click Content and Localization.
4. Search for and edit whichever of the following fields you need to change:
   • passwordreset_emailfrom -- the email's sender address
   • passwordreset_emailsubject -- the email's subject line
   • passwordreset_emailbody -- the email's body text
5. Click Save.

Special Considerations

The Password Reset email body defaults to showing the user's login ID near the beginning. To show a different identifier instead:

1. On the realm's Data tab, set an AuxID field that isn't currently in use to cn.
2. On the Overview tab, under Page Content, change Username / Displayed Name to that same AuxID.

This changes which identifier is displayed everywhere in the realm the User ID is normally shown, not just in this email. It can also break an administrator's ability to reset another user's password, unless the realm's Active Directory search filter is also based on cn.

Method 2: Change the Sender Address for Forgot Username Emails

Unlike password reset emails, the sender address for Forgot Username emails is not controlled by the realm's Email Settings on the Overview tab -- changing the Sender Address there has no effect on it.

Instead, the Forgot Username sender address is taken from the Help Desk 1 email address field on the Multi-Factor Methods tab, even when Help Desk 1 itself is left disabled.

1. Go to the Multi-Factor Methods tab and scroll down to Help Desk Settings.
2. Temporarily set Help Desk 1 to Enabled, if it isn't already.

3. Set Help Desk 1's Email field to the sender address you want Forgot Username emails to come from.
4. If you don't want Help Desk to appear as a Multi-Factor Method option to users, set Help Desk 1 back to Disabled. The email address entered above is retained and is still used as the Forgot Username sender address even while Help Desk 1 itself is disabled.
5. Click Save.

The address entered in Help Desk 1's Email field now appears as the sender on Forgot Username emails.


 

SecureAuth Knowledge Base Articles provide information based on specific use cases and may not apply to all appliances or configurations. Be advised that these instructions could cause harm to the environment if not followed correctly or if they do not apply to the current use case.

Customers are responsible for their own due diligence prior to utilizing this information and agree that SecureAuth is not liable for any issues caused by misconfiguration directly or indirectly related to SecureAuth products.