Skip to main content

Authentication events

Authentication events notify you when users successfully authenticate or when authentication attempts fail. When an authentication event is triggered, IDaaS sends an HTTP POST request to your configured webhook URL with a JSON payload containing the event details.

Payload structure

Every authentication event payload has this structure:

{
"id": "019adb89-60dd-750e-90a3-e860c924aa29",
"type": "authentication.succeeded",
"accountId": "c8485a88-4fd0-4248-8dcd-fb4ac0749fb7",
"eventTime": "2025-12-01T20:10:04Z",
"data": {
// Event-specific data here
}
}

The data object contains event-specific fields. See the event examples later on this page for the full data object for each event type.

Top-level fields

FieldTypeDescription
idstringUnique identifier for this webhook delivery
typestringThe event that occurred (e.g., authentication.succeeded)
accountIdstringYour account identifier
eventTimestringWhen the event occurred (ISO 8601 format)
dataobjectDetails about what happened (varies by event type)

Event types

authentication.succeeded

Triggered when a user successfully authenticates to IDaaS.

Example payload:

{
"id": "019adb89-60dd-750e-90a3-e860c924aa29",
"type": "authentication.succeeded",
"accountId": "c8485a88-4fd0-4248-8dcd-fb4ac0749fb7",
"eventTime": "2025-12-01T20:10:04Z",
"data": {
"subject": "f7475916-56ab-44a1-ab8a-3d4407baa102",
"subjectName": "john.smith",
"subjectType": "USER",
"resourceName": "Administration Portal",
"sourceIp": "127.0.0.1",
"token": "OTP",
"entityAttributes": {
"registrationRequired": true
}
}
}

The data object includes the following fields:

FieldDescription
subjectID of the user who authenticated
subjectNameUsername of the user who authenticated
subjectTypeAlways USER for user authentications
resourceNameWhere the authentication occurred (e.g., "Administration Portal", "User Portal")
sourceIpIP address from which the authentication was attempted
tokenAuthentication method used (e.g., "OTP", "PASSWORD", "FIDO")
entityAttributesAdditional details about the authentication event, when available (see below)

When present, the entityAttributes object can include these fields:

  • registrationRequired - Whether user registration is required

authentication.failed

Triggered when a user's authentication attempt fails.

Example payload:

{
"id": "019adb89-60dd-750e-90a3-e860c924aa29",
"type": "authentication.failed",
"accountId": "c8485a88-4fd0-4248-8dcd-fb4ac0749fb7",
"eventTime": "2025-12-01T20:10:04Z",
"data": {
"subject": "f7475916-56ab-44a1-ab8a-3d4407baa102",
"subjectName": "john.smith",
"subjectType": "USER",
"resourceName": "Administration Portal",
"sourceIp": "127.0.0.1",
"token": "OTP"
}
}

This event uses the same data structure as authentication.succeeded, but does not include entityAttributes.

FieldDescription
subjectID of the user who attempted authentication
subjectNameUsername used in the authentication attempt
subjectTypeAlways USER for user authentications
resourceNameWhere the authentication was attempted (e.g., "Administration Portal", "User Portal")
sourceIpIP address from which the authentication was attempted
tokenAuthentication method that was attempted (e.g., "OTP", "PASSWORD", "FIDO")