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

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AdminUserOrGroup_Get" type="vdi:AdminUserOrGroup_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AdminUserOrGroup_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:AdminUserOrGroupInfo"/>
               </sequence>
            </complexType>
         </element>

AdminUserOrGroup_GetLoginView

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AdminUserOrGroup_GetLoginView" type="vdi:AdminUserOrGroup_GetLoginViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AdminUserOrGroup_GetLoginViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:AdminUserOrGroupLoginView" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>

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

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AdminUserOrGroup_GetLoginViewById" type="vdi:AdminUserOrGroup_GetLoginViewByIdRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AdminUserOrGroup_GetLoginViewByIdResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:AdminUserOrGroupLoginView" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>

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

Name

Type

Description

_this

ManagedObjectReference

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

UserOrGroupId

UserOrGroupId of entity to get.

Optional parameter. If not specifing any value, this should be set to null.

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AdminUserOrGroup_GetView" type="vdi:AdminUserOrGroup_GetViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AdminUserOrGroup_GetViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:AdminUserOrGroupView"/>
               </sequence>
            </complexType>
         </element>

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

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AdminUserOrGroup_List" type="vdi:AdminUserOrGroup_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AdminUserOrGroup_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:AdminUserOrGroupInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AdminUserOrGroup_ListViews" type="vdi:AdminUserOrGroup_ListViewsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AdminUserOrGroup_ListViewsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:AdminUserOrGroupView" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

View API

Service - AdminUserOrGroup

Service Description

AdminUserOrGroup_Get

AdminUserOrGroup_GetLoginView

AdminUserOrGroup_GetLoginViewById

AdminUserOrGroup_GetView

AdminUserOrGroup_List

AdminUserOrGroup_ListViews