User Two-factor Method Add

User Two-factor Method Add

FusionAuth Reactor logo

This feature is only available in the Enterprise plan. Please visit our pricing page to learn more.

This event has been available since 1.30.0

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

Event type
user.two-factor.method.add

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.

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

Event Body

event.createInstantLong

The instant that the event was generated.

event.idUUID

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.dataObject
An object that can hold any information about the event that should be persisted.
event.info.deviceDescriptionString
The description of the device associated with the event.
event.info.deviceNameString
The device name associated with the event.
event.info.deviceTypeString
The type of device associated with the event.
event.info.ipAddressString
The source IP address of the event.
event.info.location.cityString
The city where the event originated. Note: An Enterprise plan is required to utilize event location data.
event.info.location.countryString
The country where the event originated. Note: An Enterprise plan is required to utilize event location data.
event.info.location.latitudeDouble
The latitude where the event originated. Note: An Enterprise plan is required to utilize event location data.
event.info.location.longitudeDouble
The longitude where the event originated. Note: An Enterprise plan is required to utilize event location data.
event.info.location.regionString
The geographic location where the event originated. Note: An Enterprise plan is required to utilize event location data.
event.info.location.zipcodeString
The zip code where the event originated. Note: An Enterprise plan is required to utilize event location data.
event.info.osString
The operating system associated with the event.
event.info.userAgentString
The user agent associated with the event.
event.methodObject

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

event.tenantIdUUID

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

event.typeString

The event type, this value will always be user.two-factor.method.add.

event.userObject

The user that added a new 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.add",
    "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
    }
  }
}