API key

バックエンド用の API key を発行し、無効化します。

API key は、プロダクトを動かすときに使う Credential です。バックエンド、ジョブ、CI は、API key を使って 1 つの Workspace の中で、発行時に与えられた権限の範囲だけで操作します。Workspace の API key は、その Workspace の誰でも発行・無効化できます。

API key を発行する

API key を発行 では、次の項目を入力します。

ラベル: API key をどこで使うか。後から見つけやすくするためのものです。
有効期限: なし、30 日後、90 日後、1 年後から選びます。
権限: API key に許可する操作です。まとめて選択 で 読み取りのみ か すべて を選び、そこから必要なものにチェックを入れます。必要以上の権限は与えないでください。

API key を発行: ラベル、有効期限、グループごとの権限

API key を発行 を押すと、シークレットが一度だけ表示されます。Subako はこれを再表示できないので、その場でコピーして安全な場所に保管してください。

発行された API key。一度だけ表示されます

たとえば、ユーザーのために Session を作成するバックエンドには Session › 作成が必要です。Session の状態を追ったり操作したりするなら、読み取り と管理も必要になります。Agent を公開する CI ジョブには Agent › 公開に加えて、アップロードするものに応じて Skill または Function › 管理が必要です。すべての権限の一覧は権限にあります。

API key を使う

API key は Bearer token として送ります。API key は発行元の Workspace に属しているので、API key を使った呼び出しでは Workspace を指定する Header は不要です。

curl https://api.us.cloud.subako.ai/v1/sessions \
  -H "Authorization: Bearer $SUBAKO_API_KEY"

API key はサーバー側だけに置いてください。ブラウザーには、代わりに Session token を渡します。Session token は 1 つの Session にだけ有効で、ほかの用途には使えません。

API key を無効化する

API key の一覧には、各 API key の作成者、最終使用日、有効期限が表示されます。API key のメニューからは、詳細 (API key が持つ権限) を開いたり、無効化 したりできます。無効化すると、その API key を使っているものはすぐに動かなくなります。