Service - AdminUserOrGroup
Java Class
com.omnissa.vdi.vlsi.binding.vdi.users.AdminUserOrGroup
See also
AdminUserOrGroupInfo, AdminUserOrGroupLoginView, AdminUserOrGroupView, UserOrGroupId
Since
Horizon View 6.0
Service Description¶
Information about an administrator user or a group.
Methods
Methods defined in this Service: AdminUserOrGroup_Get, AdminUserOrGroup_GetLoginView, AdminUserOrGroup_GetLoginViewById, AdminUserOrGroup_GetView, AdminUserOrGroup_List, AdminUserOrGroup_ListViews
Get an administrator user or group by ID.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_PERMISSION_VIEW | Permission read access privilege is required to get admin user information. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the AdminUserOrGroup used to make the method call. |
| id | UserOrGroupId | UserOrGroupId of entity to get. |
Return Value
| Type | Description |
|---|---|
| AdminUserOrGroupInfo | requested user or group entity. |
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
Gets login view of current loggedin user.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the AdminUserOrGroup used to make the method call. |
Return Value
| Type | Description |
|---|---|
| AdminUserOrGroupLoginView | login view of current loggedin user. |
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
Gets login view by ID.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_PERMISSION_VIEW | Permission read access privilege is required to get admin user information. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the AdminUserOrGroup used to make the method call. |
| id | UserOrGroupId | UserOrGroupId of the user. |
Return Value
| Type | Description |
|---|---|
| AdminUserOrGroupLoginView | requested user login view. |
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
Get an administrator user or group full view by ID. If this method is invoked without any argument, it will return the information related to current loggedin user.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_PERMISSION_VIEW | Permission read access privilege is required to get admin user information. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the AdminUserOrGroup used to make the method call. |
| id | UserOrGroupId | UserOrGroupId of entity to get. 1 |
Return Value
| Type | Description |
|---|---|
| AdminUserOrGroupView | requested user or group full view. |
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
List all users or groups used by the broker as administrators.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_PERMISSION_VIEW | Permission read access privilege is required to get any admin user information. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the AdminUserOrGroup used to make the method call. |
Return Value
| Type | Description |
|---|---|
| AdminUserOrGroupInfo[] | All admin user or group infos |
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
List all users or group full views used by the broker as administrators.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_PERMISSION_VIEW | Permission read access privilege is required to get any admin user information. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the AdminUserOrGroup used to make the method call. |
Return Value
| Type | Description |
|---|---|
| AdminUserOrGroupView[] | All admin user or group full views |
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
-
This parameter need not be set. ↩