管理者向けREST API

Keeper管理者向けREST APIを使用して、SIEM互換の監査イベントを取得

概要

Keeper管理コンソールのREST APIを使用すると、トークンを生成し、SIEMなどのサードパーティ統合に向けてKeeperのREST APIと連携できます。ボルトおよび管理機能に関連するAPIについては、サービスモードREST APIのページをご参照ください。

CSPMおよびMSP課金連携への対応は、近日中に提供予定です。

要件

• エンタープライズルート管理者権限 (APIトークンを作成するために必須)

• CLIでトークンを管理するためのKeeperコマンダーがインストール済み

コマンダー (CLI) でAPIトークンを管理する

コマンダーCLIには、public-api-key コマンドグループがあり、list、generate、revoke の各操作を実行できます。以下のコードでよく使用される操作手順を記載しました。

1. APIトークンの一覧表示

# テーブル形式で表示
public-api-key list

# JSON 形式でファイルに出力
public-api-key list --format json --output api_keys.json

# CSV 形式でエクスポート
public-api-key list --format csv --output api_keys.csv

2. APIトークンの生成

# 30日間有効の SIEM キー (読み取り)
public-api-key generate --name "SIEM Integration" --roles "SIEM:1" --expires 30d

# 永続キー (有効期限なし) を JSON 形式で出力
public-api-key generate --name "Permanent Tool" --roles "SIEM:1" --expires never --format json --output backup_key.json

ロールとアクションコード

• ロール: SIEM

• アクション: 1 = READ、2 = READ_WRITE

• 有効期限のオプション: 24h、7d、30d、1y、never

例: --roles "SIEM:1" は、SIEM (読み取り) を意味します。

3. APIトークンの取り消し

# 対話式で確認して取り消し
public-api-key revoke <token_value>

# 強制的に取り消し (確認なし)
public-api-key revoke <token_value> --force

---

監査イベントAPI

Get Audit Events

get

Retrieves a paginated list of audit events for a specific enterprise between two dates. This endpoint is primarily used for SIEM integrations (e.g., Azure Sentinel) and is compatible with other log aggregation tools.

Results are returned in pages. Use the continuation_token from the response to retrieve the next page. When there are no more results, continuation_token will be null and has_more will be false.

Example:

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'

認可

ApiTokenAuth

x-api-tokenstring必須

クエリパラメータ

start_datestring · date-time必須

end_datestring · date-time必須

limitinteger · 最小: 1 · 最大: 1000オプションDefault: 100

continuation_tokenstringオプション

レスポンス

200

A paginated list of audit events

application/json

400

Bad request

401

Unauthorized

500

Server error

get

/public/events

HTTPcURLJavaScriptPython

