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-identity-provider-link.md.

Identity Provider Link

Edit on GitHub
View Markdown
version
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.

Transaction Compatibility

This event is non-transactional. The operation will succeed regardless of the webhook response status code.

Event Body

event.createInstant Long

The instant that the event was generated.

event.id UUID

The unique Id of the event.

event.identityProviderLink IdentityProviderLink

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

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

The unique tenant identifier.

event.type String

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

event.user User

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
    }
  }
}