---
title: "Assignmentアカウントリストの照会"
slug: "get-accounts"
updated: 2026-09-17T09:58:02Z
published: 2026-09-17T09:58:02Z
canonical: "api.ncloud-docs.com/get-accounts"
---

> ## 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.

# Assignmentアカウントリストの照会

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

Assignmentに追加したアカウントリストを照会します。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| GET | /api/v1/assignments/accounts |

### リクエストヘッダ

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

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

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `searchWord` | String | Optional | 検索キーワード - URLエンコードが必要 - `accountName`と全体または一部が一致しない値を入力した場合、レスポンス時に`items`は空の値`[]`で表示 - `searchColumn`なしでリクエストする場合、全リストを表示 |
| `searchColumn` | String | Conditional | 検索カラム - `accountName`: 対象アカウント名 (有効値) - <例> `searchColumn=accountName` - 有効でない値を入力した場合、全リストを表示 |
| `page` | Integer | Optional | ページ番号 - 0~N (デフォルト: 0) |
| `size` | Integer | Optional | ページの出力数 - 1~N (デフォルト: 20) |

### リクエスト例

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

```
curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/assignments/accounts?searchColumn=accountName&searchWord=%ED%99%8D%EA%B8%B8%EB%8F%99&page=0&size=20' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## レスポンス

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

### レスポンスボディ

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

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

#### `items`

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `accountName` | String | - | アカウントのユーザー名 |
| `accountAlias` | String | - | アカウントのエイリアス |
| `accountLoginId` | String | - | アカウントログイン ID |
| `accountType` | String | - | アカウントのタイプ - `Master` \| `Member` - `Master`: マスターアカウント - `Member`: メンバーアカウント |
| `accountGroup` | String | - | アカウントグループ |
| `accountMbrNo` | Number | - | アカウントの会員番号(MemberNo) |

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

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

### レスポンス例

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

```
{
    "page": 0,
    "totalPages": 1,
    "totalItems": 1,
    "isFirst": true,
    "isLast": true,
    "hasPrevious": false,
    "hasNext": false,
    "items": [
        {
            "accountName": "田中太郎",
            "accountAlias": "-",
            "accountLoginId": "******@ncloud.com",
            "accountType": "-",
            "accountGroup": "-",
            "accountMbrNo": *******
        }
    ]
}
```