CLI:API キー
Content API で使う API キーを発行する、権限を変える、失効させるコマンドです。どのコマンドにも付けられる共通のフラグ(--host、--json など)は CLI のコマンドのリファレンス にあります。
権限の決め方は API キーを作る、権限を決める にあります。
| コマンド | 内容 |
|---|---|
hakocms-cli api-keys create |
API キーを発行する |
hakocms-cli api-keys list |
API キーの一覧 |
hakocms-cli api-keys reactivate |
失効したキーを再び有効にする(同じ平文のキーがまた使える) |
hakocms-cli api-keys revoke |
API キーを失効させる(あとで再び有効にできる) |
hakocms-cli api-keys update |
API キーの名前と権限を変える |
hakocms-cli api-keys create
Section titled “hakocms-cli api-keys create”API キーを発行する。
hakocms-cli api-keys create [OPTIONS]| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
--name <TEXT> |
見分けるための名前 |
--permissions <JSON> |
省略すると GET だけを許す |
--data <JSON> |
本文全体(JSON)。@file でファイル、- で標準入力から。ほかのフラグは、その上に重ねる |
hakocms-cli api-keys list
Section titled “hakocms-cli api-keys list”API キーの一覧。
hakocms-cli api-keys list [OPTIONS]| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
hakocms-cli api-keys reactivate
Section titled “hakocms-cli api-keys reactivate”失効したキーを再び有効にする(同じ平文のキーがまた使える)
hakocms-cli api-keys reactivate [OPTIONS] <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
<ID> |
ID |
hakocms-cli api-keys revoke
Section titled “hakocms-cli api-keys revoke”API キーを失効させる(あとで再び有効にできる)
失効させる(行は残す)
hakocms-cli api-keys revoke [OPTIONS] <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
<ID> |
ID |
--force |
確かめずに行う |
hakocms-cli api-keys update
Section titled “hakocms-cli api-keys update”API キーの名前と権限を変える。
hakocms-cli api-keys update [OPTIONS] <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
<ID> |
ID |
--name <TEXT> |
見分けるための名前 |
--permissions <JSON> |
渡すと、既定の権限と個別の権限をまるごと置き換える |
--data <JSON> |
本文全体(JSON)。@file でファイル、- で標準入力から。ほかのフラグは、その上に重ねる |