ts-mailcow-api
    Preparing search index...

    Interface LdapIdentityProviderAttributes

    Identity provider attributes for an external LDAP / Active Directory server.

    interface LdapIdentityProviderAttributes {
        attribute_field: string;
        authsource: "ldap";
        basedn: string;
        binddn: string;
        bindpass: string;
        default_template?: string;
        filter?: string;
        host: string;
        ignore_ssl_error?: boolean;
        import_users?: boolean;
        mappers?: string[];
        periodic_sync?: boolean;
        port: string;
        sync_interval?: number;
        templates?: string[];
        use_ssl?: boolean;
        use_tls?: boolean;
        username_field?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attribute_field authsource basedn binddn bindpass default_template? filter? host ignore_ssl_error? import_users? mappers? periodic_sync? port sync_interval? templates? use_ssl? use_tls? username_field?

    Properties

    attribute_field: string

    LDAP attribute whose value Mailcow maps to a mailbox template via mappers / templates.

    authsource: "ldap"
    basedn: string

    Base DN under which user searches are performed.

    binddn: string

    Bind DN used to perform user searches.

    bindpass: string

    Password for binddn.

    default_template?: string

    If no matching attribute mapping exists for a user, the default template is used when creating the mailbox (not on update). Mailcow expects the template name as configured under "Mailbox templates".

    filter?: string

    Optional LDAP search filter to limit who may authenticate.

    host: string

    Hostname (or comma-separated list of hostnames for fallback) of the LDAP server.

    ignore_ssl_error?: boolean

    Skip TLS certificate validation when contacting the auth source.

    false
    import_users?: boolean

    Whether new users discovered during a sync should be imported into Mailcow as mailboxes.

    false
    mappers?: string[]

    Attribute values used to match a mailbox template. Each element pairs positionally with templates -- the n-th mappers entry selects the n-th templates entry.

    periodic_sync?: boolean

    Whether Mailcow should periodically pull every user from the auth source. Defaults to false; combine with sync_interval and import_users to enable scheduled syncs.

    false
    port: string

    LDAP port as a string.

    sync_interval?: number

    Interval, in minutes, between periodic syncs.

    15
    templates?: string[]

    Mailbox template names. See mappers for how the two arrays are correlated.

    use_ssl?: boolean

    Use LDAPS. If port is 389 it is forced to 636.

    false
    use_tls?: boolean

    Use StartTLS. Mutually exclusive with use_ssl; preferred over SSL.

    false
    username_field?: string

    LDAP attribute used to identify users at login.

    'mail'

    Settings

    Member Visibility

    On This Page

    Properties