User Identity Update Event

On this page

User Identity Update

Available since 1.59.0

This event is generated when a user's phone number is added, changed, or removed.

Event type

user.identity.update

Event Scope

This is 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 non-transactional. The operation will succeed regardless of the webhook response status code.

Note

For email address changes, FusionAuth generates the User Email Update event instead.

Event Body

event.createInstant
  • Type: Long

The instant 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

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

event.info.deviceDescription
  • Type: String

The description of the device associated with the event.

event.info.deviceName
  • Type: String

The device name associated with the event.

event.info.deviceType
  • Type: String

The type of device associated with the event.

event.info.ipAddress
  • Type: String

The source IP address of the event.

event.info.location.city
  • Type: String

The city where the event originated.

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

event.info.location.country
  • Type: String

The country where the event originated.

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

event.info.location.latitude
  • Type: Double

The latitude where the event originated.

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

event.info.location.longitude
  • Type: Double

The longitude where the event originated.

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

event.info.location.region
  • Type: String

The geographic location where the event originated.

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

event.info.location.zipcode
  • Type: String

The zip code where the event originated.

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

event.info.os
  • Type: String

The operating system associated with the event.

event.info.userAgent
  • Type: String

The user agent associated with the event.

event.linkedObjectId
  • Type: UUID

The Id of the user impacted by this event.

event.loginIdType
  • Type: String

The type of the login Id that changed. The value is always phoneNumber.

event.newLoginId
  • Type: String

The new phone number. The field is missing when the update removed the phone number.

event.previousLoginId
  • Type: String

The previous phone number. The field is missing when the update added a phone number to a user that had none.

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.identity.update.

event.user
  • Type: Object

The user after the update. See the Users API for property definitions and example JSON.

Example Event JSON
{
  "event": {
    "createInstant": 1563399203743,
    "id": "c2a1f6c4-5d35-4a1f-9a5e-2b8f0d6f3e71",
    "info": {
      "ipAddress": "42.42.42.42",
      "location": {
        "city": "Denver",
        "country": "US",
        "displayString": "Denver, CO, US",
        "latitude": 39.77777,
        "longitude": -104.9191,
        "region": "CO"
      },
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36"
    },
    "linkedObjectId": "00000000-0000-0001-0000-000000000000",
    "loginIdType": "phoneNumber",
    "newLoginId": "+15555552222",
    "previousLoginId": "+15555551111",
    "tenantId": "f24aca2b-ce4a-4dad-951a-c9d690e71415",
    "type": "user.identity.update",
    "user": {
      "active": true,
      "connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
      "id": "00000000-0000-0001-0000-000000000000",
      "identities": [
        {
          "primary": true,
          "type": "phoneNumber",
          "value": "+15555552222",
          "verified": false,
          "verifiedReason": "Disabled"
        }
      ],
      "passwordChangeRequired": false,
      "phoneNumber": "+15555552222",
      "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": false
    }
  }
}