Admin API：招待

スペースに人を招待する、招待を取り消す、招待を受け入れる操作です。共通の決まり（認証、エラーの形、日時）は Admin API のリファレンス にあります。

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

操作	メソッドとパス
招待の内容	GET /admin/api/invitations/{token}
招待を受け入れる	POST /admin/api/invitations/{token}/accept
まだ受け入れられていない招待の一覧	GET /admin/api/spaces/{slug}/invitations
メンバーを招待する	POST /admin/api/spaces/{slug}/invitations
招待を取り消す	DELETE /admin/api/spaces/{slug}/invitations/{id}

招待の内容

招待の内容（受け入れの画面に出す）

GET /admin/api/invitations/{token}

• ログイン：不要

パラメーター：

名前	場所	型	必須	決まり	説明
token	パス	文字列	○		リンクのトークン

返る値：

状態	本文
200	InvitationInfo（application/json）

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

例：

curl "https://<ホスト名>.hakocms.net/admin/api/invitations/<token>"

招待を受け入れる

受け入れる。招待のメールアドレスのアカウントでログイン中なら参加し、アカウントがなければ作って参加する。

POST /admin/api/invitations/{token}/accept

• ログイン：不要

パラメーター：

名前	場所	型	必須	決まり	説明
token	パス	文字列	○		リンクのトークン

リクエストの本文（application/json。省略可）：

NewAccount か null。

返る値：

状態	本文
200	AcceptResponse（application/json）

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

例：

curl -X POST "https://<ホスト名>.hakocms.net/admin/api/invitations/<token>/accept" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "<name>",
  "password": "<password>"
}'

まだ受け入れられていない招待の一覧

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

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

パラメーター：

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

返る値：

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

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

例：

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

メンバーを招待する

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

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

パラメーター：

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

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

名前	型	必須	決まり	説明
email	文字列	○		招待する人のメールアドレス
roleId	文字列	○		参加したときのロールの ID（roles list で見る）

返る値：

状態	本文
201	CreatedInvitation（application/json）

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

例：

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

招待を取り消す

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

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

パラメーター：

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

返る値：

状態	本文
204	なし

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

例：

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