> For the complete documentation index, see [llms.txt](https://docs.metasleuth.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.metasleuth.io/ja/blocksec-aml-api/introduction/api-security-settings.md).

# API Security Settings

IP Allowlist、Request Signing、または両方で API アクセスを保護します。Address Label API と Risk Score API のセキュリティは個別に設定します。

[Settings → APIs → API Keys](https://metasleuth.io/system/settings/personal/apis) を開き、対象の API の **Security Settings** を選択します。API キーがない場合は先に生成してください。

## セキュリティ方式の選択

* **IP Allowlist** は、サーバーのパブリック送信元 IP アドレスにアクセスを制限します。
* **Request Signing** は、アプリケーションが保持する API シークレットでリクエストを検証します。

両方が有効な場合、各リクエストは両方の検証に合格する必要があります。チェックボックスの選択や解除だけでは変更は適用されません。設定を確認して **Save Changes** を選択してください。

保存済みで、後から署名を必須にする予定の設定も、セキュリティ設定の完了要件を満たします。表示された必須化時刻までは、署名のないリクエストにも、他の有効なセキュリティ検証が適用されます。

## IP Allowlist の設定

1. **IP Allowlist** を選択します。
2. サーバーのパブリック送信元 IPv4 または IPv6 アドレス、あるいは CIDR 範囲を入力します。
3. **Add IP** で 1 件追加するか、**Bulk Add** で複数の項目を 1 行ずつ貼り付けます。
4. リスト全体を確認し、**Save Changes** を選択します。確認が求められた場合は承認してください。

**API キーごとに最大 10 件の一意の項目**を保存できます。IP アドレスまたは CIDR 範囲はそれぞれ 1 件です。重複は削除されますが、重なるネットワークは自動統合されません。

API への接続に使用する NAT ゲートウェイなどのパブリック送信元アドレスを使用してください。ブラウザーの IP は自動追加されません。リストを適用する前に、すべてのアプリケーションサーバーの送信元 IP を含めてください。

ワイルドカード（`*`、`?`）、ドメイン、URL、ポート、開始/終了アドレス形式の IP 範囲、プライベートアドレス、ループバックアドレス、`0.0.0.0/0` や `::/0` などの全許可範囲には対応していません。

IP Allowlist の変更は**保存直後に有効**になります。削除した IP からのリクエストは拒否されます。Bulk Add は未保存のリストのみを更新します。適用には Save Changes を選択してください。

### IP Allowlist の編集または無効化

項目を編集して保存すると、有効なリストが置き換わります。無効化するには **IP Allowlist** の選択を解除して保存します。保存済みの項目は再利用のため保持されます。

セキュリティ保護が必須のキーでは、最後の有効な保護を解除する前に、別の方式が有効である必要があります。方式の変更時は Security Settings の設定検証に従ってください。

## Request Signing の有効化

1. **Request Signing** を選択し、API シークレットを生成します。
2. シークレットをコピーし、安全に保管します。**表示は一度だけ**で、ダイアログを閉じると再表示できません。
3. **I have saved this API secret.** を選択します。
4. **In 24 hours** または **Immediately** を選択し、**Save Changes** を選択して確認します。

**In 24 hours** の場合、新しいシークレットは保存後に使用できます。表示された必須化時刻までに、すべてのアプリケーションに署名付きリクエストを導入してください。それまでは署名なしのリクエストにも他のアクセスルールが適用されます。移行期間中でも無効な署名は拒否されます。

**Immediately** の場合、保存直後からすべてのリクエストに有効な署名が必要です。このオプションを選択する前にアプリケーションの準備を完了してください。

署名ヘッダー、コード例、トラブルシューティングは [Request Signing](https://docs.metasleuth.io/ja/blocksec-aml-api/introduction/request-signing.md) を参照してください。テスト呼び出しは実際の業務リクエストであり、API クォータを消費する場合があります。

### 署名の状態

| 状態          | 意味                                    |
| ----------- | ------------------------------------- |
| Not enabled | 初回の署名設定がまだ保存されていません。                  |
| Scheduled   | 設定は保存済みです。表示された時刻から署名付きリクエストが必須になります。 |
| Active      | すべてのリクエストに有効な署名が必要です。                 |

シークレットのローテーション中も署名は Active のままです。新しいシークレットの **Not saved** は、置き換えが未適用であることを示します。

## API シークレットのローテーション

紛失、漏えい、定期交換の際はシークレットをローテーションしてください。API キーは変わりません。古いシークレットが漏えいした可能性がある場合は **Immediately** を選択してください。24 時間の併用期間では、失効または取り消しまで古いシークレットが有効です。

1. Request Signing でローテーションアイコンを選択し、新しいシークレットを生成します。
2. 新しい値をコピーして安全に保存し、保存したことを確認します。
3. **古いシークレットの失効時刻**を選び、**Save Changes** を選択します。
   * **In 24 hours**：保存後 24 時間は両方のシークレットが有効です。古いシークレットの失効前に全アプリケーションを更新してください。
   * **Immediately**：保存直後に新しいシークレットが古いものを置き換えます。古いシークレットで署名したリクエストは拒否されます。

保存するまでは現在のシークレットは変わりません。キャンセルすると未保存の置き換え値は破棄されます。

ローテーション中は別のローテーションを開始できません。古いシークレットの失効を待つか、**Revoke Old Secret** で移行期間を早期終了できます。早期取り消し後は、古いシークレットで署名したリクエストが即座に拒否されます。

## Request Signing の無効化

**Request Signing** の選択を解除し、**Save Changes** を選択して確認します。署名は即座に無効になり、関連する API シークレットはすべて取り消され、予定された必須化や進行中のローテーションも終了します。

取り消されたシークレットによる署名を送信しないようアプリケーションを更新してください。再度署名を有効にするには、新しいシークレットを生成します。

IP Allowlist が有効なままの場合、許可された IP からのリクエストのみが受け付けられます。セキュリティ方式が 1 つも有効でない場合は API キー認証のみを使用します。保護が必須のキーでは、有効な方式を少なくとも 1 つ維持する必要があります。

## 変更の保存またはキャンセル

選択した方式と IP リストは、保存に成功した後にのみ適用されます。**Cancel** は未保存の変更を破棄します。保存に失敗した場合は、再試行前に現在の設定を確認してください。タイムアウトしたリクエストが失敗したとは限りません。

API 応答エラーは[応答形式](https://docs.metasleuth.io/ja/blocksec-aml-api/introduction/response-format.md)を参照してください。
