Get Audit Trail Stream

The endpoint returns streamed list of audit trail events of the pod depending on input parameters such as the categories of audits, time interval etc. Pages can contain an unlimited number of records.
get
https://youraudittrailURL.symphony.com/at2
/v1/audits/stream
Get Audit Trail Stream

This operation returns streamed list of audit trail events. You can narrow down search results by specifying categories, action, originating userId, attribute, groupId, authorization role, streamId, affected userId, temporary authId, disclaimerId or policyId parameter. Pages can contain an unlimited number of records. This operation returns only audits for the categories the requester is entitled to.

Parameters
Query
startDate
string
start range date restriction. Date must be formatted the following way: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
endDate
string
end range date restriction. Date must be formatted the following way: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
categories*
string
List of Audit Trail categories restriction
affectedUserId
string
"Affected User Id" filter single value restriction
originatingUserId
string
"Originating User Id" filter single value restriction (a.k.a. "Performed by)"
actionId
string
"Action Id" filter single value restriction
attribute
string
"Attribute" filter single value restriction
groupId
string
"Group Id" filter single value restriction (used by Info barrier, Role Scope...)
authorizationRole
string
"Authorization Role" filter single value restriction
streamId
string
"Stream Id" filter single value restriction (using either Base64 or Base64URL encoding)
policyId
string
"Policy Id" filter single value restriction
applicationId
string
"Application Id" filter single value restriction
tempAuthId
string
"Temporary Authorization Id" filter single value restriction
disclaimerId
string
"Disclaimer Id" filter single value restriction
dateFormat
string
Used format for output date values.<br/> Possible values:<br/> <ul> <li>STANDARD_AT_ACP_DATE - MM-dd-YYYY - as historically used in Symphony Audit Trails</li> </ul> or anything supported by java11 DateTimeFormatter (https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/format/DateTimeFormatter.html)<br/> <ul> <li>BASIC_ISO_DATE</li> <li>ISO_DATE</li> <li>ISO_DATE_TIME</li> <li>ISO_INSTANT</li> <li>ISO_LOCAL_DATE</li> <li>ISO_LOCAL_DATE_TIME</li> <li>ISO_LOCAL_TIME</li> <li>ISO_OFFSET_DATE</li> <li>ISO_OFFSET_DATE_TIME</li> <li>ISO_OFFSET_TIME</li> <li>ISO_ORDINAL_DATE</li> <li>ISO_TIME</li> <li>ISO_WEEK_DATE</li> <li>ISO_ZONED_DATE_TIME</li> <li>RFC_1123_DATE_TIME</li> <li>any supported date/time pattern - YYYYMMddHHmmss, ....</li> </ul>
limit
integer
Specifies the maximum number of objects to return. It is possible that fewer than the specified number is returned, either due to reaching the end of the record set or due to data access rules that filter results of the back end query. The number of returned objects should not be used to determine if there are more objects to retrieve. Instead, the presence of the "next" and "previous" (see below) fields should be used.
Header
Content-Type
string
Content-type expected in return
Responses
200: OK
Success
400: Bad Request
Bad request
401: Unauthorized
Unauthorized. Returned if JWT token verification failed.
403: Forbidden
Forbidden. Returned if the caller doesn't have the required entitlements to call an endpoint.
404: Not Found
Not found. Returned if specified key is not found.
Last modified 2mo ago