Audit Log

Audit log events are usually kept for 90 days.

action
string or null <= 255 characters

The action taken.

additionalInfo
Array of objects or null

Additional information related to the action.

agent
object or null

Details about the agent involved in the action.

changes
Array of objects or null

The list of changes made.

eventName
string or null <= 255 characters

Audit event name.

globalId
string or null <= 36 characters

The global UUID.

orgId
string or null <= 36 characters

The orgId UUID.

requestId
string or null <= 36 characters

The UUID of the request. RequestId groups dependent events.

result
string or null <= 255 characters

The result of the action: completed. pending or failed.

timestamp
string or null <date-time>

The timestamp of the action.

{
  • "action": "string",
  • "additionalInfo": [
    ],
  • "agent": { },
  • "changes": [
    ],
  • "eventName": "string",
  • "globalId": "string",
  • "orgId": "string",
  • "requestId": "string",
  • "result": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Audit Log Custom Filters

NAME VALUE TYPE VALUE KIND VALUE LENGTH
agentEmail string single N/A
agentIpAddress string single N/A

⌵ Audit Log Actions

Get a Collection of Audit Logs

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/auditLogs
Request samples
Response samples
application/vnd.api+json
{
  • "data": [
    ]
}