Authorization Manager Remove Entity Permission

Authorization Manager Remove Entity Permission

Removes a permission rule from an entity.

This will fail with an InvalidArgument fault if called on: the direct child folders of a datacenter managed object, the root resource pool of a ComputeResource or ClusterComputeResource, or a HostSystem that is part of a ComputeResource (Stand-alone Host). These objects always have the same permissions as their parent.

This will fail with an InvalidArgument fault if called on a fault-tolerance (FT) secondary VirtualMachine. Such a VirtualMachine always has the same permissions as its FT primary VirtualMachine.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/AuthorizationManager/{moId}/RemoveEntityPermission
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.2.0 APIs.


Request Body
RemoveEntityPermissionRequestType of type(s) application/json
Required
{
    "entity": {
        "type": "string",
        "value": "string"
    },
    "user": "string",
    "isGroup": false
}
entity
Required

Reference to an instance of the ManagedEntity managed object.

string
user
Required

User or group for which the permission is defined.

boolean
isGroup
Required

True, if user refers to a group name; false, for a user name.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

NotFound: if a permission for this entity and user or group does not exist.

AuthMinimumAdminPermission: if this change would leave the system with no Administrator permission on the root node.

InvalidArgument: if one of the new role IDs is the View or Anonymous role, or the entity does not support removing permissions.

NoPermission: if current session does not have any privilege in the permission to be removed or "Authorization.ModifyPermissions" privilege on the entity.

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"
        }
    ]
}