Edit role

Prev Next

Available in Classic and VPC

Edit role information.

Request

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

Method URI
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:

Field Type Required Description
roleNo String Required Role ID

Request body

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

Field Type Required Description
descCont String Optional Description of the role (byte)
  • 0-300
roleName String Optional Role 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
roleType String Required Role type
  • Enter existing type as it cannot be edited
sessionExpirationSec Integer Conditional Session 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
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
success Boolean - 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
}