Skip to main content

Integrate with Zammad

Support level: Community

What is Zammad​

Zammad is a web-based, open source user support/ticketing solution. Download and install it on your own servers. For free.

-- https://zammad.org/

Preparation​

The following placeholders are used in this guide:

  • zammad.company is the FQDN of the Zammad installation.
  • authentik.company is the FQDN of the authentik installation.
note

This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application.

authentik configuration​

To support the integration of Zammad with authentik, you need to create an application/provider pair in authentik.

Create property mappings​

  1. Log in to authentik as an admin, and open the authentik Admin interface.
  2. Navigate to Customization > Property Mappings and click Create. Create two SAML Provider Property Mappings with the following settings:
    • Name Mapping:
      • Name: Choose a descriptive name
      • SAML Attribute Name: name
      • Friendly Name: Leave blank
      • Expression: return request.user.name
    • Email Mapping:
      • Name: Choose a descriptive name
      • SAML Attribute Name: email
      • Friendly Name: Leave blank
      • Expression: return request.user.email

Create an application and provider in authentik​

  1. Log in to authentik as an admin, and open the authentik Admin interface.
  2. Navigate to Applications > Applications and click Create with Provider to create an application and provider pair. (Alternatively you can first create a provider separately, then create the application and connect it with the provider.)
  • Application: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings. Take note of the slug as it will be required later.
  • Choose a Provider type: select SAML Provider as the provider type.
  • Configure the Provider: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations.
    • Set the ACS URL to https://zammad.company/auth/saml/callback.
    • Set the Issuer to https://zammad.company/auth/saml/metadata.
    • Set the Audience to https://zammad.company/auth/saml/metadata.
    • Set the Service Provider Binding to Post.
    • Under Advanced protocol settings, add the two Property Mappings you created in the previous section, then set the NameID Property Mapping to the name property mapping created in the previous section.
  • Configure Bindings (optional): you can create a binding (policy, group, or user) to manage the listing and access to applications on a user's My applications page.
  1. Click Submit to save the new application and provider.

zammad Setup​

Configure Zammad SAML settings by going to settings (the gear icon), and selecting Security -> Third-party Applications and activate Authentication via SAML and change the following fields:

Additional Resources​