13fc216c68
* init * 6 more * tana... * quick reformat * welp only time for one change * wip * wip * wip * wip * wip * wip * wip * wip * Revert "wip" This reverts commit e71f0d22e3f093350e8d12eaad5e5c0f9d38253c. * wip * wip * wip * wip * wip * wip * wip * wip * wip * a
76 lines
3.8 KiB
Markdown
76 lines
3.8 KiB
Markdown
---
|
|
title: Integrate with Zammad
|
|
sidebar_label: 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 Mapping**s with the following settings:
|
|
- **Name Mapping:**
|
|
- **Name**: Choose a descriptive name
|
|
- **SAML Attribute Name**: <kbd>name</kbd>
|
|
- **Friendly Name**: Leave blank
|
|
- **Expression**: <kbd>return request.user.name</kbd>
|
|
- **Email Mapping:**
|
|
- **Name**: Choose a descriptive name
|
|
- **SAML Attribute Name**: <kbd>email</kbd>
|
|
- **Friendly Name**: Leave blank
|
|
- **Expression**: <kbd>return request.user.email</kbd>
|
|
|
|
### 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 create only an application, without a provider, by clicking **Create**.)
|
|
|
|
- **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 <kbd>https://<em>zammad.company</em>/auth/saml/callback</kbd>.
|
|
- Set the **Issuer** to <kbd>https://<em>zammad.company</em>/auth/saml/metadata</kbd>.
|
|
- Set the **Audience** to <kbd>https://<em>zammad.company</em>/auth/saml/metadata</kbd>.
|
|
- 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](/docs/add-secure-apps/flows-stages/bindings/) (policy, group, or user) to manage the listing and access to applications on a user's **My applications** page.
|
|
|
|
3. 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:
|
|
|
|
- Display name: authentik
|
|
- IDP SSO target URL: https://authentik.company/application/saml/zammad/sso/binding/init/
|
|
- IDP single logout target URL: https://zammad.company/auth/saml/slo
|
|
- IDP certificate: ----BEGIN CERTIFICATE---- …
|
|
- IDP certificate fingerprint: empty
|
|
- Name Identifier Format: empty
|
|
|
|
## Additional Resources
|
|
|
|
- https://admin-docs.zammad.org/en/latest/settings/security/third-party/saml.html
|
|
- https://community.zammad.org/t/saml-authentication-with-authentik-saml-login-url-and-auto-assign-permission/10876/3
|