Sign in

v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Audits

Get audit log

get/v1/audit/{audit_id}

Path parameters

audit_idstring required

ID of an audit log

Example:aud_0123456789ab

Response

OK

account_idstring required

ID of an account

actionstring required

Action that was performed on the resource

action_fields_jsonstring required

Unstructured fields specific to the action

audit_idstring required

ID of an audit log

audit_timestring date-time required

Time of the audit log

client_idstring required

ID of a client or an empty string

descriptionstring required

Description of the audit log

resource_idstring required

ID of the resource that was audited

resource_typestring required

Type of the resource that was audited

sourcestring required

Source of the audit log

systemboolean required

Whether the audit log was created by the system or a user

user_idstring required

ID of a user or an empty string

Example response

{
  "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"
}