---
title: "ロールリストの照会"
slug: "management-subaccount-getroles"
tags: ["Sub Account"]
updated: 2026-09-17T09:58:05Z
published: 2026-09-17T09:58:05Z
canonical: "api.ncloud-docs.com/management-subaccount-getroles"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ロールリストの照会

Classic/VPC環境で利用できます。

ロールリストを照会します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET | /api/v1/roles |

### リクエストヘッダ

Sub Account APIで共通して使用されるヘッダの詳細は、[Sub Accountのリクエストヘッダ](/docs/ja/management-subaccount#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `page` | Integer | Optional | ページ番号 - 0~N (デフォルト: 0) |
| `size` | Integer | Optional | ページの出力数 - 1~N (デフォルト: 10) |
| `searchColumn` | String | Optional | 検索カラム - `roleName` \| `roleType` \| `nrn` - `roleName`: ロール名 - `roleType`: ロールタイプ - `nrn`: ロールに対する NAVERクラウドプラットフォームリソースの識別値 |
| `searchWord` | String | Optional | 検索キーワード |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/roles?page=0&size=10' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `page` | Integer | - | ページ番号 |
| `totalPages` | Integer | - | ページの総数 |
| `totalItems` | Integer | - | レスポンス結果数 |
| `hasPrevious` | Boolean | - | 以前のページは存在するかどうか - `true` \| `false` - `true`: 存在する - `false`: 存在しない |
| `hasNext` | Boolean | - | 次のページは存在するかどうか - `true` \| `false` - `true`: 存在する - `false`: 存在しない |
| `items` | Array | - | ロールリスト: [items](/docs/ja/management-subaccount-getroles#items) |
| `isFirst` | Boolean | - | 最初のページかどうか - `true` \| `false` - `true`: 最初のページ - `false`: 最初のページではない |
| `isLast` | Boolean | - | 最後のページかどうか - `true` \| `false` - `true`: 最後のページ - `false`: 最後のページではない |

#### `items`

`items`の説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `nrn` | String | - | ロールに対する NAVERクラウドプラットフォームリソースの識別値 |
| `roleNo` | String | - | ロール ID |
| `roleName` | String | - | ロール名 |
| `roleType` | String | - | ロールタイプ - `Server` \| `Account` \| `Service` - `Server`: VPC環境のサーバリソースに割り当て。Access Keyなしでサービスやリソースにアクセス可能 - `Account`: メインアカウントのポータルとコンソールへのアクセス権限をサブアカウントに割り当て。ロールの切り替えにより対象アカウントのリソースにアクセス可能 - `Service`: サービスに割り当て。他のサービスのリソースにアクセス可能 |
| `sessionExpirationSec` | Integer | - | セッションタイムアウト(秒) - `600` \| `1800` \| `3600` \| `10800` |
| `descCont` | String | - | ロールの説明 |
| `active` | Boolean | - | ロールの状態 - `true` \| `false` - `true`: 有効化 - `false`: 無効化 |
| `createTime` | String | - | ロールの作成日時 - ISO 8601形式 |
| `modifiedTime` | String | - | ロールの最終更新日時 - ISO 8601形式 |
| `lastUseTime` | String | - | ロールの最終使用日時 - ISO 8601形式 |

### レスポンスステータスコード

Sub Account APIで共通して使用されるレスポンスステータスコードの詳細は、[Sub Accountのレスポンスステータスコード](/docs/ja/management-subaccount#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
  "page": 0,
  "totalPages": 1,
  "totalItems": 2,
  "hasPrevious": false,
  "hasNext": false,
  "items": [
    {
      "nrn": "nrn:PUB:IAM::5*****8:Role/76a744f0-****-****-****-246e966ebeb4",
      "roleNo": "76a744f0-****-****-****-246e966ebeb4",
      "roleName": "service1",
      "roleType": "Service",
      "descCont": "",
      "active": true,
      "createTime": "2024-12-23T02:41:51Z",
      "modifiedTime": "2024-12-24T02:25:16Z",
      "lastUseTime": "2025-01-02T01:26:02Z"
    },
    {
      "nrn": "nrn:PUB:IAM::5*****8:Role/6e1de560-****-****-****-246e966ebec4",
      "roleNo": "6e1de560-****-****-****-246e966ebec4",
      "roleName": "NcloudStorageManagementRole",
      "roleType": "NcloudStorage",
      "active": true,
      "createTime": "2024-11-07T05:23:32Z",
      "modifiedTime": "2024-11-07T05:23:32Z"
    }
  ],
  "isFirst": true,
  "isLast": true
}
```