Admin API：ユーザー

環境のユーザーを作る、一覧にする、削除する操作です。環境の管理者だけが使えます。共通の決まり（認証、エラーの形、日時）は Admin API のリファレンス にあります。

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

操作	メソッドとパス
環境のユーザーの一覧（環境の管理者だけ）	GET /admin/api/users
ユーザーを作る（環境の管理者だけ）	POST /admin/api/users
ユーザーを削除する	DELETE /admin/api/users/{id}
削除したユーザーを匿名化する	POST /admin/api/users/{id}/anonymize
パスワードを決めるリンクを発行する（環境の管理者だけ）	POST /admin/api/users/{id}/password-links

環境のユーザーの一覧（環境の管理者だけ）

GET /admin/api/users

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

パラメーター：

名前	場所	型	必須	決まり	説明
deleted	クエリ	真偽値			削除したユーザーも含める

返る値：

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

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

例：

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

ユーザーを作る（環境の管理者だけ）

パスワードを省くと、パスワードではログインできないユーザーを作る。パスワードを決めるリンクを発行して本人に渡す。

POST /admin/api/users

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

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

名前	型	必須	決まり	説明
email	文字列	○		メールアドレス（ログインに使う）
isAdmin	真偽値			環境の管理者にする（スペースを作成できる）
name	文字列か null			表示名。省くとメールアドレスの @ より前
password	文字列か null			省くと、パスワードのないユーザーを作る（パスワードを決めるリンクで、本人に決めてもらう）

返る値：

状態	本文
201	User（application/json）

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

例：

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

ユーザーを削除する

削除する（行は残す）。すぐにログアウトされ、スペースの所属が外れる。

DELETE /admin/api/users/{id}

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

パラメーター：

名前	場所	型	必須	決まり	説明
id	パス	文字列	○		ID

返る値：

状態	本文
204	なし

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

例：

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

削除したユーザーを匿名化する

匿名化する（削除済みのユーザーだけ、元に戻せない）

POST /admin/api/users/{id}/anonymize

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

パラメーター：

名前	場所	型	必須	決まり	説明
id	パス	文字列	○		ID

返る値：

状態	本文
200	UserSummary（application/json）

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

例：

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

パスワードを決めるリンクを発行する（環境の管理者だけ）

発行し直すと、前のリンクは使えなくなる。パスワードを忘れた人や、パスワードなしで作った人に渡す。

POST /admin/api/users/{id}/password-links

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

パラメーター：

名前	場所	型	必須	決まり	説明
id	パス	文字列	○		ID

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

PasswordLinkRequest か null。

返る値：

状態	本文
201	PasswordLinkCreated（application/json）

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

例：

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