Managed Object - AuthorizationManager

Property of
ServiceContent
See also
AuthorizationDescription, AuthorizationPrivilege, AuthorizationRole, EntityPrivilege, ManagedEntity, Permission, UserPrivilegeResult
Since
null


Managed Object Description

Properties

Name Type Description
description PAuthorizationDescription


privilegeList* PAuthorizationPrivilege[]


roleList* PAuthorizationRole[]


*May not be presentP Required privilege: System.View

Methods

Methods defined in this Managed Object
AddAuthorizationRole, FetchUserPrivilegeOnEntities, HasPrivilegeOnEntities, HasPrivilegeOnEntity, HasUserPrivilegeOnEntities, MergePermissions, RemoveAuthorizationRole, RemoveEntityPermission, ResetEntityPermissions, RetrieveAllPermissions, RetrieveEntityPermissions, RetrieveRolePermissions, SetEntityPermissions, UpdateAuthorizationRole

AddAuthorizationRole

Required Privileges
Authorization.ModifyRoles

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.
name Pxsd:string

Since null
privIds* Pxsd:string[]

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:int

Faults

Type Description
AlreadyExists
InvalidName
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



FetchUserPrivilegeOnEntities

Required Privileges
None
Since
vSphere API 6.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.
entities PManagedObjectReference[]
to a ManagedEntity[]

Since vSphere API 6.5
userName Pxsd:string

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
UserPrivilegeResult[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



HasPrivilegeOnEntities

Required Privileges
System.View
Since
vSphere API 5.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.
entity PManagedObjectReference[]
to a ManagedEntity[]

Since vSphere API 5.5
sessionId Pxsd:string

Since vSphere API 5.5
privId* Pxsd:string[]

Since vSphere API 5.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
EntityPrivilege[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



HasPrivilegeOnEntity

Required Privileges
System.View
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.
entity PManagedObjectReference
to a ManagedEntity

Since vSphere API 5.0
sessionId Pxsd:string

Since vSphere API 5.0
privId* Pxsd:string[]

Since vSphere API 5.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:boolean[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



HasUserPrivilegeOnEntities

Required Privileges
None
Since
vSphere API 6.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.
entities PManagedObjectReference[]

Since vSphere API 6.5
userName Pxsd:string

Since vSphere API 6.5
privId* Pxsd:string[]

Since vSphere API 6.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
EntityPrivilege[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



MergePermissions

Required Privileges
Authorization.ReassignRolePermissions

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.
srcRoleId Pxsd:int

Since null
dstRoleId Pxsd:int

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
AuthMinimumAdminPermission
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



RemoveAuthorizationRole

Required Privileges
Authorization.ModifyRoles

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.
roleId Pxsd:int

Since null
failIfUsed Pxsd:boolean

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
NotFound
RemoveFailed
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



RemoveEntityPermission

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.
entity PManagedObjectReference
to a ManagedEntity

Since null
user Pxsd:string

Since null
isGroup Pxsd:boolean

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
AuthMinimumAdminPermission
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ResetEntityPermissions

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.
entity PManagedObjectReference
to a ManagedEntity

Since null
permission* PPermission[]

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
AuthMinimumAdminPermission
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
UserNotFound

Events

Type
None



RetrieveAllPermissions

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.

Return Value

Type Description
Permission[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



RetrieveEntityPermissions

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.
entity PManagedObjectReference
to a ManagedEntity

Since null
inherited Pxsd:boolean

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
Permission[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



RetrieveRolePermissions

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.
roleId Pxsd:int

Since null
P Required privilege: roleId

Return Value

Type Description
Permission[]

Faults

Type Description
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



SetEntityPermissions

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.
entity PManagedObjectReference
to a ManagedEntity

Since null
permission* PPermission[]

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
AuthMinimumAdminPermission
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
UserNotFound

Events

Type
None



UpdateAuthorizationRole

Required Privileges
Authorization.ModifyRoles

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthorizationManager used to make the method call.
roleId Pxsd:int

Since null
newName Pxsd:string

Since null
privIds* Pxsd:string[]

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
AlreadyExists
InvalidName
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None