MENU
      Edit role

        Edit role


        Article summary

        Available in Classic and VPC

        Edit role information.

        Request

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

        MethodURI
        PUT/api/v1/roles/{roleNo}

        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
        roleNoStringRequiredRole ID

        Request body

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

        FieldTypeRequiredDescription
        descContStringOptionalDescription of the role (byte)
        • 0-300
        roleNameStringOptionalRole 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
        roleTypeStringRequiredRole type
        • Enter existing type as it cannot be edited
        sessionExpirationSecIntegerConditionalSession expiration time (second)
        • 600 | 1800 | 3600 | 10800
        • Required if roleType is Account

        Request example

        The request example is as follows:

        curl --location --request PUT 'https://subaccount.apigw.ntruss.com/api/v1/roles/5befa3a0-****-****-****-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' \
        --header 'Content-Type: application/json' \
        --data '{
        	"descCont": "Role description",
        	"roleName": "role000",
        	"roleType": "Account",
        	"sessionExpirationSec": 600
        }'
        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.