Service - ADUserOrGroup

Class: VMware.Hv.ADUserOrGroup
See also: ADGroupInfo, ADUserCredentialSpec, ADUserOrGroupInfo, ADUserOrGroupSummaryView, ADUserOrGroupView, UserOrGroupId
Since: Horizon View 6.0

Service Description

Data originated from Active Directory for a user or group.

Methods

Methods defined in this Service
ADUserOrGroup_Get, ADUserOrGroup_GetEntitlementGroups, ADUserOrGroup_GetInfos, ADUserOrGroup_GetSummaryView, ADUserOrGroup_GetSummaryViews, ADUserOrGroup_GetView, ADUserOrGroup_GetViews, ADUserOrGroup_Refresh, ADUserOrGroup_RefreshUsersOrGroups, ADUserOrGroup_ValidateCredentials

ADUserOrGroup_Get

Get an AD user or group info by ID.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ADUserOrGroup used to make the method call.
id	UserOrGroupId	UserOrGroupId of entity to get.

Return Value

Type	Description
ADUserOrGroupInfo	requested user or group info.

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="ADUserOrGroup_Get" type="vdi:ADUserOrGroup_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ADUserOrGroup_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ADUserOrGroupInfo"/>
               </sequence>
            </complexType>
         </element>

ADUserOrGroup_GetEntitlementGroups

Get ADGroupInfo that can be entitled for a given user by ID.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ADUserOrGroup used to make the method call.
id	UserOrGroupId	UserOrGroupId of entity to get.

Return Value

Type	Description
ADGroupInfo[]	Array of ADGroupInfo that can be entitled for the 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="ADUserOrGroup_GetEntitlementGroups" type="vdi:ADUserOrGroup_GetEntitlementGroupsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ADUserOrGroup_GetEntitlementGroupsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ADGroupInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ADUserOrGroup_GetInfos

Get AD user or group infos by ids.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ADUserOrGroup used to make the method call.
ids	UserOrGroupId[]	UserOrGroupIds of entities to get.

Return Value

Type	Description
ADUserOrGroupInfo[]	requested 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="ADUserOrGroup_GetInfos" type="vdi:ADUserOrGroup_GetInfosRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ADUserOrGroup_GetInfosResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ADUserOrGroupInfo" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ADUserOrGroup_GetSummaryView

Get an AD user or group summary view by ID.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ADUserOrGroup used to make the method call.
id	UserOrGroupId	UserOrGroupId of entity to get.

Return Value

Type	Description
ADUserOrGroupSummaryView	requested user or group summary 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="ADUserOrGroup_GetSummaryView" type="vdi:ADUserOrGroup_GetSummaryViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ADUserOrGroup_GetSummaryViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ADUserOrGroupSummaryView"/>
               </sequence>
            </complexType>
         </element>

ADUserOrGroup_GetSummaryViews

Get AD user or group summary views by ids.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ADUserOrGroup used to make the method call.
ids	UserOrGroupId[]	UserOrGroupIds of entities to get.

Return Value

Type	Description
ADUserOrGroupSummaryView[]	requested user or group summary 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="ADUserOrGroup_GetSummaryViews" type="vdi:ADUserOrGroup_GetSummaryViewsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ADUserOrGroup_GetSummaryViewsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ADUserOrGroupSummaryView" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ADUserOrGroup_GetView

Get an AD user or group full view by ID.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ADUserOrGroup used to make the method call.
id	UserOrGroupId	UserOrGroupId of entity to get.

Return Value

Type	Description
ADUserOrGroupView	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="ADUserOrGroup_GetView" type="vdi:ADUserOrGroup_GetViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ADUserOrGroup_GetViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ADUserOrGroupView"/>
               </sequence>
            </complexType>
         </element>

ADUserOrGroup_GetViews

Get AD user or group full views by ids.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ADUserOrGroup used to make the method call.
ids	UserOrGroupId[]	UserOrGroupIds of entities to get.

Return Value

Type	Description
ADUserOrGroupView[]	requested 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="ADUserOrGroup_GetViews" type="vdi:ADUserOrGroup_GetViewsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ADUserOrGroup_GetViewsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ADUserOrGroupView" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ADUserOrGroup_Refresh

Refresh and return the given user or group with current general information from Active Directory (including name, phone, email, user name, and default Windows domain) for any entitled or admin user or group stored in LDAP FSPs. This information is cached by the broker, both locally and globally if Multi-DataCenter View is enabled. The latter will only be refreshed if permissions exist to modify global data. If the given user or group's domain is one-way trusted, the refresh for that user may occur asynchronously when that user next logs in. In those cases, the returned value will be null.

Privileges

Privilege	Description
FEDERATED_LDAP_MANAGE	Global LDAP management is required to update the user or group in global LDAP in addition to local LDAP.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ADUserOrGroup used to make the method call.
id	UserOrGroupId	UserOrGroupId of entities to refresh.

Return Value

Type	Description
ADUserOrGroupSummaryView	The refreshed summary view of the user or group.

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="ADUserOrGroup_Refresh" type="vdi:ADUserOrGroup_RefreshRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ADUserOrGroup_RefreshResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ADUserOrGroupSummaryView" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>

ADUserOrGroup_RefreshUsersOrGroups

Refreshes the given users and/or groups with current general information from Active Directory (including name, phone, email, user name, and default Windows domain) for any entitled or admin user or group stored in LDAP FSPs. This information is cached by the broker, both locally and globally if Multi-DataCenter View is enabled. The latter will only be refreshed if permissions exist to modify global data.
If the given user or group's domain is one-way trusted, the refresh for that user may occur asynchronously when that user next logs in. In those cases, the returned value will be null.
If this method is invoked with null argument, it refreshes the FSP entries from local LDAP. In this case, refresh for the user will occur asynchronously when the user next logs in. So, the returned value will be null.

Privileges

Privilege	Description
FEDERATED_LDAP_MANAGE	Global LDAP management is required to update the user or group in global LDAP in addition to local LDAP.

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

ids

UserOrGroupId[]

UserOrGroupIds of entities to refresh.

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

Return Value

Type	Description
ADUserOrGroupSummaryView[]	Refreshed summary views of given users/groups.

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="ADUserOrGroup_RefreshUsersOrGroups" type="vdi:ADUserOrGroup_RefreshUsersOrGroupsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ADUserOrGroup_RefreshUsersOrGroupsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ADUserOrGroupSummaryView" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ADUserOrGroup_ValidateCredentials

Validate supplied credentials.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ADUserOrGroup used to make the method call.
adUserCredentialSpec	ADUserCredentialSpec

Return Value

Type	Description
None

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="ADUserOrGroup_ValidateCredentials" type="vdi:ADUserOrGroup_ValidateCredentialsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ADUserOrGroup_ValidateCredentialsResponse">
            <complexType/>
         </element>