Admin API：API キー

Content API で使う API キーを発行する、権限を変える、失効させる操作です。共通の決まり（認証、エラーの形、日時）は Admin API のリファレンス にあります。

権限の決め方は、API キーを作る、権限を決める にあります。

例の <ホスト名> はあなたの環境のホスト名、<アクセストークン> は hako_pat_ で始まるアクセストークンに置き換えます。<slug> などのほかの山かっこの値は、各操作のパラメーターの表にあるものに置き換えます。

操作	メソッドとパス
API キーの一覧	GET /admin/api/spaces/{slug}/api-keys
API キーを発行する	POST /admin/api/spaces/{slug}/api-keys
API キーの名前と権限を変える	PATCH /admin/api/spaces/{slug}/api-keys/{id}
API キーを失効させる	DELETE /admin/api/spaces/{slug}/api-keys/{id}
失効した API キーを再び有効にする	POST /admin/api/spaces/{slug}/api-keys/{id}/reactivate

API キーの一覧

GET /admin/api/spaces/{slug}/api-keys

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ

返る値：

状態	本文
200	ApiKey の配列（application/json）

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/api-keys" \
  -H "Authorization: Bearer <アクセストークン>"

API キーを発行する

POST /admin/api/spaces/{slug}/api-keys

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ

リクエストの本文（application/json）：

名前	型	必須	決まり	説明
name	文字列	○		見分けるための名前
permissions	ApiKeyPermissions か null

返る値：

状態	本文
201	ApiKeyCreated（application/json）

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl -X POST "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/api-keys" \
  -H "Authorization: Bearer <アクセストークン>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "<name>"
}'

API キーの名前と権限を変える

PATCH /admin/api/spaces/{slug}/api-keys/{id}

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ
id	パス	文字列	○		ID

リクエストの本文（application/json）：

名前	型	必須	決まり	説明
name	文字列か null			見分けるための名前
permissions	ApiKeyPermissions か null

返る値：

状態	本文
200	ApiKey（application/json）

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl -X PATCH "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/api-keys/<id>" \
  -H "Authorization: Bearer <アクセストークン>" \
  -H "Content-Type: application/json" \
  -d '{}'

API キーを失効させる

失効させる（行は残す）

DELETE /admin/api/spaces/{slug}/api-keys/{id}

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ
id	パス	文字列	○		ID

返る値：

状態	本文
204	なし

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl -X DELETE "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/api-keys/<id>" \
  -H "Authorization: Bearer <アクセストークン>"

失効した API キーを再び有効にする

失効したキーを再び有効にする（同じ平文のキーがまた使える）

POST /admin/api/spaces/{slug}/api-keys/{id}/reactivate

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ
id	パス	文字列	○		ID

返る値：

状態	本文
200	ApiKey（application/json）

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl -X POST "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/api-keys/<id>/reactivate" \
  -H "Authorization: Bearer <アクセストークン>"