| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
description P | AuthorizationDescription |
|
privilegeList* P | AuthorizationPrivilege[] |
|
roleList* P | AuthorizationRole[] |
|
Methods
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AuthorizationManager used to make the method call. |
roleId P | xsd:int |
Since null |
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 |
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 |
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 |
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 |
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 |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |