Breached Password Email Template
On this page
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 AdminReplacement Variables#
applicationThe 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]
baseUrlThe base URL for links in the email. FusionAuth uses the Application baseURL, then the Tenant baseURL, then http://localhost:9011.
breachResult.loginIds The email addresses or usernames from the breach that match the user. An empty array means only the password matched.
breachResult.match 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.comis a sub-address ofjoe@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.
tenantThe Tenant object. For field definitions, see the Tenant API.
userThe User object for the recipient. For field definitions, see the User API.
Related
API documentation for the FusionAuth Create an Email Template API.
Learn about the APIs for creating, retrieving, updating and deleting email templates as well as sending emails to users.
API documentation for the FusionAuth Preview an Email Template API.
API documentation for the FusionAuth Retrieve an Email Template API.