Viewing sub account list
- Print
- PDF
Viewing sub account list
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
View the sub account list.
API
- GET /sub-accounts
Requests
Parameters
| Parameter | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| searchColumn | N | String | loginId, name, subAccountNo | - Search column loginId, name, subAccountNo |
| searchWord | N | String | Search keywords | |
| page | N | int | - Page number Default: 0 | |
| size | N | int | - Size of result list Default: 10 |
Responses
{
"hasNext": "boolean",
"hasPrevious": "boolean",
"isFirst": "boolean",
"isLast": "boolean",
"items": [
{
"nrn": "string",
"active": "boolean",
"canAPIGatewayAccess": "boolean",
"canConsoleAccess": "boolean",
"consolePermitIps": [
"string"
],
"createTime": "string",
"email": "string",
"lastLoginTime": "string",
"loginId": "string",
"memo": "string",
"modifiedTime": "string",
"name": "string",
"needPasswordReset": "boolean",
"subAccountNo": "integer",
"subAccountId": "string",
"useConsolePermitIp": "boolean",
"useApiAllowSource": "boolean",
"apiAllowSources": [
{
"type": "string",
"source": "string"
}
],
}
],
"page": "integer",
"totalItems": "integer",
"totalPages": "integer"
}
| Item | Type | Description | Note |
|---|---|---|---|
| hasNext | boolean | Whether there is a next page | |
| hasPrevious | boolean | Whether there is a previous page | |
| isFirst | boolean | Whether this is the first page | |
| isLast | boolean | Whether this is the last page | |
| items | array | ||
| items.nrn | string | Naming rule for an Ncloud resource | |
| items.active | boolean | Sub account status (true: enabled, false: disabled) | |
| items.canAPIGatewayAccess | boolean | - API Gateway Access You can create an access key to use APIs registered in the API Gateway | |
| items.canConsoleAccess | boolean | - Console Access Set a sub account to access the management console | |
| items.consolePermitIps | array | List of IP ranges accessible to the console | |
| items.createTime | string | Creation time 2019-08-10T13:21:00Z | |
| items.email | string | ||
| items.lastLoginTime | string | Last access time 2019-08-10T13:21:00Z | |
| items.loginId | string | Login ID | |
| items.memo | string | Memo (max: 100 bytes) | |
| items.modifiedTime | string | Last edit time 2019-08-10T13:21:00Z | |
| items.name | string | Name | |
| items.needPasswordReset | boolean | - Indicates whether password requires reset Guides the user to change the password upon login through the created sub account | |
| items.subAccountNo | integer | Sub account number | Used as a search filter |
| items.subAccountId | string | Sub account ID | |
| items.useConsolePermitIp | boolean | Whether IP range restriction is used upon access to the console | |
| items.useApiAllowSource | boolean | Access restrictions are available when using API | |
| items.apiAllowSources | array | API accessible list | |
| items.apiAllowSources[].type | string | Type of accessible source (IP, VPC, VPC_SERVER) | |
| items.apiAllowSources[].source | string | Accessible source information (IP, InstanceNo) | |
| page | integer | Page number | |
| totalItems | integer | Total number of items | |
| totalPages | integer | Total number of pages |
Was this article helpful?