Audit - Single Record

GET

/audit/v2/{bucket}/{resource_type}/{uid}/audit

Pull audit log messages from a single record

Parameters

Path Parameters

bucket

required

The bucket (client) name

string

Example

example

resource_type

required

The type of resource, usually the second element in the URI e.g person, organisation, member, payment

string

Example

person

uid

required

Usually the final element in the URI, an alphanumeric unique identifier

string

Example

6305f074683e800f3abe809e

Query Parameters

limit

integer

default: 250

since_days

integer

default: 180

Responses

200

A list of change records for the URI

List of changes to the record

object

results

Array<object>

object

date

A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm

string

Example

2023-09-05T11:27:06.437000

message

Human readable diff

string

uri

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

user

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

revertable

boolean

resource

The type of resource, usually the second element in the URI e.g person, organisation, member, payment

string

Example

person

clean_diff

Array<object>

object

field

string

prev

The previous value

string

value

The new value

string

verb

The type of change

string

Allowed values: change add drop

count

The number of changes

integer

uri

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

related_uris

Array<string>

400

A standard error message

401

Authentication error