Forgot Password Email Template

On this page

FusionAuth sends this email when a user starts the forgot password workflow, on the hosted login pages or through the Forgot Password API. The default template is also known as the Change Password template. Assign the template in Forgot password on the Tenants -> Your Tenant -> Identities tab. To override the template for one Application, set the template on the Applications -> Your Application -> Identities tab.

Default Template#

FusionAuth ships the following default template:

[#setting url_escaping_charset="UTF-8"]
To change your password click on the following link.
<p>
  [#-- The optional 'state' map provided on the Forgot Password API call is exposed in the template as 'state'.
       If we have an application context, append the client_id to ensure the correct application theme when applicable.
  --]
  [#assign url = "${baseUrl}/password/change/${changePasswordId}?client_id=${(application.oauthConfiguration.clientId)!''}&tenantId=${user.tenantId}" /]
  [#list state!{} as key, value][#if key != "tenantId" && key != "client_id" && value??][#assign url = url + "&" + key?url + "=" + value?url/][/#if][/#list]
  <a href="${url?html}">${url?html}</a>
</p>
- FusionAuth Admin
[#setting url_escaping_charset="UTF-8"]
To change your password click on the following link.

  [#-- The optional 'state' map provided on the Forgot Password API call is exposed in the template as 'state'.
       If we have an application context, append the client_id to ensure the correct application theme when applicable.
  --]
[#assign url = "${baseUrl}/password/change/${changePasswordId}?client_id=${(application.oauthConfiguration.clientId)!''}&tenantId=${user.tenantId}" /]
[#list state!{} as key, value][#if key != "tenantId" && key != "client_id" && value??][#assign url = url + "&" + key?url + "=" + value?url/][/#if][/#list]

${url}

- FusionAuth Admin

Replacement Variables#

application
  • Type: Application
  • Available since 1.21.0

The Application object. For field definitions, see the Application API.

The variable is present only when the request that sends the email identifies an Application. Check for the variable before you use it:

[#if application??]
  ${application.name}
[/#if]
baseUrl
  • Type: String
  • Available since 1.68.0

The base URL for links in the email. FusionAuth uses the Application baseURL, then the Tenant baseURL, then http://localhost:9011.

changePasswordId
  • Type: String

The change password Id for the Change a User's Password API.

state
  • Type: Object

The state from the forgot password request. The variable is present only when the request includes state.

tenant
  • Type: Tenant
  • Available since 1.18.2

The Tenant object. For field definitions, see the Tenant API.

user
  • Type: User

The User object for the recipient. For field definitions, see the User API.