User Identity Provider Link
User Identity Provider Link
This event is generated when a user is linked to an Identity Provider.
Event typeuser.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.createInstant
LongThe instant that the event was generated.
event.id
UUIDThe unique Id of the event.
event.identityProviderLink
IdentityProviderLinkThe identity provider link created. See the Identity Provider Links API for property definitions and example JSON.
event.info.data
ObjectAvailable since 1.30.0An object that can hold any information about the event that should be persisted.
event.info.deviceDescription
StringAvailable since 1.30.0The description of the device associated with the event.
event.info.deviceName
StringAvailable since 1.30.0The device name associated with the event.
event.info.deviceType
StringAvailable since 1.30.0The type of device associated with the event.
event.info.ipAddress
StringAvailable since 1.27.0The source IP address of the event.
event.info.location.city
StringAvailable since 1.30.0The city where the event originated.
Note: An Enterprise plan is required to utilize event location data.
event.info.location.country
StringAvailable since 1.30.0The country where the event originated.
Note: An Enterprise plan is required to utilize event location data.
event.info.location.latitude
DoubleAvailable since 1.30.0The latitude where the event originated.
Note: An Enterprise plan is required to utilize event location data.
event.info.location.longitude
DoubleAvailable since 1.30.0The longitude where the event originated.
Note: An Enterprise plan is required to utilize event location data.
event.info.location.region
StringAvailable since 1.30.0The geographic location where the event originated.
Note: An Enterprise plan is required to utilize event location data.
event.info.location.zipcode
StringAvailable since 1.30.0The zip code where the event originated.
Note: An Enterprise plan is required to utilize event location data.
event.info.os
StringAvailable since 1.30.0The operating system associated with the event.
event.info.userAgent
StringAvailable since 1.30.0The user agent associated with the event.
event.tenantId
UUIDThe unique tenant identifier.
event.type
StringThe event type, this value will always be user.identity-provider.link
.
event.user
UserThe 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
}
}
}