ARAMイベント

管理者REST APIを使って、企業の監査およびセキュリティイベントのデータを取得

説明

ARAMイベントエンドポイントは、Keeperのレポート・アラートモジュール (ARAM)によって収集された、企業向けの監査ログおよびセキュリティイベントにプログラムからアクセスするためのエンドポイントです。管理者やセキュリティ担当者は、このエンドポイントを利用して、コンプライアンス監視、セキュリティ分析、SIEM連携を目的に、監査イベントデータの取得、フィルタリング、エクスポートを行えます。

ARAMは、認証イベント、管理操作、レコード操作、共有アクティビティ、KeeperPAMの特権アクセスイベントなど、Keeperプラットフォーム全体で300種類以上のイベントタイプを記録します。監査イベントエンドポイントでは、これらのデータをREST形式のインターフェースを通じて取得できるため、カスタムアプリケーション、自動化ワークフロー、サードパーティのセキュリティツールと手軽に連携できます。

要件

• 有効なKeeperエンタープライズサブスクリプション
• レポート・アラートモジュール (ARAM)のアドオンが有効になっていること
• レポート権限を含む管理者権限
• 有効な管理者向けREST API認証情報

エンドポイント

ARAM管理者向けAPIのエンドポイントは、Keeperエンタープライズのリージョンによって異なり、いずれも /api/rest/public/events で終わります。

US:

https://keepersecurity.com/api/rest/public/events

EU:

https://keepersecurity.eu/api/rest/public/events

AU:

https://keepersecurity.com.au/api/rest/public/events

CA:

https://keepersecurity.ca/api/rest/public/events

JP:

https://keepersecurity.jp/api/rest/public/events

GOV:

https://govcloud.keepersecurity.us/api/rest/public/events

本ガイドでは以降、USのアドレスを使用します。エンタープライズのリージョンと異なるアドレスを呼び出すと、Invalid Token エラーが返されます。

イベントカテゴリ

本エンドポイントでは、以下のカテゴリのイベントが返されます。

カテゴリ	説明
セキュリティイベント	ログイン試行、2要素認証 (2FA) の変更、マスターパスワードの変更、認証失敗
管理イベント	ユーザーのプロビジョニング、ロールの割り当て、ポリシーの変更、ノード管理
レコードイベント	レコードの作成、更新、削除、およびアクセスイベント
共有イベント	レコードの共有、共有フォルダの操作、チームメンバーシップの変更
KeeperPAMイベント	特権セッションの記録、接続イベント、シークレットへのアクセス
シークレットマネージャーイベント	KSMアプリケーションへのアクセス、シークレットの取得、ローテーションイベント
BreachWatchイベント	高リスクパスワードの検出、対応状況の追跡

監査イベントの取得

指定した2つの日付の間における特定のエンタープライズの監査イベントを、ページ分割形式で取得します。本エンドポイントは主にSIEM連携 (例: Azure Sentinel) で使用され、他のログ集約ツールにも対応しています。 結果はページ単位で返されます。次のページを取得するには、レスポンスの continuation_token を使用します。これ以上結果がない場合、continuation_token は null、has_more は false になります。 例 curl --location 'https://keepersecurity.com/api/rest/public/events?start_date=2025-11-24T00%3A00%3A00Z&limit=20&end_date=2025-11-26T23%3A59%3A59Z' \ --header 'x-api-token: Bearer YOUR_API_TOKEN'

{"openapi":"3.0.3","info":{"title":"Keeper Integration API","version":"1.0.0"},"servers":[{"url":"https://keepersecurity.com/api/rest","description":"Production environment"}],"security":[{"ApiTokenAuth":[]}],"components":{"securitySchemes":{"ApiTokenAuth":{"type":"apiKey","in":"header","name":"x-api-token"}}},"paths":{"/public/events":{"get":{"summary":"Get Audit Events","description":"Retrieves a paginated list of audit events for a specific enterprise between two\ndates. This endpoint is primarily used for SIEM integrations (e.g., Azure Sentinel)\nand is compatible with other log aggregation tools.\n\nResults are returned in pages. Use the `continuation_token` from the response\nto retrieve the next page. When there are no more results, `continuation_token`\nwill be `null` and `has_more` will be `false`.\n\nExample:\n\ncurl --location 'https://keepersecurity.com/api/rest/public/events?start_date=2025-11-24T00%3A00%3A00Z&limit=20&end_date=2025-11-26T23%3A59%3A59Z' \\\n--header 'x-api-token: Bearer YOUR_API_TOKEN'\n","tags":["Audit Events"],"parameters":[{"name":"start_date","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"end_date","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A paginated list of audit events","content":{"application/json":{"schema":{"type":"object","properties":{"continuation_token":{"type":"string","nullable":true},"has_more":{"type":"boolean"},"events":{"type":"array","items":{"type":"object","properties":{"audit_event":{"type":"string"},"remote_address":{"type":"string"},"category":{"type":"string"},"client_version":{"type":"string"},"enterprise_id":{"type":"integer"},"username":{"type":"string"},"timestamp":{"type":"integer"}}}}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"500":{"description":"Server error"}}}}}}

エンドポイント

GET /api/rest/public/events

目的 エンタープライズ向けに、指定した期間内の監査イベントを取得します。

認証 APIキーを x-api-token ヘッダーで送信します。 x-api-token: Bearer <API_TOKEN>

クエリパラメータ

名前	型	必須	説明
start_date	ISO 8601	必須	期間の開始日時 (例: 2024-07-09T00:00:00Z)
end_date	ISO 8601	必須	期間の終了日時 (例: 2025-07-10T19:45:00Z)
continuation_token	文字列	ページネーション時のみ	APIが返すトークンを使用して、イベントの次のページを取得

ヘッダー

ヘッダー	例
x-api-token	Bearer <API_TOKEN>

リクエスト例

ページネーションなし

curl --location 'https://keepersecurity.com/api/rest/public/events?start_date=2024-07-09T00%3A00%3A00Z&end_date=2025-07-10T19%3A45%3A00Z' \
  --header 'x-api-token: Bearer <API_TOKEN>'

ページネーション付き

curl --location 'https://keepersecurity.com/api/rest/public/events?start_date=2024-07-09T00%3A00%3A00Z&end_date=2025-07-10T19%3A45%3A00Z&continuation_token=<CONT_TOKEN>' \
  --header 'x-api-token: Bearer <API_TOKEN>'

成功レスポンスの例 (200)

{
  "has_more": true,
  "events": [
    {
      "audit_event": "login_failure",
      "remote_address": "10.15.12.197",
      "category": "ADMIN",
      "client_version": "Commander 17.1.0",
      "enterprise_id": 8560,
      "username": "[e-mail]",
      "timestamp": 1751910807587
    }
  ],
  "continuation_token": "vWiXa0eu2edoe_fonw5IJHwEbLmxXOACIvuoQRh7j4XiKuu1"
}

エラーコード

コード	メッセージ	原因
400	開始日が指定されていません	start_date クエリパラメータが未指定
400	終了日が指定されていません	end_date クエリパラメータが未指定
401	認証されていません	APIトークンが無効、または指定されていません
500	内部サーバーエラー	想定外のサーバーエラー

付録: クイックリファレンス (コマンダー)

# 一覧表示
public-api-key list [--format table|json|csv] [--output <file>]

# 生成
public-api-key generate \
  --name "<name>" \
  --roles "SIEM:1" \
  --expires 24h|7d|30d|1y|never \
  [--format json|csv] [--output <file>]

# 取り消し
public-api-key revoke <token_value> [--force]