API キーを作成および管理してアクセス レベルを設定することで、サービス統合を環境に追加し管理します。

API キーを作成するときは、次の制限と影響を理解する必要があります。

  • API 呼び出しの大部分には、「カスタム」タイプの API キーが必要です。その他のキー タイプはレガシーであり、段階的に廃止されています。このキー タイプは、Splunk アプリケーションおよび今後リリースされるその他の統合に必要です。アクセスを制限するには、必要な権限のみを持つアクセス レベルを作成します。
  • SIEM タイプの API キーは通知 API からの通知のみ受け取ることができます。SIEM タイプの API キーを使用して Syslog コネクタを構成します。新しい統合では、使用可能なすべてのデータを受信するために次のいずれかを使用する必要があります。
    • データ フォワーダ: アラートまたはイベントを自分の S3 バケットにストリーミングし、保持を管理できます。
    • アラート v6 API: 最大 180 日間の履歴アラート データを検索します
  • ポリシーと監査ログ API には API タイプのキーが必要です。
  • [API Access (API アクセス)] ページの API ID と API 秘密鍵は、Carbon Black Cloud コンソールのログイン パスワードと同様に扱います。

前提条件

統合に [カスタム] アクセス権限を使用するには、アクセス レベルを作成する必要があります。

手順

  1. 左側のナビゲーション ペインで [設定] > [API アクセス] をクリックします。
  2. [オプション]: API キーにカスタム アクセス レベルが必要な場合は、ここでそのアクセス レベルを作成します。
    1. [アクセス レベル] タブをクリックします。
    2. アクセス レベル名を指定します。
    3. アクセス レベルの権限を指定します。

    詳細なガイドについては、Developer Network の「認証」セクションを参照してください。

  3. [API キーを追加] をクリックします。
    1. API キーに一意の名前と簡単な説明を入力します。
    2. 適切なアクセス レベル タイプを選択します。
      注： カスタム アクセス レベルを使用するには、 [アクセス レベル タイプ] ドロップダウン メニューから [カスタム] を選択し [カスタム アクセス レベル] を指定します。(手順 2 を参照。)
    3. [オプション]: 承認された IP アドレスを追加します。
      セキュリティ上の理由から、API キーの使用を特定の IP アドレス セットに制限できます。
      注： 承認された IP アドレスは、カスタム キーでは使用できません。
  4. 変更を適用するには、[保存] をクリックします。

結果

ポップアップ ウィンドウに新しい API 認証情報が表示されます。これには、API ID と API セキュリティ キーが含まれます。

例

API ID: F3HLZ13ZS3

API セキュリティ キー: FGD7T51232HQ37GN3VE8UZYF

次のタスク

目的 アクション
特定の API キーの名前、説明、または IP アドレスを更新するには: [アクション] 列の [編集] ボタンをクリックします。
特定の API キーの認証情報を表示するには: [アクション] ドロップダウン メニューをクリックし、[API 認証情報] を選択します。
新しい認証情報を生成するには: [アクション] ドロップダウン メニューをクリックし、[API 認証情報] を選択して [新しい API 秘密鍵の生成] をクリックします。
注： 統合を有効にするには、API 秘密鍵を再入力する必要があります。
時間枠内に API キーに送信されたすべての通知を表示するには: [アクション] ドロップダウン メニューをクリックし、時間枠を選択します。
API キーの削除を確認するには: [アクション] ドロップダウン メニューをクリックし、[削除] を選択します。
注： 通知ルールに関連付けられている API キーは削除できません。