Authorization Manager Retrieve Entity Permissions

Authorization Manager Retrieve Entity Permissions

Gets permissions defined on or effective on a managed entity.

This returns the actual permission objects defined in the system for all users and groups relative to the managed entity. The inherited flag specifies whether or not to include permissions defined by the parents of this entity that propagate to this entity.

For complex entities, the entity reported as defining the permission may be either the parent or a child entity belonging to the complex entity.

The purpose of this method is to discover permissions for administration purposes, not to determine the current permissions. The current user's permissions are found on the effectiveRole property of the user's ManagedEntity.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/AuthorizationManager/{moId}/RetrieveEntityPermissions
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
RetrieveEntityPermissionsRequestType of type(s) application/json
Required 
{
    "entity": {
        "type": "string",
        "value": "string"
    },
    "inherited": false
}
MoRefManagedEntity
entity
Required

Reference to an instance of the ManagedEntity managed object.

boolean
inherited
Required

Whether or not to include propagating permissions defined by parent entities.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Array of Permission of type(s) application/json 
[
    {
        "_typeName": "string",
        "entity": {
            "type": "string",
            "value": "string"
        },
        "principal": "string",
        "group": false,
        "roleId": 0,
        "propagate": false
    }
]

On This Page
Authorization Manager Operations
POST
Authorization Manager Add Authorization Role
POST
Authorization Manager Fetch User Privilege On Entities
GET
Authorization Manager Get Description
GET
Authorization Manager Get Privilege List
GET
Authorization Manager Get Role List
POST
Authorization Manager Has Privilege On Entities
POST
Authorization Manager Has Privilege On Entity
POST
Authorization Manager Has User Privilege On Entities
POST
Authorization Manager Merge Permissions
POST
Authorization Manager Remove Authorization Role
POST
Authorization Manager Remove Entity Permission
POST
Authorization Manager Reset Entity Permissions
POST
Authorization Manager Retrieve All Permissions
POST
Authorization Manager Retrieve Entity Permissions
POST
Authorization Manager Retrieve Role Permissions
POST
Authorization Manager Set Entity Permissions
POST
Authorization Manager Update Authorization Role