Skip to main content

Audit logs

Audit logs (2.0.0)

Download OpenAPI specification:Download

API for interacting with the Snow Atlas audit logs service.

Auditlogs

Get audit logs

Returns the details of the tenant logs matching a criteria.

Authorizations:
bearerAuth
query Parameters
attachments
boolean <boolean>

Specify if the attachments should be included in the response.

filter
string
Example: filter=?filter=accountId -eq "bf49948b-9e55-4bb5-3316-08d90e3e012d"

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example
accountId The unique ID of the account. string ?filter=accountId -eq "bf49948b-9e55-4bb5-3316-08d90e3e012d"
category The log category. double ?filter=category -eq 3
created The log create date. string ?filter=created -eq "2023-08-26T00:00:00Z"
identityName A full name of the user performing a action, or application name. string ?filter=identityName -eq "John Doe"
ipAddress The IP address. string ?filter=ipAddress -eq "127.0.0.1"
resourceId The unique ID of the resource. string ?filter=resourceId -eq "bf49948b-9e55-4bb5-3316-08d90e3e012d"
resourceName The name of the resource. string ?filter=resourceName -eq "User John Doe"
source The log source. string ?filter=source -eq "identity"
type The log type. string ?filter=type -eq "identity.account.reset"
userId The unique ID of the user. string ?filter=userId -eq "5cdef9c0-b177-4bbc-7f9a-08d90e3e012c"

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]