v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB

Audits

List audit logs

get/v1/audit

Query parameters

offsetinteger

Starting index for pagination

limitinteger

Number of items to return for pagination

audit_action_namestring

Audit action

Example:user_created

audit_resource_type_namestring

Audit resource type

sort_by'audit_time'

Sort by a specific field

sort_ascboolean

Sort in ascending order

audit_time_beforestring date-time

Filter audit logs to before a specific audit timestamp (RFC3339 format)

audit_time_afterstring date-time

Filter audit logs to after a specific audit timestamp (RFC3339 format)

Response

Example response

{
  "data": [
    {
      "account_id": "act_0123456789ab",
      "action": "user_created",
      "action_fields_json": "{\"user_id\":\"user_123\"}",
      "audit_id": "aud_0123456789ab",
      "audit_time": "2021-01-01T00:00:00Z",
      "client_id": "c_0123456789ab",
      "description": "User created",
      "resource_id": "u_0123456789ab",
      "resource_type": "user",
      "source": "api",
      "system": true,
      "user_id": "u_0123456789ab"
    }
  ],
  "pagination": {
    "next_offset": 10
  }
}