Skip to content

Auth Log

An Auth Log object records an authentication event for audit and compliance purposes. Every login attempt, logout, token refresh, account creation, confirmation, password reset, and anonymous session generates a log entry with the event type, status, and contextual metadata.

Sample Object

{
  "id": "log_abc123def456",
  "owner_id": "ppl_abc123def456",
  "realm": "app",
  "event": "LOGIN_ATTEMPT",
  "status": "success",
  "failure_reason": "",
  "ip_address": "203.0.113.42",
  "browser": "Chrome 120",
  "operating_system": "macOS 14.2",
  "location": "New York, US",
  "identifier": "jane@example.com"
}

Fields

FieldTypeDescription
idstringUnique identifier for the Auth Log entry.
owner_idstringUnique identifier of the Person linked to this event.
realmstringRealm name where the event occurred.
eventenumType of authentication event. One of LOGIN_ATTEMPT, LOGOUT, TOKEN_REFRESH, MFA_CHALLENGE, MFA_SUCCESS, PASSWORD_RESET, PASSWORD_RESET_REQUESTED, ACCOUNT_CREATED, ACCOUNT_CONFIRMED, ANONYMOUS_SESSION.
statusenumEvent outcome. One of success, failure.
failure_reasonstringHuman-readable reason when the event status is failure.
ip_addressstringIP address of the client that triggered the event.
browserstringBrowser user agent string.
operating_systemstringOperating system of the client.
locationstringGeographical location derived from the IP address.
identifierstringEmail or other identifier used in the event.

Actions

Listing all auth logs

Retrieve all authentication log entries. Requires authentication.

No CLI command available. Use the REST or SDK methods.

Getting an auth log entry

Retrieve a single authentication log entry by its ID. Requires authentication.

No CLI command available. Use the REST or SDK methods.