Admin API:CLI のログインの許可
CLI からのログインを、管理画面で許可・拒否する操作です。共通の決まり(認証、エラーの形、日時)は Admin API のリファレンス にあります。
例の <ホスト名> はあなたの環境のホスト名、<アクセストークン> は hako_pat_ で始まるアクセストークンに置き換えます。<slug> などのほかの山かっこの値は、各操作のパラメーターの表にあるものに置き換えます。
| 操作 | メソッドとパス |
|---|---|
| CLI のログインの内容 | GET /admin/api/cli-logins/{code} |
| CLI のログインを許可する(管理画面のセッションだけ) | POST /admin/api/cli-logins/{code}/approve |
| CLI のログインを拒否する(管理画面のセッションだけ) | POST /admin/api/cli-logins/{code}/deny |
CLI のログインの内容
Section titled “CLI のログインの内容”許可の画面に出す。
GET /admin/api/cli-logins/{code}- ログイン:要る(セッションかアクセストークン)
パラメーター:
| 名前 | 場所 | 型 | 必須 | 決まり | 説明 |
|---|---|---|---|---|---|
code |
パス | 文字列 | ○ | CLI のログインの文字 |
返る値:
| 状態 | 本文 |
|---|---|
200 |
LoginView(application/json) |
うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。
例:
curl "https://<ホスト名>.hakocms.net/admin/api/cli-logins/<code>" \ -H "Authorization: Bearer <アクセストークン>"CLI のログインを許可する(管理画面のセッションだけ)
Section titled “CLI のログインを許可する(管理画面のセッションだけ)”POST /admin/api/cli-logins/{code}/approve- ログイン:要る(セッションかアクセストークン)
パラメーター:
| 名前 | 場所 | 型 | 必須 | 決まり | 説明 |
|---|---|---|---|---|---|
code |
パス | 文字列 | ○ | CLI のログインの文字 |
返る値:
| 状態 | 本文 |
|---|---|
200 |
LoginView(application/json) |
うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。
例:
curl -X POST "https://<ホスト名>.hakocms.net/admin/api/cli-logins/<code>/approve" \ -H "Authorization: Bearer <アクセストークン>"CLI のログインを拒否する(管理画面のセッションだけ)
Section titled “CLI のログインを拒否する(管理画面のセッションだけ)”POST /admin/api/cli-logins/{code}/deny- ログイン:要る(セッションかアクセストークン)
パラメーター:
| 名前 | 場所 | 型 | 必須 | 決まり | 説明 |
|---|---|---|---|---|---|
code |
パス | 文字列 | ○ | CLI のログインの文字 |
返る値:
| 状態 | 本文 |
|---|---|
200 |
LoginView(application/json) |
うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。
例:
curl -X POST "https://<ホスト名>.hakocms.net/admin/api/cli-logins/<code>/deny" \ -H "Authorization: Bearer <アクセストークン>"