Iskra API Reference
    Preparing search index...

    Interface SearchOptions

    interface SearchOptions {
        attributes?: readonly string[];
        base?: string;
        binaryAttributes?: readonly string[];
        filter?: string;
        pageSize?: number | false;
        scope?: "sub" | "base" | "one";
        sizeLimit?: number;
    }
    Index
    attributes? base? binaryAttributes? filter? pageSize? scope? sizeLimit?
    attributes?: readonly string[]

    Default: every user attribute.

    base?: string

    Default baseDN.

    binaryAttributes?: readonly string[]

    Attributes read as bytes. Default objectGUID and objectSid.

    filter?: string

    Default (objectClass=*). Build it with ldapFilter to escape values.

    pageSize?: number | false

    Entries per page; false for one request without paging. Default pageSize (500).

    scope?: "sub" | "base" | "one"

    Default 'sub'.

    sizeLimit?: number

    At most this many entries.

    Settings
    Member Visibility

    On This Page
    Properties