任意のロールの詳細情報を取得できるAPIです。
リクエストの際に必要な認証キーです。
マネジメントAPIの権限で「ロールの取得(一覧・詳細)」を有効にして、リクエストヘッダーに含めて送信してください。
X-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「APIキー(APIの認証と権限管理)」をご覧ください。
正常に取得できた場合は、以下のようなレスポンスが返却されます。
{
"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です。 | |
| ロール名です。 | |
| 管理者ロールかどうかを示します。 | |
|
| デフォルト権限の設定です。 |
| API個別権限の設定です。 | |
| ロールの作成日時です。 | |
| ロールの更新日時です。 | |
permissionsには、管理画面のロール設定画面に表示される内容と同じ権限設定が返却されます。
管理者ロールの場合は、すべての権限が有効な状態で返却され、individualPermissionsは常に空の配列([])となります。
permissions 内の各キーの内容は以下のとおりです。説明欄は、管理画面のロール設定画面での項目名に対応しています。
キー列は、JSONの階層ごとに列を分けて表示しています。左の列から順に「.」でつなげたものが、実際のキーになります。
例:members → read → level は members.read.level を表し、レスポンスでは次のようになります。
"members": {
"read": {
"level": "ALL"
}
}キー | 型 | 説明 | ||
|---|---|---|---|---|
|
|
| string | メンバーの読み取り権限 |
| array | 閲覧できるメンバーのID | ||
| boolean | メンバーの招待 | ||
| boolean | メンバーに紐づくロールの変更 | ||
| boolean | メンバーの削除 | ||
|
|
| string | ロールの読み取り権限 |
| boolean | ロールの作成 | ||
| boolean | 権限内容の変更 | ||
| boolean | ロールの削除 | ||
|
| boolean | お支払い設定画面へのアクセス | |
| boolean | プランの変更とクレジットカードの変更 | ||
|
| boolean | APIキー設定画面へのアクセス | |
|
| boolean | 利用量確認 | |
|
|
| string | 環境の読み取り権限 |
| array | 閲覧できる環境のサービスID | ||
| boolean | 環境の作成 | ||
| boolean | 環境の削除 | ||
| object | レビューに関する権限 | ||
|
|
| string | メディアの読み取り権限 |
| boolean | アップロード | ||
| boolean | ファイル名 / 代替テキストの編集 | ||
| boolean | メディアの削除 | ||
|
| boolean | APIの読み取り | |
| boolean | APIの作成 | ||
| boolean | API設定全般と | ||
| boolean | APIの削除 | ||
| object | コンテンツに関する権限 | ||
|
| boolean | 開発者向け設定の表示 | |
API単位で設定された個別権限の配列です。個別権限が設定されていない場合は空の配列([])となります。
配列の各要素は以下のとおりです。
キー | 型 | 説明 | |
|---|---|---|---|
| string | 対象APIのエンドポイント | |
|
| boolean | APIの読み取り |
| boolean | API設定全般と | |
| boolean | APIの削除 | |
| object | コンテンツに関する権限 | |
|
| boolean | 開発者向け設定の表示 |
| object | レビューに関する権限 | |
defaultPermissions.contentとindividualPermissions[].contentで共通です。
キー | 型 | 説明 | |
|---|---|---|---|
|
| string | コンテンツの読み取り権限 |
|
| boolean | 下書き保存 |
| boolean | 公開 | |
|
| boolean | 下書き保存 |
| boolean | 下書きの破棄 | |
| boolean | 非公開コンテンツを下書きに戻す | |
| boolean | 非公開コンテンツのコンテンツID変更 | |
| boolean | 非公開コンテンツの並び替え | |
| boolean | 非公開コンテンツの公開日時の変更 | |
| boolean | コンテンツ作成者の変更 | |
| boolean | draftKeyの変更 | |
| boolean | 未承認のコンテンツを公開 / 公開予約 | |
| boolean | 承認済みのコンテンツを公開 / 公開予約 | |
| boolean | 未承認のコンテンツを公開終了 / 公開終了予約 | |
| boolean | 承認済みのコンテンツを公開終了 / 公開終了予約 | |
| boolean | 公開中コンテンツを下書きに戻す | |
| boolean | 公開中コンテンツのコンテンツID変更 | |
| boolean | 公開中コンテンツの並び替え | |
| boolean | 公開中コンテンツの公開日時の変更 | |
| boolean | コンテンツの削除 | |
defaultPermissions.reviewsとindividualPermissions[].reviewsで共通です。
キー | 型 | 説明 | |
|---|---|---|---|
|
| string | レビュー申請の読み取り権限 |
| boolean | レビュー申請 | |
|
| string | レビュー申請の編集権限 |
ステータスコード | 条件 |
|---|---|
| UUID形式ではないロールIDを指定した場合 |
| 子環境に対してリクエストした場合 |
| 存在しないロールを指定した場合 |
その他のエラーについては、「マネジメントAPIのエラーレスポンス」をご覧ください。