-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
website/integrations: add zendesk #17541
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Deploy Preview for authentik-storybook canceled.
|
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for authentik-integrations ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
@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 |
|
iirc Zammad which is a ticketing solution, is in infrastructure/, but i'd consider moving this to chat-collaboration-communication/? |
|
authentik PR Installation instructions Instructions for docker-composeAdd the following block to your 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)sAfterwards, run the upgrade commands from the latest release notes. Instructions for KubernetesAdd the following block to your 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-32d2a68795f3f663a7f81a0de072246b1523a377Afterwards, run the upgrade commands from the latest release notes. |
website/integrations/chat-communication-collaboration/zendesk/index.mdx
Outdated
Show resolved
Hide resolved
dewi-tik
left a comment
There was a problem hiding this 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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a few comments
tanberry
left a comment
There was a problem hiding this 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!
|
@tanberry thanks! Those changes have been made, let me know what y'all think |
dominic-r
left a comment
There was a problem hiding this 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
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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. |
There was a problem hiding this comment.
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 >
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
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
left a comment
There was a problem hiding this 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!
tanberry
left a comment
There was a problem hiding this 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 !
|
Thank you all! Looking forward to getting this in the integration list for the release notes :D |
* 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) ...
Details
Add oidc and saml zendesk integration steps
Checklist
ak test authentik/)make lint-fix)If an API change has been made
make gen-build)If changes to the frontend have been made
make web)If applicable
make docs)