Audit Logs
Track all important actions using our rich audit logs.
An audit log object provides information about the action and user that initiated the changes and the old and new values, where applicable.
The API allows you to retrieve audit logs for a given client, action, resource, or trigger.
Attribute | Type | Description |
id | string | The unique identifier for an audit log. |
memberId | string | |
resourceType | string | The type of audited resource. Valid values include:
|
resourceId | string | The id of the audited resource. |
clientId | string | The id of the client associated with the audited resource. |
trigger | string | The event that triggered the audit log creation, e.g. updateClient. |
action | string | The type of action. Possible values are:
|
diff | array[object] | |
createdAt | string | The date and time when the audit log was created. |
Attribute | Type | Description |
action | string | Indicates the kind of change. Possible values are:
|
path | array[string] | The left-to-right path of the attribute in the audited resource e.g. ['personDetails', 'firstName'] indicates that firstName within the personDetails object is the attribute affected by the action. |
old | string | The old value of the audited attribute. |
new | string | The new value of the audited attribute. When action is new, the type of new is object rather than string |
Last modified 1mo ago