mirror of
https://github.com/goauthentik/authentik
synced 2026-04-27 18:07:15 +02:00
6ed5cb5249
* website/integrations: rename "Create with Provider" to "New Application" The application list page now uses a split-button labeled "New Application" instead of the old "Create with Provider" dropdown. Update all 113 integration guides to match. * website/docs: update flow, stage, and policy button labels - "Create" → "New Flow", "New Stage", "New Policy" for trigger buttons - "Finish" → "Create Flow", "Create Stage", "Create Policy" for submit - "Create and bind stage" → "New Stage" / "Bind Existing Stage" - "Create" (binding submit) → "Create Stage Binding" * website/docs: update provider button labels - "Create" → "New Provider" for trigger buttons - "Create with Provider" → "New Application" in RAC docs - "Create" → "New Property Mapping", "New RAC Endpoint", "New Prompt" for related entity creation * website/docs: update directory button labels - "Create" → "New Source" for federation/social login pages - "Create" → "New Role", submit → "Create Role" - "Create" → "New Invitation" - Policy binding submit → "Create Policy Binding" * website/docs: update endpoint device and system management button labels - "Create" → "New Endpoint Connector", "New Enrollment Token", "New Device Access Group", "New Flow" - Submit → "Create Device Access Group" - "Create" → "New Notification Rule", "New Notification Transport" - Binding submit → "Create Policy Binding" * Reorganize policy documentation * website/docs: address policy docs review feedback * post-rebase * website/docs: Reorganize policy documentation -- Revisions (#21601) * apply suggestions * Fix escaped. * Fix whitespace. * Update button label. * Fix phrasing. * Fix phrasing. * Clean up stragglers. * Format. --------- Co-authored-by: Dominic R <dominic@sdko.org>
138 lines
7.3 KiB
Markdown
138 lines
7.3 KiB
Markdown
---
|
|
title: Integrate with Zammad
|
|
sidebar_label: Zammad
|
|
support_level: community
|
|
---
|
|
|
|
import TabItem from "@theme/TabItem";
|
|
import Tabs from "@theme/Tabs";
|
|
|
|
## 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.
|
|
|
|
:::info
|
|
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.
|
|
:::
|
|
|
|
## Configuration methods
|
|
|
|
There are two ways to configure single sign-on for Zammad; SAML or OIDC.
|
|
|
|
<Tabs
|
|
defaultValue="saml"
|
|
values={[
|
|
{ label: "Log in with SAML", value: "saml" },
|
|
{ label: "Log in with OIDC", value: "oidc" },
|
|
]}>
|
|
<TabItem value="saml">
|
|
|
|
## authentik configuration
|
|
|
|
To support the integration of Zammad with authentik, you need to create an application/provider pair in authentik.
|
|
|
|
### Create an application and provider in authentik
|
|
|
|
1. Log in to authentik as an administrator and open the authentik Admin interface.
|
|
2. Navigate to **Applications** > **Applications** and click **New Application** to open the application wizard.
|
|
- **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`.
|
|
- Set the **SLS URL** to `https://zammad.company/auth/saml/slo`.
|
|
- Set the **SLS Binding** to `Redirect`.
|
|
- Set the **Logout Method** to `Front-channel (Iframe)`.
|
|
- Under **Advanced protocol settings**, select an available **Signing certificate**.
|
|
- **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/bindings-overview/) (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.
|
|
|
|
### Download certificate file
|
|
|
|
1. Log in to authentik as an administrator and open the authentik Admin interface.
|
|
2. Navigate to **Applications** > **Providers** and click on the name of the provider that you created in the previous section (e.g. `Provider for zammad`).
|
|
3. Under **Related objects** > **Download signing certificate**, click on **Download**. This downloaded file is your certificate file and it will be required in the next section.
|
|
|
|
## Zammad configuration
|
|
|
|
To configure Zammad's integration with authentik, go to **Settings** (the gear icon) and select **Security** > **Third-party Applications**. Next, activate the **Authentication via SAML** toggle and change the following fields:
|
|
|
|
1. Set the following fields:
|
|
- **Display name**: authentik
|
|
- **IDP SSO target URL**: `https://authentik.company/application/saml/<application_slug>/sso/binding/redirect/`
|
|
- **IDP single logout target URL**: `https://authentik.company/application/saml/<application_slug>/slo/binding/redirect/`
|
|
- **IDP Certificate**: paste the contents of your certificate file.
|
|
- **IDP certificate fingerprint**: Leave this empty.
|
|
- **Name Identifier Format**: `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress`
|
|
- **Automatic account link on initial logon**: Enable this to automatically create Zammad users when they sign in using authentik for the first time.
|
|
2. Click **Submit** to save the authentication settings.
|
|
|
|
:::info
|
|
The **SSL verification** can fail when Zammad tries to connect to authentik directly, while accessing authentik in your browser works perfectly fine. You may have to disable the verification in order to save the configuration. See https://github.com/zammad/zammad/issues/5225 for details.
|
|
:::
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="oidc">
|
|
|
|
## authentik configuration
|
|
|
|
To support the integration of Zammad with authentik, you need to create an application/provider pair in authentik.
|
|
|
|
### Create an application and provider in authentik
|
|
|
|
1. Log in to authentik as an administrator and open the authentik Admin interface.
|
|
2. Navigate to **Applications** > **Applications** and click **New Application** to open the application wizard.
|
|
- **Application**: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings.
|
|
- **Choose a Provider type**: select **OAuth2/OpenID Connect** 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 **Client type** to `Public`.
|
|
- Take note of the **Client ID** and **slug** values because they will be required later.
|
|
- Set the **Redirect URIs/Origins** to `Strict` / `https://zammad.company/auth/openid_connect/callback`.
|
|
- Select a **Signing Key**.
|
|
- Under **Advanced protocol settings**, set **Subject mode** to **Based on the User's Email**.
|
|
- **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/bindings-overview/) (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 configuration
|
|
|
|
To configure Zammad's integration with authentik, go to **Settings** (the gear icon) and select **Security** > **Third-party Applications**. Next, activate the **Authentication via OpenID Connect** toggle and change the following fields:
|
|
|
|
1. Set the following fields:
|
|
- **Display name**: authentik
|
|
- **Identifier**: the **Client ID** from above.
|
|
- **Issuer**: `https://authentik.company/application/o/<application_slug>/`
|
|
- **PKCE**: set to **yes**.
|
|
|
|
2. Click **Submit** to save the authentication settings.
|
|
|
|
At the very top of the **Third-party Applications** page are a few additional settings:
|
|
|
|
- **Automatic account link on initial logon**: Enable this to automatically link existing Zammad users when they sign in using authentik for the first time.
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
## Configuration verification
|
|
|
|
To verify that authentik is correctly integrated with Zammad, log out of Zammad and then log back in by clicking the SAML or OIDC button on the login screen. The button will show the **Display Name** you specified above. You should be redirected to authentik to log in, and if the process is successful, you'll be logged in to the Zammad dashboard.
|
|
|
|
## Resources
|
|
|
|
- [Zammad Admin Documentation - SAML](https://admin-docs.zammad.org/en/latest/settings/security/third-party/saml.html)
|
|
- [Zammad Admin Documentation - OpenID Connect](https://admin-docs.zammad.org/en/latest/settings/security/third-party/openid-connect.html)
|