ts-mailcow-api
    Preparing search index...

    Interface GenericOidcIdentityProviderAttributes

    Identity provider attributes for an arbitrary OIDC provider that is not Keycloak (Authentik, Auth0, Okta, ...).

    interface GenericOidcIdentityProviderAttributes {
        authorize_url: string;
        authsource: "generic-oidc";
        client_id: string;
        client_scopes?: string;
        client_secret: string;
        default_template?: string;
        ignore_ssl_error?: boolean;
        import_users?: boolean;
        mappers?: string[];
        periodic_sync?: boolean;
        redirect_url: string;
        redirect_url_extra?: string[];
        sync_interval?: number;
        templates?: string[];
        token_url: string;
        userinfo_url: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authorize_url authsource client_id client_scopes? client_secret default_template? ignore_ssl_error? import_users? mappers? periodic_sync? redirect_url redirect_url_extra? sync_interval? templates? token_url userinfo_url

    Properties

    authorize_url: string

    Authorization endpoint URL.

    authsource: "generic-oidc"
    client_id: string

    Client ID issued by the OIDC provider.

    client_scopes?: string

    Space-separated list of OIDC scopes requested at login.

    'openid profile email mailcow_template'
    client_secret: string

    Client secret issued by the OIDC provider.

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

    Primary redirect URL registered with the provider.

    redirect_url_extra?: string[]

    Additional accepted redirect URLs.

    sync_interval?: number

    Interval, in minutes, between periodic syncs.

    15
    templates?: string[]

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

    token_url: string

    Token endpoint URL.

    userinfo_url: string

    Userinfo endpoint URL.

    Settings

    Member Visibility

    On This Page

    Properties