MENU
      Set role list status

        Set role list status


        Article summary

        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:

        MethodURI
        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:

        FieldTypeRequiredDescription
        activeRequired-Role status
        • true | false
          • true: enabled
          • false: disabled

        Request body

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

        FieldTypeRequiredDescription
        roleNoListArrayRequiredRole 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"
        ]'
        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
        idString-Role ID
        nameString-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"
            }
        ]
        JSON
        Plain text

        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.