ユーザーと管理用のリソースを扱う


この機能は Ver. 3.3.0 で追加予定の、リリース前の機能です

このページは、アルファ版(Ver. 3.3.0-alpha.1)時点の内容です。正式版までに仕様や設定項目が変わる可能性があります。本番サイトでは使わず、検証環境でお試しください。

このページのリソースは、個人情報や管理者向けの情報を含むため、ほとんどが「強い権限」のスコープ(users:read など)を要ります。read / write のトークンでは使えません(REST API の認証と API トークン)。読み取りも監査ログに「REST API でデータを読み取りました」として残ります。

ユーザー

操作

メソッドとパス

スコープ

権限

一覧・取得

GET /users・GET /users/{id}

users:read

公開側で見えるユーザー

作成

POST /users

users:write

URL のブログの管理者

更新

PATCH / PUT /users/{id}

users:write

プロフィールは管理者と本人、status・auth・indexing・global_auth・login_expire は管理者だけ

削除

DELETE /users/{id}

users:write

URL のブログの管理者

curl -s -X POST "${ACMS_API}/users/" \
  -H "Authorization: Bearer ${ACMS_API_TOKEN}" -H "Content-Type: application/json" \
  -d '{"code":"sato","name":"佐藤 花子","mail":"sato@example.com","auth":"contributor","status":"open","indexing":true,"locale":"ja_JP.UTF-8"}'
{
  "id": 1,
  "code": "ui",
  "name": "ui",
  "status": "open",
  "auth": "administrator",
  "url": "https://example.com/uid/1/",
  "icon_url": "usericon/user1.png",
  "locale": "ja_JP.UTF-8",
  "indexing": true,
  "login_expire": "9999-12-31T00:00:00+09:00",
  "blog_id": 1,
  "global_auth": true,
  "mail": "ui@example.com",
  "fields": {},
  "links": { "self": "https://example.com/rest-api/acms/v1/users/1/", "blog": "https://example.com/rest-api/acms/v1/blogs/1/" }
}

キー

説明

code

ユーザーコード(64 文字まで)

name

名前(255 文字まで)

status

open・close(読み取りでは pseudo・withdrawal もあります)。作成で省略すると open

auth

administrator・editor・contributor・subscriber。作成で省略すると subscriber。自分自身の権限は変えられません

locale

ロケール(例: ja_JP.UTF-8)

indexing

インデキシング(作成で省略すると true)

login_expire

ログインの有効期限(日付 YYYY-MM-DD も可。null は期限なし)

global_auth

子ブログへの権限。true にできるのはルートブログのユーザーのトークンだけ

mail

メールアドレス。本人と URL のブログの管理者のトークンにだけ返します

pass

受け付けません(送ると 400)。作成したユーザーは本人がパスワードの再設定で設定します

fields

ユーザーのカスタムフィールド

id・url・icon_url・blog_id・links

読み取り専用

エントリーのあるユーザー・自分自身・最後の管理者は削除できません(409)。最後の管理者の降格・無効化も 409 です。

ユーザーグループとロール(エンタープライズ)

エンタープライズライセンスで、ルートブログの管理者だけが使えます。作成はルートブログの URL から行います。

リソース

パス

スコープ

本文の項目

ユーザーグループ

/usergroups・/usergroups/{id}

usergroups:read / usergroups:write

name(255 文字まで)・description(512 文字まで)・role_id(書き込みでは必須)・approval_point(承認ポイント)・user_ids(所属するユーザー。一覧を置き換え)

ロール

/roles・/roles/{id}

roles:read / roles:write

name(128 文字まで)・description・blog_axis(self・descendant)・blog_ids(管轄ブログ。一覧を置き換え)・permissions(送ったキーだけを変える)

ロールの permissions のキーは、entry_edit・entry_edit_all・entry_delete・category_create・category_edit・form_view・form_edit・tag_edit・media_upload・media_edit・publish_edit・publish_exec・config_edit・module_edit・rule_edit・backup_export・backup_import・admin_etc・field_definition_edit・api_connect(API・MCP の接続)で、値は真偽値です。

curl -s -X PATCH "${ACMS_API}/roles/3/" \
  -H "Authorization: Bearer ${ACMS_API_TOKEN}" -H "Content-Type: application/json" \
  -d '{"permissions":{"api_connect":false}}'

ワークフローで使われているユーザーグループ、ユーザーグループで使われているロールは削除できません(409)。

エイリアスとフォーム ID

リソース

パス

スコープ

本文の項目

エイリアス

/aliases・/aliases/{id}

aliases:read / aliases:write

name・status(open・close)・domain・code・scope(local・global)・indexing。description・sort は読み取り専用

フォーム ID

/forms・/forms/{id}・/forms/{id}/duplicate

forms:read / forms:write

code(64 文字まで)・name(255 文字まで)・scope・log(投稿データを保存するか)・mail(メールの設定。キーは管理画面の項目名、値は文字列か文字列の配列。キー単位でマージし null で消す)・options(入力チェックの field・method・value の配列。置き換え)

フォームの投稿ログ

GET /forms/{id}/logs

forms:read

読み取りだけ

# 投稿ログを新しい順に
curl -s "${ACMS_API}/forms/2/logs/?limit=20&include=entry" -H "Authorization: Bearer ${ACMS_API_TOKEN}"

投稿ログの要素は、serial(フォームごとの通番)・blog_id・datetime・remote_addr・user_agent・entry_id・mail_to(自動返信の宛先)・fields(name と values の配列)・mails(admin と auto_reply ごとの status・subject・body・envelope)です。主要なエイリアスは削除できません。フォーム ID の削除は投稿ログも削除します。

