Resources
🤖 For AI agents: The complete documentation index is available at /docs/llms.txt. A markdown version of this page is available at /docs/extend/events-and-webhooks/events/user/user-deactivate.md.

Deactivate

Edit on GitHub
View Markdown

User Deactivate

This event is generated when a user is deactivated, also referred to as a soft delete.

Event type
user.deactivate

Event Scope

Prior to version 1.37.0 this was a tenant scoped event. This event will be sent to all tenants that are listening, but will contain a tenantId to allow for filtering.

In version 1.37.0 and later this is also a tenant scoped event. It can be sent to all tenants or to one or more specified tenants. However, those tenants will not be sent events for other tenants, but only events related to themselves.

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

Event Body

event.createInstant Long

The instant that the event was generated.

event.id 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 Object Available since 1.30.0

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

event.info.deviceDescription String Available since 1.30.0

The description of the device associated with the event.

event.info.deviceName String Available since 1.30.0

The device name associated with the event.

event.info.deviceType String Available since 1.30.0

The type of device associated with the event.

event.info.ipAddress String Available since 1.27.0

The source IP address of the event.

event.info.location.city String Available since 1.30.0

The city where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.country String Available since 1.30.0

The country where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.latitude Double Available since 1.30.0

The latitude where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.longitude Double Available since 1.30.0

The longitude where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.region String Available since 1.30.0

The geographic location where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.zipcode String Available since 1.30.0

The zip code where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.os String Available since 1.30.0

The operating system associated with the event.

event.info.userAgent String Available since 1.30.0

The user agent associated with the event.

event.linkedObjectId UUID Available since 1.53.0

The Id of the user impacted by this event.

event.tenantId UUID Available since 1.8.0

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

event.type String

The event type, this value will always be user.deactivate.

event.user Object

The user that has been created. See the Users API for property definitions and example JSON.

Example Event JSON

{
  "event": {
    "createInstant": 1629912352952,
    "id": "6c854b61-8e16-45db-b9ac-9465255b0fae",
    "info": {
      "ipAddress": "63.239.150.2",
      "location": {
        "city": "Denver",
        "country": "US",
        "displayString": "Denver, CO, US",
        "latitude": 39.73915,
        "longitude": -104.9847,
        "region": "CO"
      },
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36"
    },
    "tenantId": "a743e2cd-55bb-789c-b076-8846fdd3a51f",
    "type": "user.deactivate",
    "user": {
      "active": false,
      "birthDate": "1990-08-03",
      "connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
      "email": "nelson@fusionauth.io",
      "firstName": "Nelson",
      "id": "7b6c267c-4a31-47a4-8c19-11aa40dbd304",
      "insertInstant": 1629911425124,
      "lastLoginInstant": 1629912339471,
      "lastName": "Bighetti",
      "lastUpdateInstant": 1629911425124,
      "passwordChangeRequired": false,
      "passwordLastUpdateInstant": 1629911425337,
      "registrations": [
        {
          "applicationId": "d23ecde6-0661-44a7-808b-a23013e6dfdc",
          "id": "9a38796c-9f0e-449a-960f-774565d9a89e",
          "insertInstant": 1629912339471,
          "lastLoginInstant": 1629912339471,
          "lastUpdateInstant": 1629912339471,
          "roles": [
            "USER"
          ],
          "usernameStatus": "ACTIVE",
          "verified": true
        }
      ],
      "tenantId": "a743e2cd-55bb-789c-b076-8846fdd3a51f",
      "timezone": "America/Denver",
      "twoFactor": {},
      "usernameStatus": "ACTIVE",
      "verified": true
    }
  }
}