メインコンテンツへスキップ
コンソールまたは REST API を通じて API キーを作成または読み取ると、ゲートウェイはトークン オブジェクトを返します — キーのアイデンティティ、その制限、そしてそのトラフィックを統制する 2 つのポリシーアタッチメントを保持する JSON レコードです。このページはそのオブジェクトの フィールドごとのリファレンスです:各フィールドが何を意味するか、その型、そして特別な意味を 運ぶセンチネル値(0-1)。 これらのフィールドのなぜ — 最小権限モデル — については、 スコープ付きキー概要から始めてください。このページは、キー作成を スクリプト化する間に開いておくルックアップテーブルです。

1. トークンオブジェクトリファレンスの概観

スケジュール要約エージェント向けに新しく作成されたキーは、次のようになります:
{
  "id": 4812,
  "name": "support-summarizer-prod",
  "status": 1,
  "key": "sk-orca-a1b2****yz90",
  "created_time": 1733616000,
  "accessed_time": 1733702400,
  "expired_time": -1,
  "unlimited_quota": false,
  "remain_quota": 500000,
  "used_quota": 12340,
  "model_limits_enabled": true,
  "model_limits": "openai/gpt-4o-mini",
  "credit_limit_usd": 25,
  "allow_ips": "203.0.113.7",
  "environment": "prod",
  "guardrail_id": 17,
  "firewall_policy_id": 9,
  "is_firewall_gateway": false,
  "group": "default"
}
key フィールドはすべての読み取りでマスクされます — ブランドプレフィックスと最後の 4 文字が 見え、完全なシークレットは決して見えません。平文は作成時に一度表示されます。 キーマスキングを参照。

2. アイデンティティとライフサイクルのフィールド

これらは、これがどのキーで、ライフサイクルのどこにあるかを記述します。
キーの安定した数値識別子。更新および削除呼び出しでキーを指定するために使います。読み取り専用。
コンソールとログに表示される、キーの人間向けラベル。それを保持するエージェントにちなんで キーを名付けてください — 1 つのキー、1 つのエージェント。
有効 / 無効の状態。1 はアクティブを意味します;無効化されたキーは削除されることなく認証で 拒否されるため、キーを一時停止して再有効化できます。
ベアラーシークレット、マスクされて返されます(sk-orca-…****…)。完全な値は作成時に一度だけ 表示されます。パスワードのように扱ってください。
キーが発行されたときと、最後にリクエストを処理したときの Unix タイムスタンプ(秒)。 accessed_time は、取り消す価値のある古いまたは未使用のキーのあなたのシグナルです。
Unix タイムスタンプとしての絶対的な失効。センチネル -1 はキーが決して失効しないことを 意味します。キーを自動失効させるには実際のタイムスタンプを設定してください — CI 実行と 一時的なエージェントに正しいデフォルトです。失効するキーを 参照。

3. 支出とクォータのフィールド

これらは、キーが機能を停止するまでにどれだけ消費できるかを境界づけます。
フィールド意味
credit_limit_usdnumberUSD での生涯支出上限。0 = 無制限。
unlimited_quotabooleantrue のとき、キーはクォータ残高に対して課金されません。
remain_quotanumberキーに残っているクォータ。
used_quotanumberこれまでに消費されたクォータ。
credit_limit_usd: 0 かつ unlimited_quota: true かつ expired_time: -1 のキーは、 支出上限がなく決して失効しません — 漏洩した場合に最悪の被害範囲です。無境界のキーが正当化される 場面については、無制限 vs 境界づけを参照してください。

4. リーチとスコープのフィールド

これらは、キーが何に到達できるか — どのモデル、どのアドレスから — を上限設定します。
model_limits はキーが呼んでよいモデルのリストです;model_limits_enabled はオン / オフの スイッチです。制限が有効な場合、リスト外の任意のモデルへの呼び出しはゲートウェイを離れる 前に拒否されます — エージェントはより高価あるいはより高性能なモデルに切り替えられません。 モデル制限を参照。
IP / CIDR 許可リスト、1 行につき 1 エントリ。リストにないアドレスからキーを提示する リクエストは認証層で拒否されます;の値はすべてのアドレスが許可されることを意味します。 IP 許可リストを参照。
キーを整理しログをフィルタするための自由形式のデプロイラベル(prodstagingdev、 あるいは好きなもの)。純粋に組織化目的 — 強制を変えません。 環境を参照。
キーがモデルを解決するルーティンググループ。特定のグループを与えられていない限り、 ワークスペースデフォルトのままにしてください。

5. ポリシーアタッチメントのフィールド

キー上の最も強力な 2 つのフィールド。それぞれがキーを、そのトラフィックを統制する ワークスペーススコープのポリシーにバインドします — ポリシーを変更すると、それにアタッチされた すべてのキーが次のリクエストで変更を反映します、再デプロイなし。
フィールドキーをバインドする先
guardrail_idnumberリクエストとレスポンスのテキストをスクリーニングするコンテンツガードレール
firewall_policy_idnumberキーが発行するツール呼び出しを統制するファイアウォールポリシー
is_firewall_gatewaybooleanキーを、ファイアウォール MCP / evaluate ルート用(推論用ではない)のゲートウェイスコープトークンとしてマークします。
両方のアタッチメントのセンチネルは 0(未アタッチ)です。 しかし 2 つのプレーンは無効化 されたアタッチメントを異なって解決します:
  • 無効化された guardrail_id はオフスイッチです — キーはいかなるガードレールも得ず、 ワークスペースデフォルトへのフォールバックはありません。
  • 無効化された firewall_policy_id は、ワークスペースデフォルトのファイアウォールポリシーに フォールバックします。
完全な解決順序は ポリシーをバインドスコープとキーに あります。
is_firewall_gateway: true は、/api/v1/firewall/* ルート専用のゲートウェイスコープキーを 発行します — それを決して推論キーに付けないでください。フラグを有効化すること、そして ゲートウェイキーの平文を読むことには、どちらも Admin+ が必要です。

6. これらのフィールドの設定

上のすべてのフィールドは、リレーキーを通じてではなく、コンソールのキーエディタ (/console/token)で設定されます。キーの作成または編集には Developer ロール以上が必要 です;is_firewall_gateway フラグには Admin+ が必要です。
トークンオブジェクトは設定の表面です。キーの平文sk-orca-…)は、エージェントが /v1/* リレー呼び出しで提示するものです。キーをコンソールで設定してください;エージェントはシークレット しか決して見ません。
具体的な最小権限キー — エディタで設定され、上のオブジェクトとして読み戻される — は、1 つの モデル、1 つのソース IP レンジ、週次の USD 上限、失効、そして 1 つのガードレールと 1 つの ファイアウォールポリシーを上限設定します。それを保持するエージェントが プロンプトインジェクションで乗っ取られると、被害範囲は 正確にそれらの境界で止まります。

7. 関連リファレンス

スコープ付きキー概要

最小権限モデルと、すべてのキーフィールドのハブ。

ポリシーをバインド

guardrail_idfirewall_policy_id がどうアクティブなポリシーに解決するか。

クォータ、上限、失効

credit_limit_usdexpired_time、そしてクォータフィールドを詳しく。

最小権限チェックリスト

すべてのキーを同じ強化パスに通す。
モデルは初めてですか? トークンオブジェクトがワークスペース → ポリシー → キーの階層にどう フィットするかについては、 スコープ、キー、ポリシー、ワークスペースを 読んでください。