User Login Success
User Login Success
This event is generated when a user completes a successful login.
Event typeuser.login.success
Event Scope
Prior to version 1.37.0 this was a tenant or application scoped event. It can be sent to all applications or to one or more specified applications.
The ability to limit the generation of an event for only certain applications is legacy functionality and is removed as of version 1.37.0. In earlier versions, you almost certainly want to enable this event at the tenant level and optionally filter on the tenantId when consuming the event.
In version 1.37.0 and later this is a tenant scoped event. It can be sent to all tenants or to one or more specified tenants. Those tenants will only be sent events related to their tenant. You can optionally also filter on the applicationId when consuming the event.
Transaction Compatibility
This event is transactional. The final state of the operation which caused the webhook is not persisted to FusionAuth until after the webhook finishes; learn more
Event Body
event.applicationId
UUIDThe unique Id of the Application for which the user has requested login. If the login request omits the applicationId or the user is not registered for the requested applicationId this value will not be returned in the event.
event.authenticationType
StringThe type of authentication used in the login request.
event.connectorId
UUIDAvailable since 1.18.0The unique Id of the connector used to complete the login.
event.createInstant
LongThe instant that the event was generated.
event.id
UUIDThe 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.identityProviderId
UUIDThe unique Id of the identity provider used to complete the login. This value will be omitted from the event if an identity provider was not used.
event.identityProviderName
StringThe name of the identity provider used to complete the login. This value will be omitted from the event if an identity provider was not used.
event.ipAddress
StringDEPRECATEDThe IP address provided in the login request.
Moved to event.info in 1.30.0
event.info.data
ObjectAvailable since 1.30.0event.info.deviceDescription
StringAvailable since 1.30.0event.info.deviceName
StringAvailable since 1.30.0event.info.deviceType
StringAvailable since 1.30.0event.info.ipAddress
StringAvailable since 1.27.0event.info.location.city
StringAvailable since 1.30.0event.info.location.country
StringAvailable since 1.30.0event.info.location.latitude
DoubleAvailable since 1.30.0event.info.location.longitude
DoubleAvailable since 1.30.0event.info.location.region
StringAvailable since 1.30.0event.info.location.zipcode
StringAvailable since 1.30.0event.info.os
StringAvailable since 1.30.0event.info.userAgent
StringAvailable since 1.30.0event.tenantId
UUIDAvailable since 1.8.0The unique tenant identifier. This value may not be returned if not applicable.
event.type
StringThe event type, this value will always be user.login.success
.
event.user
ObjectThe user that completed the login request. See the Users API for property definitions and example JSON
{
"event": {
"applicationId": "10000000-0000-0002-0000-000000000001",
"authenticationType": "PASSWORD",
"connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
"createInstant": 1505762615056,
"id": "e502168a-b469-45d9-a079-fd45f83e0406",
"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.login.success",
"user": {
"active": true,
"connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
"email": "example@fusionauth.io",
"id": "00000000-0000-0001-0000-000000000000",
"passwordChangeRequired": false,
"registrations": [
{
"applicationId": "10000000-0000-0002-0000-000000000001",
"id": "00000000-0000-0002-0000-000000000000",
"insertInstant": 1446064706250,
"roles": [
"user"
],
"usernameStatus": "ACTIVE"
}
],
"tenantId": "f24aca2b-ce4a-4dad-951a-c9d690e71415",
"twoFactorEnabled": false,
"usernameStatus": "ACTIVE",
"verified": true
}
}
}