MENU
      Set access key status

        Set access key status


        Article summary

        Available in Classic and VPC

        Set the access key status of a sub account. Set it to Enabled to enable the use of the access key in the sub account, or to Disabled to disable it.

        Request

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

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

        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
        accessKeyStringRequiredAccess Key
        activeBooleanRequiredSub account access key status
        • true | false
          • true: enabled
          • false: disabled

        Request example

        The request example is as follows:

        curl --location --request PUT 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts/f1a03ae0-*************************/access-keys' \
        --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' \
        --data '{
          "accessKey": "ncp_iam_*********************",
          "active": 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.