監査 API
監査 API を使用して、日付フィルタ、並べ替えメカニズム、改ページの特定の入力組み合わせのための監査データをリクエストします。
前提条件
注: Community Edition で Control Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。
- 認証 API を使用して JSON Web トークンを生成します。認証 API をご覧ください。
- AAE_Admin ロールを持つユーザーまたは [全員の監査ログ アクションを表示] 権限を持つユーザーは、Control Room で監査ログを表示できます。
手順
- 認証 API を使用して JSON Web トークンを生成します。認証 API をご覧ください。
-
フィルタを適用して、Web ページの基本的な条件付きクエリおよび改ページの制御を実行します。
フィルタリングには、フィルタリングの条件、列の並び替え、改ページ パラメーターという 3 つの基本的な機能があります。
-
POST メソッドとエンドポイント URL:
<your_control_room_url>/v1/audit/messages/list
。次の例は、2019 年 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" }, { "operator": "substring", "field": "userName", "value": "joe.typical@myemiil.com" } ] }, "fields": [], "page": { "length": "1000", "offset": "0" } }
-
リクエストを送信します。
この例のレスポンスは、日付フィルタ、並べ替え、および改ページのデータを返しました。リクエストにフィルタリングがない場合、指定した Control Room のすべてのページでレスポンスが正常に返されます。レスポンス本文:
{ "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" } ] }
REST API は、HTTP レスポンス コードで各リクエストに応答します。 レスポンス コードについては、API レスポンス コード を参照してください。