Iskra API Reference
    Preparing search index...

    Interface LdapConfig

    interface LdapConfig {
        baseDN: string;
        bindDN: string;
        bindPassword: string;
        connectTimeoutMs?: number;
        directory?: DirectoryKind;
        groups?: { base?: string };
        pageSize?: number;
        startTLS?: boolean;
        timeoutMs?: number;
        tls?: ConnectionOptions;
        transport?: LdapTransportFactory;
        url: string | readonly string[];
        users?: {
            attributes?: readonly string[];
            base?: string;
            binaryAttributes?: readonly string[];
            filter?: string;
        };
    }
    Index
    baseDN bindDN bindPassword connectTimeoutMs? directory? groups? pageSize? startTLS? timeoutMs? tls? transport? url users?
    baseDN: string

    Where users and groups are searched: DC=corp,DC=example,DC=com.

    bindDN: string

    The service account that searches: a DN, or in Active Directory a UPN (svc-app@corp.example.com).

    bindPassword: string
    connectTimeoutMs?: number

    Default 5000.

    directory?: DirectoryKind

    Default 'activeDirectory'.

    groups?: { base?: string }

    Type Declaration

    • Optionalbase?: string

      Default baseDN.

    pageSize?: number

    Entries per page of a search (the paged results control). Default 500.

    startTLS?: boolean

    Upgrades ldap:// connections with StartTLS.

    timeoutMs?: number

    Each operation's limit, after which its connection is closed. Default 10000.

    tls?: ConnectionOptions

    For ldaps:// and StartTLS: ca (the directory's CA), servername…

    transport?: LdapTransportFactory

    How connections are made: ldapts by default.

    url: string | readonly string[]

    ldaps://dc1.corp.example.com:636, or several, tried in order when one cannot be reached.

    users?: {
        attributes?: readonly string[];
        base?: string;
        binaryAttributes?: readonly string[];
        filter?: string;
    }

    Type Declaration

    • Optionalattributes?: readonly string[]

      Attributes to read besides the defaults (employeeID, department…).

    • Optionalbase?: string

      Default baseDN.

    • OptionalbinaryAttributes?: readonly string[]

      Of those, the binary ones (read as bytes).

    • Optionalfilter?: string

      The filter that finds a user by login; {login} is the login, escaped. Default in AD: by sAMAccountName or userPrincipalName (a DOMAIN\user login is taken as user); in OpenLDAP by uid.

    Settings
    Member Visibility

    On This Page
    Properties