Service -
Permission
- Class
- VMware.Hv.Permission
- See also
-
PermissionBase, PermissionId, PermissionInfo
- Since
- Horizon View 6.0
Service Description
Information about a permission. This represents a simple association between
a single admin user, a single role (which may encompass multiple privileges),
and a single access group. Admin users/groups, roles, and access groups may
each be associated with multiple permissions.
Methods
Permission_Create
Add a permission that connects a user/group, role, and access group.
delete/create should be used instead of update.
Privileges
Privilege
|
Description
|
GLOBAL_PERMISSION_MANAGEMENT |
Permission management privilege is
required to create a permission.
|
Parameters
Return Value
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
Event
|
Description
|
ADMIN_PERMISSION_ADDED |
Sent when a permission is successfully
created.
|
ADMIN_PERMISSION_ADD_FAILED |
Sent when a permission fails to be
created.
|
Show WSDL type definition
Permission_CreatePermissions
Create multiple admin permissions. If all creations were not successful, a
PartialFailureFault will be thrown indicating which bases were
successfully created and which failed. The index of results in the
PartialFailureFault correspond to the index of the original base. The
result entry will contain either be the original return type (on success)
or an exception (on failure).
Privileges
Privilege
|
Description
|
GLOBAL_PERMISSION_MANAGEMENT |
Permission management privilege is
required to create any permissions.
|
Parameters
Return Value
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
PartialFailureFault | Thrown if all operations were not successful, a PartialFailureFault will be thrown indicating which permissions were successfully created and which ones failed. The index of results in the PartialFailureFault correspond to the index of the original permission. The result entry will contain either the original return type (on success) or an exception (on failure). |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
Event
|
Description
|
ADMIN_PERMISSION_ADDED |
Sent for each permission that is
successfully created.
|
ADMIN_PERMISSION_ADD_FAILED |
Sent for each permission that fails to
be created.
|
Show WSDL type definition
Permission_Delete
Delete a given permission. delete/create should be used instead of update.
Privileges
Privilege
|
Description
|
GLOBAL_PERMISSION_MANAGEMENT |
Permission management privilege is
required to delete any permissions.
|
Parameters
Return Value
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
Event
|
Description
|
ADMIN_PERMISSION_REMOVED |
Sent when a permission is successfully
deleted.
|
ADMIN_PERMISSION_REMOVE_FAILED |
Sent when a permission fails to be
deleted.
|
Show WSDL type definition
Permission_DeletePermissions
Delete multiple admin permissions. If all deletions were not successful, a
PartialFailureFault will be thrown indicating which bases were
successfully deleted and which failed. The index of results in the
PartialFailureFault correspond to the index of the original base. The
result entry will contain a fault if the deletion failed.
Privileges
Privilege
|
Description
|
GLOBAL_PERMISSION_MANAGEMENT |
Permission management privilege is
required to delete any permissions.
|
Parameters
Return Value
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
PartialFailureFault | Thrown if all operations were not successful, a PartialFailureFault will be thrown indicating which permissions were successfully deleted and which ones failed. The index of results in the PartialFailureFault correspond to the index of the original permission. The result entry will contain either the original return type (on success) or an exception (on failure). |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
Event
|
Description
|
ADMIN_PERMISSION_REMOVED |
Sent for each permission that is
successfully deleted.
|
ADMIN_PERMISSION_REMOVE_FAILED |
Sent for each permission that fails
to be deleted.
|
Show WSDL type definition
Permission_Get
Get a permission by Id.
Privileges
Privilege
|
Description
|
GLOBAL_PERMISSION_VIEW |
Permission read access privilege is
required to read any permissions.
|
Parameters
Return Value
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
Permission_GetInfos
Get multiple permission by Id.
Privileges
Privilege
|
Description
|
GLOBAL_PERMISSION_VIEW |
Permission read access privilege is
required to read any permissions.
|
Parameters
Return Value
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
Permission_List
List all permissions.
Privileges
Privilege
|
Description
|
GLOBAL_PERMISSION_VIEW |
Permission read access privilege is
required to read any permissions.
|
Parameters
Return Value
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
© 2022 VMware, Inc. All rights reserved.
Revision Sep-2022 Version 8.7.0