Sign in

v1

latestOpenAPI 3.0.3AGPL-3.0-or-later2026-07-2687268192.4 KB
Audit Logs

Get a list of audit logs

get/audit_logs

Query parameters

pageinteger

The page which should be returned

per_pageinteger

The number of returned items

start_timestring
Example:2022-09-12T12:48:48.000Z

Date and time from which the logs are included

end_timestring
Example:2022-09-15T12:48:48.000Z

Date and time to which the logs are included

actor_user_idstring uuid4
Example:c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c

Only audit logs with the specified user_id are included

actor_emailstring email
Example:example@example.com

Only audit logs with the specified email are included

string ipv4
OR
string ipv6

Only audit logs with the specified ip address are included

qstring
Example:example.com

Only audit logs are included when the search string matches values in meta_source_ip or actor_user_id or actor_email

typeAuditLogTypes[]

Only audit logs with the specified type are included

Response

Details about audit logs

idstring uuid4 required
type'user_logged_out' | 'password_set_succeeded' | 'password_set_failed' | 'password_login_succeeded' | 'password_login_failed' | 'passcode_login_init_succeeded' | 'passcode_login_init_failed' | 'passcode_login_final_succeeded' | 'passcode_login_final_failed' | 'webauthn_registration_init_succeeded' | 'webauthn_registration_init_failed' | 'webauthn_registration_final_succeeded' | 'webauthn_registration_final_failed' | 'webauthn_authentication_init_succeeded' | 'webauthn_authentication_init_failed' | 'webauthn_authentication_final_succeeded' | 'webauthn_authentication_final_failed' | 'webauthn_credential_updated' | 'webauthn_credential_deleted' | 'thirdparty_signup_succeeded' | 'thirdparty_signin_succeeded' | 'thirdparty_linking_succeeded' | 'thirdparty_signin_signup_failed' | 'token_exchange_succeeded' | 'token_exchange_failed' | 'user_created' | 'email_created' | 'email_verified' | 'email_deleted' | 'primary_email_changed' | 'user_deleted' | 'login_success' | 'login_failure' | 'otp_created' | 'passkey_created' | 'passkey_deleted' | 'security_key_created' | 'username_changed' | 'username_deleted' | 'password_changed' | 'password_deleted' required

The type of the audit log

errorstring

A more detailed message why something failed

meta_http_request_idstring required

The ID of the corresponding http request

meta_source_ipstring ip-address required

The IP from where the http request came from

meta_user_agentstring required

The user agent from where the http request came from

actor_user_idstring uuid4
actor_emailstring email

The email from the actor

created_atstring date-time required

Time of creation of the audit log

Example response

[
  {
    "id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
    "meta_http_request_id": "0a2xsrhlhiQv49FIpq8KV8uQVq6ky9Bw",
    "meta_source_ip": "172.27.0.1",
    "actor_user_id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
    "created_at": "2022-09-14T12:15:09.788784Z"
  }
]
All 87 operations