About the Directory
A URI is provided for users to allow them to search the directory and find addressable objects that can be used to send messages, be added to a private list, and so on. The directory can be searched several different ways. The example below searches for names that start with "user":
The directory can be searched by name or extension, or by both name and extension (to search by both name and extension, simply do not provide search criteria; see examples below). When searching by name, an alias, display name, first name, or last name on the object in question that matches the search term is treated as a match.
The directory can be searched in a "startswith" or "is" manner. A "startswith" search will match any field that starts with the search term, while an "is" search will match only those fields that exactly contain the search term.
The actual search argument can be either a string of all numbers, or a string of anything else. In most cases you would want to search by extension with numbers, and by name with alphanumeric characters.
All the matches are returned as Address objects. The Address objects contain all of the critical information that is needed to use these objects with other resources.