翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
API を使用して検出結果のバックログを一括修復する
ウェブ UI と AWS Security Hub CSPM カスタムアクションは、少数の検出結果をインタラクティブに修復するのに便利です。ソリューションをデプロイした直後など、既存の検出結果の大量のバックログをプログラムで処理するには、ソリューションの REST API を直接呼び出します。
ウェブ UI を支えているのと同じ REST API (API Gateway コンソールでは AutomatedSecurityResponseApi という名前) は、1 回のリクエストで修復対象の検出結果を一括して受け入れる POST /findings/action エンドポイントを公開しています。これにより、手動で検出結果を選択するのではなく、バックログの修復をスクリプトで自動化できます。
注記
このエンドポイントは、ウェブ UI が有効になっている (ShouldDeployWebUI を [はい] に設定して管理者スタックをデプロイする) 場合にのみ使用できます。prod ステージの API の呼び出し URL は、API Gateway コンソールの AutomatedSecurityResponseApi API で確認できます。
Authenticate
すべての API リクエストには、ソリューションのユーザープールに対して発行された Amazon Cognito アクセストークンが必要です。このトークンは、ベアラートークンとして Authorization ヘッダーに渡されます。トークンには asr-api/api スコープが必要です。ソリューションのロール (管理者、委任管理者、またはアカウントオペレーター) のいずれかのトークンを使用します。ウェブ UI に適用されるのと同じロールベースの認可が API にも適用されます。無人オートメーションの場合は、対話型のユーザーサインインではなく、マシンツーマシン (クライアント認証情報) OAuth フローを使用してトークンを取得します。
修復する検出結果を収集する
POST /findings を使用して、修復する検出結果を探してページ送りしながら確認し、それぞれの findingId を収集します。返される検出結果は、ロールに許可されたアカウントに限定されるため、アカウントオペレーターは割り当てられたアカウントの検出結果のみを受け取ります。
検出結果に対するアクションのエンドポイントを呼び出す
収集した検出結果 ID を POST /findings/action に送信します。actionType として Remediate を指定します。各検出結果は、ウェブ UI からの場合とまったく同じようにオーケストレーターを介してルーティングされます。
POST /findings/action Authorization: Bearer <access-token> Content-Type: application/json { "actionType": "Remediate", "findingIds": [ "arn:aws:securityhub:us-east-1:111111111111:security-control/Lambda.1/finding/...", "arn:aws:securityhub:us-east-1:111111111111:security-control/S3.5/finding/..." ] }
actionType は も受け入れます。これによりRemediateAndGenerateTicket、検出結果が修正され、設定されたチケットチャネルでチケットが開きます。またUnsuppress、ソリューションのデフォルトの検出結果ビューで検出結果を非表示または表示する Suppressと も受け入れます。 Suppress は、AWS Security Hub または AWS Security Hub CSPM で検出結果のワークフローステータスを変更しません。また、期限適用の遅延スキャンでは、このように抑制された検出結果がスキップされますが、完全自動修復は停止されません。Remediate または RemediateAndGenerateTicket リクエストは、本文が {"status": "IN_PROGRESS"} の HTTP 202 を返します。Suppress および Unsuppress は HTTP 200 を返します。
重要
リクエストごとに最大 50 個の検出結果 ID を送信します。より大きなバックログを修復するには、検出結果 ID を 50 以下のバッチに分割し、バッチごとに 1 つのリクエストを発行します。API は、レートベースのルールによっても保護されているため (API Gateway セキュリティポリシー の AWS WAF 設定を参照)、バッチをすべて一度に送信するのではなく、間隔を空けて少しずつ送信してください。
進行状況をモニタリングする
API を通じて開始した修復は、ウェブ UI から開始した修復と同様に、非同期的に実行されます。修復の進捗状況は、ウェブ UI の [実行履歴] ページ、ソリューションの Amazon SNS 通知、または POST /remediations へのクエリを通じて追跡します。