Creating sub account
- Print
- PDF
Creating sub account
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Create a sub account.
API
- POST /sub-accounts
Requests
Body
{
"active": "boolean",
"canAPIGatewayAccess": "boolean",
"canConsoleAccess": "boolean",
"email": "string",
"loginId": "string",
"memo": "string",
"name": "string",
"needPasswordReset": "boolean",
"needPasswordGenerate": "boolean",
"password": "string",
"isMfaMandatory": "boolean",
"useConsolePermitIp": "boolean",
"consolePermitIps": [
"string"
],
"useApiAllowSource": "boolean",
"apiAllowSources": [
{
"type": "string",
"source": "string"
}
]
}
| Parameter | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| active | Y | boolean | Sub account status (true: enabled, false: disabled) | |
| canAPIGatewayAccess | Y | boolean | - API Gateway Access - You can create an access key to use APIs registered in the API Gateway | |
| canConsoleAccess | Y | boolean | - Console Access - Set a sub account to access the management console | |
| N | string | |||
| loginId | Y | string | 3 to 60 characters | Login ID |
| memo | N | string | Up to 300 bytes | Notes |
| name | Y | string | 2 to 30 characters | Name |
| needPasswordReset | Y | boolean | - Indicates whether password requires reset - When users log in with the sub account created, this helps them change their passwords | |
| needPasswordGenerate | N | boolean | Whether the automatic generation of a password is required | |
| password | N | string | Required if needPasswordGenerate is false | Password |
| isMfaMandatory | N | boolean | Whether two-factor authentication is required (true: required, false: optional) | |
| useConsolePermitIp | N | boolean | Whether IP range restriction is used upon access to the console (default: false) | |
| 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 |
|---|---|---|---|
| ProcessResultWithPassword | Y | ProcessResultWithPassword | Process result |
- Response examples - Succeeded in registration
{
"success": true,
"id": "subAccountId",
"generatedPassword": "Pa$$w0rd"
}
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 |
|---|---|---|
| 400 | 120 | - Duplicate ID - You need to enter another ID |
| 400 | 9015 | Unsafe password |
Was this article helpful?