TOtoriihq
Audit

Get admin audit logs

The Audit Log API allows the user to pull Audit Log events happening in the organization account. <br>The API is sorted based on <code>creationTime</code> and supports pagination. The default sort order is descending. <br>Filtering is possible using the following attributes: <code>entity</code>, <code>startTime</code>, <code>endTime</code> <br>An HTTP 413 error means the response is too large to return. Send the <code>Accept-Encoding: gzip</code> header, or lower the <code>size</code> parameter.

<p><ul><li>Rate limit: 200 requests per minute</li></ul></p>
get/audit

Request

  • Base URL
    https://api.toriihq.com/v1.0
  • Auth
    API key in header Authorization

Query parameters

entity'workflows' | 'tasks' | 'campaigns' | 'contracts' | 'users' | 'apps' | 'transactions' | 'orgs' | 'roles' | 'authentication' | 'access' | 'integrations' | 'licenses' | 'files' | 'features' | 'testConnection' | 'appCatalog' | 'plugin' | 'mergeUsersRules' | 'sendingDomains' | 'anonymizeUser' | 'reports' | 'renewalForecast' | 'dashboards' | 'accessRequestDefinitions' | 'accessRequests' | 'accessPolicies' | 'userGroups'

Audit Category

startTimestring date

Items' creation time is greater than startTime

endTimestring date

Items' creation time is less than or equal to endTime

sizeinteger

Number of items to return.

cursorstring

A base64 string indicating the offset from which to start. <br>Pass the value of nextCursor returned from the previous call to get the next set of results

sort'asc' | 'desc'

Sort order by creation time. Defaults to descending.

Response

Audit Log

nextCursorstring

A base64 string indicating the offset from which to start. <br>Pass the value of nextCursor returned from the previous call to get the next set of results

countinteger

Example response

{
  "audit": [
    {
      "performedBy": 1000,
      "performedByFirstName": "Tony",
      "performedByLastName": "Tony",
      "performedByEmail": "tony@stark.com",
      "idTargetOrg": 1000,
      "creationTime": "2020-01-01T00:00:00.000Z",
      "requestDetails": {
        "path": "/api/orgs/10/contracts/50000",
        "method": "put",
        "remoteAddress": "10.10.10.10"
      },
      "properties": {}
    }
  ],
  "nextCursor": "WzE0NjM1Mzg4NTcsIjY1NDMyMyJd",
  "count": 100
}

Changes

No recorded changes to this operation across all 1 revision of this API.