Logo / Docs

User Identity Provider Link

User Identity Provider Link

This event has been available since 1.36.0

This event is generated when a user is linked to an Identity Provider.

Event type 
user.identity-provider.link

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.

event.identityProviderLinkIdentityProviderLink

The identity provider link created. See the Identity Provider Links API for property definitions and example JSON.

event.info.dataObjectAvailable since 1.30.0
An object that can hold any information about the event that should be persisted.
event.info.deviceDescriptionStringAvailable since 1.30.0
The description of the device associated with the event.
event.info.deviceNameStringAvailable since 1.30.0
The device name associated with the event.
event.info.deviceTypeStringAvailable since 1.30.0
The type of device associated with the event.
event.info.ipAddressStringAvailable since 1.27.0
The source IP address of the event.
event.info.location.cityStringAvailable since 1.30.0
The city where the event originated.

Note: An Enterprise plan is required to utilize event location data.

event.info.location.countryStringAvailable since 1.30.0
The country where the event originated.

Note: An Enterprise plan is required to utilize event location data.

event.info.location.latitudeDoubleAvailable since 1.30.0
The latitude where the event originated.

Note: An Enterprise plan is required to utilize event location data.

event.info.location.longitudeDoubleAvailable since 1.30.0
The longitude where the event originated.

Note: An Enterprise plan is required to utilize event location data.

event.info.location.regionStringAvailable since 1.30.0
The geographic location where the event originated.

Note: An Enterprise plan is required to utilize event location data.

event.info.location.zipcodeStringAvailable since 1.30.0
The zip code where the event originated.

Note: An Enterprise plan is required to utilize event location data.

event.info.osStringAvailable since 1.30.0
The operating system associated with the event.
event.info.userAgentStringAvailable since 1.30.0
The user agent associated with the event.
event.tenantIdUUID

The unique tenant identifier.

event.typeString

The event type, this value will always be user.identity-provider.link.

event.userUser

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

Example Event JSON

{
  "event": {
    "createInstant": 1505762615056,
    "id": "e502168a-b469-45d9-a079-fd45f83e0406",
    "identityProviderLink": {
      "displayName": "Google",
      "identityProviderId": "82339786-3dff-42a6-aac6-1f1ceecb6c46",
      "identityProviderUserId": "42",
      "insertInstant": 1505762615057,
      "lastLoginInstant": 1505762615057,
      "tenantId": "e872a880-b14f-6d62-c312-cb40f22af465",
      "userId": "00000000-0000-0001-0000-000000000000"
    },
    "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"
    },
    "tenantId": "e872a880-b14f-6d62-c312-cb40f22af465",
    "type": "user.identity-provider.link",
    "user": {
      "active": true,
      "connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
      "email": "example@fusionauth.io",
      "id": "00000000-0000-0001-0000-000000000000",
      "lastLoginInstant": 1471786483322,
      "passwordChangeRequired": false,
      "passwordLastUpdateInstant": 1471786483322,
      "registrations": [
        {
          "applicationId": "10000000-0000-0002-0000-000000000001",
          "id": "00000000-0000-0002-0000-000000000000",
          "insertInstant": 1446064706250,
          "lastLoginInstant": 1456064601291,
          "roles": [
            "user"
          ],
          "usernameStatus": "ACTIVE"
        }
      ],
      "tenantId": "e872a880-b14f-6d62-c312-cb40f22af465",
      "usernameStatus": "ACTIVE",
      "verified": true
    }
  }
}