Available in Classic and VPC
Organization is a NAVER Cloud Platform service that provides integrated billing and resource usage policy management for all accounts in an organization. The Organization service provides APIs for the organization, account, group, and quota policy features in a RESTful form.
Common Organization settings
The following describes commonly used request and response formats in Organization APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows.
https://organization.apigw.ntruss.com
Request headers
The following describes the headers.
| Field | Required | Description |
|---|---|---|
x-ncp-apigw-timestamp |
Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC
|
x-ncp-iam-access-key |
Required | Access key issued on NAVER Cloud Platform
|
x-ncp-apigw-signature-v2 |
Required | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)
|
Accept |
Optional | Response data format
|
Content-type |
Optional | Request data format
|
Response
The following describes the common response format.
Response status codes
The following describes the response status codes.
| HTTP status code | Code | Message | Description |
|---|---|---|---|
| 401 | COMMON_201 | This feature can only be performed with the main account. | Not a master account |
| 403 | COMMON_101 | This account is not a master account. | Not a master account |
| 403 | COMMON_102 | Failed to send the email. Please try again later. | Failed to send email |
| 403 | COMMON_103 | An internal server error has occurred. If the problem persists, please contact Support (+82-1544-5876). | Internal server error |
| 403 | COMMON_104 | The function will be limited for a while due to frequent requests. | Too frequent requests |
| 403 | ACCOUNT_101 | You can't invite new accounts to Organization because you currently have outstanding bills. | Invitation approval failed: service usage fee not paid |
| 403 | ACCOUNT_102 | You can only invite an account belonging to the country where you are located. | Invitation failed: different country of residence |
| 403 | ACCOUNT_103 | This account has already been invited. | Invitation failed: account already invited |
| 403 | ACCOUNT_104 | There is already an organization they have joined. | Invitation failed: invitee signed up with another organization |
| 403 | ACCOUNT_105 | Please check the account information again. | Invitation failed: account information entry error |
| 403 | ACCOUNT_106 | This account has already joined the organization. | Invitation failed: account already signed up |
| 403 | ACCOUNT_107 | Please check the PIN code again. | Invitation failed: PIN code entry error |
| 403 | ACCOUNT_108 | The invitation has expired. | Invitation failed: invitation expired |
| 403 | ACCOUNT_109 | You still have outstanding payments. | Invitation approval failed: service usage fee not paid |
| 403 | ACCOUNT_111 | Member account invitations are only available to business members with the same business registration number as the master account. | Invitation failed: business registration numbers of the master account and the invited account different |
| 403 | ACCOUNT_112 | Account scheduled for partner member signing/withdrawal or partner code change | Invitation failed: partner member signing/withdrawal scheduled, partner code change scheduled |
| 403 | ACCOUNT_113 | Account that is not a normal member or whose information cannot be verified | Invitation failed: not a regular member or unable to confirm member information |
| 403 | ACCOUNT_114 | Account with different currency code than its Master account | Invitation failed: different currency code from master account |
| 403 | ACCOUNT_115 | Account with different membership type from its Master account | Invitation failed: different member type from master account |
| 403 | ACCOUNT_116 | Partner main account | Invitation failed: partner main account |
| 403 | ACCOUNT_117 | Account with different partner code from its Master account | Invitation failed: different partner code from master account |
| 403 | ACCOUNT_201 | Account with invalid account name or login ID | Withdrawal failed: loginId, memberNo entry error |
| 403 | ACCOUNT_202 | You have an outstanding payment. | Withdrawal failed: service usage fee not paid |
| 403 | ACCOUNT_203 | You have not registered any payment methods. | Withdrawal failed: payment method not registered |
| 403 | ACCOUNT_204 | Withdrawal isn't available between 00:00 on the 1st day and 23:59 of the 2nd day of each month. Please proceed again on or after the 3rd day. | Withdrawal failed: usage restriction hours |
| 403 | ORG_101 | There is already an organization they have joined. | Organization creation failed: account signed up with another organization |
| 403 | ORG_102 | This account is not a business owner account. | Organization creation failed: not a business account |
| 403 | ORG_103 | You have not registered any payment methods. | Organization creation failed: payment method not registered |
| 403 | ORG_104 | You have an outstanding payment. | Organization creation failed: service usage fee not paid |
| 403 | ORG_201 | You can't delete an organization that has a member account or a pending account. | Organization creation failed: member account or inviting account exists |
| 403 | GROUP_101 | The name is required. | Group creation/modification failed: required field missing |
| 403 | GROUP_102 | The name must be 3 to 50 characters. | Group creation/modification failed: value entry error |
| 403 | GROUP_103 | Only English alphabet, numbers, and “-”, “_”, and “.” characters are allowed. | Group creation/modification failed: value entry error |
| 403 | GROUP_104 | You can create a group up to Level 5. | Group creation/modification failed: limit exceeded |
| 403 | GROUP_105 | No parent node exists. | Group creation/modification failed: parent node missing |
| 403 | GROUP_106 | It is not a suitable organization. | Group creation/modification failed: invalid request
|
| 403 | GROUP_201 | It is not a suitable organization. | Group creation/modification failed: invalid request
|
| 403 | GROUP_202 | You can't delete this because there is a sub group or sub account. | Group deletion failed: sub group or account exists |
| 403 | GROUP_301 | You can create a group up to Level 5. | Group move failed: limit exceeded |
| 403 | QUOTA_101 | It can't be created because the limit has been exceeded. | Policy creation failed: resource limit exceeded |
Note
For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
Organization API
The following describes the APIs provided by the Organization service.
Organization
The following describes the organization-related APIs.
| API | Description |
|---|---|
| Get organization | Get organization
|
| Create organization | Create organization
|
| Delete organization | Delete organization
|
Account
The following describes the account-related APIs.
| API | Description |
|---|---|
| Get account list | Get the list of accounts belonging to the organization
|
| Invite account | Invite as organization member account
|
| Get invitation list | Get account invitation information for organization
|
| Accept invitation | Approve organization invitation
|
| Decline invitation | Decline organization invitation
|
| Get withdrawal request list | Get withdrawal request list
|
| Approve or deny withdrawal request | Approve or deny member account withdrawal request
|
| Forcefully withdraw | Forcefully withdraw member account
|
Account group
The following describes the account group-related APIs.
| API | Description |
|---|---|
| Get account group list | Get account group list
|
| Create account group | Create account group
|
| Remove account groups | Delete account group
|
| Change account group name | Change account group name
|
| Move account groups | Move account group location
|
Quota Policy
The following describes the quota policy-related APIs.
| API | Description |
|---|---|
| Get Region list | Get Regions applicable for quota policy
|
| Get resource category list | Get resource category applicable for quota policy
|
| Get resource list. | Get resources applicable for quota policy
|
| Get resource type list | Get resource detailed types applicable for quota policy
|
| Get resource usage limit | Get details of resource usage limit by account
|
| Get quota policy list | Get quota policy list
|
| Create the Quota Policy | Create quota policy
|
| Delete the Quota Policy | Delete quota policy
|
| Get quota policy application | Get quota policy applied to account group
|
| Apply quota policy | Apply quota policy to account group
|
| Remove quota policy application | Remove quota policy applied to account group
|
Organization related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand Organization APIs.
- Organization API guide
- Create signature: how to create a signature to add to the request header
- API Gateway User Guide: how to issue the API key to be added to the request header
- Sub Account User guide: how to issue the access key to be added to the request header
- Common Ncloud response status codes: information on common response status codes of NAVER Cloud Platform used by the Organization service
- Organization service guide
- Organization User Guide: how to use Organization in the NAVER Cloud Platform console
- Ncloud use environment guide: guide for VPC and Classic environments and support availability
- Introduction to pricing, characteristics, and detailed features: summary of Organization pricing system, characteristics, and detailed features
- Latest service news: the latest news on the Organization service
- FAQ: frequently asked questions from the Organization service users
- Contact us: Send direct inquiries for unresolved questions that aren't answered by the API guide