Set role status

Available in Classic and VPC

Set the role status.

Note

When disabling a server role, the access key is also invalidated.
When disabling an account role, the role-switched sub account is automatically logged out and the Secure Token Service (STS) expires.
Single sign-on roles must be disabled in Ncloud Single Sign-On.
When disabling a service role, the service application to which the role is applied may be interrupted.

Request

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

Method	URI
PUT	/api/v1/roles/{roleNo}/enable

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 See Get role list

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`active`	Required	-	Role 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/roles/5befa3a0-****-****-****-246e96591a38/enable?active=true' \
--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'

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
}