API 監査イベント

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

監査イベントをクエリして、プラットフォーム内でのユーザーとシステムのアクションの詳細な記録を取得できます。

注: IXP 監査ログ ビューアー ロールが割り当てられている必要があります。

/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"
    }
  ]
}

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

• ユーザーのログイン
• ユーザーによるパスワードの変更
• ユーザーによる、別のユーザーの権限の変更

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

filter の形式は次のとおりです。

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

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

名前	入力	Required	説明
minimum	string	×	ISO-8601 形式のタイムスタンプです。指定した場合、このタイムスタンプ以降の監査イベントのみを返します。
maximum	string	×	ISO-8601 形式のタイムスタンプです。指定した場合、このタイムスタンプより前の監査イベントのみを返します。

監査イベントの種類

このセクションには、非構造化ドキュメントと複雑なドキュメントに適用されるすべての監査イベントの種類が記載されています。

プロジェクト管理

予定の種類	説明
ucd_project_created	非構造化ドキュメントと複雑なドキュメント プロジェクトが作成されました。
ucd_project_deleted	非構造化ドキュメントと複雑なドキュメント プロジェクトが削除されました。

モデルの管理

予定の種類	説明
model_version_published	モデルがパブリッシュされました。
model_version_unpublished	モデル タグが更新されました。
model_tag_deleted	パブリッシュ済みのモデルが削除されました。

データセットの管理

予定の種類	説明
get_datasets	データセットが取得されました。
get_datasets_by_owner	データセットが所有者によって取得されました。
get_dataset	特定のデータセットが取得されました。
export_dataset	データセットがエクスポートされました。

ユーザーの管理

予定の種類	説明
create_user	新しいユーザーが作成されました。
delete_user	ユーザーが削除されました。
get_users	ユーザー情報が取得されました。
update_user	ユーザー情報が変更されました。

認証とセキュリティ

予定の種類	説明
login_success	ユーザー ログインが成功しました。
authentication_failed_password	パスワードが間違っているためログインに失敗しました。
authentication_failed_totp	TOTP コードが間違っているためログインに失敗しました。
login_failed_ip_address	IP アドレス制限のためログインに失敗しました。
revoke_api_tokens	API トークンが取り消されました。
revoke_login_tokens	ログイン トークンが取り消されました。
revoke_current_login_token	現在のセッション トークンが取り消されました。
replace_api_token	API トークンが置換されました。
authentication_failed_totp_lockout	TOTP のロックアウトのためログインが失敗しました。

パスワードのリセット

予定の種類	説明
send_password_reset_success	パスワード リセット メールの送信に成功しました。
send_password_reset_failed_ip_address	IP によってパスワードのリセットがブロックされました。
verify_password_reset_success	パスワードのリセットの検証に成功しました。
verify_password_reset_failed_ip_address	IP によってパスワードのリセットの検証がブロックされました。
change_password_success	パスワードの変更が成功しました。
change_password_failed_totp	TOTP のためにパスワードの変更に失敗しました。
change_password_failed_ip_address	パスワードの変更がブロックされました。
verify_password_reset_failed_signature	パスワード リセットの署名が無効です。
verify_password_reset_failed_timestamp	パスワードのリセット リンクが期限切れです。
change_password_failed_current_password	現在のパスワードに間違ったパスワードが入力されました。

コメントのクエリ

予定の種類	説明
comment_query_text	テキストベースのコメントのクエリ。
comment_query_sample	コメントのクエリのサンプル。
comment_query_learning	学習関連のコメントのクエリ。
comment_query_any_label_asc	昇順のラベルベースのクエリ。
comment_query_recent	最近のコメントのクエリ。
comment_query_by_label	特定のラベルでフィルター処理したクエリ。
comment_query_diagnostic	診断コメントのクエリ。
comment_query_label_property	ラベルのプロパティのクエリ。
comment_query_attachment_text	添付ファイル テキストのクエリ。

注釈

予定の種類	説明
get_annotations	アノテーションが取得されました。
update_annotation	アノテーションが変更されました。

クォータの管理

予定の種類	説明
quota_set	クォータが設定されました。
quota_reset	クォータがリセットされます。
quotas_get	クォータが取得されました。

システムと管理

予定の種類	説明
audit_event_query	監査イベントが直接クエリされました。