PersonSearch.searchByFilter()

The method searches for a person by a filter.

Availability

IBM® Tivoli® Identity Manager 4.x

IBM Tivoli Identity Manager 5.x

IBM Security Identity Manager 6.x

IBM Security Identity Manager 7.0.

Synopsis
personSearch.searchByFilter(profileName, filter, scope)
Arguments
profileName
The name of the person profile to use.
filter
LDAP search filter that defines the criteria for returned containers to meet. The filter must be in the format defined by RFC2254.
scope
Optional search scope. Use 1 for One Level Scope and 2 for SubTree Scope. One Level Scope is the default scope.
Returns
An array of DirectoryObjects representing the results of the search.
Description
This method searches for a person by a filter.
Usage
var personSearch = new PersonSearch();
var searchResult1 = personSearch.searchByFilter("Person", 
  "(sn=Smith)", 2);

// use default one level scope
var searchResult2 = personSearch.searchByFilter("Person", 
    "(sn=Smith)");