# Breached Password Email Template

Learn when FusionAuth sends the email that warns a user about a breached password, and which variables the template receives.

> For the index of this section of the site, see [llms.txt](https://fusionauth.io/docs/llms.txt)

> **PLAN:** This feature requires [at least a Starter plan](https://fusionauth.io/docs/concepts/plans-and-limits/plans-features.md#starter-features).

FusionAuth sends this email when [breached password detection](https://fusionauth.io/docs/security/account-protection/breached-password-detection.md) 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:

```ftl
[#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
```

```ftl
[#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](https://fusionauth.io/docs/apis/applications.md).

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

```ftl
[#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](https://fusionauth.io/docs/apis/tenants.md).

`user`

*   Type: `User`

The User object for the recipient. For field definitions, see the [User API](https://fusionauth.io/docs/apis/users.md).

Related

[APIs Create an Email Template API API documentation for the FusionAuth Create an Email Template API. freemarker](https://fusionauth.io/docs/apis/emails/create-an-email-template.md)

[APIs Email API Learn about the APIs for creating, retrieving, updating and deleting email templates as well as sending emails to users. freemarker](https://fusionauth.io/docs/apis/emails.md)

[APIs Preview an Email Template API API documentation for the FusionAuth Preview an Email Template API. freemarker](https://fusionauth.io/docs/apis/emails/preview-an-email-template.md)

[APIs Retrieve an Email Template API API documentation for the FusionAuth Retrieve an Email Template API. freemarker](https://fusionauth.io/docs/apis/emails/retrieve-an-email-template.md)
---

## Other pages in Security

> For the full index of this section, see [Email](https://fusionauth.io/docs/llms-email.txt).

- [Admin Two-Factor Method Removed Email Template](https://fusionauth.io/docs/email/template-reference/security/admin-two-factor-method-removed.md): Learn when FusionAuth sends the email that tells a user an administrator removed a two-factor method, and which variables the template receives.
- [Email Update Email Template](https://fusionauth.io/docs/email/template-reference/security/email-update.md): Learn when FusionAuth sends the email that tells a user their email address changed, and which variables the template receives.
- [Login Id Duplicate on Create Email Template](https://fusionauth.io/docs/email/template-reference/security/login-id-duplicate-on-create.md): Learn when FusionAuth sends the email that tells a user someone tried to sign up with their login Id, and which variables the template receives.
- [Login Id Duplicate on Update Email Template](https://fusionauth.io/docs/email/template-reference/security/login-id-duplicate-on-update.md): Learn when FusionAuth sends the email that tells a user another account tried to take their login Id, and which variables the template receives.
- [Password Reset Success Email Template](https://fusionauth.io/docs/email/template-reference/security/password-reset-success.md): Learn when FusionAuth sends the email that confirms a password reset, and which variables the template receives.
- [Password Update Email Template](https://fusionauth.io/docs/email/template-reference/security/password-update.md): Learn when FusionAuth sends the email that tells a user their password changed, and which variables the template receives.
- [Threat Detected Email Template](https://fusionauth.io/docs/email/template-reference/security/threat-detected.md): Learn when FusionAuth sends the email for a login from a new device or a suspicious login, and which variables the template receives.
- [Two-Factor Authentication Email Template](https://fusionauth.io/docs/email/template-reference/security/two-factor-authentication.md): Learn when FusionAuth sends the email that contains a two-factor code, and which variables the template receives.
- [Two-Factor Method Added Email Template](https://fusionauth.io/docs/email/template-reference/security/two-factor-method-added.md): Learn when FusionAuth sends the email that tells a user a two-factor method was added, and which variables the template receives.
- [Two-Factor Method Removed Email Template](https://fusionauth.io/docs/email/template-reference/security/two-factor-method-removed.md): Learn when FusionAuth sends the email that tells a user a two-factor method was removed, and which variables the template receives.
