diff --git a/website/integrations/services/zammad/index.md b/website/integrations/services/zammad/index.md index 7e5ef72872..26d6edc0f2 100644 --- a/website/integrations/services/zammad/index.md +++ b/website/integrations/services/zammad/index.md @@ -26,21 +26,6 @@ This documentation lists only the settings that you need to change from their de 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 administrator 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**: 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 administrator and open the authentik Admin interface. @@ -53,21 +38,29 @@ To support the integration of Zammad with authentik, you need to create an appli - 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. + - Under **Advanced protocol settings**, select an available signing certificate. - **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 +### Download certificate file -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: +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. -- 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 +## Zammad configuration + +To configure the Zammad SAML options go to **Settings** (the gear icon) and select **Security** > **Third-party Applications**. Next, activate the **Authentication via SAML** toggle and change the following fields: + + - **Display name**: authentik + - **IDP SSO target URL**: `https://authentik.company/application/saml//sso/binding/post/` + - **IDP single logout target URL**: `https://authentik.company/application/saml//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. ## Additional Resources