# User Password Breach Event

Learn about the User Password Breach event.

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

## User Password Breach

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

Available since `1.15.0`

This event is generated when Reactor detects a user is using a vulnerable, or breached password. This event will only occur during login when the Tenant is not configured to require the user to change their password. All other breached password detections will occur during password validation and because the user will not be allowed to use the password.

Event type

user.password.breach

### Event Scope

This is a tenant-scoped event.

Prior to version `1.37.0` this event was sent to all webhooks, and it was a webhook's responsibility to filter on the **tenantId** field.

In version `1.37.0` and later, this event will only be sent to tenants for which webhooks for this event are enabled.

### Transaction Compatibility

This event is transactional. The final state of the operation which caused the webhook is not persisted to FusionAuth until after the webhook finishes; [learn more](https://fusionauth.io/docs/events/webhooks/writing-a-webhook.md#calling-fusionauth-apis-in-webhooks)

### Event Body

`event.createInstant`

*   Type: `Long`

The [instant](https://fusionauth.io/docs/apis/data-types.md#instants) that the event was generated.

`event.id`

*   Type: `UUID`

The unique Id of the event. You may receive an event more than once based upon your transaction settings. This Id may be used to identify a duplicate event.

`event.info.data`

*   Type: `Object`
*   Available since `1.30.0`

An object that can hold any information about the event that should be persisted.

`event.info.deviceDescription`

*   Type: `String`
*   Available since `1.30.0`

The description of the device associated with the event.

`event.info.deviceName`

*   Type: `String`
*   Available since `1.30.0`

The device name associated with the event.

`event.info.deviceType`

*   Type: `String`
*   Available since `1.30.0`

The type of device associated with the event.

`event.info.ipAddress`

*   Type: `String`
*   Available since `1.27.0`

The source IP address of the event.

`event.info.location.city`

*   Type: `String`
*   Available since `1.30.0`

The city where the event originated.

**Enterprise plan** To use event location data, you'll need [an Enterprise plan](https://fusionauth.io/docs/concepts/plans-and-limits/plans-features.md#enterprise-features).

`event.info.location.country`

*   Type: `String`
*   Available since `1.30.0`

The country where the event originated.

**Enterprise plan** To use event location data, you'll need [an Enterprise plan](https://fusionauth.io/docs/concepts/plans-and-limits/plans-features.md#enterprise-features).

`event.info.location.latitude`

*   Type: `Double`
*   Available since `1.30.0`

The latitude where the event originated.

**Enterprise plan** To use event location data, you'll need [an Enterprise plan](https://fusionauth.io/docs/concepts/plans-and-limits/plans-features.md#enterprise-features).

`event.info.location.longitude`

*   Type: `Double`
*   Available since `1.30.0`

The longitude where the event originated.

**Enterprise plan** To use event location data, you'll need [an Enterprise plan](https://fusionauth.io/docs/concepts/plans-and-limits/plans-features.md#enterprise-features).

`event.info.location.region`

*   Type: `String`
*   Available since `1.30.0`

The geographic location where the event originated.

**Enterprise plan** To use event location data, you'll need [an Enterprise plan](https://fusionauth.io/docs/concepts/plans-and-limits/plans-features.md#enterprise-features).

`event.info.location.zipcode`

*   Type: `String`
*   Available since `1.30.0`

The zip code where the event originated.

**Enterprise plan** To use event location data, you'll need [an Enterprise plan](https://fusionauth.io/docs/concepts/plans-and-limits/plans-features.md#enterprise-features).

`event.info.os`

*   Type: `String`
*   Available since `1.30.0`

The operating system associated with the event.

`event.info.userAgent`

*   Type: `String`
*   Available since `1.30.0`

The user agent associated with the event.

`event.linkedObjectId`

*   Type: `UUID`
*   Available since `1.53.0`

The Id of the user impacted by this event.

`event.tenantId`

*   Type: `UUID`

The unique tenant identifier. This value may not be returned if not applicable.

`event.type`

*   Type: `String`

The event type, this value will always be `user.password.breach`.

`event.user`

*   Type: `Object`

The user that failed the login request. See the [Users API](https://fusionauth.io/docs/apis/users.md) for property definitions and example JSON.

Example Event JSON

```json
{
  "event": {
    "createInstant": 1505762615056,
    "id": "e502168a-b469-45d9-a079-fd45f83e0406",
    "tenantId": "e872a880-b14f-6d62-c312-cb40f22af465",
    "type": "user.password.breach",
    "user": {
      "active": true,
      "connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
      "email": "example@fusionauth.io",
      "id": "00000000-0000-0001-0000-000000000000",
      "breachedPasswordStatus": "ExactMatch",
      "breachedPasswordLastCheckedInstant": 1505762615056,
      "passwordChangeReason": "Breached",
      "passwordChangeRequired": true,
      "registrations": [
        {
          "applicationId": "10000000-0000-0002-0000-000000000001",
          "id": "00000000-0000-0002-0000-000000000000",
          "insertInstant": 1446064706250,
          "roles": [
            "user"
          ],
          "usernameStatus": "ACTIVE"
        }
      ],
      "tenantId": "f24aca2b-ce4a-4dad-951a-c9d690e71415",
      "twoFactorEnabled": false,
      "usernameStatus": "ACTIVE",
      "verified": true
    }
  }
}
```

Related

[Events User Password Reset Send Event Learn about the User Password Reset Send event. fusionauth userwebhook event](https://fusionauth.io/docs/events/reference/user/password/user-password-reset-send.md)

[Events User Password Reset Start Event Learn about the User Password Reset Start event. fusionauth userwebhook event](https://fusionauth.io/docs/events/reference/user/password/user-password-reset-start.md)

[Events User Password Reset Success Event Learn about the User Password Reset Success event. fusionauth userwebhook event](https://fusionauth.io/docs/events/reference/user/password/user-password-reset-success.md)

[Events User Password Update Event Learn about the User Password Update event. fusionauth userwebhook event](https://fusionauth.io/docs/events/reference/user/password/user-password-update.md)
---

## Other pages in Password

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

- [User Password Reset Send Event](https://fusionauth.io/docs/events/reference/user/password/user-password-reset-send.md): Learn about the User Password Reset Send event.
- [User Password Reset Start Event](https://fusionauth.io/docs/events/reference/user/password/user-password-reset-start.md): Learn about the User Password Reset Start event.
- [User Password Reset Success Event](https://fusionauth.io/docs/events/reference/user/password/user-password-reset-success.md): Learn about the User Password Reset Success event.
- [User Password Update Event](https://fusionauth.io/docs/events/reference/user/password/user-password-update.md): Learn about the User Password Update event.
