​

api-keys

orc api-keys は、選択したWorkspaceのAPIキーを作成し、メタデータや権限を確認・変更し、不要なキーを失効させるコマンドです。作成時に一度だけ返る秘密値は新しい非公開ファイルへ保存し、通常の出力にはメタデータだけを表示します。

orc auth login で取得したCLI認証を使用します。ブラウザーAPIのセッション認証も利用できますが、APIキー自身ではキーを管理できません。CLIが作成できるのはWorkspaceスコープのキーです。

APIキーのメタデータを一覧にします。

キーのメタデータを一覧にします。--limit と --cursor でページを指定できます。応答に秘密値は含まれません。

--name と新しい保存先の --output を指定してキーを作成します。--mode は live または test、--type は read_only または read_write です。--scope organization と workspace_id: null はAPIを呼ぶ前に拒否されます。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

Key mode. live consumes credits, test uses sandbox.; enum: live|test

型: string。任意。

(required) Required human-readable name.

型: string。任意。

Credential binding scope. Organization scope creates a key without a Workspace binding.; enum: workspace|organization

型: string。任意。

Permission type. read_only grants read access; read_write grants read and write access.; enum: read_only|read_write

型: string。任意。

Optional explicit Workspace binding. Omit for the current Workspace; use null with organization scope.; (use "null" or "reset" to clear)

型: string。任意。

キーIDを指定し、--name、--type、またはJSONオブジェクトの --permissions を更新します。秘密値の再取得ではありません。

New display name.

型: string。任意。

Endpoint-group permission map. Each key is an endpoint group name,
value is the access level. Unspecified groups default to none.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Permission preset for a user-owned key.; enum: read_only|read_write

型: string。任意。

キーIDを指定して失効させます。失効は取り消せません。非対話環境では --yes が必要です。

秘密値を新しい非公開ファイルへ保存して作成します。

キーの名前を変更します。

不要になったキーを失効させます。

--output には存在しないファイルを指定してください。CLIは所有者だけが読める権限 (0600) で原子的に保存し、既存ファイルを上書きしません。保存先の親ディレクトリを用意し、ソース管理外の場所を使用してください。標準出力は秘密値を除いたメタデータです。

orc api-keys では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。