Managed Object - UserDirectory

Property of
ServiceContent
See also
UserSearchResult


Managed Object Description

Contains operations for discovering and verifying users in the underlying user directory. The results are used as input to SetEntityPermissions and ResetEntityPermissions in AuthorizationManager.

On a Windows host, the operations apply to the set of trusted domains on the host, including the primary domain of the system. Contents of the domain apply to users and groups defined in that domain. A special domain, "" (empty string) refers to the users and groups local to the host.

On ESX Server or a Linux host, the operations apply to the users defined in the /etc/passwd file. The domain argument should always be passed as "" (empty string).

Properties

Name Type Description
domainList* Pxsd:string[]

List of Windows domains available for user searches. On ESX Server or Linux systems, this is an empty list.
*May not be presentP Required privilege: System.View

Methods

Methods defined in this Managed Object
RetrieveUserGroups

RetrieveUserGroups

Searches for users and groups. On Windows, a search is restricted to the given domain. If you omit the domain argument, then the search is done on local users and groups. On ESX Server (or Linux systems), only local users and groups are searched.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the UserDirectory used to make the method call.
domain*xsd:string

Domain that is searched. If unset, then the local machine is searched.
searchStrxsd:string

Case insensitive substring used to filter results; this matches not only on the login and full name for users, but also on the name and description for groups. Leave this blank to match all users.
belongsToGroup*xsd:string

If present, only users or groups that directly belong to the specified group are returned. Users or groups that have indirect membership will not be returned.
belongsToUser*xsd:string

If present, only groups that directly contain the specified user are returned. Groups that indirectly contain the user will not be returned.
exactMatchxsd:boolean

Indicates the searchStr passed should match a user or group name exactly.
findUsersxsd:boolean

True, if users should be included in the result.
findGroupsxsd:boolean

True, if groups should be included in the result.
*Need not be set

Return Value

Type Description
UserSearchResult[]

Faults

Type Description
NotFoundThrown if any of the domain, belongsToGroup, or belongsToUser arguments refer to entities that do not exist.
NotSupportedThrown if the domain argument is present for systems that do not support domains, such as ESX Server 2.5, or if the belongsToGroup or belongsToUser argument is present but by-membership queries are not supported by the server.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition