key — APIキー

プロジェクトの APIキーを管理します。公開読み取り用の Consumer Key と、RBAC を伴うコンテンツ操作用の Management Key の 2 種類があります。

すべて認証とプロジェクトコンテキストが必要です。

Orizm の APIキーは発行後もいつでも平文を参照できますが、画面共有やログへの露出事故を防ぐため、CLI はキーを含む出力を既定でマスクします（x_consumer_**** のような表示）。--show-key を付けたときだけ平文で表示します（--json 出力にも適用されます）。

Consumer Key

`orizm key consumer list`

Consumer Key の一覧を表示します。


orizm key consumer list [--show-key]

オプション

オプション	説明
`--show-key`	キーをマスクせず平文で表示します。

`orizm key consumer create`

Consumer Key を新規発行します。


orizm key consumer create --description <s> [--can-read-drafts] [--show-key]

オプション

オプション	説明
`--description <s>`	（必須）キーの用途説明。
`--can-read-drafts`	下書きコンテンツの読み取りを許可します。
`--show-key`	発行したキーを平文で表示します。

`orizm key consumer delete`

Consumer Key を失効させます。


orizm key consumer delete <id> [--yes]

引数

引数	説明
`<id>`	Consumer Key の数値 ID。

オプション

オプション	説明
`--yes`	確認プロンプトをスキップします。

Management Key

`orizm key management list`

Management Key の一覧を表示します。


orizm key management list [--show-key]

オプション

オプション	説明
`--show-key`	キーをマスクせず平文で表示します。

`orizm key management create`

Management Key を新規発行します。Group / Role の付与は update で行います。


orizm key management create --description <s> [--show-key]

オプション

オプション	説明
`--description <s>`	（必須）キーの用途説明。
`--show-key`	発行したキーを平文で表示します。

`orizm key management update`

説明や Group / Role を更新します。


orizm key management update <id> [--description <s>] [--group-role <g>:<r>] [--add-group-role <g>:<r>] [--remove-group-role <g>] [--clear-group-roles] [--show-key]

引数

引数	説明
`<id>`	Management Key の数値 ID。

オプション

オプション	説明
`--description <s>`	用途説明を変更します。
`--group-role <g>:<r>`	RBAC を全置換します（複数指定可）。
`--add-group-role <g>:<r>`	RBAC を追加します。同じ group は role を置き換えます（複数指定可）。
`--remove-group-role <g>`	group 名を指定して RBAC を削除します（複数指定可）。
`--clear-group-roles`	RBAC をすべて削除します。
`--show-key`	結果表示でキーをマスクしません。

Group / Role の編集方式については Group / Role の編集を参照してください。


orizm key management update 12 --add-group-role editors:writer --add-group-role admins:owner

`orizm key management delete`

Management Key を失効させます。


orizm key management delete <id> [--yes]

引数

引数	説明
`<id>`	Management Key の数値 ID。

オプション

オプション	説明
`--yes`	確認プロンプトをスキップします。

Group / Role の編集

API は groupRoles を配列の全置換でしか受け付けませんが、CLI では要素単位の編集オプションを提供します。

全置換 — --group-role <g>:<r>（複数指定可）。指定した内容で丸ごと置き換えます。
追加 / 削除 — --add-group-role <g>:<r> / --remove-group-role <g>。現在の値を取得してから編集して送ります。同じ group には複数の role を持てないため、--add-group-role は既存の role を置き換えます。
全削除 — --clear-group-roles。

全置換系（--group-role / --clear-group-roles）と編集系（--add-group-role / --remove-group-role）は同時に指定できません。存在しない group の削除は無視されますが、タイポに気づけるよう通知が出ます。