microCMS
ドキュメント
  • 料金プラン
  • ブログ
  • よくある質問
  • お問い合わせ
  • ログイン
  • 無料ではじめる
ナビゲーション
チュートリアル
Next.js
  • Next.jsとの連携
  • Getting Started(App Router)
  • チュートリアル(App Router)
  • Getting Started(Pages Router)
  • チュートリアル(Pages Router)
Astro
  • Astroとの連携
  • Getting Started
  • チュートリアル
Nuxt
  • Nuxtとの連携
  • Getting Started
  • チュートリアル
Gatsby
  • Gatsbyとの連携
  • Getting Started
  • チュートリアル
JavaScript
  • JavaScriptとの連携
  • Getting Started(ブラウザ)
  • Getting Started(サーバー)
PHP
  • PHPとの連携
  • Getting Started
Ruby
  • Rubyとの連携
  • Getting Started
Go
  • Goとの連携
  • Getting Started
操作マニュアル
  • はじめに
アカウントとログイン
  • アカウント登録
  • ログイン
  • メールアドレス認証をする
サービス
  • サービスの作成
  • サービス設定
  • テンプレート
  • サービスの削除
お支払い
  • 料金プランの変更
  • 決済方法の登録と変更
API
  • APIの作成・管理
  • API設定
  • APIスキーマのエクスポート/インポート
フィールド
  • テキストフィールド
  • テキストエリア
  • 画像
  • 複数画像
  • 日時
  • 真偽値
  • セレクトフィールド
  • コンテンツ参照
  • 複数コンテンツ参照
  • 数字
  • ファイル
  • カスタム
  • 繰り返し
  • 拡張フィールド
コンテンツ
  • コンテンツの作成
  • コンテンツの編集
  • コンテンツ管理
  • ビュー
  • コンテンツのステータス
  • カスタムステータス
  • コンテンツIDの設定
  • コンテンツに自動付与される値
  • コンテンツのCSVエクスポート
  • コンテンツのCSVインポート
  • APIプレビュー
  • APIプレビューを活用したクエリパラメータの利用例
  • レンダリング方式ごとの組み込み方法
  • 画面プレビュー
  • コンテンツのWebhookを設定
リッチエディタ
  • リッチエディタの操作方法
  • リッチエディタのWRITE API
  • 旧リッチエディタの操作方法
レビュー機能
  • レビュー
  • AIレビュー
メディア
  • メディア管理
  • メディアのフィルター・表示順の変更
  • メディアのタグ設定
  • メディアのWebhookを設定
  • メディアのカスタムドメイン設定
権限管理
  • メンバーの管理
  • ロール(管理画面の権限管理)
複数環境
  • 複数環境(開発環境)
  • 環境間のAPI設定のマージ
外部連携
  • Amazon S3連携
データログ
  • 監査ログ
  • データ転送量
セキュリティ
  • コンテンツの更新履歴
  • 管理画面のIP制限
  • APIのIP制限
認証設定
  • 2要素認証の設定
  • 2要素認証の必須化
  • シングルサインオン
仕様・制限事項
  • 推奨環境
  • 制限事項/注意事項
コンテンツAPI
  • コンテンツAPIとは
基本操作
  • GET /api/v1/{endpoint}
  • GET /api/v1/{endpoint}/{content_id}
  • POST /api/v1/{endpoint}
  • PUT /api/v1/{endpoint}/{content_id}
  • PATCH /api/v1/{endpoint}/{content_id}
  • DELETE /api/v1/{endpoint}/{content_id}
APIキー
  • APIキー(APIの認証と権限管理)
  • 旧API(X-API-KEYなど)からの移行
レスポンスとエラー処理
  • GET APIのフィールドごとのレスポンス形式
  • GET APIにおけるクエリパラメータの指定
  • コンテンツAPIのエラーレスポンス
マネジメントAPI(ベータ)
  • マネジメントAPIとは
コンテンツ操作
  • GET /api/v1/contents/{endpoint}
  • GET /api/v1/contents/{endpoint}/{content_id}
  • PATCH /api/v1/contents/{endpoint}/{content_id}/status
  • PATCH /api/v1/contents/{endpoint}/{content_id}/createdBy
  • PUT /api/v1/contents/{endpoint}/{content_id}/reservation
メディア操作
  • GET /api/v2/media
  • GET /api/v1/media
  • POST /api/v1/media
  • DELETE /api/v2/media
メンバー操作
  • GET /api/v1/members
  • GET /api/v1/members/{member_id}
  • PATCH /api/v1/members/{member_id}
