MENU
      Overview of Organization
        • PDF

        Overview of Organization

        • PDF

        Article summary

        Available in Classic and VPC

        Overview

        Organization, account, account group, and quota policy can be managed by calling HTTP GET/POST/PUT/DELETE method of the RESTful API type.

        Common settings

        API URL

        GET or POST or PUT or DELETE
        https://organization.apigw.ntruss.com/open-api/v1/
        HTML

        Request headers

        Go to the creation guide of the NAVER Cloud Platform authentication key and signature

        Header nameDescriptionRemarks
        x-ncp-apigw-timestampThis is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference compared to the APIGW server is more than 5 minutes, the request is considered invalid.Ncloud common
        x-ncp-iam-access-keyThis is the Access Key ID value issued by NAVER Cloud Platform portal.Ncloud common
        x-ncp-apigw-signature-v2This is the signature encrypted with Access Key ID value and Secret Key.Ncloud common

        Basic Information

        The Organization API provides 4 major functions.

        • Manage (view/create/delete) Organization
        • Manage accounts (information inquiry and invitation)
        • Manage (view, create, move, change, delete) account groups
        • Manage quota policy (query, create, delete, apply quota policy)

        Operation

        Organization works through the following APIs.

        Organization-related API

        • View Organization (GET /org)
        • Create Organization (POST /org)
        • Delete Organization (DELETE /org/{organizationNo})

        Account management-related API

        • View account list (GET /account/group/{organizationGroupNo})
        • View account withdrawal application list (GET /account/leave)
        • Forced withdrawal of accounts (POST /account/leave/force)
        • Account withdrawal approval/rejection (POST /account/leave)
        • Invite accounts (POST /account/invite)
        • View invitation list (GET /account/invite/invitation)
        • Accept account invitation (POST /account/invite)
        • Reject account invitation (POST /account/reject)

        Account group-related API

        • View account groups (GET /group/tree)
        • Create account groups (POST /group)
        • Delete account groups (DELETE /group/{organizationGroupNo})
        • Change account group name (PUT /group/{organizationGroupNo})
        • Move account groups (POST /group/move)

        Quota Policy management-related API

        • View region list (GET /policy/regionNo)
        • View resource category (GET /policy/category/{regionNo})
        • View resource list (GET /policy/resource/{regionNo}/{categoryCode})
        • View resource type list (GET /policy/detail/{regionNo}/{resourceTypeCode})
        • View quota policy (GET /policy/list)
        • View detailed quota policy (GET /policy/allotment/{memberNo}/{regionNo})
        • View applied quota policy list (GET /policy/applied)
        • Create quota policy (POST /policy)
        • Apply quota policy (POST /policy/apply)
        • Detach applied quota policy (POST /policy/remove)
        • Delete quota policy (DELETE /policy)

        Response code

        Common service error codes

        For information on common service response codes, see API Guide > 3. Call > Failure guide.

        Organization Error Codes

        For information on Organization error codes, see the following:

        HttpStatusCode

        ErrorCode

        ErrorMessage

        Description

        403

        COMMON_101

        It is not a master account.

        It is not a master account.

        403

        COMMON_102

        Failed to send the email. Please try again later.

        Failed to send the email

        403

        COMMON_103

        An internal server error has occurred. If the problem persists, contact Customer Support (1544-5876).

        Internal server error

        403

        COMMON_104

        The function will be limited for a while due to frequent requests.

        Frequent request errors

        403

        ACCOUNT_101

        You can't invite new accounts to your Organization because you currently have an outstanding balance.

        Invitation failed (Organization has an outstanding balance.)

        403

        ACCOUNT_102

        You can only invite an account belonging to the country where you are located.

        Invitation failed (different country of residence between the master account and the member account)

        403

        ACCOUNT_103

        This account has already been invited.

        Invitation failed (already invited account)

        403

        ACCOUNT_104

        You have already joined an Organization.

        Invitation failed (account has already joined another Organization)

        403

        ACCOUNT_105

        Please check the account information again.

        Invitation failed (Login ID, Member No. error)

        403

        ACCOUNT_106

        This account has already joined the organization.

        Invitation approval failed (account has already joined)

        403

        ACCOUNT_107

        Please check the PIN code again.

        Invitation approval failed (Pin Code error)

        403

        ACCOUNT_108

        The invitation has expired.

        Invitation approval failed (The invitation has expired.)

        403

        ACCOUNT_109

        You still have outstanding payments.

        Invitation approval failed (outstanding balance)

        403

        ACCOUNT_110

        This account can't be invited. Please recheck the account to invite.

        Invitation failed (This account cannot be invited.)

        403

        ACCOUNT_201

        Please check the account information again.

        Withdrawal failed (Login ID, Member No error)

        403

        ACCOUNT_202

        You have an outstanding payment.

        Withdrawal failed (outstanding balance)

        403

        ACCOUNT_203

        You have not registered any payment methods.

        Withdrawal failed (Payment method has not been 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 (Withdrawal is not allowed between 00:00 on the 1st day of every month and 24:00 on the 2nd day of each month)

        403

        ORG_101

        You have already joined an Organization.

        Organization creation failed (account has already joined 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 has not been registered)

        403

        ORG_104

        You have an outstanding payment.

        Organization creation failed (outstanding balance)

        403

        ORG_201

        You cannot delete an Organization if it has any member accounts or pending accounts.

        Organization deletion failed (Member accounts or pending accounts remain)

        403

        GROUP_101

        The name is required.

        Group creation/editing failed (The name is required.)

        403

        GROUP_102

        The name must be 3 to 50 characters.

        Group creation/editing failed (The name must be between 3-50 characters)

        403

        GROUP_103

        For the name, only English letters, numbers, “-”, “_”, “.” characters can be entered.

        Group creation/editing failed (For the name, only English letters, numbers, -,_, . can be entered)

        403

        GROUP_104

        You can create a group up to level 5.

        Group creation/editing failed (group level 5 or lower can be created)

        403

        GROUP_105

        No parent node exists.

        Group creation/editing failed (Parent node is missing)

        403

        GROUP_106

        It is not an appropriate organization.

        Group creation/editing failed (not my group)

        403

        GROUP_201

        It is not an appropriate organization.

        Group deletion failed (not my group)

        403

        GROUP_202

        You cannot delete this because there is a sub group or sub account.

        Group deletion failed (subgroups or accounts exist)

        403

        GROUP_301

        You can create a group up to level 5.

        Group move failed (Group level 5 or lower can be created.)

        403

        QUOTA_101

        You cannot create more than the maximum number.

        Policy error (Maximum resource limit has been reached)

        401

        COMMON_201

        This function is only available for use by a main account.

        Permission error (Not a master account)

        Examples of response errors

        {
         "timestamp": "2022-11-29T13:55:11Z",
         "status": 401,
         "error": "UNAUTHORIZED",
         "message": " .",
         "code": "COMMON_201"
        }
        Plain text

        Available API’s by account type

        There are restrictions on available API’s for each organization's master account and member account.

        Account typeAvailable API's
        -Create Organization (POST /org)
        Master accountView Organization (GET /org)
        Master accountDelete Organization (DELETE /org/{organizationNo})
        Master accountView account list (GET /account/group/{organizationGroupNo})
        Master accountView account withdrawal application list (GET /account/leave)
        Master accountForced withdrawal of accounts (POST /account/leave/force)
        Master accountAccount withdrawal approval/rejection (POST /account/leave)
        Master accountInvite accounts (POST /account/invite)
        -View invitation list (GET /account/invite/invitation)
        -Accept account invitation (POST /account/invite)
        -Reject account invitation (POST /account/reject)
        Master accountView account groups (GET /group/tree)
        Master accountCreate account groups (POST /group)
        Master accountDelete account groups (DELETE /group/{organizationGroupNo})
        Master accountChange account group name (PUT /group/{organizationGroupNo})
        Master accountMove account groups (POST /group/move)
        Master accountView region list (GET /policy/regionNo)
        Master accountView resource category (GET /policy/category/{regionNo})
        Master accountView resource list (GET /policy/resource/{regionNo}/{categoryCode})
        Master accountView resource type list (GET /policy/detail/{regionNo}/{resourceTypeCode})
        Master accountView quota policy (GET /policy/list)
        Master accountView detailed quota policy (GET /policy/allotment/{memberNo}/{regionNo})
        Master accountView applied quota policy list (GET /policy/applied)
        Master accountCreate quota policy (POST /policy)
        Master accountApply quota policy (POST /policy/apply)
        Master accountDetach applied quota policy (POST /policy/remove)
        Master accountDelete quota policy (DELETE /policy)

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.