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
ADUserOrGroup_Get
Get an AD user or group info by ID.
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
ADUserOrGroup_GetEntitlementGroups
Get ADGroupInfo that can be entitled for a given user by ID.
Parameters
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
ADUserOrGroup_GetInfos
Get AD user or group infos by ids.
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
ADUserOrGroup_GetSummaryView
Get an AD user or group summary view by ID.
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
ADUserOrGroup_GetSummaryViews
Get AD user or group summary views by ids.
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
ADUserOrGroup_GetView
Get an AD user or group full view by ID.
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
ADUserOrGroup_GetViews
Get AD user or group full views by ids.
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
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
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
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
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
ADUserOrGroup_ValidateCredentials
Validate supplied credentials.
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
© 2020 VMware, Inc. All rights reserved.
Revision Nov-2020 Version 8.1.0