メインコンテンツへスキップ
API キーは Guard API の呼び出しを認可します。キーは API プロジェクト内の Guardian に属します。

​
キーを作成する

Guardian を開き → API Keys → Add API Key、名前を付けて Create をクリックします。
Add API Key ボタンがハイライトされた API Keys ページ
キーは確認ダイアログに一度だけ表示され、sf_ で始まります。後から取得することはできないため、今すぐコピーしてください。
キーは一度だけ表示されます。今すぐコピーしてください
キーはパスワードと同様に扱ってください。キーの名前はすべてのトレースにタグとして表示されるため、呼び出し元や環境ごとに名前を付けてください（例: prod-backend）。キー名はプロジェクト内で一意である必要があります — そのすべての Guardian のキーをまたいで — そのため、名前はトレース内で呼び出し元を明確に識別します。

​
キーのライフサイクル

状態意味遷移
Active通常どおり動作します。→ Inactive、→ Revoked
Inactive管理者によって一時的に無効化されています — 呼び出しは拒否されます。→ Active、→ Revoked
Revoked恒久的に無効化されています。なし — 不可逆
Active と Inactive は自由に切り替えられます。Revoke は恒久的です: 失効したキーは再有効化できません — 代わりに新しいキーを発行してください。 キーが欠落・無効・失効している呼び出しは HTTP 401 を受け取ります — 認証とエラーと状態を参照してください。

​
キーの状態と Kill Switch

キーの状態と Kill Switch は独立しており、Starfort はすべてのリクエストで両方をチェックします:
  • Kill Switch（組織、プロジェクト、または Guardian 上）は、オンの間、Active なキーであってもトラフィックをブロックします。キーは状態を保持し、Kill Switch がクリアされた瞬間に通常どおり再開します。
  • Guardian より上のいずれかの Kill Switch がオンの間は、そこで新しいキーを作成することもできません。