User Two-factor Method Remove Event

Edit on GitHubView Markdown
On this page

User Two-factor Method Remove

Available since 1.30.0

This event is generated when a user has removed a new two-factor method.

Event type

user.two-factor.method.remove

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

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
  • Available since 1.53.0

The Id of the user impacted by this event.

event.method
  • Type: Object

The two-factor method that was removed. See the Multi-Factor/Two-Factor APIs for property definitions and example JSON.

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.two-factor.method.remove.

event.user
  • Type: Object

The user that removed a two-factor method. See the Users API for property definitions and example JSON.

Example Event JSON
{
  "event": {
    "createInstant": 1629437566354,
    "id": "818ffddf-51ed-49be-a8e1-a9005e7a509e",
    "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"
    },
    "method": {
      "id": "2P24",
      "method": "sms",
      "mobilePhone": "555-555-5555"
    },
    "tenantId": "30663132-6464-6665-3032-326466613934",
    "type": "user.two-factor.method.remove",
    "user": {
      "active": true,
      "birthDate": "1981-06-04",
      "connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
      "data": {
        "Company": "Aviato",
        "foobar": "baz",
        "user_type": "iconoclast"
      },
      "email": "admin@fusionauth.io",
      "firstName": "Erlich",
      "id": "9ea5b4b6-14df-44af-8a5e-c6e4bcb31ced",
      "insertInstant": 1625783576299,
      "lastLoginInstant": 1629436831940,
      "lastName": "Bachman",
      "lastUpdateInstant": 1628024498202,
      "passwordChangeRequired": false,
      "passwordLastUpdateInstant": 1625783576327,
      "tenantId": "a743e2cd-55bb-789c-b076-8846fdd3a51f",
      "twoFactor": {},
      "usernameStatus": "ACTIVE",
      "verified": true
    }
  }
}

Related

Extend

User Two-factor Challenge Event

Learn about the User Two-factor Challenge event.

mfa webhookfusionauth userwebhook event
Extend

User Two-factor Failed Attempt Event

Learn about the User Two-factor Failed Attempt event.

mfa webhookfusionauth userwebhook event
Extend

User Two-factor Method Add Event

Learn about the User Two-factor Method Add event.

mfa webhookfusionauth userwebhook event
Extend

User Two-factor Success Event

Learn about the User Two-factor Success event.

mfa webhookfusionauth userwebhook event