Breached Password Email Template

On this page
Starter plan required

This feature requires at least a Starter plan.

FusionAuth sends this email when breached password detection finds the user's password at login, and the tenant's action is to notify the user. Assign the template in Notify user template under Tenants -> Your Tenant -> Password -> Breach detection settings .

Default Template#

FusionAuth ships the following default template:

[#setting url_escaping_charset="UTF-8"]
<p>This password was found in the list of vulnerable passwords, and is no longer secure.</p>

<p>In order to secure your account, it is recommended to change your password at your earliest convenience.</p>

<p>Follow this link to change your password.</p>

[#assign url = "${baseUrl}/password/forgot?client_id=${(application.oauthConfiguration.clientId)!''}&email=${user.email?url}&tenantId=${user.tenantId}" /]
<a href="${url?html}">
  ${url?html}
</a>

- FusionAuth Admin
[#setting url_escaping_charset="UTF-8"]
This password was found in the list of vulnerable passwords, and is no longer secure.

In order to secure your account, it is recommended to change your password at your earliest convenience.

Follow this link to change your password.

${baseUrl}/password/forgot?client_id=${(application.oauthConfiguration.clientId)!''}&email=${user.email?url}&tenantId=${user.tenantId}

- FusionAuth Admin

Replacement Variables#

application
  • Type: Application
  • Available since 1.27.2

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.

breachResult.loginIds
  • Type: Array<String>

The email addresses or usernames from the breach that match the user. An empty array means only the password matched.

breachResult.match
  • Type: String

The match type. The possible values are:

  • ExactMatch: The user's login Id and password appear in the breach exactly.
  • SubAddressMatch: The password and a sub-address of the email address appear in the breach. For example, joe+test@example.com is a sub-address of joe@example.com.
  • PasswordOnly: The password appears in the breach, but not with the user's login Id.
  • CommonPassword: The password is one of the most commonly breached passwords.
tenant
  • Type: Tenant

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.