監査イベント

監査イベントをクエリする

/api/v1/audit_events/query

必要なアクセス許可: 監査ログを読み取ります。

• bash

  curl -X POST 'https://<my_api_endpoint>/api/v1/audit_events/query' \
      -H "Authorization: Bearer $REINFER_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
    "filter": {
      "timestamp": {
        "maximum": "2021-07-10T00:00:00Z",
        "minimum": "2021-06-10T00:00:00Z"
      }
    }
  }'

• ノード

  const request = require("request");
  
  request.post(
    {
      url: "https://<my_api_endpoint>/api/v1/audit_events/query",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
      json: true,
      body: {
        filter: {
          timestamp: {
            maximum: "2021-07-10T00:00:00Z",
            minimum: "2021-06-10T00:00:00Z",
          },
        },
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.post(
      "https://<my_api_endpoint>/api/v1/audit_events/query",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
      json={
          "filter": {
              "timestamp": {
                  "minimum": "2021-06-10T00:00:00Z",
                  "maximum": "2021-07-10T00:00:00Z",
              }
          }
      },
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• レスポンス

  {
    "audit_events": [
      {
        "actor_user_id": "e2148a6625225593",
        "dataset_ids": ["1fe230edc85ffc1a"],
        "event_id": "2555880060c23eb5",
        "event_type": "get_datasets",
        "project_ids": ["ce3c61dcf210f425", "274400867ab17af9"],
        "tenant_ids": ["c59b6e209da438a8"],
        "timestamp": "2021-06-10T16:32:53Z"
      }
    ],
    "continuation": "2555880060c23eb5",
    "datasets": [
      {
        "id": "1fe230edc85ffc1a",
        "name": "collateral-sharing",
        "project_id": "ce3c61dcf210f425",
        "title": "Collateral Sharing"
      },
      {
        "id": "274400867ab17af9",
        "name": "Customer-Feedback",
        "project_id": "ce3c61dcf210f425",
        "title": "Customer Feedback"
      }
    ],
    "projects": [
      {
        "id": "ce3c61dcf210f425",
        "name": "bank-collateral",
        "tenant_id": "c59b6e209da438a8"
      }
    ],
    "status": "ok",
    "tenants": [
      {
        "id": "c59b6e209da438a8",
        "name": "acme"
      }
    ],
    "users": [
      {
        "display_name": "Alice",
        "email": "[e-mail]",
        "id": "e2148a6625225593",
        "tenant_id": "c59b6e209da438a8",
        "username": "alice"
      }
    ]
  }

監査イベントは、Communications Mining™ プラットフォームのユーザーが実行したアクションのレコードです。監査可能なイベントの例は次のとおりです。

• ログインしているユーザー
• ユーザーがパスワードを変更する
• ユーザーが別のユーザーの権限を変更した場合。

名前	型	必須	説明
continuation	string	×	前のクエリが応答で continuation を返した場合は、イベントの別のページを使用できます。 返された継続値をここに設定して、次のページを取得します。
limit	Number	×	ページごとに返される監査イベントの数。 デフォルトは 128 です。
filter	フィルター	×	返す監査イベントを指定するフィルター。

ここで Filter の形式は次のとおりです。

名前	型	必須	説明
timestamp	タイムスタンプフィルター	×	イベントを返す時間範囲を指定するフィルター。

ここで TimestampFilter の形式は次のとおりです。

名前	型	必須	説明
minimum	string	×	ISO-8601 タイムスタンプ。 指定した場合、このタイムスタンプの後またはこのタイムスタンプを含む監査イベントのみを返します。
maximum	string	×	ISO-8601 形式のタイムスタンプ。指定した場合、このタイムスタンプより前の監査イベントのみを返します。

応答形式

監査イベントのリストは、応答の最上位レベルの audit_events キーの下にあります。 各 AuditEvent は他のリソース (ソース、データセット、ユーザーなど) を ID で参照できます。 参照されるリソースごとに、応答の最上位レベルのそれぞれのキー (sources、 datasets、 usersなど) の下に追加情報があります。

AuditEvent は、プラットフォーム内のユーザーによって実行されるアクションを表し、次の基本形式を持ちます。の値によっては、追加のキーが存在する場合 event_type。 たとえば、 get_datasets 監査イベントには、ユーザーが読み取った dataset_ids の一覧が含まれます。

名前	型	説明
event_id	string	このイベントの一意の ID。
event_type	string	このイベントの種類。 次のセクションのイベントの種類のリストを参照してください。
timestamp	string	最も近い秒までの、このイベントの ISO-8601 タイムスタンプ。
actor_user_id	string	このアクションを実行したユーザーの ID。
actor_tenant_id	string	このアクションを実行したユーザーのテナント ID。

最後に、応答に continuation キーが含まれている場合は、要求の continuation フィールドをこの値に設定して、イベントの次のページをフェッチする必要があります。

監査イベントの種類

監査イベントを警告する

イベントの種類	説明
alert_create	アラートが作成されます。
alert_get	アラートが表示されます。
alert_get_all	アラートのリストが表示されます。
alert_update	アラートの設定が編集されます。
alert_delete	アラートが削除されます。
alert_subscriptions_get	アラートのサブスクリプションのリストが表示されます。
alert_subscriptions_delete	アラートのサブスクリプションが削除されます。

クォータ監査イベント

イベントの種類	説明
quotas_get	クォータが表示されます。
quotas_set	クォータが更新されます。
quotas_reset	クォータがリセットされます。

監査イベントを配信する (ストリームは以前は「トリガー」と呼ばれていました)

イベントの種類	説明
trigger_create	ストリームが作成されます。
trigger_get	ストリームが表示されます。
trigger_get_all	ストリームのリストが表示されます。
trigger_update	ストリームの設定が編集されます。
trigger_delete	ストリームが削除されます。
trigger_fetch	ストリームがクエリされます (従来の操作)。
trigger_advance	ストリームはアドバンスです。
trigger_reset	ストリームがリセットされます。
trigger_fetch_gx	生成 AI による抽出ストリームがクエリされます (従来の操作)。
trigger_get_results	ストリームが照会されます。