Service - AdminUserOrGroup

Class
VMware.Hv.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

AdminUserOrGroup_Get

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

NameTypeDescription
_thisManagedObjectReference A reference to the AdminUserOrGroup used to make the method call.
idUserOrGroupId

UserOrGroupId of entity to get.

Return Value

Type Description
AdminUserOrGroupInforequested user or group entity.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



AdminUserOrGroup_GetLoginView

Gets login view of current loggedin user.

Parameters

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

Return Value

Type Description
AdminUserOrGroupLoginViewlogin view of current loggedin user.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



AdminUserOrGroup_GetLoginViewById

Gets login view by ID.

Privileges

Privilege Description
GLOBAL_PERMISSION_VIEW Permission read access privilege is required to get admin user information.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AdminUserOrGroup used to make the method call.
idUserOrGroupId

UserOrGroupId of the user.

Return Value

Type Description
AdminUserOrGroupLoginViewrequested user login view.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



AdminUserOrGroup_GetView

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

NameTypeDescription
_thisManagedObjectReference A reference to the AdminUserOrGroup used to make the method call.
idUserOrGroupId

UserOrGroupId of entity to get.
  • Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type Description
AdminUserOrGroupViewrequested user or group full view.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



AdminUserOrGroup_List

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

NameTypeDescription
_thisManagedObjectReference 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
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



AdminUserOrGroup_ListViews

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

NameTypeDescription
_thisManagedObjectReference 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
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition