> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/reference/ja/ren-zheng/authentication/rotate-api-keys.md).

# APIキーをローテーションする

Roboflow APIキーをいつローテーションするか、ローテーション前にそのキーがどこで使われているかを見つける方法、Rollの仕組み、そしてローテーションのリマインダーの仕組みについて説明します。

APIキーをローテーションすると、シークレット値が新しい値に置き換わります。古い値を保持したままのものは、すべてアクセスできなくなります。

Roboflowでは、キーをおよそ1年に1回ローテーションすることを推奨しています。これはガイドラインであり、必須ではありません。1年という間隔は、Roboflowを利用する組織のセキュリティポリシーに基づくもので、ローテーションの予定日を過ぎてもキーは引き続き機能します。ローテーションのリマインダーは、侵害の兆候ではありません。

キーが漏えいした場合（例：公開リポジトリにコミットした、チャットに貼り付けた、チームを離れた人が保持していた場合）は、直ちにローテーションしてください。漏えいしたキーを有効なままにしてはいけません。すぐにロールするか失効させ、停止を受け入れたうえで、キーを使う側を修正してください。保護されたキーはロールも失効もできないため、まずダッシュボードで保護を解除してください。

## キーの使用箇所を特定する

ローテーションで難しいのは、そのキーに依存しているものを把握することです。どのシステムが使っているか不明なキーをローテーションすると、そのシステムは停止します。まず次の情報を確認してください。

* キー一覧にあるキーの名前とメタデータ。キーの名前が使用元にちなんだもので（例："line-3-camera-gateway"）、メタデータに所有者が記載されていれば、最もすばやく使用元を特定できます。詳しくは、 [カスタムメタデータ](https://docs.roboflow.com/reference/ja/ren-zheng/authentication/scoped-api-keys.md#custom-metadata).
* 依存関係の警告。「ロール」、「失効」、または「無効化」をクリックすると、ダイアログにRoboflowが把握しているキーの依存先が表示されます。Dedicated Deployment、請求フォルダー、エッジデバイス、そのキーがワークスペースのデフォルトキーかどうか、過去30日間に課金対象の使用があったかどうかが含まれます。詳しくは、 [依存関係の警告](https://docs.roboflow.com/reference/ja/ren-zheng/authentication/manage-api-keys-in-the-dashboard.md#dependency-warnings).
* 監査ログ。キーを使った管理操作と書き込み操作が記録されますが、推論や読み取りのトラフィックは記録されないため、キーの用途の一部しか確認できません。詳しくは、 [監査ログとSIEMへのエクスポート](https://docs.roboflow.com/platform/enterprise-features/audit-logs-and-siem-export).
* 使用状況レポート。課金対象の使用状況はキーごとに記録されるため、最近の使用状況から、その時点でキーが使われていたことはわかります。ただし、その後に使用元が変わっている可能性があります。課金対象でない呼び出しは表示されません。詳しくは、 [請求フォルダー](https://docs.roboflow.com/platform/billing-and-plans/billing-folders).
* 独自に管理している情報：環境ファイル、シークレットマネージャー、CI変数、Dockerコマンド、手動でプロビジョニングしたデバイス。

キーがエッジデバイスまたはWorkflowからの推論にのみ使われている場合、それらのデバイスに新しい値を設定すれば、ロールのリスクは低くなります。チーム内にキーの使用箇所を把握している人がいない場合は、ロールするのではなく、2つ目のキーを作成して移行してください。

## キーをロールする

「ロール」は、キーを失効させて、置き換え用のキーを一度に作成します。新しいキーには、古いキーの名前、権限、フォルダー、メタデータ、無効状態が引き継がれます。古いキーで実行されているDedicated Deploymentは、自動的に新しいキーに移行されます。移行できないものがある場合、ロールはエラー「The API key was not rolled」で失敗し、古いキーは引き続き有効です。また、同じ名前の置き換え用キーがすでに作成されている可能性があるため、再試行する前にキー一覧を確認してください。それ以外のすべての使用元は、新しい値に更新するまで機能しなくなります。

短時間で切り替えられる場合や、キーが漏えいして今すぐ使えなくする必要がある場合は、「ロール」を使ってください。漏えいしたキーがDedicated Deploymentで使われている場合は、ロールに頼らないでください。デプロイに別のキーを割り当ててから、ダッシュボードで古いキーを失効させてください。デプロイは一時停止します。

{% stepper %}
{% step %}
キー一覧を開きます。ワークスペースキーは「設定」の「APIキー」にあります。フォルダーキーはフォルダーカードのメニューにある「APIキー」にあります。
{% endstep %}

{% step %}
キーの行にある「ロール」アイコンをクリックします。依存関係の警告を確認します。何か表示された場合は、確認ボックスにチェックを入れます。
{% endstep %}

{% step %}
「理解しました。このAPIキーをロールする」をクリックします。行がハイライト表示され、「新規」とマークされます。新しい値をコピーします。
{% endstep %}

{% step %}
すべての使用元を新しい値に更新し、再起動が必要なものを再起動します。
{% endstep %}

{% step %}
今後数時間、使用元のログとヘルスチェックで、認証エラー（401および403）が発生していないか確認します。Roboflowは失効したキーによる拒否済みの呼び出しを記録しないため、使用元の更新漏れを検知できるのは独自の監視だけです。
{% endstep %}
{% endstepper %}

保護されたキーはロールできません。先に保護を解除してください。詳しくは、 [キーを保護する](https://docs.roboflow.com/reference/ja/ren-zheng/authentication/manage-api-keys-in-the-dashboard.md#protect-a-key).

スクリプトまたはエージェントからロールするには、 `roboflow api-key roll`、REST API、またはMCP Serverを使用してください。詳しくは、 [APIキーをロールする](https://docs.roboflow.com/reference/ja/ren-zheng/authentication/manage-api-keys.md#roll-an-api-key).

<figure><img src="https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-b0951e8d7a079f9a5348097011a8362f38c76d13%2Fapi-keys-roll-dialog.png?alt=media" alt="Roll API Key dialog with a dependency warning listing a Dedicated Deployment and the workspace default, and the confirmation checkbox"><figcaption><p>まだ使用中のキーで「APIキーをロール」を実行すると、警告にDedicated Deploymentとワークスペースのデフォルトキーが表示され、確認ボックスにチェックを入れるまでロールは無効のままです。</p></figcaption></figure>

## 新しいキーを作成して移行する

有効なキーを2つ用意すると、使用元を1つずつ移行でき、最後の使用元を切り替えるまで古いキーを予備として残せます。この方法は計画的なローテーションにのみ使用し、漏えいしたキーには決して使用しないでください。

{% stepper %}
{% step %}
「新しいキーを生成」をクリックし、古いキーと同じ権限とフォルダーを新しいキーに設定します。使用元にちなんだ名前を付けます。
{% endstep %}

{% step %}
使用元を1つずつ新しい値に更新します。
{% endstep %}

{% step %}
すべての使用元で新しいキーが機能することを確認したら、古いキーを失効させます。依存関係の警告では移行を確認できません。過去30日間に課金対象の使用があれば警告に表示されるため、先週移行を終えたキーにも表示されます。一方、課金対象でない呼び出しは表示されません。失効させる前に、各使用元を自分で確認してください。
{% endstep %}
{% endstepper %}

## キーをローテーションできるユーザー

キーをロールするには、「Create Api Key」と「Revoke Api Key」の権限が必要です。キーが保護されている場合は、「Update Api Key」の権限も必要です。ワークスペースキーの場合、メンバーには「View Workspace API Keys」も必要です。フォルダーキーの場合、メンバーにはそのフォルダーへの書き込みアクセス権が必要です。詳しくは、 [ロールベースのアクセス制御](https://docs.roboflow.com/platform/enterprise-features/role-based-access-control).

誰かがチームを離れてもローテーションが滞らないよう、すべてのキーをローテーションできる人を少なくとも2人確保してください。 [推奨されるアクセス設定](https://docs.roboflow.com/platform/enterprise-features/recommended-enterprise-access-setup#api-keys-in-this-model) では、これを実現するロール構成を説明しています。

## ローテーションのリマインダー

{% hint style="info" %}
ローテーションのリマインダーは、 [Advanced API Keys](https://docs.roboflow.com/reference/ja/ren-zheng/authentication/scoped-api-keys.md)（Enterpriseアドオン）の一部です。 [営業担当者にお問い合わせいただくか、](https://roboflow.com/sales) アカウント担当者に連絡して有効にしてください。
{% endhint %}

誰かがキーに「ローテーション期限」を設定した場合にのみ、そのキーのリマインダーが送信されます。キーを作成するとき、または「編集」から日付を設定してください。「1年後を提案」を選ぶと、1年後の日付が入力されます。日付をクリアすると、リマインダーは停止します。

「所有者」は、そのキーについてメールを受け取るメンバーです。キーをロールできるメンバーだけが所有者になれます。また、有効なアカウントを持ち、メールアドレスが確認済みか、IDプロバイダーによって確認されている必要があります。リストを空にすると、ロールできる全員にメールが送信されます。所有者の誰もキーをロールできなくなった場合（例：ワークスペースを離れた場合）、その理由を記したメモとともに、ロールできる全員にメールが送信されます。条件を満たしていれば、「新しいAPIキーを生成」ダイアログでは自分が所有者としてあらかじめ選択されます。このフィールドをクリアすると、全員にメールが送信されます。

各受信者には、キーが有効な間、期限日の15日前から期限日当日までのいずれかの日に、期限ごとにメールが1通送信されます。期限まで15日を切ってから日付を設定した場合は、翌日にリマインダーが送信されることがあります。この期間中にキーが無効になっていると、リマインダーは送信されません。期限日を過ぎてからキーを有効にしても、メールは送信されません。また、請求制限のあるワークスペースには、リマインダーは一切送信されません。期限日になってもキーに何も起こらず、そのまま使用できます。

キーの一覧表では、各日付までの状況が表示されます。日付とともに「ローテーション期限」、期限まで30日以内は「期限まであと」、当日は「本日期限」、期限を過ぎると「期限超過」と表示されます。「ローテーション期限が近いキーのみ表示」を選ぶと、期限まで30日以内または期限超過のキーに絞り込まれます。日付が設定されていないキーには「ローテーション日なし」と表示されます。

キーをロールすると、次の期限は最大1年の範囲で、現在の期限までの間隔と同じ分だけ先の日付に移動します。そのため、予定どおりにローテーションしたキーは、以降も予定どおりのスケジュールになります。作成日の記録がないキーは、ロールしても日付が変わらないため、ロール時に新しい日付を設定してください。

<figure><img src="https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-12c5d1165945971573f6fcc7050e680d67e299a8%2Fapi-keys-settings-table.png?alt=media" alt="Key table with Due in, Rotate by and No Rotation Date badges"><figcaption><p>キー一覧表のローテーションバッジ。2日後が期限のキーは、期限まで30日以内です。そのため、「ローテーション期限が近いキーのみ表示」ではキーが1つと表示され、一方、1年後が期限のキーには「ローテーション期限」と表示されます。</p></figcaption></figure>
