Admin API：ロール

スペースのロールを作る、変える、削除する操作です。共通の決まり（認証、エラーの形、日時）は Admin API のリファレンス にあります。

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

操作	メソッドとパス
ロールの一覧	GET /admin/api/spaces/{slug}/roles
ロールを作る	POST /admin/api/spaces/{slug}/roles
ロールを取得する	GET /admin/api/spaces/{slug}/roles/{id}
ロールの名前と権限を変える	PUT /admin/api/spaces/{slug}/roles/{id}
ロールを削除する	DELETE /admin/api/spaces/{slug}/roles/{id}

ロールの一覧

GET /admin/api/spaces/{slug}/roles

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

パラメーター：

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

返る値：

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

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

例：

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

ロールを作る

POST /admin/api/spaces/{slug}/roles

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

パラメーター：

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

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

名前	型	必須	決まり	説明
actions	RoleActions			コンテンツタイプごとの操作。既定はどれにも何もできない
name	文字列	○		ロールの名前
permissions	文字列の配列			スペース全体への権限（文字列の配列）。既定は空

返る値：

状態	本文
201	RoleView（application/json）

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

例：

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

ロールを取得する

GET /admin/api/spaces/{slug}/roles/{id}

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

パラメーター：

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

返る値：

状態	本文
200	RoleView（application/json）

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

例：

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

ロールの名前と権限を変える

PUT /admin/api/spaces/{slug}/roles/{id}

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

パラメーター：

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

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

名前	型	必須	決まり	説明
actions	RoleActions			コンテンツタイプごとの操作。既定はどれにも何もできない
name	文字列	○		ロールの名前
permissions	文字列の配列			スペース全体への権限（文字列の配列）。既定は空

返る値：

状態	本文
200	RoleView（application/json）

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

例：

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

ロールを削除する

DELETE /admin/api/spaces/{slug}/roles/{id}

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

パラメーター：

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

返る値：

状態	本文
204	なし

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

例：

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