Audit API

Use the Audit API to request audit data for a given input combination of date filter, sorting mechanism, and pagination.

Prerequisiti

Nota: You can view the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.
Users with the AAE_Admin role or users with the View everyone audit log actions permission can view audit logs for the Control Room.

Procedura

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.
Apply filters to perform basic conditional queries and pagination control for processing web pages.
There are three basic features related to filtering: filtering conditions, sorting columns, and pagination parameters.
Filtering, pagination, and sorting

Use the POST method and endpoint URL: <your_control_room_url>/v1/audit/messages/list.

The following example requests unsuccessful login attempts for the month of December, 2019.

Request body:

{
  "sort": [
    {
      "field": "createdOn",
      "direction": "desc"
    }
  ],
  "filter": {
    "operator": "and",
    "operands": [
      {
        "operator": "gt",
        "field": "createdOn",
        "value": "2019-12-01T00:00:00.001Z"
      },
      {
        "operator": "lt",
        "field": "createdOn",
        "value": "2019-12-31T23:59:59.999Z"
      },
      {
        "operator": "eq",
        "field": "status",
        "value": "Unsuccessful"
      },
      {
        "operator": "substring",
        "field": "activityType",
        "value": "LOGIN"
      },
      {
        "operator": "substring",
        "field": "userName",
        "value": "joe.typical@myemiil.com"
      }
    ]
  },
  "page": {
    "length": "1000",
    "offset": "0"
  }
}

Send the request.

The response for this example returns data for the date filter, sorting, and pagination. If no filtering is used in the request, a successful response returns all pages for the specified Control Room.

Response body:

{
  "page": {
    "offset": 0,
    "total": 731064850,
    "totalFilter": 9
  },
  "list": [
    {
      "id": "XlHj6G4BFXSpOOji5B7S",
      "eventDescription": "User does not exist in Control Room.",
      "activityType": "LOGIN",
      "environmentName": "",
      "hostName": "12.xxx.xx.x",
      "userName": "joe.typical@myemiil.com",
      "status": "Unsuccessful",
      "source": "Control Room",
      "objectName": "N/A",
      "detail": "",
      "createdOn": "2019-12-09T04:21:19Z",
      "requestId": "04965c2e-82e0-4ce4-a88d-bebe1dc3a2a8",
      "createdBy": "0"
    },
    {
      "id": "g1Hj6G4BFXSpOOji2Rwx",
      "eventDescription": "User does not exist in Control Room.",
      "activityType": "LOGIN",
      "environmentName": "",
      "hostName": "12.xxx.xx.x",
      "userName": "joe.typical@myemiil.com",
      "status": "Unsuccessful",
      "source": "Control Room",
      "objectName": "N/A",
      "detail": "",
      "createdOn": "2019-12-09T04:21:16Z",
      "requestId": "61672553-477d-4012-ab47-2a27f6553c4e",
      "createdBy": "0"
    },
    ..............................
    {
      "id": "ETyk6G4BFXSpOOjiaJjt",
      "eventDescription": "User does not exist in Control Room.",
      "activityType": "LOGIN",
      "environmentName": "",
      "hostName": "12.xxx.xx.x",
      "userName": "joe.typical@myemiil.com",
      "status": "Unsuccessful",
      "source": "Control Room",
      "objectName": "N/A",
      "detail": "",
      "createdOn": "2019-12-09T03:11:58Z",
      "requestId": "ebeb01de-1f81-4a7c-8978-405806e146bd",
      "createdBy": "0"
    }
  ]
}

The REST API responds to each request with an HTTP response code. For response codes, see API response codes.