MENU
      Get group

        Get group


        Article summary

        Available in Classic and VPC

        Get group details.

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        GET/api/v1/groups/{groupId}

        Request headers

        For information about the headers common to all Sub Account APIs, see Sub Account request headers.

        Request path parameters

        You can use the following path parameters with your request:

        FieldTypeRequiredDescription
        groupIdStringRequiredGroup ID

        Request example

        The request example is as follows:

        curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/groups/50b77400-****-****-****-246e96591a38' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --header 'Accept: application/json'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        groupIdString-Group ID
        groupNameString-Group name
        subAccountsArray-List of sub accounts belonging to group
        policiesArray-List of policies assigned to group
        nrnString-NAVER Cloud Platform resource identification value for group

        subAccounts

        The following describes subAccounts.

        FieldTypeRequiredDescription
        subAccountIdString-Sub account ID
        loginIdString-Sub account login ID
        nameString-Sub account username
        nrnString-NAVER Cloud Platform resource identification value for sub account

        policies

        The following describes policies.

        FieldTypeRequiredDescription
        policyIdString-Policy ID
        policyNameString-Policy Name
        policyTypeString-Policy type
        • SYSTEM_MANAGED | USER_CREATED
          • SYSTEM_MANAGED: System Managed Policies
          • USER_CREATED: User Created Policies
        policyDescString-Policy description
        nrnString-NAVER Cloud Platform resource identification value for policy

        Response status codes

        For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.

        Response example

        The response example is as follows:

        {
            "groupId": "50b77400-****-****-****-246e96591a38",
            "groupName": "group001",
            "subAccounts": [
                {
                    "subAccountId": "dfafe250-****-****-****-246e96591594",
                    "loginId": "user000",
                    "name": "user000",
                    "nrn": "nrn:PUB:IAM::2768364:SubAccount/dfafe250-****-****-****-246e96591594"
                }
            ],
            "policies": [
                {
                    "policyId": "56377a60-****-****-****-246e96591594",
                    "policyName": "NCP_ADMINISTRATOR",
                    "policyType": "SYSTEM_MANAGED",
                    "policyDesc": "Permission to access the portal and console as the same as the main account",
                    "nrn": "nrn:PUB:IAM:::Policy/56377a60-****-****-****-246e96591594"
                },
                {
                    "policyId": "f9a2ba60-****-****-****-000000008000",
                    "policyName": "NCP_FINANCE_MANAGER",
                    "policyType": "SYSTEM_MANAGED",
                    "policyDesc": " Permission to access the Cost Explorer service and the My Page menu in the portal, as well as the payment method management menu",
                    "nrn": "nrn:PUB:IAM:::Policy/f9a2ba60-****-****-****-000000008000"
                }
            ],
            "nrn": "nrn:PUB:IAM::2768364:Group/50b77400-****-****-****-246e96591a38"
        }
        JSON

        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.