mirror of
https://github.com/goauthentik/authentik
synced 2026-04-28 10:28:22 +02:00
127 lines
6.2 KiB
Plaintext
127 lines
6.2 KiB
Plaintext
---
|
|
title: Integrate with Zendesk
|
|
sidebar_label: Zendesk
|
|
support_level: community
|
|
---
|
|
|
|
import TabItem from "@theme/TabItem";
|
|
import Tabs from "@theme/Tabs";
|
|
|
|
## What is Zendesk
|
|
|
|
> Zendesk is a customer support and ticketing platform.
|
|
>
|
|
> -- https://zendesk.com
|
|
|
|
## Preparation
|
|
|
|
The following placeholders are used in this guide:
|
|
|
|
- `company.zendesk.com` is the FQDN of your Zendesk company portal.
|
|
- `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
|
|
|
|
Zendesk can be configured to use either OIDC or SAML. This guide covers both methods.
|
|
|
|
<Tabs
|
|
defaultValue="oidc"
|
|
values={[
|
|
{ label: "Log in with OIDC", value: "oidc" },
|
|
{ label: "Log in with SAML", value: "saml" },
|
|
]}>
|
|
<TabItem value="oidc">
|
|
|
|
## authentik configuration
|
|
|
|
To support the integration of Zendesk 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 **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.
|
|
- **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.
|
|
- Note the **Client ID**, **Client Secret**, and **slug** values because they will be required later.
|
|
- Set a `Strict` redirect URI to `https://company.zendesk.com/access/oidc/callback`.
|
|
- Select any available signing key.
|
|
- **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.
|
|
|
|
## Zendesk configuration
|
|
|
|
1. Log in to Zendesk as an administrator.
|
|
2. Navigate to **Security** > **Single sign-on (SSO)** > **Create SSO configuration** and click **OpenID Connect**.
|
|
- **Configuration name**: `authentik`
|
|
- **Client ID**: enter the client ID from authentik.
|
|
- **Client secret**: enter the client secret from authentik.
|
|
- **Scopes**: `openid profile email`
|
|
- **Issuer**: `https://authentik.company/application/o/<application_slug>/`
|
|
- **Authentication mode**: `PKCE`
|
|
- **Issuer url**: `https://authentik.company/application/o/<application_slug>/`
|
|
- **Show button when users sign in**: enabled
|
|
- **Button text**: `authentik`
|
|
|
|
3. Click **Submit**.
|
|
|
|
</TabItem>
|
|
<TabItem value="saml">
|
|
|
|
## authentik configuration
|
|
|
|
To support the integration of Zendesk 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 **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.
|
|
- Note the **slug** value because it will be required later.
|
|
- Set the **ACS URL** to `https://company.zendesk.com/access/saml/`.
|
|
- Set the **Issuer** to `https://authentik.company`.
|
|
- Set the **Service Provider Binding** to `Post`.
|
|
- Under **Advanced protocol settings**, set **Signing Certificate** to use any available 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.
|
|
|
|
### Copy the Certificate Fingerprint (SHA256)
|
|
|
|
1. Log in to authentik as an administrator and open the authentik Admin interface.
|
|
2. Go to **System** > **Certificates** and click the **>** symbol next to the certificate pair you selected in the previous step.
|
|
3. Take note of the **Certificate Fingerprint (SHA256)** as it will be required in the next step.
|
|
|
|
## Zendesk configuration
|
|
|
|
1. Log in to Zendesk as an administrator.
|
|
2. Navigate to **Security** > **Single sign-on (SSO)** > **Create SSO configuration** and click **SAML**.
|
|
- **Configuration name**: authentik
|
|
- **SAML SSO URL**: `https://authentik.company/application/saml/<application_slug>/sso/binding/post/`
|
|
- **Certificate fingerprint**: Paste the **Certificate Fingerprint (SHA256)** copied from authentik.
|
|
- **Remote logout URL**: `https://authentik.company/application/saml/<application_slug>/slo/binding/redirect/`
|
|
- **Show button when users sign in**: enabled
|
|
- **Button value**: `authentik`
|
|
|
|
3. Click **Submit**.
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
## Configuration verification
|
|
|
|
To confirm that authentik is properly configured with Zendesk, log out, then attempt to log back in by visit your Zendesk portal and clicking **Log in with authentik**.
|
|
|
|
## Resources
|
|
|
|
- [Zendesk Help - Setting up single sign-on with OpenID Connect (OIDC)](https://support.zendesk.com/hc/en-us/articles/7957465432474-Setting-up-single-sign-on-with-OpenID-Connect-OIDC)
|
|
- [Zendesk Help - Enabling SAML single sign-on](https://support.zendesk.com/hc/en-us/articles/4408887505690-Enabling-SAML-single-sign-on)
|