Viewing a single sub account
- Print
- PDF
Viewing a single sub account
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
View a single sub account.
API
- GET /sub-accounts/{subAccountId}
Requests
Path Variables
| Parameter | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| subAccountId | Y | String | Sub Account Id |
Responses
{
"nrn": "string"
"active": "boolean",
"canAPIGatewayAccess": "boolean",
"canConsoleAccess": "boolean",
"consolePermitIps": [
"string"
],
"createTime": "string",
"email": "string",
"groups": [
{
"groupId": "string",
"groupName": "string",
"policies": [
{}
],
"subAccounts": [
{}
]
}
],
"lastLoginTime": "string",
"loginId": "string",
"memo": "string",
"modifiedTime": "string",
"name": "string",
"needPasswordReset": "boolean",
"policies": [
{
"policyId": "string",
"policyName": "string",
"policyType": "string"
}
],
"subAccountNo": "integer",
"subAccountId": "string",
"useConsolePermitIp": "boolean",
"useApiAllowSource": "boolean",
"apiAllowSources": [
{
"type": "string",
"source": "string"
}
]
}
| Item | Type | Description | Note |
|---|---|---|---|
| nrn | string | Naming rule for an Ncloud resource | |
| active | boolean | Sub account status (true: enabled, false: disabled) | |
| canAPIGatewayAccess | boolean | - API Gateway Access - You can create an access key to use APIs registered in the API Gateway | |
| canConsoleAccess | boolean | - Console Access - Set a sub account to access the management console | |
| consolePermitIps | array | List of IP ranges accessible to the console | |
| createTime | string | Creation time 2019-08-10T13:21:00Z | |
| string | |||
| groups | array | List of groups to which the sub account belongs | |
| groups.groupId | string | Group ID | |
| groups.groupName | string | Group name | |
| groups.policies | array | List of policies assigned to the group | |
| groups.subAccounts | array | List of sub accounts belonging to the group | |
| lastLoginTime | string | Last access time 2019-08-10T13:21:00Z | |
| loginId | string | Login ID | |
| memo | string | Memo (max: 100 bytes) | |
| modifiedTime | string | Last edit time 2019-08-10T13:21:00Z | |
| name | string | Name | |
| needPasswordReset | boolean | - Indicates whether password requires reset - Guides the user to change the password upon login through the created sub account | |
| policies | array | List of policies assigned to the sub account | |
| policies.policyId | string | Policy ID | |
| policies.policyName | string | Policy name | |
| policies.policyType | string | Policy type (SYSTEM_MANAGED, USER_CREATED) | |
| subAccountNo | integer | Sub account number | |
| subAccountId | string | Sub account ID | |
| useConsolePermitIp | boolean | Whether IP range restriction is used upon access to the console | |
| useApiAllowSource | boolean | Access restrictions are available when using API | |
| apiAllowSources | array | List of accessible sources when API is used | |
| apiAllowSources[].type | string | Type of accessible source (IP, VPC, VPC_SERVER) | |
| apiAllowSources[].source | string | Accessible source information (IP, InstanceNo) |
Errors
Errors that may occur while using this action are listed below. For the error response format, see ErrorResponse.
For more information about common errors, see NAVER Cloud Platform API.
| HTTP status code | Error code | Error message |
|---|---|---|
| 401 | 30 | Nonexistent account |
Was this article helpful?