This method searches the directory and returns entities whose names or email
addresses or phone numbers matching the specified
name; no
assumption must be made about the type of entities that may be
returned except that they are likely to be limited to one or more subtypes
of
directoryEntry
The returned entities will only contain limited data.
More specifically, only the following attributes will be returned.
- Name
- All
addresses and
numbers
- Default email address and phone number
The matched entities should subsequently be loaded with suitable
projections to fetch other data, if required.
URI: /comb/v1/d/directory/search
HTTP Method: POST
Request Parameters: (expand)
| Name |
Style |
Required |
Description |
name |
Query |
 |
the search key; the % (percent) character may be prefixed,
suffixed or both for endsWith, beginsWith or contains match respectively. |
maxresults |
Query |
|
the result set size which must be equal to or smaller
than 250. |
accept |
Header |
- application/json
- application/xml
|
Directive to the server, indicating the format of the returned payload (or error class) |
runas |
Query |
 |
Identity under-which to execute this operation. Callers require permission to run as a different identity. |
suppress_20x_code |
Query |
|
Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault. |
anticsrf |
Query |
|
Specifies the anti-CSRF token |
Request Payload:
Response Payload: list<Addressable>
Fault: restFault
| HTTP Status |
Description |
| 400 |
Error processing "runas" value |
| 400 |
Invalid value specified for query parameter |
| 400 |
Required header not specified |
| 400 |
Required query parameter not specified |
| 406 |
Unsupported value in Accept header |
| 500 |
Internal error occurred |
