Editing sub account
- Print
- PDF
Editing sub account
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Edit the sub account information.
API
- PUT /sub-accounts/{subAccountId}
Requests
Path Variables
| Parameter | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| subAccountId | Y | String | Sub Account Id |
Body
{
"active": "boolean",
"canAPIGatewayAccess": "boolean",
"canConsoleAccess": "boolean",
"email": "string",
"memo": "string",
"name": "string",
"isMfaMandatory": "boolean",
"useConsolePermitIp": "boolean",
"consolePermitIps": [
"string"
],
"useApiAllowSource": "boolean",
"apiAllowSources": [
{
"type": "string",
"source": "string"
}
]
}
| Parameter | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| active | N | boolean | Sub account status (true: enabled, false: disabled) | |
| canAPIGatewayAccess | N | boolean | - API Gateway Access - You can create an access key to use APIs registered in the API Gateway | |
| canConsoleAccess | N | boolean | Console Access Set a sub account to access the management console | |
| N | string | |||
| memo | N | string | Memo (max: 100 bytes) | |
| name | Y | string | Name | |
| isMfaMandatory | N | boolean | Whether two-factor authentication is required (true: required, false: optional) | |
| useConsolePermitIp | N | boolean | Availability of IP range limitation when accessing the console | |
| consolePermitIps | N | array | List of IP ranges accessible to the console | |
| useApiAllowSource | N | boolean | Access restrictions are available when using API | |
| apiAllowSources | N | array | API accessible list | |
| apiAllowSources[].type | N | string | Type of accessible source (IP, VPC, VPC_SERVER) | |
| apiAllowSources[].source | N | string | Accessible source information (IP, InstanceNo) |
Responses
- Responses
| Parameter name | Required | Type | Description |
|---|---|---|---|
| ProcessResult | Y | ProcessResult | Process result |
- Response examples - Succeeded
{
"success": true,
"id": "subAccountId"
}
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?