監査 API

日付フィルター、並べ替えメカニズム、改ページの特定の入力組み合わせのための監査データを要求します。

前提条件

JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。監査 API を使用して認証トークンを生成します。すべての Control Room API を実行するには、JWT が必要です。
ロールとライセンス
AAE_Admin ロールのあるユーザーまたは全員の監査ログ アクションを表示権限のあるユーザーは、Control Room で監査ログを表示できます。
  • URL: http://<your_control_room_url>/v1/audit/messages/list
  • メソッド: POST
注:
  • API をテストするには、Control Room にインストールされた Swagger 定義ファイルを使用します。利用可能な Swagger API は http://<your_control_room_url>/swagger/ で参照できます。
  • また、REST Client を使用してこのタスクを完了することもできます。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    注: 認証 API を使用して JSON Web トークンを生成します。
  2. [POST] メソッドを選択します。
    注: フィルターを適用して、Web ページの基本的な条件付きクエリおよび改ページの制御を実行します。フィルタリングには、フィルタリングの条件、列の並び替え、改ページ パラメーターという 3 つの基本的な機能があります。API リクエスト本文でフィルタリングを参照してください。

    次の例は、12 月 に失敗したログイン試行をリクエストします。

    リクエスト本文:

    
    {
      "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"
          }
        ]
      },
      "fields": [],
      "page": {
        "length": "1000",
        "offset": "0"
      }
    }
  3. リクエストを送信します。
    • Swagger で、[実行] をクリックします。
    • REST Client で [SEND] をクリックします。

    この例のレスポンスは、日付フィルター、並べ替え、および改ページのデータを返しました。リクエストにフィルタリングがない場合、指定した Control Room のすべてのページでレスポンスが正常に返されます。

    レスポンス本文:
    {
      "page": {
        "offset": 0,
        "total": 847,
        "totalFilter": 4
      },
      "list": [
        {
          "id": "aOhx024BVd_jtov73ujy",
          "eventDescription": "User does not exist in Control Room.",
          "activityType": "LOGIN",
          "environmentName": "",
          "hostName": "50.xxx.xxx.66",
          "userName": "string",
          "status": "Unsuccessful",
          "source": "Control Room",
          "objectName": "N/A",
          "detail": "",
          "createdOn": "2019-12-05T00:24:45Z",
          "requestId": "a5f69abd-766c-4eed-8d2f-79aff572538c",
          "createdBy": "0"
        },
        {
          "id": "Y-ht024BVd_jtov7Nej4",
          "eventDescription": "User provided incorrect password.",
          "activityType": "LOGIN",
          "environmentName": "",
          "hostName": "50.xxx.xxx.66",
          "userName": "docs-2fa",
          "status": "Unsuccessful",
          "source": "Control Room",
          "objectName": "N/A",
          "detail": "",
          "createdOn": "2019-12-05T00:19:40Z",
          "requestId": "8995877f-a9ba-41cf-8d6a-a3cfe5a5d63a",
          "createdBy": "0"
        },
        {
          "id": "m46_yG4BGE7puvDMHe_6",
          "eventDescription": "User does not exist in Control Room.",
          "activityType": "LOGIN",
          "environmentName": "",
          "hostName": "50.xxx.xxx.66",
          "userName": "string",
          "status": "Unsuccessful",
          "source": "Control Room",
          "objectName": "N/A",
          "detail": "",
          "createdOn": "2019-12-02T22:33:18Z",
          "requestId": "e3e6387e-9cd9-45af-ac5c-9279c1a63f95",
          "createdBy": "0"
        },
        {
          "id": "mI6qyG4BGE7puvDMle-y",
          "eventDescription": "User does not exist in Control Room.",
          "activityType": "LOGIN",
          "environmentName": "",
          "hostName": "50.xxx.xxx.66",
          "userName": "System",
          "status": "Unsuccessful",
          "source": "Control Room",
          "objectName": "N/A",
          "detail": "",
          "createdOn": "2019-12-02T22:10:52Z",
          "requestId": "a1d5944e-f14e-4981-a65d-7d2a59ed0c44",
          "createdBy": "0"
        }
      ]
    }
    レスポンス ヘッダー:
     cache-control: no-cache, no-store, max-age=0, must-revalidate 
     content-length: 1854 
     content-security-policy: default-src 'self' 
     content-type: application/json 
     date: Sun, 08 Dec 2019 04:58:53 GMT 
     expires: 0 
     pragma: no-cache 
     x-content-type-options: nosniff 
     x-frame-options: SAMEORIGIN 
     x-xss-protection: 1; mode=block  
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。
curl -X POST "http://ec2-34-210-185-177.us-west-2.compute.amazonaws.com/v1/audit/messages/list" -H "accept: application/json" -H "X-Authorization: eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI0IiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzU3ODExMTUsImV4cCI6MTU3NTc4MjMxNSwiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjU2MzI3OTk4MTE5ODEzMDAsImNzcmZUb2tlbiI6IjRmYWM1ODg1ZjM0ZThkYmJhZGQ1ZTMwZDIxNGY3MDA3In0.sqyQ5DiAMqSqu4qpiALFxW0cJGZCJCT8u-oJ9AoUBSvQ7gS5Ss0hszFR4zYIMG_8qQBcENnySnfeDpTysyclRKRx2TCjb2OVpPI8Y76g-6vlaZgJP-_iOloOBzso1I0Q7EHkFE7UOaeWurLcltUXCnjZfYaPC4UJqQTNto0LqavlxsBC3HdxYLg4FiA0D7CKP_sb9CAVPVKN9wlxU35gFzggiBYxifVXSAtB_wtWbJzHeirgx4fuAw8lTBIO0URjgRSR4mgMt0y6hOHIrGuLhtx13c3YQnQ2n5xfWX2OzbdwOLreIu87mbCiA4KZ9X95q1TuI7r6jKecUlrv-RwkVw" -H "Content-Type: application/json" -d "{ \"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\" } ] }, \"fields\": [], \"page\": { \"length\": \"1000\", \"offset\": \"0\" }}"