ts-mailcow-api
    Preparing search index...

    Interface KeycloakIdentityProviderAttributes

    Identity provider attributes for an external Keycloak server.

    interface KeycloakIdentityProviderAttributes {
        authsource: "keycloak";
        client_id: string;
        client_secret: string;
        default_template?: string;
        ignore_ssl_error?: boolean;
        import_users?: boolean;
        mailpassword_flow?: boolean;
        mappers?: string[];
        periodic_sync?: boolean;
        realm: string;
        redirect_url: string;
        redirect_url_extra?: string[];
        server_url: string;
        sync_interval?: number;
        templates?: string[];
        version: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authsource client_id client_secret default_template? ignore_ssl_error? import_users? mailpassword_flow? mappers? periodic_sync? realm redirect_url redirect_url_extra? server_url sync_interval? templates? version

    Properties

    authsource: "keycloak"
    client_id: string

    Client ID of the Mailcow OIDC client inside the realm.

    client_secret: string

    Client secret paired with client_id. Sent back from Mailcow as "*" once configured.

    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
    mailpassword_flow?: boolean

    Validate user passwords via the Keycloak admin REST API instead of relying only on the Authorization Code Flow. Required for IMAP/SMTP to keep working when Keycloak is the source of truth for passwords.

    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
    realm: string

    Keycloak realm where the Mailcow client is configured.

    redirect_url: string

    Primary redirect URL configured for the Mailcow client in Keycloak.

    redirect_url_extra?: string[]

    Additional accepted redirect URLs.

    server_url: string

    Base URL of the Keycloak server (no trailing slash needed).

    sync_interval?: number

    Interval, in minutes, between periodic syncs.

    15
    templates?: string[]

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

    version: string

    Keycloak version (for example 26.1.3). Mailcow uses this to pick the right admin API shape internally.

    Settings

    Member Visibility

    On This Page

    Properties