| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
The content of the returned results depends on the server environment:
Properties
Name | Type | Description |
---|---|---|
domainList* P | xsd:string[] |
List of Windows domains available for user searches, if the underlying
system supports windows domain membership.
|
Methods
Methods defined in this Managed Object |
---|
RetrieveUserGroups |
You must hold the Authorization.ModifyPermissions privilege to invoke this method. If you hold the privilege on any ManagedEntity, you will have access to user and group information for the server.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the UserDirectory used to make the method call. |
domain* P | xsd:string |
Domain to be searched. If not set, then the method searches
the local machine.
Since 2.0 |
searchStr P | xsd:string |
Case insensitive substring used to filter results;
the search string is compared to the login and full name for users,
and the name and description for groups. Leave
this blank to match all users.
Since 2.0 |
belongsToGroup* P | xsd:string |
If present, the returned list contains only users or groups
that directly belong to the specified group. Users or groups that
have indirect membership will not be included in the list.
Since 2.0 |
belongsToUser* P | xsd:string |
If present, the returned list contains only groups that directly
contain the specified user. Groups that indirectly contain
the user will not be included in the list.
Since 2.0 |
exactMatch P | xsd:boolean |
Indicates the searchStr passed should match a user or
group name exactly.
Since 2.0 |
findUsers P | xsd:boolean |
True, if users should be included in the result.
Since 2.0 |
findGroups P | xsd:boolean |
True, if groups should be included in the result.
Since 2.0 |
Return Value
Type | Description |
---|---|
UserSearchResult[] |
Faults
Type | Description |
---|---|
NotFound | Thrown if any of the domain, belongsToGroup, or belongsToUser arguments refer to entities that do not exist. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |