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(ベータ)

GET /api/v1/roles/{role_id}

最終更新日: 2026/11/17

任意のロールの詳細情報を取得できるAPIです。

リクエストヘッダー

X-MICROCMS-API-KEY

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

Caution

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

パスパラメータ

role_id

取得するロールのIDを指定してください。
ロールIDは、ロール一覧取得APIのレスポンスのidから確認可能です。なお、ROLE# の接頭辞は不要です。

レスポンス

ステータスコード

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

レスポンスボディ

正常に取得できた場合は、以下のようなレスポンスが返却されます。

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

レスポンスには以下のデータが含まれます。

値

説明

id

ロールのIDです。

name

ロール名です。

isAdmin

管理者ロールかどうかを示します。
true:管理者ロール、false:管理者ロール以外

permissions

defaultPermissions

デフォルト権限の設定です。

individualPermissions

API個別権限の設定です。
APIごとの権限設定の配列で、未設定の場合は空の配列([])となります。

createdAt

ロールの作成日時です。

updatedAt

ロールの更新日時です。

permissionsには、管理画面のロール設定画面に表示される内容と同じ権限設定が返却されます。
管理者ロールの場合は、すべての権限が有効な状態で返却され、individualPermissionsは常に空の配列([])となります。

権限の詳細

permissions 内の各キーの内容は以下のとおりです。説明欄は、管理画面のロール設定画面での項目名に対応しています。
キー列は、JSONの階層ごとに列を分けて表示しています。左の列から順に「.」でつなげたものが、実際のキーになります。
例:members → read → level は members.read.level を表し、レスポンスでは次のようになります。

"members": {
  "read": {
    "level": "ALL"
  }
}

defaultPermissions(デフォルト権限)

キー

型

説明

members

read

level

string

メンバーの読み取り権限
・ALL:すべてのメンバー
・SAME_ROLE:このロールが付与されているメンバー
・SPECIFIC:任意のメンバーのみ
・NONE:なし

memberIds

array

閲覧できるメンバーのID
members.read.levelがSPECIFICの場合のみ返却されます。
メンバーが指定されていない場合は空の配列([])となります。

create

boolean

メンバーの招待

update

boolean

メンバーに紐づくロールの変更

delete

boolean

メンバーの削除

roles

read

level

string

ロールの読み取り権限
・ALL:すべてのロール
・SAME_ROLE:自分が所属するロールのみ
・NONE:なし

create

boolean

ロールの作成

update

boolean

権限内容の変更

delete

boolean

ロールの削除

billing

read

boolean

お支払い設定画面へのアクセス

update

boolean

プランの変更とクレジットカードの変更

apiKeys

read

boolean

APIキー設定画面へのアクセス

usage

read

boolean

利用量確認
(データ転送量確認画面とAPIリクエスト数確認画面へのアクセス)

environments

read

level

string

環境の読み取り権限
・ALL:すべての環境
・URL_ONLY:URLを知っている環境のみ(非推奨)
・RESTRICTED:任意の環境のみ
・NONE:なし

serviceIds

array

閲覧できる環境のサービスID
environments.read.levelがRESTRICTEDの場合のみ返却されます。

create

boolean

環境の作成

delete

boolean

環境の削除

reviews

object

レビューに関する権限
詳細は「reviewsの詳細」をご覧ください。

media

read

level

string

メディアの読み取り権限
・ALL:すべてのメディア
・SAME_ROLE:このロールのメンバーが作成したメディアのみ
・CREATED:自分がアップロードしたメディアのみ
・NONE:なし

create

boolean

アップロード

update

boolean

ファイル名 / 代替テキストの編集
再アップロード / メディアタグのセット

delete

boolean

メディアの削除

api

read

boolean

APIの読み取り
(サイドバーの表示やコンテンツ参照など)

create

boolean

APIの作成

update

boolean

API設定全般と
カスタムフィールドの作成 / 編集 / 削除

delete

boolean

APIの削除

content

object

コンテンツに関する権限
詳細は「contentの詳細」をご覧ください。

developerMenu

read

boolean

開発者向け設定の表示

individualPermissions(個別権限)

API単位で設定された個別権限の配列です。個別権限が設定されていない場合は空の配列([])となります。
配列の各要素は以下のとおりです。

キー

型

説明

apiId

string

対象APIのエンドポイント

api

read

boolean

APIの読み取り
(サイドバーの表示やコンテンツ参照など)

update

boolean

API設定全般と
カスタムフィールドの作成 / 編集 / 削除

delete

boolean

APIの削除

content

object

コンテンツに関する権限
詳細は「contentの詳細」をご覧ください。

developerMenu

read

boolean

開発者向け設定の表示

reviews

object

レビューに関する権限
詳細は「reviewsの詳細」をご覧ください。

contentの詳細

defaultPermissions.contentとindividualPermissions[].contentで共通です。

キー

型

説明

read

level

string

コンテンツの読み取り権限
・ALL:すべてのコンテンツ
・SAME_ROLE:このロールのメンバーが作成したコンテンツのみ
・CREATED:自分が作成したコンテンツのみ
・NONE:なし

create

draft

boolean

下書き保存

publish

boolean

公開

update

saveDraft

boolean

下書き保存

removeDraft

boolean

下書きの破棄

revertToDraftUnpublished

boolean

非公開コンテンツを下書きに戻す

changeContentIdUnpublished

boolean

非公開コンテンツのコンテンツID変更

reorderUnpublished

boolean

非公開コンテンツの並び替え

changePublicationDateUnpublished

boolean

非公開コンテンツの公開日時の変更

changeAuthor

boolean

コンテンツ作成者の変更

changeDraftKey

boolean

draftKeyの変更

publish

boolean

未承認のコンテンツを公開 / 公開予約

publishApproved

boolean

承認済みのコンテンツを公開 / 公開予約

unpublish

boolean

未承認のコンテンツを公開終了 / 公開終了予約

unpublishApproved

boolean

承認済みのコンテンツを公開終了 / 公開終了予約

revertToDraft

boolean

公開中コンテンツを下書きに戻す

changeContentIdPublished

boolean

公開中コンテンツのコンテンツID変更

reorderPublished

boolean

公開中コンテンツの並び替え

changePublicationDatePublished

boolean

公開中コンテンツの公開日時の変更

delete

boolean

コンテンツの削除

reviewsの詳細

defaultPermissions.reviewsとindividualPermissions[].reviewsで共通です。

キー

型

説明

read

level

string

レビュー申請の読み取り権限
・ALL:すべてのレビュー申請
・SAME_ROLE:このロールのメンバーが作成したレビューのみ
・CREATED:自分が作成したレビュー申請のみ
・NONE:なし

create

boolean

レビュー申請

update

level

string

レビュー申請の編集権限
・ALL:承認 + 編集
・EDIT:編集
・NONE:なし

エラーレスポンス

ステータスコード

条件

400

UUID形式ではないロールIDを指定した場合

403

子環境に対してリクエストした場合

404

存在しないロールを指定した場合

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

制約事項

複数環境での利用

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

目次

  • リクエストヘッダー
  • X-MICROCMS-API-KEY
  • パスパラメータ
  • role_id
  • レスポンス
  • ステータスコード
  • レスポンスボディ
  • エラーレスポンス
  • 制約事項
  • 複数環境での利用
  • 運営会社
  • 特定商取引法に基づく表記
  • 利用規約
  • プライバシーポリシー

Copyright © microcms.io All rights reserved.