ts-mailcow-api
    Preparing search index...

    Interface BaseIdentityProviderAttributes

    Attributes shared across every identity-provider configuration, regardless of which auth source it targets.

    interface BaseIdentityProviderAttributes {
        default_template?: string;
        ignore_ssl_error?: boolean;
        import_users?: boolean;
        mappers?: string[];
        periodic_sync?: boolean;
        sync_interval?: number;
        templates?: string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    default_template? ignore_ssl_error? import_users? mappers? periodic_sync? sync_interval? templates?

    Properties

    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".

    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
    sync_interval?: number

    Interval, in minutes, between periodic syncs.

    15
    templates?: string[]

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

    Settings

    Member Visibility

    On This Page

    Properties