Interface SearchOptions

Options for LdapSession.search and the one-shot search.

interface SearchOptions {
    attributes?: string[];
    base: string;
    filter?: string | Filter;
    scope?: SearchScope;
    sizeLimit?: number;
}

Properties

attributes?: string[]

Attribute names to return; empty or omitted returns all user attributes.

base: string

The base DN to search under.

filter?: string | Filter

A filter string (RFC 4515) or structured Filter; defaults to (objectClass=*).

Search scope; defaults to 'sub'.

sizeLimit?: number

Maximum number of entries the server should return (0 = no client-side limit).