サブアカウントリストの照会

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

サブアカウントリストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/sub-accounts

リクエストヘッダ

Sub Account APIで共通して使用されるヘッダの詳細は、Sub Accountのリクエストヘッダをご参照ください。

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

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

フィールド	タイプ	必須の有無	説明
`searchColumn`	String	Optional	検索カラム `loginId` \| `name` \| `subAccountNo` `loginId`: サブアカウントログイン ID `name`: サブアカウント名 `subAccountNo`: サブアカウント番号
`searchWord`	String	Optional	検索キーワード
`page`	Integer	Optional	ページ番号 0~N (デフォルト: 0)
`size`	Integer	Optional	ページの出力数 1~N (デフォルト: 10)

リクエスト例

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

curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/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}' \
--header 'Accept: application/json'

レスポンス

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

レスポンスボディ

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

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

`items`

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

フィールド	タイプ	必須の有無	説明
`subAccountId`	String	-	サブアカウント ID
`subAccountNo`	Integer	-	サブアカウント番号
`loginId`	String	-	サブアカウントログイン ID
`name`	String	-	サブアカウントのユーザー名
`email`	String	-	サブアカウントユーザーのメールアドレス
`needPasswordReset`	Boolean	-	サブアカウントログインパスワード再設定を通知するかどうかサブアカウントで初回ログイン時にパスワード変更の案内をするかどうか `true` \| `false` `true`: 案内する `false`: 案内しない
`canAPIGatewayAccess`	Boolean	-	サブアカウントは API Gatewayにアクセス可能かどうか Access Keyを作成すると API Gatewayに登録された APIは使用可能かどうか `true` \| `false` `true`: 可能 `false`: 不可
`canConsoleAccess`	Boolean	-	サブアカウントはコンソールにアクセス可能かどうか `true` \| `false` `true`: 可能 `false`: 不可
`useConsolePermitIp`	Boolean	-	サブアカウントがコンソールにアクセス可能な IPアドレス帯域を制限するかどうか `true` \| `false` `true`: 指定の IPアドレス帯域からのみアクセス可能 `false`: 制限なしでアクセス可能
`consolePermitIps`	Array	-	サブアカウントがコンソールにアクセスできる IPアドレス帯域リスト
`useApiAllowSource`	Boolean	-	サブアカウントが APIにアクセス可能なソースを制限するかどうか `true` \| `false` `true`: 指定のソースからのみアクセス可能 `false`: すべてのソースからアクセス可能
`apiAllowSources`	Array	-	サブアカウントが APIにアクセス可能なソースリスト
`lastLoginTime`	String	-	サブアカウントの最終ログイン日時 ISO 8601形式
`createTime`	String	-	サブアカウントの作成日時 ISO 8601形式
`memo`	String	-	サブアカウントの説明
`active`	Boolean	-	サブアカウントの状態 `true` \| `false` `true`: 有効化 `false`: 無効化
`modifiedTime`	String	-	サブアカウントの最終更新日時 ISO 8601形式
`nrn`	String	-	サブアカウントに対する NAVERクラウドプラットフォームリソースの識別値

`apiAllowSources`

apiAllowSourcesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`type`	String	-	アクセスソースのタイプ `IP` \| `VPC` \| `VPC_SERVER` `IP`: サーバの単一 IPアドレスまたはサブネットを含む IPアドレス帯域 `VPC`: 使用中の VPC `VPC_SERVER`: 使用中の VPC環境のサーバ
`source`	String	-	アクセスソース情報 IPアドレスまたはインスタンス番号

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

Sub Account APIで共通して使用されるレスポンスステータスコードの詳細は、Sub Accountのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "page": 0,
    "totalPages": 1,
    "totalItems": 1,
    "hasPrevious": false,
    "hasNext": false,
    "items": [
        {
            "subAccountId": "89b556d0-****-****-****-***********",
            "subAccountNo": 16***,
            "loginId": "h***",
            "name": "h***",
            "email": "l*****@*******.com",
            "needPasswordReset": false,
            "canAPIGatewayAccess": true,
            "canConsoleAccess": true,
            "useConsolePermitIp": true,
            "consolePermitIps": [
                "***.***.***.***"
            ],
            "useApiAllowSource": true,
            "apiAllowSources": [
                {
                    "type": "IP",
                    "source": "***.***.***.***"
                }
            ],
            "lastLoginTime": "2025-01-01T23:48:07Z",
            "createTime": "2024-09-30T04:57:47Z",
            "memo": "",
            "active": true,
            "modifiedTime": "2024-12-23T02:56:29Z",
            "nrn": "nrn:PUB:IAM::5*****8:SubAccount/89b556d0-****-****-****-***********"
        }
    ],
    "isFirst": true,
    "isLast": true
}