Create group
    • PDF

    Create group

    • PDF

    Article summary

    Available in Classic and VPC

    Create a group.

    Note
    • You can create up to 300 groups.
    • Up to 10 groups can be affiliated with each sub account.

    Request

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

    MethodURI
    POST/api/v1/groups

    Request headers

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

    Request body

    You can include the following data in the body of your request:

    FieldTypeRequiredDescription
    groupNameStringRequiredGroup name
    • 3-30 characters using Korean, English uppercase and lowercase letters, Japanese, and special characters . _ -
    • First letter must be Korean, English uppercase and lowercase letter, or Japanese

    Request example

    The request example is as follows:

    curl --location --request POST 'https://subaccount.apigw.ntruss.com/api/v1/groups' \
    --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' \
    --header 'Content-Type: application/json' \
    --data '{
        "groupName": "group000"
    }'
    

    Response

    This section describes the response format.

    Response body

    The response body includes the following data:

    FieldTypeRequiredDescription
    successBoolean-API call success status
    • true | false
      • true: succeeded
      • false: failed
    idString-Group ID

    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:

    {
        "success": true,
        "id": "bd8864a0-****-****-****-005056a79baa"
    }
    

    Was this article helpful?

    What's Next
    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.