edgeport - v1.0.3
    Preparing search index...

    Interface LdapConnectOptions

    Options for connect and search.

    interface LdapConnectOptions {
        bindDN?: string;
        expectedServerHostname?: string;
        hostname: string;
        password?: string;
        port?: number;
        timeoutMs?: number;
        tls?: "off" | "starttls" | "implicit";
    }

    Hierarchy (View Summary)

    Index
    bindDN? expectedServerHostname? hostname password? port? timeoutMs? tls?
    bindDN?: string

    Bind DN; when provided, connect binds before returning.

    expectedServerHostname?: string

    Hostname the server's TLS certificate must match (server-identity verification). Applies to the StartTLS upgrade; defaults to LdapConnectOptions.hostname. For implicit LDAPS the runtime validates the certificate against the connection hostname directly.

    hostname: string

    Remote LDAP host.

    password?: string

    Bind password; paired with LdapConnectOptions.bindDN.

    port?: number

    Remote port; defaults to 389 (or 636 via edgeport/ldaps).

    timeoutMs?: number

    Per-operation read deadline in milliseconds.

    tls?: "off" | "starttls" | "implicit"

    Transport security:

    • 'off' (default): plaintext LDAP.
    • 'implicit': TLS from the first byte (LDAPS).
    • 'starttls': plaintext, upgraded with the StartTLS extended operation before bind.

    Settings
    Member Visibility

    On This Page
    Properties