API操作
  • GET /api/v1/apis
  • GET /api/v1/apis/{endpoint}
  • POST /api/v1/apis
ロール操作
  • GET /api/v1/roles
  • GET /api/v1/roles/{role_id}
  • POST /api/v1/roles
  • PATCH /api/v1/roles/{role_id}
  • DELETE /api/v1/roles/{role_id}
サービス操作
  • GET /api/v1/service
レスポンスとエラー処理
  • マネジメントAPIのエラーレスポンス
画像API
  • 画像APIとは
主なパラメータ
  • 画像サイズ
  • 品質
  • 解像度・画面サイズ
  • フォーマット
  • テキスト
  • 枠線
  • パディング
  • 形状
  • ダウンロード
  • ウォーターマーク
MCPサーバー
  • microCMS MCP
  • microCMS Document MCP Server
  • トップ
  • マネジメントAPI(ベータ)

PATCH /api/v1/members/{member_id}

最終更新日: 2026/11/17

メンバーに付与されているロールを更新するAPIです。

リクエストヘッダー

X-MICROCMS-API-KEY

リクエストの際に必要な認証キーです。
マネジメントAPIの権限で「メンバーのロールを変更」を有効にして、リクエストヘッダーに含めて送信してください。

Caution

X-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「APIキー(APIの認証と権限管理)」をご覧ください。

Content-Type

送信するデータの形式を指定します。
microCMSではJSON形式のデータのみ扱っているため、application/json と指定してください。

パスパラメータ

member_id

更新するメンバーのIDを指定してください。
メンバーIDは、管理画面の各メンバーの詳細ページもしくは、メンバー情報取得API(一覧、詳細)のレスポンスから確認できます。

リクエストボディ

更新後にメンバーへ付与するロールを指定します。
ロールIDは、ロール一覧取得API(GET /api/v1/roles)のレスポンスの roles[].id から確認可能です。現在のメンバーに付与されているロールIDは、メンバー取得APIのレスポンスの roleIds で確認できます。

プロパティ

型

指定要否

説明

roleIds

array

必須

更新後に付与するロールIDの配列です。対象サービスに存在するロールIDを、文字列の配列で1件以上指定してください。空の配列([])や同じIDの重複は指定できません。

付与済みのロールは、送信した 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で返却される主なエラーは以下のとおりです。

ステータスコード

条件

400

リクエストボディが不正な場合(roleIds の欠落、null、型の不一致、未定義のプロパティなど)

400

roleIds が空の配列、同じロールIDが重複、または指定できる形式ではないロールIDを含む場合

400

指定したロールが対象サービスに存在しない場合(別サービスのロールを含む)

403

複数環境機能で作成した環境に対してリクエストした場合

404

指定したメンバーが対象サービスに存在しない場合

409

招待中のメンバーを指定した場合

409

更新後に、管理者ロールを持つ参加済みメンバーが対象サービスに1人もいなくなる場合

413

リクエストボディのサイズが1MiBを超える場合

エラーの詳細は、レスポンスボディの message で確認できます。例えば、roleIds に空の配列を指定した場合は、次のようなレスポンスが返却されます。

{
  "message": "\"roleIds\" must not be empty"
}

その他のエラーについては、「マネジメントAPIのエラーレスポンス」をご覧ください。

制約事項

更新できないメンバー・ロール設定

招待中のメンバーに付与されているロールは更新できません。
更新後も、参加済みの管理者が1人以上残る必要があります。招待中のメンバーは、管理者の人数に含まれません。

複数環境での利用

複数環境機能で作成した環境へのリクエストには対応していません。
親サービスでメンバーに付与するロールを変更しても、子環境のメンバーに付与されているロールには反映されません。

同時更新

同じメンバーを同時に更新すると、最後に保存されたロール設定が適用されます。
ロールの削除および更新は、同時に実行せず、順番に実行してください。
複数の管理者から管理者ロールを同時に外すと、参加済みの管理者がいなくなる可能性があります。管理者ロールを外す操作も、順番に実行してください。

目次

  • リクエストヘッダー
  • X-MICROCMS-API-KEY
  • Content-Type
  • パスパラメータ
  • member_id
  • リクエストボディ
  • リクエスト例
  • レスポンス
  • ステータスコード
  • レスポンスボディ
  • エラーレスポンス
  • 制約事項
  • 更新できないメンバー・ロール設定
  • 複数環境での利用
  • 同時更新
  • 運営会社
  • 特定商取引法に基づく表記
  • 利用規約
  • プライバシーポリシー

Copyright © microcms.io All rights reserved.