Admin API：メンバー

スペースのメンバーの一覧、ロールの変更、外す操作です。共通の決まり（認証、エラーの形、日時）は Admin API のリファレンス にあります。

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

操作	メソッドとパス
メンバーの一覧	GET /admin/api/spaces/{slug}/members
スペースから自分で抜ける	DELETE /admin/api/spaces/{slug}/members/me
メンバーのロールを変える	PATCH /admin/api/spaces/{slug}/members/{user_id}
メンバーを外す	DELETE /admin/api/spaces/{slug}/members/{user_id}

メンバーの一覧

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

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

パラメーター：

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

返る値：

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

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

例：

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

スペースから自分で抜ける

自分で抜ける。members.manage は要らない。

DELETE /admin/api/spaces/{slug}/members/me

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

パラメーター：

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

返る値：

状態	本文
204	なし

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

例：

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

メンバーのロールを変える

PATCH /admin/api/spaces/{slug}/members/{user_id}

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

パラメーター：

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

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

名前	型	必須	決まり	説明
roleId	文字列	○		新しいロールの ID（roles list で見る）

返る値：

状態	本文
200	MemberView（application/json）

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

例：

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

メンバーを外す

DELETE /admin/api/spaces/{slug}/members/{user_id}

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

パラメーター：

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

返る値：

状態	本文
204	なし

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

例：

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