@digitalpersona/services
Version:
DigitalPersona Web Access Services
23 lines (15 loc) • 1.64 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@digitalpersona/services](./services.md) > [SearchQuery](./services.searchquery.md)
## SearchQuery interface
<b>Signature:</b>
```typescript
export interface SearchQuery
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [attributes](./services.searchquery.attributes.md) | <code>string[]</code> | A list of strings with object attributes requested. NOTE: the bigger list of attributes requested, the slower the search, and the larger amount of data to be transferred over networks. |
| [baseDN](./services.searchquery.basedn.md) | <code>string</code> | A distinguished name of the entry at which to start the search. This is an optional parameter and if it set to <code>null</code> we will perform the search from a default base (an AD root for the DPCA AD Server, LDS partition root for the DPCA LDS Server) |
| [filter](./services.searchquery.filter.md) | <code>string</code> | A search filter. Check https://msdn.microsoft.com/en-us/library/aa746475(v=vs.85).aspx for LDAP filter syntax. |
| [scope](./services.searchquery.scope.md) | <code>SearchScope</code> | A scope of the search. |
| [sort](./services.searchquery.sort.md) | <code>string</code> | A name of the attribute to perform result sorting. For example, <code>"cn"</code> will sort users search results based on the “cn” (Common Name) attribute. NOTE: Sorting can be performed only on indexed attributes. This is optional parameter and it can be set to null if sorting is not required. |