GET
/
audit_logs
curl --request GET \
  --url https://{tenant_id}.hanko.io/admin/audit_logs \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
    "type": "user_created",
    "error": "<string>",
    "meta_http_request_id": "0a2xsrhlhiQv49FIpq8KV8uQVq6ky9Bw",
    "meta_source_ip": "172.27.0.1",
    "meta_user_agent": "<string>",
    "actor_user_id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
    "actor_email": "jsmith@example.com",
    "created_at": "2022-09-14T12:15:09.788784Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API key. Must only be used when using Hanko Cloud.

Query Parameters

​
page
integer
default:1

The page which should be returned

​
per_page
integer
default:20

The number of returned items

​
start_time
string

Date and time from which the logs are included

Example:

"2022-09-12T12:48:48.000Z"

​
end_time
string

Date and time to which the logs are included

Example:

"2022-09-15T12:48:48.000Z"

​
actor_user_id
string

Only audit logs with the specified user_id are included

Example:

"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"

​
actor_email
string

Only audit logs with the specified email are included

Example:

"example@example.com"

​
meta_source_ip
string

Only audit logs with the specified ip address are included

Example:

"127.0.0.1"

​
q
string

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

Example:

"example.com"

​
type
enum<string>[]

Only audit logs with the specified type are included

The type of the audit log

Available options:
user_created,
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,
thirdparty_signup_succeeded,
thirdparty_signin_succeeded
Example:

"user_created"

Response

200
application/json
Details about audit logs
​
id
string
required

The ID of the audit log

Example:

"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"

​
type
enum<string>
required

The type of the audit log

Available options:
user_created,
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,
thirdparty_signup_succeeded,
thirdparty_signin_succeeded
​
meta_http_request_id
string
required

The ID of the corresponding http request

Example:

"0a2xsrhlhiQv49FIpq8KV8uQVq6ky9Bw"

​
meta_source_ip
string
required

The IP from where the http request came from

Example:

"172.27.0.1"

​
meta_user_agent
string
required

The user agent from where the http request came from

​
created_at
string
required

Time of creation of the audit log

Example:

"2022-09-14T12:15:09.788784Z"

​
error
string

A more detailed message why something failed

​
actor_user_id
string

The userID from the actor

Example:

"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"

​
actor_email
string

The email from the actor

Was this page helpful?

Suggest editsRaise issue