Authorization Manager Remove Authorization Role

Removes a role.

Required privileges: Authorization.ModifyRoles

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/AuthorizationManager/{moId}/RemoveAuthorizationRole

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case AuthorizationManager/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body

RemoveAuthorizationRoleRequestType of type(s) application/json

Required

{
    "roleId": 0,
    "failIfUsed": false
}

integer As int32 As int32

roleId

Required

roleId

boolean

failIfUsed

Required

If true, prevents the role from being removed if any permissions are using it.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

NotFound: if the role does not exist.

InvalidArgument: if the role is a system role, meaning it cannot be changed.

RemoveFailed: if failIfUsed is true and the role has permissions.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Virtual Infrastructure Operations

POST

Authorization Manager Add Authorization Role