GET /api/rest/public/events?start_date=2026-01-24T13%3A56%3A40.194Z&end_date=2026-01-24T13%3A56%3A40.194Z HTTP/1.1
Host: keepersecurity.com
x-api-token: YOUR_API_KEY
Accept: */*

{
  "continuation_token": "text",
  "has_more": true,
  "events": [
    {
      "audit_event": "text",
      "remote_address": "text",
      "category": "text",
      "client_version": "text",
      "enterprise_id": 1,
      "username": "text",
      "timestamp": 1
    }
  ]
}

エンドポイント

GET /api/rest/public/events

目的

指定した日付範囲内の監査イベントをエンタープライズ全体から取得する。

認証

以下のように、APIトークンを x-api-token ヘッダに含めて送信します。

x-api-token: Bearer <API_TOKEN>

クエリのパラメータ

名前	型	必須	説明
start_date	ISO 8601	はい	日付範囲の開始日時 (例: 2024-07-09T00:00:0Z)
end_date	ISO 8601	はい	日付範囲の終了日時 (例: 2025-07-10T19:45:00Z)
continuation_token	文字列	ページネーション時のみ	APIから返されたトークンを使用して次のページのイベントを取得します。

ヘッダ

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

リクエストの例

ページネーションなし

curl --location 'https://dev.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://dev.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": "[email protected]",
      "timestamp": 1751910807587
    }
  ],
  "continuation_token": "vWiXa0eu2edoe_fonw5IJHwEbLmxXOACIvuoQRh7j4XiKuu1"
}

エラーコード

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

---

セキュリティ上の注意事項

• APIトークンはパスワードと同様に扱い、定期的にローテーションしてください。

• 権限は必要最小限のロールとアクションに制限してください。

• 有効期限は短く設定し、自動化など特別な用途でのみ「期限なし」を使用してください。

• トークンは安全な場所 (例: Keeperボルト、クラウドKMSなど) に保管してください。

---

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

# 一覧表示
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]

リスク管理API

Wiz、Tenable、Saviyntなどのセキュリティポスチャ管理ツール向けのネイティブコネクターは、近日提供予定です。現時点では、AWS CloudTrailやCloudWatchなどのミドルウェアを使用し、KeeperからWizへデータを中継できます。詳細については、AWSのドキュメントをご参照ください。

エンタープライズ統計

エンドポイント

GET /api/rest/rmd/get_enterprise_stat

目的

リスク管理における直近のログイン数を取得します。

認証

APIトークンを x-api-token ヘッダで送信します。

x-api-token: Bearer <API_TOKEN>

ヘッダ

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

クエリパラメータ

リクエスト

curl 'https://local.keepersecurity.com/api/rest/rmd/get_enterprise_stat' \
  --header 'x-api-token: Bearer <API_TOKEN>'

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

{
  "users_has_records": 0,
  "users_logged_recent": 1
}

エラーコード

コード	メッセージ	原因
401	認証されていません	APIトークンが無効、または指定されていません
500	内部サーバーエラー	サーバーで予期しないエラーが発生しました

---

セキュリティ上の注意

• APIトークンはパスワードと同様に扱い、定期的にローテーションしてください。

• 権限は、必要最小限のロールと操作に制限してください。

• 有効期限は短く設定し、never は特別な自動化用途に限って使用してください。

• トークンはKeeperボルトなど、安全な場所に保管してください。

---

エンタープライズ統計の詳細

エンドポイント

GET /api/rest/rmd/get_enterprise_stat_details

目的

直近30日以内にログインしたユーザー数と、ボルト内に少なくとも1件のレコードを持つユーザー数を取得します。

認証

APIトークンを x-api-token ヘッダで送信します。

x-api-token: Bearer <API_TOKEN>

ヘッダ

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

クエリパラメータ

リクエスト

curl 'https://local.keepersecurity.com/api/rest/rmd/get_enterprise_stat_details' \
  --header 'x-api-token: Bearer <API_TOKEN>'

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

{
  "enterprise_stat_details": [
    {
      "last_logged_in": "2025-11-21 22:11:15",
      "has_records": false,
      "enterprise_user_id": "[email protected]"
    }
  ]
}

エラーコード

コード	メッセージ	原因
401	認証されていません	APIトークンが無効、または指定されていません
500	内部サーバーエラー	サーバーで予期しないエラーが発生しました

---

セキュリティ上の注意

• APIトークンはパスワードと同様に扱い、定期的にローテーションしてください。

• 権限は、必要最小限のロールと操作に制限してください。

• 有効期限は短く設定し、never は特別な自動化用途に限って使用してください。

• トークンはKeeperボルトなど安全な場所に保管してください。

---

セキュリティアラートの概要

エンドポイント

GET /api/rest/rmd/get_security_alerts_summary

目的

直近30日間に発生したイベントの概要を取得します。

認証

APIトークンを x-api-token ヘッダで送信します。

x-api-token: Bearer <API_TOKEN>

ヘッダ

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

クエリパラメータ

リクエスト

curl 'https://local.keepersecurity.com/api/rest/rmd/get_security_alerts_summary' \
  --header 'x-api-token: Bearer <API_TOKEN>'

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

{
  "security_alerts_summary": [
    {
      "event_occurrences": 1,
      "unique_users": 1,
      "last_users": 0,
      "event": "account_recovery_decline",
      "last_events": 0
    }
  ]
}

エラーコード

コード	メッセージ	原因
401	認証されていません	APIトークンが無効、または指定されていません
500	内部サーバーエラー	サーバーで予期しないエラーが発生しました

---

セキュリティ上の注意

• APIトークンはパスワードと同様に扱い、定期的にローテーションしてください。

• 権限は、必要最小限のロールと操作に制限してください。

• 有効期限は短く設定し、never は特別な自動化用途に限って使用してください。

• トークンはKeeperボルトなど安全な場所に保管してください。

---

セキュリティアラートの詳細

エンドポイント

GET /api/rest/rmd/get_security_alerts_detail

目的

直近30日間に発生した特定のイベントについて、その前の30日間との比較を含む詳細情報を取得します。

aet は監査イベントタイプ (ID) を示します (例: account_recovery_decline)

認証

APIトークンを x-api-token ヘッダで送信します。

x-api-token: Bearer <API_TOKEN>

クエリパラメーター

名前	型	必須	説明
audit_event_type	string	はい	統計情報から取得した監査イベントタイプ

ヘッダ

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

クエリパラメーター

リクエスト

curl 'https://local.keepersecurity.com/api/rest/rmd/get_security_alerts_detail?audit_event_type=account_recovery_decline' \
  --header 'x-api-token: Bearer <API_TOKEN>'

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

{
  "security_alerts_summary": [
    {
      "event_occurrences": 1,
      "unique_users": 1,
      "last_users": 0,
      "event": "account_recovery_decline",
      "last_events": 0
    }
  ]
}

エラーコード

コード	メッセージ	原因
400	必須のクエリパラメータ audit_event_type の値が見つかりません	audit_event_type が指定されていない、または内部マッピングと一致していません
401	認証されていません	APIトークンが無効、または指定されていません
500	内部サーバーエラー	サーバーで予期しないエラーが発生しました

---

セキュリティ上の注意

• APIトークンはパスワードと同様に扱い、定期的にローテーションしてください。

• 権限は、必要最小限のロールと操作に制限してください。

• 有効期限は短く設定し、never は特別な自動化用途に限って使用してください。

• トークンはKeeperボルトなど安全な場所に保管してください。

---

セキュリティベンチマークの取得

エンドポイント

GET /api/rest/rmd/get_security_benchmarks

目的

呼び出し元のエンタープライズに設定されているセキュリティベンチマークの一覧を取得します。

認証

APIトークンを x-api-token ヘッダーで送信します。

x-api-token: Bearer <API_TOKEN>

ヘッダ

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

クエリパラメーター

リクエスト

curl 'https://local.keepersecurity.com/api/rest/rmd/get_security_benchmarks' \
  --header 'x-api-token: Bearer <API_TOKEN>'

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

{
  "security_benchmarks": [
    {
      "id": "SB_DEPLOY_ACROSS_ENTIRE_ORGANIZATION",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    },
    {
      "last_updated": "2025-12-11 23:37:29",
      "id": "SB_PREVENT_INSTALLATION_OF_UNTRUSTED_EXTENSIONS",
      "auto_resolve": false,
      "status": "RESOLVED"
    },
    {
      "id": "SB_ENABLE_ACCOUNT_TRANSFER_POLICY",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    },
    {
      "id": "SB_REDUCE_ADMINISTRATOR_PRIVILEGE",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    },
    {
      "id": "SB_ENSURE_OUTSIDE_SSO_ADMINISTRATOR_EXISTS",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    },
    {
      "id": "SB_LOCK_DOWN_SSO_PROVIDER",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    },
    {
      "id": "SB_CREATE_AT_LEAST_TWO_KEEPER_ADMINISTRATORS",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    },
    {
      "id": "SB_ENSURE_TWO_FACTOR_AUTHENTICATION_ADMIN_USERS",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    },
    {
      "id": "SB_ENFORCE_STRONG_MASTER_PASSWORD",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    },
    {
      "id": "SB_ENSURE_TWO_FACTOR_AUTHENTICATION_FOR_END_USERS",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    },
    {
      "id": "SB_CONFIGURE_IP_ALLOWLISTING",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    },
    {
      "id": "SB_CREATE_ALERTS",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    },
    {
      "id": "SB_DISABLE_BROWSER_PASSWORD_MANAGERS",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    },
    {
      "id": "SB_DISABLE_ACCOUNT_RECOVERY",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    },
    {
      "id": "SB_ENFORCE_LEAST_PRIVILEGE_POLICY",
      "auto_resolve": false,
      "status": "UNRESOLVED"
    }
  ]
}

エラーコード

コード	メッセージ	原因
401	認証されていません	APIトークンが無効、または指定されていません
500	内部サーバーエラー	サーバーで予期しないエラーが発生しました

---

セキュリティ上の注意

• APIトークンはパスワードと同様に扱い、定期的にローテーションしてください。

• 権限は、必要最小限のロールと操作に制限してください。

• 有効期限は短く設定し、never は特別な自動化用途に限って使用してください。

• トークンはKeeperボルトなど安全な場所に保管してください。

---

セキュリティ指標の設定

エンドポイント

POST /api/rest/rmd/set_security_benchmarks

目的

セキュリティ指標の一覧を設定します。設定された指標に対応する監査イベントは記録されます。

認証

APIトークンを x-api-token ヘッダで送信します。

x-api-token: Bearer <API_TOKEN>

ヘッダ

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

クエリパラメータ

リクエスト

curl -X POST \
  -H 'x-api-token: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  'https://local.keepersecurity.com/api/rest/rmd/set_security_benchmarks' \
  -d '[{"benchmark": "SB_PREVENT_INSTALLATION_OF_UNTRUSTED_EXTENSIONS", "status": "RESOLVED"}]'

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

{
  "security_benchmarks": [
    {
      "id": "SB_PREVENT_INSTALLATION_OF_UNTRUSTED_EXTENSIONS",
      "auto_resolve": false,
      "status": "RESOLVED"
    }
  ]
}

エラーコード

コード	メッセージ	原因
401	認証されていません	APIトークンが無効、または指定されていません
500	内部サーバーエラー	サーバーで予期しないエラーが発生しました

---

セキュリティ上の注意

• APIトークンはパスワードと同様に扱い、定期的にローテーションしてください。

• 権限は、必要最小限のロールと操作に制限してください。

• 有効期限は短く設定し、never は特別な自動化用途に限って使用してください。

• トークンはKeeperボルトなど安全な場所に保管してください。

課金API

APIトークンの生成

課金APIを使用する場合は、以下のようにAPIトークンを生成する際に BILLING の読み取りロールを指定してください。

# 30日間有効なBILLINGキー(読み取り)
public-api-key generate --name "Billing Integration" --roles "BILLING:1" --expires 30d

MSP課金利用状況API

エンドポイント

GET bi_api/rest/public/msp/billing-usage

目的

認証済みのMSPおよび紐付けられた管理対象企業 (MC) について、指定した月と年における月次の課金利用状況を取得します。取得対象には、単価、基本ライセンスおよびアドオンの利用状況、数量、関連する費用が含まれます。

認証

x-api-tokenヘッダにAPIトークンを指定します。

x-api-token: Bearer <API_TOKEN>

クエリパラメータ

名称	型	必須	説明
month	整数	はい	1〜12の単一の数値を指定します。先頭に0は付けません (例: 1、11)。
year	整数	はい	4桁の年を指定します (例: 2025、2023)。

ヘッダ

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

リクエスト例

ページネーションなしのリクエスト例

curl --location '<https://dev.keepersecurity.com/bi_api/rest/public/msp/billing-usage?month=8&year=2025>' \
--header 'x-api-token: Bearer g0mNDtMW6zkJl0Jcxv-4kJH9beIrIsLqVvvDOhp0'

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

{
    "total": 3.91,
    "tax": 0.51,
    "currency": "USD",
    "mcItems": [
        {
            "total": 3.4,
            "companyName": "free mc",
            "products": [
                {
                    "unitPrice": 3.4,
                    "unit": "user",
                    "quantity": 1,
                    "productId": 10010,
                    "productName": "Keeper Enterprise Bundle",
                    "avgMonthlyCost": 3.4
                }
            ]
        }
    ],
    "subTotal": 3.4,
    "mspItem": {
        "total": 3.4,
        "companyName": "free msp",
        "products": [
            {
                "unitPrice": 3.4,
                "unit": "user",
                "quantity": 1,
                "productId": 720,
                "productName": "MSP Base License",
                "avgMonthlyCost": 3.4
            }
        ]
    }
}

エラーコード

コード	メッセージ	原因
400	monthが未指定、または無効です	monthの値が不正です
400	yearが未指定、または無効です	yearの値が不正です
403	アクセスが拒否されました	管理対象企業 (MC) がAPIにアクセスしようとしています
401	認証されていません	トークンが無効、または指定されていません
500	内部サーバーエラー	予期しないエラーが発生しました

---

セキュリティに関する注意事項

• APIトークンはパスワードと同様に扱い、定期的にローテーションしてください。

• 必要最小限のロールと操作に権限を制限してください。

• 有効期限はできるだけ短く設定し、無期限は特別な自動化用途に限って使用してください。

• トークンは安全な場所 (例: Keeperボルト) に保管してください。

MSP現在の利用状況API

エンドポイント

GET bi_api/rest/public/msp/current-usage

目的

認証済みのMSPおよび紐付けられた管理対象企業 (MC) について、現在の利用状況 (基本ライセンスおよびアドオン) のスナップショットを取得します。

認証

x-api-token ヘッダにAPIトークンを指定します。

x-api-token: Bearer <API_TOKEN>

ヘッダ

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

リクエスト例

ページネーションなしのリクエスト例

curl --location '<https://dev.keepersecurity.com/bi_api/rest/public/msp/current-usage>' \
--header 'x-api-token: Bearer g0mNDtMW6zkJl0Jcxv-4kJH9beIrIsLqVvvDOhp0'

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

{
    "mcItems": [
        {
            "maximumAllowedUsers": 2147483647,
            "companyName": "free mc",
            "plan": "Keeper Enterprise Bundle",
            "invitedUsers": 0,
            "products": [
                {
                    "unit": "user",
                    "quantity": 1,
                    "productId": 10010,
                    "productName": "Keeper Enterprise Bundle"                    
                }
            ]
        }
    ],
    "mspItem": {
        "companyName": "free msp",
        "invitedUsers": 2,
        "products": [
            {
                "unit": "user",
                "quantity": 1,
                "productId": 720,
                "productName": "MSP Base License"
            }
        ]
    }
}

エラーコード

コード	メッセージ	原因
403	アクセスが拒否されました	管理対象企業 (MC) がAPIにアクセスしようとしています
401	認証されていません	トークンが無効、または指定されていません
500	内部サーバーエラー	予期しないエラーが発生しました

---

セキュリティに関する注意事項

• APIトークンはパスワードと同様に扱い、定期的にローテーションしてください。

• 必要最小限のロールと操作に権限を制限してください。

• 有効期限はできるだけ短く設定し、無期限は特別な自動化用途に限って使用してください。

• トークンは安全な場所 (例: Keeperボルト) に保管してください。