Skip to content

Conversation

@PeshekDotDev
Copy link
Contributor

Details

Add oidc and saml zendesk integration steps


Checklist

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)

If applicable

  • The documentation has been updated
  • The documentation has been formatted (make docs)

@PeshekDotDev PeshekDotDev requested a review from a team as a code owner October 20, 2025 00:09
@netlify
Copy link

netlify bot commented Oct 20, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 32d2a68
🔍 Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/68f70cdd9cf72200085139af

@netlify
Copy link

netlify bot commented Oct 20, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 32d2a68
🔍 Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/68f70cddbb260d0008e1c449
😎 Deploy Preview https://deploy-preview-17541--authentik-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Oct 20, 2025

Deploy Preview for authentik-integrations ready!

Name Link
🔨 Latest commit 32d2a68
🔍 Latest deploy log https://app.netlify.com/projects/authentik-integrations/deploys/68f70cdd389171000840c1d7
😎 Deploy Preview https://deploy-preview-17541--authentik-integrations.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@dominic-r dominic-r changed the title Add zendesk integration steps website/integrations: add zendesk Oct 20, 2025
@dominic-r dominic-r self-requested a review October 20, 2025 00:12
@codecov
Copy link

codecov bot commented Oct 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.93%. Comparing base (5e0bc44) to head (32d2a68).
⚠️ Report is 84 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17541      +/-   ##
==========================================
+ Coverage   92.92%   92.93%   +0.01%     
==========================================
  Files         868      868              
  Lines       47907    47913       +6     
==========================================
+ Hits        44517    44528      +11     
+ Misses       3390     3385       -5     
Flag Coverage Δ
e2e 45.24% <ø> (+0.03%) ⬆️
integration 23.19% <ø> (+0.01%) ⬆️
unit 91.07% <ø> (-0.01%) ⬇️
unit-migrate 91.12% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@PeshekDotDev
Copy link
Contributor Author

@dominic-r I'm open to ideas on what folder to put this in if you want it somewhere else. I just put it there for now to get it started

@dominic-r
Copy link
Member

iirc Zammad which is a ticketing solution, is in infrastructure/, but i'd consider moving this to chat-collaboration-communication/?

@github-actions
Copy link
Contributor

github-actions bot commented Oct 20, 2025

authentik PR Installation instructions

Instructions for docker-compose

Add the following block to your .env file:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-32d2a68795f3f663a7f81a0de072246b1523a377
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

Afterwards, run the upgrade commands from the latest release notes.

Instructions for Kubernetes

Add the following block to your values.yml file:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-32d2a68795f3f663a7f81a0de072246b1523a377

Afterwards, run the upgrade commands from the latest release notes.

Copy link
Contributor

@dewi-tik dewi-tik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I merged some minor changes and I have two comments. Otherwise it looks great.

- 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.
- Go to **System** > **Certificates** > and copy the **SHA-256 Fingerprint** of the certificate you selected in the previous step.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This certificate step should be a separate section like it is in other docs because you shouldn't leave the wizard before completing the steps.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made it step 4 after saving the provider. I wasn't other what integrations to check, but this felt intuitive to the flow. Please let me know if this is wrong

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like Zoom I'd say

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But copy the cert fingerprint instead of downloading it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. I added a new section with explicit steps, let me know what you think

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a few comments

Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @PeshekDotDev! Other than Dewi's comment about moving the cert step out of the steps that are done in the wizard, and moving it to the category, this looks great, good to have Zendesk added to our Int Guides!

@PeshekDotDev
Copy link
Contributor Author

@tanberry thanks! Those changes have been made, let me know what y'all think

Copy link
Member

@dominic-r dominic-r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few comments on my side + circling back to Dewi's comment on the cert steps

PeshekDotDev and others added 5 commits October 20, 2025 20:46
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Connor Peshek <connor@connorpeshek.me>
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Connor Peshek <connor@connorpeshek.me>
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Connor Peshek <connor@connorpeshek.me>
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Connor Peshek <connor@connorpeshek.me>
### Copy the signing certificate SHA256 fingerprint

1. Log in to authentik as an administrator and open the authentik Admin interface.
2. Go to **System** > **Certificates** > and click the certificate pair you selected in the previous step.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Go to **System** > **Certificates** > and click the certificate pair you selected in the previous step.
2. Go to **System** > **Certificates** and click the certificate pair you selected in the previous step.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh and if my memory serves me well, clicking on the name of the cert pair doesn't work, you need to explicitly click on the >

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is true. I do not like this in our UI, but your statement is accruate. Updated

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you could mention it in #team-frontend

PeshekDotDev and others added 3 commits October 20, 2025 21:08
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Connor Peshek <connor@connorpeshek.me>
Signed-off-by: Connor Peshek <connor@connorpeshek.me>
- 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I like this wording too much, I'll try to think of a better way to formulate it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright. This was a copy paste from another integration, so multiple integrations probably use this wording. Lot's of integrations use different wording for this, so maybe lets change all of that in a different PR that handles all of those

- **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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like in SAML we need to say where

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is another copy paste, I searched across the repo and this wording is used 87 different files. So let's address that in a different PR

PeshekDotDev and others added 3 commits October 20, 2025 23:28
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Connor Peshek <connor@connorpeshek.me>
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Connor Peshek <connor@connorpeshek.me>
Signed-off-by: Connor Peshek <connor@connorpeshek.me>
@dominic-r dominic-r self-requested a review October 21, 2025 20:48
Copy link
Member

@dominic-r dominic-r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good looking doc!

Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge, and list in the 2025.10 Rel Notes as a new Int Guide! Thanks so much @PeshekDotDev !

@PeshekDotDev
Copy link
Contributor Author

Thank you all! Looking forward to getting this in the integration list for the release notes :D

@PeshekDotDev PeshekDotDev merged commit 157aef6 into main Oct 21, 2025
99 checks passed
@PeshekDotDev PeshekDotDev deleted the add-zendesk-integration branch October 21, 2025 20:58
kensternberg-authentik added a commit that referenced this pull request Nov 10, 2025
* main: (213 commits)
  web: bump @types/node from 24.9.0 to 24.9.1 in /packages/prettier-config (#17617)
  web: bump @types/node from 22.15.19 to 24.9.1 in /web (#17618)
  web: bump knip from 5.66.1 to 5.66.2 in /web (#17619)
  translate: Updates for file web/xliff/en.xlf in pt_BR (#17639)
  core, web: update translations (#17643)
  website/docs: rel notes 2025.10: add 3 more integration guides (#17641)
  providers/proxy: drop headers with underscores (#17650)
  core: bump astral-sh/uv from 0.9.4 to 0.9.5 (#17645)
  web: bump style-mod from 4.1.2 to 4.1.3 in /web (#17647)
  core: bump github.com/getsentry/sentry-go from 0.36.0 to 0.36.1 (#17646)
  website/integrations: add terraform cloud (#17610)
  website/integrations: add zendesk (#17541)
  core: bump djangorestframework from 3.16.0 (our fork) to v3.16.1 (official package) (#16594)
  enterprise: add prometheus metrics for license usage and expiry (#17606)
  ci: link to next. for pre-release docs (#17634)
  web: sync web/package-lock.json (#17611)
  website/integrations: random fixes (#17631)
  website/docs: add short-lived certificate recommendation (#17628)
  core, web: update translations (#17605)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in pt_BR (#17622)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants