CLI を使い始める
api-keys
api-keys コマンドは、選択したワークスペースの API キーを管理します。orc auth login で取得した CLI 認証を使います。ブラウザー API のセッション認証も引き続き利用できますが、API キー自身ではキーを管理できません。
コマンド一覧
orc api-keys create— API キーを作成するorc api-keys list— API キーのメタデータを一覧するorc api-keys update— 名前または権限を更新するorc api-keys delete— API キーを失効させる
orc api-keys create
orc api-keys create --workspace WORKSPACE_ID --name "Automation key" --scope workspace --output /secure/path/api-key --json--output には存在しないファイルを指定します。CLI は作成時に一度だけ返るシークレットを owner-only (0600) のファイルへ原子的に保存し、既存ファイルを上書きしません。標準出力にはシークレットを除いたメタデータだけを返します。
CLI では workspace スコープだけを作成できます。--scope organization と workspace_id: null は API を呼ぶ前に拒否されます。
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--name | string | はい | 表示名 |
--output | string | はい | 一度だけ返るシークレットの新規保存先 |
--mode | string | いいえ | live または test |
--type | string | いいえ | read_only または read_write |
--scope | string | いいえ | CLI では workspace のみ |
--workspace-id | string | いいえ | 明示的なワークスペース binding |
orc api-keys list
orc api-keys list --workspace WORKSPACE_ID --json--limit と --cursor でページを指定できます。レスポンスにシークレットは含まれません。
orc api-keys update
orc api-keys update KEY_ID --workspace WORKSPACE_ID --name "Renamed key" --json--name、--type、または JSON オブジェクトの --permissions を指定します。
orc api-keys delete
orc api-keys delete KEY_ID --workspace WORKSPACE_ID --yes --json失効は取り消せません。非対話実行では --yes が必要です。
共通オプションはグローバルオプションを参照してください。