サービスのロールの一覧を取得できるAPIです。
リクエストの際に必要な認証キーです。
マネジメントAPIの権限で「ロールの取得(一覧・詳細)」を有効にして、リクエストヘッダーに含めて送信してください。
X-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「APIキー(APIの認証と権限管理)」をご覧ください。
取得するロールの件数を指定してください。
省略した場合、または0以下の整数を指定した場合は、デフォルト値の10として扱われます。
100より大きい値や、整数として解釈できない値を指定した場合は、400 レスポンスが返却されます。
ページネーションに利用するトークンを指定してください。
レスポンスに含まれるtokenの値を次のリクエストに指定することで、続きのデータを取得できます。
前回のレスポンスに含まれるtokenの値を、クエリパラメータtokenに指定します。
curl -H 'X-MICROCMS-API-KEY: [APIキー]' 'https://[サービスID].microcms-management.io/api/v1/roles?limit=10&token=[トークン]'正常に取得できた場合は、以下のようなレスポンスが返却されます。
{
"roles": [
{
"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"
},
{
...
}
],
"totalCount": 5,
"token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}レスポンスには以下のデータが含まれます。
ロールの配列です。管理画面のロール一覧と同じ順序で返却されます。
各ロールオブジェクトの内容は、「GET /api/v1/roles/{role_id}」のレスポンスと同じです。
ロールの全件数です。
ページネーションに利用するトークンです。
返却された値を次のリクエストのクエリパラメータ token に指定してください。レスポンスに token が含まれなくなるまで繰り返すことで、すべてのロールを取得できます。
なお、token を指定したリクエストでも、取得結果が空配列になる場合があります。
ステータスコード | 条件 |
|---|---|
|
|
| 複数環境機能で作成した環境に対してリクエストした場合 |
その他のエラーについては、「マネジメントAPIのエラーレスポンス」をご覧ください。