Admin API：ログインとアクセストークン

ログイン、ログアウト、ログイン中のユーザーの取得と、アクセストークンの作成・一覧・取り消しの操作です。共通の決まり（認証、エラーの形、日時）は Admin API のリファレンス にあります。

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

操作	メソッドとパス
メールアドレスとパスワードでログインし、セッション Cookie を発行する	POST /admin/api/auth/login
ログアウトする	POST /admin/api/auth/logout
ログイン画面で使える機能	GET /admin/api/auth/settings
CLI のログインを始める	POST /admin/api/cli-logins
CLI のログインの結果を受け取る	POST /admin/api/cli-logins/token
ログイン中のユーザー	GET /admin/api/me
自分のアクセストークンの一覧	GET /admin/api/me/access-tokens
アクセストークンを作る（管理画面のセッションだけ）	POST /admin/api/me/access-tokens
自分のアクセストークンを取り消す	DELETE /admin/api/me/access-tokens/{id}

メールアドレスとパスワードでログインし、セッション Cookie を発行する

POST /admin/api/auth/login

• ログイン：不要

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

名前	型	必須	決まり	説明
email	文字列	○
password	文字列	○

返る値：

状態	本文
200	MeResponse（application/json）

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

例：

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

ログアウトする

ログアウトする。アクセストークンで呼ぶと、そのトークンを取り消す。

POST /admin/api/auth/logout

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

返る値：

状態	本文
204	なし

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

例：

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

ログイン画面で使える機能

GET /admin/api/auth/settings

• ログイン：不要

返る値：

状態	本文
200	AuthSettings（application/json）

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

例：

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

CLI のログインを始める

CLI のログインを始める。ログインは要らない（CLI はまだトークンを持っていない）

POST /admin/api/cli-logins

• ログイン：不要

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

名前	型	必須	決まり	説明
clientName	文字列	○		トークンの名前にする（CLI はコンピューターの名前を送る）

返る値：

状態	本文
201	StartLoginResponse（application/json）

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

例：

curl -X POST "https://<ホスト名>.hakocms.net/admin/api/cli-logins" \
  -H "Content-Type: application/json" \
  -d '{
  "clientName": "<clientName>"
}'

CLI のログインの結果を受け取る

CLI が結果を問い合わせる。許可されていれば、ここでトークンを作って返す（1 度だけ）

POST /admin/api/cli-logins/token

• ログイン：不要

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

名前	型	必須	決まり	説明
pollToken	文字列	○

返る値：

状態	本文
200	PollResponse（application/json）

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

例：

curl -X POST "https://<ホスト名>.hakocms.net/admin/api/cli-logins/token" \
  -H "Content-Type: application/json" \
  -d '{
  "pollToken": "<pollToken>"
}'

ログイン中のユーザー

ログイン中のユーザーと、メンバーになっているスペース。

GET /admin/api/me

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

返る値：

状態	本文
200	MeResponse（application/json）

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

例：

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

自分のアクセストークンの一覧

GET /admin/api/me/access-tokens

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

返る値：

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

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

例：

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

アクセストークンを作る（管理画面のセッションだけ）

POST /admin/api/me/access-tokens

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

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

名前	型	必須	決まり	説明
expiresIn	ExpiresIn か null
name	文字列	○
scope	TokenScope か null

返る値：

状態	本文
201	AccessTokenCreated（application/json）

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

例：

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

自分のアクセストークンを取り消す

DELETE /admin/api/me/access-tokens/{id}

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

パラメーター：

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

返る値：

状態	本文
204	なし

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

例：

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