Sign in
Audit

Query audit logs for an asset, glossaryTerm, classificationDef, etc.

post/audit/query

Query parameters

api-versionstring required

The version of the API.

Request body

category'Asset' | 'GlossaryTerm' | 'ClassificationDef'

Audit category in audit log query request.

guidstring

GUID of the targe asset, glossary term or classification definition.

typeNamestring

Only applied to asset; specifies the asset type name.

qualifiedNamestring

Only applied to asset; specifies the asset qualified name.

operationType'EntityCreated' | 'EntityUpdated' | 'EntityDeleted' | 'ClassificationAdded' | 'ClassificationUpdated' | 'ClassificationDeleted' | 'SensitivityLabelChanged' | 'GlossaryTermAssigned' | 'GlossaryTermDisassociated' | 'ClassificationDefinitionCreated' | 'ClassificationDefinitionUpdated' | 'ClassificationDefinitionDeleted' | 'GlossaryTermCreated' | 'GlossaryTermUpdated' | 'GlossaryTermDeleted'

Audit operation type.

userIdstring

User principal name or service principle object ID.

keywordsstring

Any keywords contained in audit log old value or new value part.

startTimestring

Start time of audit log; ISO-8601 representation. Default value is 1970-01-01T00:00:00Z.

endTimestring

End time of audit log; ISO-8601 representation. Default value is UTC now.

sortBystring

Property to sort by. The value should be one of the audit log schema field. Must be used with "SortOrder". CreationTime is suggested.

sortOrder'Ascending' | 'Descending'

Audit query result sort order.

pageSizeinteger

The number of items we hope to return in one page. The maximum value is 1000.

continuationTokenstring

The continuation token to retrieve the next page.

Response

OK. On successful lookup of audit logs within the search criteria.

continuationTokenstring

The continuation token to retrieve the next page. When "lastPage" is false. Client uses this token in the query payload to retrieve the next page.

lastPageboolean

Indicates whether it's the last page.

totalResultCountinteger

The number of total items that qualified for the search criteria.

recordCountinteger

The number of items in current page.

Changes