Webhook

URL のブログの管理者が使えます。スコープは webhooks:read / webhooks:write です。送信先の URL・カスタムヘッダー・署名シークレットは書き込み専用で、読み取りでは返しません。

キー

説明

name

名前(255 文字まで)

status

open・close

type

対象の種類(entry・form・user など。設定 webhook_types の値)

events

フックするイベント(例: entry:created)の配列

history

リクエストの履歴を残すか

scope

local・global(下の階層のブログも対象)

payload / payload_tpl

default・custom / custom のときのテンプレート

method / content_type

送信のメソッド / Content-Type(Professional 以上で変更できます)

url

送信先(書き込み専用。許可リストのホストに限る)

secret

署名シークレット(書き込み専用。128 文字まで。null か空文字で消す)

headers

カスタムヘッダー(name・value の配列。Professional 以上。置き換え)

# 保存済みの設定でテスト送信する(Webhook ごとに 1 分に 5 回まで)
curl -s -X POST "${ACMS_API}/webhooks/4/test/" -H "Authorization: Bearer ${ACMS_API_TOKEN}"
# {"status_code":200,"success":true,"duration_ms":182}

テスト送信は、event が test の固定のペイロードを 1 回送り、結果(status_code・success・duration_ms)だけを返します。届かなかったときは status_code が 0(200 で返す)です。送信先が空・許可リスト外などのときは送信せずに 422 です。

リダイレクト

スコープは redirects:read / redirects:write で、URL のブログの管理者が使えます。詳しい使い方は REST API と Hook でリダイレクトを扱う を参照してください。

curl -s -X POST "${ACMS_API}/redirects/" \
  -H "Authorization: Bearer ${ACMS_API_TOKEN}" -H "Content-Type: application/json" \
  -d '{"source":"/old-news/","match_type":"prefix","destination":"/news/","status_code":301}'
{
  "id": 5,
  "name": "",
  "status": "open",
  "source": "/old-news/",
  "match_type": "prefix",
  "destination": "/news/",
  "status_code": 301,
  "trigger": "not_found_only",
  "query": "pass",
  "scope": "local",
  "sort": 1,
  "created_datetime": "2026-11-12T14:00:00+09:00",
  "updated_datetime": "2026-11-12T14:00:00+09:00",
  "blog_id": 1,
  "links": { "self": "https://example.com/rest-api/acms/v1/redirects/5/", "blog": "https://example.com/rest-api/acms/v1/blogs/1/" }
}

省略したときの値は、match_type が exact、status_code が 301、trigger が not_found_only、query が pass、scope が local、status が open です。並べ替えは POST /redirects/reorder に {"ids":[...]}(URL のブログのすべてのルールの ID を照合する順に)を送ります。

監査ログ

スコープは audit-logs:read で、ルートブログの管理者だけが読めます。既定では DEBUG を含めず、新しい順です。

# REST API の失敗だけを、あるトークンで絞り込む
curl -s -G "${ACMS_API}/audit-logs/" -H "Authorization: Bearer ${ACMS_API_TOKEN}" \
  --data-urlencode "channel=rest" \
  --data-urlencode "status=failure" \
  --data-urlencode "api_token_id=25" \
  --data-urlencode "start=2026-11-01" \
  --data-urlencode "fields=id,datetime,level_name,message,http_status,route"
{
  "items": [
    { "id": 2588, "datetime": "2026-11-12T13:53:40+09:00", "level_name": "NOTICE", "message": "REST API の認可に失敗しました", "http_status": "403", "route": "acms/v1.entries.update" }
  ],
  "meta": { "total": 1, "page": 1, "limit": 20, "last_page": 1 },
  "links": { "...": "..." }
}

絞り込みのクエリは keyword(メッセージの部分一致)・start・end・user_id・level(DEBUG・INFO・NOTICE・WARNING・ERROR・CRITICAL・ALERT・EMERGENCY をカンマ区切り)・channel(rest・mcp・other)・status(success・failure・2xx・403 など)・api_token_id・oauth_client_id・oauth_grant_id・route(GET /routes の name)・order です。要素の主な項目は、datetime・level_name・message・user_id・method・url・http_status・ip_address・user_agent・channel・api_token_id・route・context(使ったトークンの名前などを含む)です。URL などはマスクして返します。

キャッシュのクリアと、登録済みのルート

# ページキャッシュとテンプレートキャッシュを消す(cache:write。編集者以上)
curl -s -i -X POST "${ACMS_API}/cache/clear/" -H "Authorization: Bearer ${ACMS_API_TOKEN}"
# HTTP/2 204

# 登録済みのルートの一覧(診断用。URL のブログの管理者だけ。スコープ不要)
curl -s "${ACMS_API}/routes/?limit=100" -H "Authorization: Bearer ${ACMS_API_TOKEN}"

ルートの要素は、name(例: acms/v1.entries.show)・namespace・method・path・description・scope・has_request_body・has_response_body・mcp・middleware です。キャッシュのクリアの ?dry_run=1 は、権限を確かめるだけでキャッシュは消しません。

よくある質問・つまずき

ユーザーの mail が応答にありません

mail は、本人と URL のブログの管理者のトークンにだけ返します。それ以外ではキーごとありません。

ユーザーをパスワード付きで作れますか

作れません。pass は受け付けません(400)。作成したユーザーに、パスワードの再設定で設定してもらってください。

Webhook の url を確かめたい

送信先は認証情報として扱うため、REST API では返しません。管理画面で確かめてください。

監査ログで INFO が取得できません

Professional 未満のエディションでは、INFO のログは単体の取得でも 404 です。