Search Audit Records

post

{protocol}://{server}:{port}{basePath}/accounts/{accountId}/audit-records:search

This API requires the Account Administrator role.

Searches the audit records based on the supplied filter.

The value of searchKeyword can be used to perform a text search across all fields within an audit record (excluding date).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

The unique 6 character internal id that represents the customer account.

Query Params

pageNumber

int32

≥ 1

Defaults to 1

The page number of the records to retrieve. Default value is 1.

pageSize

int32

5 to 50

Defaults to 5

The max number of records to retrieve per page. Default value is 5, max value is 50.

orderBy

string

length between 4 and 23

Field name on which sorting needs to be performed. The possible fields
you ordered on are date (date of audit record) and author.
Field Names are case-sensitive (should be written as it is in description). The default sorting order is ascending. To specify descending order, a suffix " desc" should be added. For example, "date asc" for ascending or "date desc" for descending".

Body Params

The filter to be applied when searching for audit records.

startDate

date-time

required

The starting datetime to use when searching for audit records (in ISO 8601 format including timezone, 'yyyy-MM-dd'T'HH:mm:ss[.SSS]Z').

endDate

date-time

required

The ending datetime to use when searching for audit records (in ISO 8601 format including timezone, 'yyyy-MM-dd'T'HH:mm:ss[.SSS]Z').

author

string

length ≤ 255

The ID of the author who changed the auditable object. This can be a user within the system or an automated app.

event

string

enum

This field indicates the type of event that occurred on the auditable object.

An explanation of the values is listed below:

CREATED - A new auditable object was created.
UPDATED - An existing auditable object was updated.
DELETED - An existing auditable object was deleted.

Allowed:

type

string

enum

required

The type of auditable object.

Accepted values:

PROFILE
USER
RESOURCE_PARTITION
USERS_DEFAULT_RESOURCE

Allowed:

ipAddress

string

length ≤ 15

The originating IP Address of the author who changed the auditable object.

searchKeyword

string

length ≤ 255

Keyword to search for across all the audit records.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

500Request processing failed