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/roles/{role_id}

最終更新日: 2026/11/17

サービスのロールを更新するAPIです。

リクエストヘッダー

X-MICROCMS-API-KEY

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

Caution

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

Content-Type

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

パスパラメータ

role_id

更新するロールのIDを指定してください。
ロールIDは、ロール一覧取得APIのレスポンスのidから確認可能です。

リクエストボディ

更新する項目を指定します。
nameとpermissionsはどちらも任意ですが、少なくとも一方を指定してください。指定しなかった項目は変更されません。

プロパティ

型

指定要否

説明

name

string

任意

ロール名です。1〜100文字で指定します。

permissions

object

任意

ロールの権限設定です。指定した場合は、権限設定全体を置き換えます。defaultPermissionsとindividualPermissionsの両方を指定します。形式や各キーの指定方法については、「POST /api/v1/roles」のpermissionsをご覧ください。

未定義のプロパティや、isAdmin・id・createdAt・updatedAt を指定した場合は、400 レスポンスが返却されます。

Information

permissions は、一部の権限だけを更新することはできません。送信した内容で権限設定全体が置き換わり、送信しなかった個別権限は削除されます。
個別権限をすべて削除する場合は、individualPermissions に空の配列([])を指定してください。

リクエスト例

ロール名のみを更新する場合

curl -X PATCH 'https://[サービスID].microcms-management.io/api/v1/roles/[ロールID]' \
  -H 'X-MICROCMS-API-KEY: [APIキー]' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "コンテンツ編集者(改)" }'

現在の権限設定の一部を変更する場合

以下は、ロール詳細取得APIで取得した現在の権限設定をもとに、お支払い設定画面へのアクセス権限(billing.read)を有効にする例です。
この例では、APIキーのマネジメントAPI権限で「ロールの取得 (一覧・詳細)」と「ロールの更新」を有効にしてください。

1. 現在のロール情報を取得する

curl -H 'X-MICROCMS-API-KEY: [APIキー]' \
  'https://[サービスID].microcms-management.io/api/v1/roles/[ロールID]'


2. リクエストボディを用意する
取得に成功したことを確認し、レスポンスのpermissionsをコピーします。defaultPermissions.billing.readをtrueに変更し、変更後のpermissionsを次の形式でrole.jsonに保存します。

{
  "permissions": 取得して編集した権限設定
}

実際のファイルには、取得したpermissionsオブジェクト全体を指定してください。維持したい個別権限も含めます。idやisAdminなど、レスポンスのその他のプロパティは含めないでください。

3. 更新する

curl -X PATCH 'https://[サービスID].microcms-management.io/api/v1/roles/[ロールID]' \
  -H 'X-MICROCMS-API-KEY: [APIキー]' \
  -H 'Content-Type: application/json' \
  -d @role.json

レスポンス

ステータスコード

正常にロールを更新できた場合は、200レスポンスが返却されます。
エラー時のステータスコードについては、「エラーレスポンス」をご覧ください。

レスポンスボディ

正常にロールを更新できた場合は、以下のようなレスポンスが返却されます。
形式は「GET /api/v1/roles/{role_id}」のレスポンスと同じです。

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "コンテンツ編集者(改)",
  "isAdmin": false,
  "permissions": {
    "defaultPermissions": { ... },
    "individualPermissions": [ ... ]
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-02T00:00:00.000Z"
}

エラーレスポンス

本APIで返却される主なエラーは以下のとおりです。

ステータスコード

条件

400

UUID形式ではないロールID(英大文字を含むUUIDを含む)を指定した場合

400

nameとpermissionsのどちらも指定しなかった場合

400

リクエストボディが不正な場合(defaultPermissions・individualPermissionsの片方のみの指定、必須キーの不足、null、型の不一致、未定義のプロパティ、levelに指定できない値など)

400

存在しないメンバー・環境・APIを指定した場合(招待中のメンバー、他のサービスのメンバーや環境を含む)

403

管理者ロールを指定した場合

403

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

404

サービスに存在しないロールを指定した場合

413

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

エラーの詳細は、レスポンスボディのmessageで確認できます。
たとえば、nameとpermissionsのどちらも指定しなかった場合は、次のようなレスポンスが返却されます。

{ "message": "Either \"name\" or \"permissions\" is required" }

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

制約事項

更新できないロール

管理者ロールは更新できません。

複数環境での利用

複数環境機能で作成した環境へのリクエストには対応していません。

目次

  • リクエストヘッダー
  • X-MICROCMS-API-KEY
  • Content-Type
  • パスパラメータ
  • role_id
  • リクエストボディ
  • リクエスト例
  • ロール名のみを更新する場合
  • 現在の権限設定の一部を変更する場合
  • レスポンス
  • ステータスコード
  • レスポンスボディ
  • エラーレスポンス
  • 制約事項
  • 更新できないロール
  • 複数環境での利用
  • 運営会社
  • 特定商取引法に基づく表記
  • 利用規約
  • プライバシーポリシー

Copyright © microcms.io All rights reserved.