---
title: "listSubAccounts"
slug: "gov-iam-v2-sub-account-listsubaccounts"
updated: 2026-10-22T10:47:34Z
published: 2026-10-22T10:47:34Z
canonical: "api-gov.ncloud-docs.com/gov-iam-v2-sub-account-listsubaccounts"
---

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

# listSubAccounts

이 가이드는 API 명세를 기반으로 자동 생성했습니다.

Classic/VPC 환경에서 이용 가능합니다.

Ncloud API 표준 규격을 적용한 API입니다.

인증된 계정에 속한 서브 계정 목록을 페이지 단위로 반환. 지원되는 필드로 정렬할 수 있습니다. 목록 항목은 탐색에 필요한 필드(subAccountId·nrn·loginId·name·consoleAccessible·apiGatewayAccessible·active·createdDateTime·lastLoginDateTime)만 담으며, 이메일·메모·접근 허용 IP/소스·그룹·정책 등 상세 정보는 GET /sub-accounts/{subAccountId}로, 태그는 GET /sub-accounts/{subAccountId}/tags로 조회합니다.

## 요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

| 메서드 | URI |
| --- | --- |
| GET | /sub-accounts |

### 요청 헤더

Sub Account API에서 공통으로 사용하는 헤더에 대한 정보는 [Sub Account 요청 헤더](/docs/gov-iam-v2-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오.

### 요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `pageNo` | Integer (int32) | Optional | 페이지 번호. 0부터 시작 - 범위: 0 ~ - 기본값: 0 - <예시> 0 |
| `pageSize` | Integer (int32) | Optional | 페이지당 항목 수 - 범위: 1 ~ 100 - 기본값: 20 - <예시> 20 |
| `sort` | List<String> | Optional | 정렬 조건. 형식은 property,(asc\|desc)이며, loginId, name, createdDateTime를 지원 값이 고유하지 않은 정렬 키를 사용하면 동일한 값을 가진 항목 사이의 순서는 보장되지 않음 - 기본값: `[&quot;createdDateTime,desc&quot;]` - <예시> `[&quot;createdDateTime,desc&quot;]` |

### 요청 예시

요청 예시는 다음과 같습니다.

```
curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v2/sub-accounts' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## 응답

응답 형식을 설명합니다.

### 응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `subAccounts` | List<[SubAccountListItem](/docs/gov-iam-v2-sub-account-listsubaccounts#SubAccountListItem)> | - | 현재 페이지의 서브 계정 목록. 목록 탐색에 필요한 요약 필드만 반환하며, 이메일·메모·접근 허용 IP/소스·그룹·정책 등 상세 정보는 GET /sub-accounts/{subAccountId}로, 태그는 GET /sub-accounts/{subAccountId}/tags로 조회 |
| `totalElements` | Integer (int64) | - | 조건에 맞는 전체 항목 수 - <예시> 150 |
| `totalPages` | Integer (int32) | - | 전체 페이지 수 - <예시> 8 |
| `pageNo` | Integer (int32) | - | 현재 페이지 번호. 0부터 시작 - <예시> 0 |
| `pageSize` | Integer (int32) | - | 페이지당 항목 수 - <예시> 20 |

#### SubAccountListItem

서브 계정 목록 항목. 목록 탐색에 필요한 필드(식별자·로그인 아이디·이름·콘솔/API Gateway 접근 여부·상태·생성 일시·최종 접속 일시)만 담으며, 이메일·메모·접근 허용 IP/소스·그룹·정책 등 상세 정보는 GET /sub-accounts/{subAccountId}로, 태그는 GET /sub-accounts/{subAccountId}/tags로 조회

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `subAccountId` | String (uuid) | - | 서브 계정의 식별자 - <예시> 4e066e50-9c3a-11e7-8a66-1e5021fa7c80 |
| `loginId` | String | - | 서브 계정의 로그인 아이디 - <예시> myloginid01 |
| `name` | String | - | 서브 계정의 표시 이름 - <예시> 홍길동 |
| `consoleAccessible` | Boolean | - | 콘솔 접근 허용 여부 - `true` \| `false` - `true`: 서브 계정의 관리 콘솔 접근 가능 - `false`: 관리 콘솔 접근 불가 - <예시> true |
| `apiGatewayAccessible` | Boolean | - | API Gateway 접근 허용 여부 - `true` \| `false` - `true`: 액세스 키를 생성해 API Gateway에 등록된 API 사용 가능 - `false`: API Gateway에 등록된 API 사용 불가 - <예시> false |
| `active` | Boolean | - | 서브 계정 활성화 상태 - `true` \| `false` - `true`: 서브 계정이 활성 상태 - `false`: 서브 계정이 비활성 상태여서 로그인·API 호출 불가 - <예시> true |
| `createdDateTime` | String (date-time) | - | 서브 계정이 생성된 일시 - <예시> 2024-01-01T00:00:00Z |
| `lastLoginDateTime` | String (date-time) | - | 서브 계정이 마지막으로 로그인한 일시 - <예시> 2024-01-01T00:00:00Z |
| `nrn` | String | - | 서브 계정의 NRN(Ncloud Resource Name) - <예시> nrn:GOV:IAM::25000000:SubAccount/4e066e50-9c3a-11e7-8a66-1e5021fa7c80 |

### 응답 상태 코드

Sub Account API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Sub Account 응답 상태 코드](/docs/gov-iam-v2-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오.

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

| HTTP 상태 코드 | 코드 | 메시지 | 설명 |
| --- | --- | --- | --- |
| 200 | - | - | 조건에 맞는 서브 계정 목록을 페이지 단위로 반환 |
| 400 | BadRequest | The request is malformed or contains an error such as an invalid parameter value or a missing required parameter. | 유효하지 않은 요청. pageNo/pageSize 범위 위반, 지원하지 않는 sort 속성 등 쿼리 파라미터 검증 실패 |
| 403 | Forbidden | You do not have sufficient permissions to perform this action. | 요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환 |

### 응답 예시

응답 예시는 다음과 같습니다.

```
{
  "subAccounts": [
    {
      "subAccountId": "4e066e50-9c3a-11e7-8a66-1e5021fa7c80",
      "loginId": "myloginid01",
      "name": "홍길동",
      "consoleAccessible": true,
      "apiGatewayAccessible": false,
      "active": true,
      "createdDateTime": "2024-01-01T00:00:00Z",
      "lastLoginDateTime": "2024-01-01T00:00:00Z",
      "nrn": "nrn:GOV:IAM::25000000:SubAccount/4e066e50-9c3a-11e7-8a66-1e5021fa7c80"
    }
  ],
  "totalElements": 150,
  "totalPages": 8,
  "pageNo": 0,
  "pageSize": 20
}
```