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 P	AuthorizationDescription
privilegeList* P	AuthorizationPrivilege[]
roleList* P	AuthorizationRole[]

Name

Type

Description

description P

AuthorizationDescription

privilegeList* P

AuthorizationPrivilege[]

roleList* P

AuthorizationRole[]

*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

Name

Type

Description

_this

ManagedObjectReference

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

name P

xsd:string

Since null

privIds* P

xsd:string[]

Since null

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

Return Value

Type	Description
xsd:int

Faults

Type	Description
AlreadyExists
InvalidName
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

entities P

ManagedObjectReference[]
to a ManagedEntity[]

Since vSphere API 6.5

userName P

xsd:string

Since vSphere API 6.5

PRequired privilege - see tooltip for details

Return Value

Type	Description
UserPrivilegeResult[]

Faults

Type	Description
RuntimeFault	Thrown 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

Name	Type	Description
_this	ManagedObjectReference	A reference to the AuthorizationManager used to make the method call.
entity P	ManagedObjectReference[] to a ManagedEntity[]	*Since* vSphere API 5.5
sessionId P	xsd:string	*Since* vSphere API 5.5
privId* P	xsd:string[]	*Since* vSphere API 5.5

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

Return Value

Type	Description
EntityPrivilege[]

Faults

Type	Description
RuntimeFault	Thrown 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

Name	Type	Description
_this	ManagedObjectReference	A reference to the AuthorizationManager used to make the method call.
entity P	ManagedObjectReference to a ManagedEntity	*Since* vSphere API 5.0
sessionId P	xsd:string	*Since* vSphere API 5.0
privId* P	xsd: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
RuntimeFault	Thrown 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

Name	Type	Description
_this	ManagedObjectReference	A reference to the AuthorizationManager used to make the method call.
entities P	ManagedObjectReference[]	*Since* vSphere API 6.5
userName P	xsd:string	*Since* vSphere API 6.5
privId* P	xsd:string[]	*Since* vSphere API 6.5

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

Return Value

Type	Description
EntityPrivilege[]

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

srcRoleId P

xsd:int

Since null

dstRoleId P

xsd:int

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
AuthMinimumAdminPermission
NotFound
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

roleId P

xsd:int

Since null

failIfUsed P

xsd:boolean

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
NotFound
RemoveFailed
RuntimeFault	Thrown 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

Name	Type	Description
_this	ManagedObjectReference	A reference to the AuthorizationManager used to make the method call.
entity P	ManagedObjectReference to a ManagedEntity	*Since* null
user P	xsd:string	*Since* null
isGroup P	xsd:boolean	*Since* null

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
AuthMinimumAdminPermission
NotFound
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

entity P

ManagedObjectReference
to a ManagedEntity

Since null

permission* P

Permission[]

Since null

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

Return Value

Type	Description
None

Faults

Type	Description
AuthMinimumAdminPermission
NotFound
RuntimeFault	Thrown 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

Name	Type	Description
_this	ManagedObjectReference	A reference to the AuthorizationManager used to make the method call.

Return Value

Type	Description
Permission[]

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

entity P

ManagedObjectReference
to a ManagedEntity

Since null

inherited P

xsd:boolean

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
Permission[]

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

roleId P

xsd:int

Since null

P Required privilege: roleId

Return Value

Type	Description
Permission[]

Faults

Type	Description
NotFound
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

entity P

ManagedObjectReference
to a ManagedEntity

Since null

permission* P

Permission[]

Since null

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

Return Value

Type	Description
None

Faults

Type	Description
AuthMinimumAdminPermission
NotFound
RuntimeFault	Thrown 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

Name	Type	Description
_this	ManagedObjectReference	A reference to the AuthorizationManager used to make the method call.
roleId P	xsd:int	*Since* null
newName P	xsd:string	*Since* null
privIds* P	xsd:string[]	*Since* null

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

Return Value

Type	Description
None

Faults

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

Events

Type
None