Connect your SAML identity provider as a single sign-on (SSO) method.
🤷 What is SAML?
SAML is an open standard for SSO authentication (among other things). Sign-ins are shared across multiple service providers and managed by a central identity provider (IdP).
This guide assumes you are already using SAML within your organization (i.e., that your IdP is fully set up).
Step 1: Configure Your IdP¶
Add Zammad as a client/app¶
Import Zammad into your IdP using the XML configuration
🙋 What if my IdP doesn’t support XML import?
You will have to configure Zammad as a new client/app manually using the above XML metadata file for reference. For instance, when you see this tag:
<md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="http://your.zammad.domain/auth/saml/callback" index="0" isDefault="true"/>
Set the Assertion Consumer Service Binding URL
(sometimes also listed as Valid Redirect URIs)
Set up user attribute mapping¶
Zammad requests the following user attributes (or “properties”) from the IdP:
Email address (
Full name (
Given name (
Family name (
You may need to set up “mappers” (or “mappings”) to tell your IdP how user attributes in SAML correspond to those in Zammad. For a more detailed breakdown, refer to the XML metadata file referenced in the previous section.
To add Zammad as a client, save the XML configuration to disk (
https://your.zammad.domain/auth/saml/metadata) and use Clients > Clients list > Import client in the Keycloak admin panel.
To help Zammad match its own user accounts to Keycloak users, create a user attribute (or “property”) mapper. In Clients list, click on your newly created Client ID, choose the tab Client scopes and click on the link which refers to your Zammad instance. Choose Add mapper > By configuration > User Property and create a mapper with the following entries:
SAML Attribute Name
SAML Attribute NameFormat
In the example above, we’re telling Zammad that whenever it receives a SAML login request, it should take the
If your Keycloak users’ email addresses are stored on another property (e.g.,
username), adjust accordingly.
Back in Settings, enter the Client ID (
https://your.zammad.domain/auth/saml/metadata) in the field Master SAML Processing URL.
You also need to enable Sign assertions.
Step 2: Configure Zammad¶
Enable SAML and enter your IdP’s details in the Admin Panel under Settings > Security > Third Party Applications > Authentication via SAML:
- Display name
Allows you to define a custom button name for SAML. This helps your users to understand better what the button on the login page does.
- IDP SSO Target URL
This is the target URL Zammad shall redirect to when the user presses the SAML button. For Keycloak, this needs to look like https://your.domain/realms/your-realm/protocol/saml
- IDP Certificate
The public certificate of your IDP for Zammad to verify during the callback phase.
- IDP Certificate fingerprint
The fingerprint of your IDPs public certificate to verify during callback phase.
🔏 For the IdP certificate / certificate fingerprint:
Provide only one or the other—do not provide both! (Between the two, we recommend the signing certificate itself: fingerprints use SHA-1, which has been broken for a while now.)
Keycloak users: Find your certificate in the Keycloak admin panel under Realm Settings > Keys > Algorithm: RS256 > Certificate.
- Name Identifier format
This is the unique identifiers field type. Usually should be
urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddressin any case.
Zammad expects an email address as unique identifier!
- Your callback URL
This URL is needed for your IDP configuration so it knows where to redirect to after successful authentication.
See automatic account linking for details on how to link existing Zammad accounts to IdP accounts.
- Automatic account linking doesn’t work
Have you double-checked your IdP’s user attribute mapping configuration?