habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website/integrations-all: convert authentik configuration to wizard (#13144)

Browse Source 
* 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
This commit is contained in:
Dominic R
2025-03-26 17:38:57 -04:00
committed by GitHub
parent 27aed4b315
commit 13fc216c68
93 changed files with 2248 additions and 2070 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
website/integrations/services/zammad/index.md
View File

@ -22,45 +22,41 @@ The following placeholders are used in this guide:
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
## authentik configuration
### Step 1 - Property Mappings
To support the integration of Zammad with authentik, you need to create an application/provider pair in authentik.
Create two Mappings (under _Customization/Property Mappings_) with these settings:
### Create property mappings
#### name mapping
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>
- Name: Zammad SAML Mapping: name
- SAML Attribute Name: name
- Friendly Name: none
- Expression: `return request.user.name`
### Create an application and provider in authentik
#### email mapping
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**.)
- Name: Zammad SAML Mapping: email
- SAML Attribute Name: email
- Friendly Name: none
- Expression: `return request.user.email`
- **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.
### Step 2 - SAML Provider
In authentik, create a SAML Provider (under _Applications/Providers_) with these settings :
- Name : zammad
- ACS URL: `https://zammad.company/auth/saml/callback`
- Issuer: `https://zammad.company/auth/saml/metadata`
- Service Provider Binding: Post
- Audience: `https://zammad.company/auth/saml/metadata`
- Property mappings: Zammad SAML Mapping: name & Zammad SAML Mapping: email
- NameID Property Mapping: Zammad SAML Mapping: name
### Step 3 - Application
In authentik, create an application (under _Resources/Applications_) with these settings :
- Name: Zammad
- Slug: zammad
- Provider: zammad
3. Click **Submit** to save the new application and provider.
## zammad Setup