Audit events
This page lists the audit events Semaphore records and the fields you can search and filter them by. To turn on the audit log, see Audit log.
Edition is the Semaphore edition that records the event.
Event format
Every event is a JSON object. Fields that do not apply to an event are left out.
| Field | When present | Meaning |
|---|---|---|
event_id | Always | Unique event ID. Use it to remove duplicate deliveries. |
seq | Always | Increasing sequence number. Use it to restore event order. |
timestamp | Always | Event time in UTC. |
schema_version | Always | Version of the event envelope. |
category, event_code, type, action | Always | Stable values that identify what happened. |
outcome | Always | success or failure. |
reason | Always | Why the action failed, if the event lists its reasons. On a partial success, what did not complete. Empty on any other success. |
actor | Always | The user, anonymous client, system component, runner or integration that acted. |
source | HTTP requests | Client IP address and, when available, User-Agent. |
target | When an object is identified | The object affected by the action. |
scope | Project events | The project that contains the action. |
request_id | HTTP requests | The request ID also returned in X-Request-ID. |
instance_id | Always | The installation name configured by the administrator. |
node_id | HA installations | The node that recorded the event. |
metadata | Always | Additional fields documented for the event kind. |
Authentication
auth.login is recorded once sign-in is complete, including the TOTP check if the user has one. A wrong TOTP code is recorded as an auth.mfa failure.
| Event code | Action | Type | Outcomes | Reasons | Metadata | Edition |
|---|---|---|---|---|---|---|
auth.login | authenticate | start | success, failure | invalid_credentials, user_not_found, method_disabled, invalid_state, provider_error, internal_error | method, provider | Community |
auth.logout | terminate_session | end | success | Community | ||
auth.mfa | verify_totp | info | success, failure | invalid_passcode | Community | |
auth.mfa | verify_email | info | success, failure | invalid_passcode, code_expired, too_many_attempts | Pro | |
auth.mfa | recover | info | success, failure | invalid_recovery_code | Community | |
auth.api_token | reject | denied | failure | token_unknown, token_expired | Community | |
auth.authorization | deny | denied | failure | forbidden | method, permission | Community |
auth.csrf | block | denied | failure | cross_origin | method | Community |