メンバーに付与されているロールを更新するAPIです。
リクエストの際に必要な認証キーです。
マネジメントAPIの権限で「メンバーのロールを変更」を有効にして、リクエストヘッダーに含めて送信してください。
X-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「APIキー(APIの認証と権限管理)」をご覧ください。
送信するデータの形式を指定します。
microCMSではJSON形式のデータのみ扱っているため、application/json と指定してください。
プロパティ | 型 | 指定要否 | 説明 |
|---|---|---|---|
| array | 必須 | 更新後に付与するロールIDの配列です。対象サービスに存在するロールIDを、文字列の配列で1件以上指定してください。空の配列( |
付与済みのロールは、送信した roleIds の内容ですべて置き換えられます。維持したい既存のロールIDも、roleIds に含めて送信してください。
以下は、メンバーに付与するロールを、指定した2つのロールに置き換える例です。
curl -X PATCH 'https://[サービスID].microcms-management.io/api/v1/members/[メンバーID]' \
-H 'X-MICROCMS-API-KEY: [APIキー]' \
-H 'Content-Type: application/json' \
-d '{
"roleIds": [
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz"
]
}'ロールを追加する場合は、維持したい既存のロールIDと、追加するロールIDをすべて指定してください。ロールを外す場合は、維持したいロールIDのみを指定してください。
正常にロールを更新できた場合は、200レスポンスが返却されます。
エラー時のステータスコードについては、「エラーレスポンス」をご覧ください。
正常にロールを更新できた場合は、以下のようなレスポンスが返却されます。形式は、メンバー取得API(GET /api/v1/members/{member_id})のレスポンスと同じです。
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "test-member",
"email": "test@microcms.co.jp",
"roleIds": [
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz"
],
"mfa": true,
"lastAccessedAt": "2026-01-01T00:00:00.000Z"
}本APIで返却される主なエラーは以下のとおりです。
ステータスコード | 条件 |
|---|---|
| リクエストボディが不正な場合( |
|
|
| 指定したロールが対象サービスに存在しない場合(別サービスのロールを含む) |
| 複数環境機能で作成した環境に対してリクエストした場合 |
| 指定したメンバーが対象サービスに存在しない場合 |
| 招待中のメンバーを指定した場合 |
| 更新後に、管理者ロールを持つ参加済みメンバーが対象サービスに1人もいなくなる場合 |
| リクエストボディのサイズが1MiBを超える場合 |
エラーの詳細は、レスポンスボディの message で確認できます。例えば、roleIds に空の配列を指定した場合は、次のようなレスポンスが返却されます。
{
"message": "\"roleIds\" must not be empty"
}その他のエラーについては、「マネジメントAPIのエラーレスポンス」をご覧ください。
招待中のメンバーに付与されているロールは更新できません。
更新後も、参加済みの管理者が1人以上残る必要があります。招待中のメンバーは、管理者の人数に含まれません。
複数環境機能で作成した環境へのリクエストには対応していません。
親サービスでメンバーに付与するロールを変更しても、子環境のメンバーに付与されているロールには反映されません。
同じメンバーを同時に更新すると、最後に保存されたロール設定が適用されます。
ロールの削除および更新は、同時に実行せず、順番に実行してください。
複数の管理者から管理者ロールを同時に外すと、参加済みの管理者がいなくなる可能性があります。管理者ロールを外す操作も、順番に実行してください。