メインコンテンツへスキップ
Guard API は、リクエストヘッダーで送信される API キーで認証します。

​
ヘッダー

X-Starfort-Guard-Api-Key: sf_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  • キーは Console で Guardian ごとに作成され、sf_ で始まります。
  • キーは作成時に一度だけ表示されます。安全に保管してください。
  • キーの名前はすべてのトレースにタグとして記録されるため、呼び出し元や環境ごとに名前を付けてください。
認証用のクエリパラメータはありません。認証はヘッダーのみで行います。

​
無効なキーまたはキーの欠落

キーが欠落している、見つからない／形式が不正である、または取り消されている場合、HTTP 401 で拒否されます。取り消しは恒久的かつ不可逆であり、取り消されたキーが再び認証されることは決してありません。 
{
  "ok": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid credentials (getApiGuardGate)",
    "details": "API_KEY_INVALID"
  }
}

​
認証 vs. アクティブ状態

認証（上記の 401）は、キーが現在実行を許可されているかどうかとは別に、その前にチェックされます。認証に成功したキーであっても、管理者がそれを非アクティブに切り替えた、または親リソースで Kill Switch が発動したために、実行が停止されることがあります。これらは 401 ではなく、どのリソースがブロックしたかも明かしません。エラーと状態を参照してください。

​
キーの管理

キーはアクティブまたは非アクティブにでき、取り消すこともできます。取り消しは恒久的です。ライフサイクル全体についてはAPI キーの管理を参照してください。