MENU
      Edit sub account

        Edit sub account


        Article summary

        Available in Classic and VPC

        Edit sub account information.

        Request

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

        MethodURI
        PUT/api/v1/sub-accounts/{subAccountId}

        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
        subAccountIdStringRequiredSub account ID

        Request body

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

        FieldTypeRequiredDescription
        activeBooleanOptionalWhether it is enabled
        • true | false
          • true: enabled
          • false: disabled
        apiAllowSourcesArrayOptionalList of sources accessible via API
        canAPIGatewayAccessBooleanOptionalAPI Gateway accessibility
        • true | false
          • true: accessible
          • false: not accessible
        • You can use APIs registered in API Gateway by creating a access key
        canConsoleAccessBooleanOptionalConsole accessibility
        • true | false
          • true: accessible
          • false: not accessible
        consolePermitIpsArrayOptionalList of IP range accessible to the console
        emailStringOptionalUser's email address
        • 6-100 characters
        isMfaMandatoryBooleanOptionalWhether two-factor authentication is required
        • true | false
          • true: required
          • false: optional
        memoStringOptionalDescription of the sub account (byte)
        • 0-300
        nameStringRequiredSub account user's name
        • 2-30 characters
        useApiAllowSourceBooleanOptionalWhether the accessible source for the API is restricted
        • true | false
          • true: Accessible only from specified sources
          • false: Accessible from all sources
        useConsolePermitIpBooleanOptionalWhether the IP range accessible to the console is restricted
        • true | false
          • true: Accessible only from specified IP range
          • false: Accessible from everywhere

        apiAllowSources

        The following describes apiAllowSources.

        FieldTypeRequiredDescription
        typeStringConditionalAccess source type
        • IP | VPC | VPC_SERVER
          • IP: Single server IP or IP range including subnet
          • VPC: VPC in use
          • VPC_SERVER: Server in the VPC in use
        sourceStringConditionalAccess source information
        • Enter an IP address or an instance number

        Request example

        The request example is as follows:

        curl --location --request PUT 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts/2b141960-****-****-****-246e9659184c' \
        --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 '{
            "email": "email@ncloud.com",
            "isMfaMandatory": false,
            "memo": "test",
            "name": "test",
            "useApiAllowSource": false,
            "useConsolePermitIp": false
        }'
        Shell

        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

        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
        }
        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.