Set role list status
- Print
- PDF
Set role list status
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Set the status of two or more roles.
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 |
Request headers
For information about the headers common to all Sub Account APIs, see Sub Account request headers.
Request query parameters
You can use the following query parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
active | Required | - | Role status
|
Request body
You can include the following data in the body of your request:
| Field | Type | Required | Description |
|---|---|---|---|
roleNoList | Array | Required | Role ID list
|
Request example
The request example is as follows:
curl --location --request PUT 'https://subaccount.apigw.ntruss.com/api/v1/roles?active=false' \
--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 '[
"5d0d4d80-****-****-****-246e96591a38",
"d386b950-****-****-****-005056a7dc04"
]'
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
|
id | String | - | Role ID |
name | String | - | Action type |
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,
"id": "5d0d4d80-****-****-****-246e96591a38",
"name": "enableRole"
},
{
"success": true,
"id": "d386b950-****-****-****-005056a7dc04",
"name": "enableRole"
}
]
Was this article helpful?