Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Auditlog

This endpoint filters audit events by userId, targetId, targetType, auditType

get/auditLogs

Query parameters

include'description' | 'userAgent' | 'data' | 'ipAddressLocation'
userIdstring
Example:ca0de584

Filter by userId

targetIdstring

Filter by targetId

targetType'user' | 'account' | 'device' | 'file'

Filter by targetType

locationIdstring

Filter by locationId

auditType'requestDownload' | 'saveDownload' | 'createDevice' | 'deleteDevice' | 'updateDevice' | 'createAccount' | 'updateAccount' | 'createUser' | 'createUserSso' | 'deleteUser' | 'updateUser' | 'switchAccount' | 'devicesOn' | 'devicesOff' | 'deviceRestart' | 'userLogin' | 'userLogout' | 'getLayout' | 'createLayout' | 'deleteLayout' | 'updateLayout' | 'managedSwitchControl' | 'managedSwitchUpdate' | 'forgotPassword' | 'resetPassword' | 'videoRecordStart' | 'videoRecordEnd' | 'viewVideoEnd' | 'viewVideoStart' | 'createFile' | 'deleteFile' | 'updateFile' | 'activateFirstResponders' | 'deactivateFirstResponders' | 'openTunnel' | 'closeTunnel' | 'activeOutput0' | 'activeOutput1' | 'activeOutput2' | 'activeOutput3' | 'lprSearch' | 'videoSearch' | 'cameraSnapshot' | 'talkdownSessionStarted' | 'talkdownSessionFinished' | 'createLocation' | 'updateLocation' | 'deleteLocation'

Valid values given by /auditTypes endpoint.

Filter by auditType

timestamp__gtestring date-time
Example:2021-04-22T00:00:00.000+00:00

Minimum timestamp to list auditlogs.

timestamp__ltestring date-time
Example:2021-04-22T00:00:00.000+00:00

Maximum timestamp to list auditlogs.

pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

Response

List of audit events

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

Example response

{
  "results": [
    {
      "timestamp": "2021-04-22T00:00:00.000+00:00",
      "userId": "ca0de584",
      "accountId": "00011557",
      "locationId": "2428fda3-389f-48ce-b062-85875dd6b2e2",
      "data": [
        {
          "type": "details",
          "id": "ioOutput1",
          "header": "IO - Output 1",
          "rows": [
            {
              "id": "turnOnOutput",
              "label": "Turn on output",
              "value": "relay_1",
              "oldValue": "relay_old"
            }
          ]
        }
      ]
    }
  ]
}