Audit Users and User Access Details
User Access Audit Details
This API will retrieve the audit details of account user access.
GET
/network/audit/accounts/{accountId}/userAccess
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| fromDate | date-time | Valid start date | Yes |
| toDate | date-time | Valid end date. Must be greater than the start date. | Yes |
| nextContinuationToken | string | Id from subsequent request to get next set of records. | No |
Example Response
Headers: Transfer-Encoding: chunked totalRecords: 0 nextfromdate: 2018-08-30T13:20:01.764Z nextcontinuationtoken: string Content-Type: text/csv
Body:
MessageKey,EntityKey,EntityId,When,Principal,Message,PreviousState,CurrentState
string,string,string,2018-08-30T13:20:01.764Z,"{json string}","{json string}","{json string}"
Response Codes
| Code | Description |
|---|---|
| 401 | Unauthorized error |
| 500 | Internal server error |
User Access Audit Details of Specified User
This API will retrieve user access details of a specified user.
GET
/network/audit/accounts/{accountId}/userAccess/{userId}
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| userId | string | ID of the user | Yes |
| fromDate | date-time | Valid start date | Yes |
| toDate | date-time | Valid end date. Must be greater than the start date. | Yes |
| nextContinuationToken | string | Id from subsequent request to get next set of records. | No |
Example Response
Headers: Transfer-Encoding: chunked totalRecords: 0 nextfromdate: 2018-08-30T13:20:01.764Z nextcontinuationtoken: string Content-Type: text/csv
Body:
MessageKey,EntityKey,EntityId,When,Principal,Message,PreviousState,CurrentState
string,string,string,2018-08-30T13:20:01.764Z,"{json string}","{json string}","{json string}"
Response Codes
| Code | Description |
|---|---|
| 401 | Unauthorized error |
| 500 | Internal server error |
Users Audit Details
This API will retrieve audit details of all users.
GET
/network/audit/accounts/{accountId}/users
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| fromDate | date-time | Valid start date | Yes |
| toDate | date-time | Valid end date. Must be greater than the start date. | Yes |
| nextContinuationToken | string | Id from subsequent request to get next set of records. | No |
Example Response
Headers: Transfer-Encoding: chunked totalRecords: 0 nextfromdate: 2018-08-30T13:20:01.764Z nextcontinuationtoken: string Content-Type: text/csv
Body:
MessageKey,EntityKey,EntityId,When,Principal,Message,PreviousState,CurrentState
string,string,string,2018-08-30T13:20:01.764Z,"{json string}","{json string}","{json string}"
Response Codes
| Code | Description |
|---|---|
| 401 | Unauthorized error |
| 500 | Internal server error |
Audit Details of Specified User
This API will retrieve audit details of a specified user.
GET
/network/audit/accounts/{accountId}/users/{userId}
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| userId | string | ID of the user | Yes |
| fromDate | date-time | Valid start date | Yes |
| toDate | date-time | Valid end date. Must be greater than the start date. | Yes |
| nextContinuationToken | string | Id from subsequent request to get next set of records. | No |
Example Response
Headers: Transfer-Encoding: chunked totalRecords: 0 nextfromdate: 2018-08-30T13:20:01.764Z nextcontinuationtoken: string Content-Type: text/csv
Body:
MessageKey,EntityKey,EntityId,When,Principal,Message,PreviousState,CurrentState
string,string,string,2018-08-30T13:20:01.764Z,"{json string}","{json string}","{json string}"
Response Codes
| Code | Description |
|---|---|
| 401 | Unauthorized error |
| 500 | Internal server error |
- User Access Audit Details
-
User Access Audit Details
This API will retrieve the audit details of account user access.
GET/network/audit/accounts/{accountId}/userAccessRequest Parameters
Name Type Description Required fromDate date-time Valid start date Yes toDate date-time Valid end date. Must be greater than the start date. Yes nextContinuationToken string Id from subsequent request to get next set of records. No Example Response
Headers: Transfer-Encoding: chunked totalRecords: 0 nextfromdate: 2018-08-30T13:20:01.764Z nextcontinuationtoken: string Content-Type: text/csv
Body: MessageKey,EntityKey,EntityId,When,Principal,Message,PreviousState,CurrentState string,string,string,2018-08-30T13:20:01.764Z,"{json string}","{json string}","{json string}"Response Codes
Code Description 401 Unauthorized error 500 Internal server error - Specific User Access Audit Details
-
User Access Audit Details of Specified User
This API will retrieve user access details of a specified user.
GET/network/audit/accounts/{accountId}/userAccess/{userId}Request Parameters
Name Type Description Required userId string ID of the user Yes fromDate date-time Valid start date Yes toDate date-time Valid end date. Must be greater than the start date. Yes nextContinuationToken string Id from subsequent request to get next set of records. No Example Response
Headers: Transfer-Encoding: chunked totalRecords: 0 nextfromdate: 2018-08-30T13:20:01.764Z nextcontinuationtoken: string Content-Type: text/csv
Body: MessageKey,EntityKey,EntityId,When,Principal,Message,PreviousState,CurrentState string,string,string,2018-08-30T13:20:01.764Z,"{json string}","{json string}","{json string}"Response Codes
Code Description 401 Unauthorized error 500 Internal server error - Users Audit Details
-
Users Audit Details
This API will retrieve audit details of all users.
GET/network/audit/accounts/{accountId}/usersRequest Parameters
Name Type Description Required fromDate date-time Valid start date Yes toDate date-time Valid end date. Must be greater than the start date. Yes nextContinuationToken string Id from subsequent request to get next set of records. No Example Response
Headers: Transfer-Encoding: chunked totalRecords: 0 nextfromdate: 2018-08-30T13:20:01.764Z nextcontinuationtoken: string Content-Type: text/csv
Body: MessageKey,EntityKey,EntityId,When,Principal,Message,PreviousState,CurrentState string,string,string,2018-08-30T13:20:01.764Z,"{json string}","{json string}","{json string}"Response Codes
Code Description 401 Unauthorized error 500 Internal server error - Audit Details of Specified User
-
Audit Details of Specified User
This API will retrieve audit details of a specified user.
GET/network/audit/accounts/{accountId}/users/{userId}Request Parameters
Name Type Description Required userId string ID of the user Yes fromDate date-time Valid start date Yes toDate date-time Valid end date. Must be greater than the start date. Yes nextContinuationToken string Id from subsequent request to get next set of records. No Example Response
Headers: Transfer-Encoding: chunked totalRecords: 0 nextfromdate: 2018-08-30T13:20:01.764Z nextcontinuationtoken: string Content-Type: text/csv
Body: MessageKey,EntityKey,EntityId,When,Principal,Message,PreviousState,CurrentState string,string,string,2018-08-30T13:20:01.764Z,"{json string}","{json string}","{json string}"Response Codes
Code Description 401 Unauthorized error 500 Internal server error