Skip to content

website/integrations: Update Zammad SAML Instructions#14774

Merged
tanberry merged 18 commits intogoauthentik:mainfrom
pacohope:update-zammad-saml
Jun 2, 2025
Merged

website/integrations: Update Zammad SAML Instructions#14774
tanberry merged 18 commits intogoauthentik:mainfrom
pacohope:update-zammad-saml

Conversation

@pacohope
Copy link
Contributor

Details

I just configured Zammad 6.4.1 to work with Authentik 2025.4.1. There seem to have been some changes since these instructions were written. Zammad does not allow the Name ID Format to be blank. The SSO URL and the logout URL were incorrect. I was getting an Error 422 from Zammad until I turned on signing assertions, so I conclude that is required and I wrote instructions for that. I saw some discussion online elsewhere that the ----BEGIN and ---END lines should be removed. I tested it both ways and it worked both ways. I wrote the instructions to keep those lines in because it seemed simplest and most intuitive.


If applicable

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

I just configured Zammad 6.4.1 to work with Authentik 2025.4.1. There seem to have been some changes since these instructions were written. The Name ID Format cannot be left blank. The SSO URL and the logout URL were incorrect. I was getting an Error 422 from Zammad until I turned on signing assertions, so I conclude that is required and I wrote instructions for that. I saw some discussion online elsewhere that the `----BEGIN` and `---END` lines should be removed. I tested it both ways and it worked both ways. I wrote the instructions to keep those lines in because it seemed simplest and most intuitive.

Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>
@pacohope pacohope requested a review from a team as a code owner May 29, 2025 01:42
@netlify
Copy link

netlify bot commented May 29, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 6d87c3c
🔍 Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/683df2d81671370008fb0263
😎 Deploy Preview https://deploy-preview-14774--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 May 29, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 6d87c3c
🔍 Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/683df2d89e12f1000814d10a

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.

Thanks for the contribution @pacohope. Appreciate it very much.

I've requested a few changes.

I also suspect that the property mappings aren't required and that the built-in authentik default SAML Mapping: Name and authentik default SAML Mapping: Email property mappings would be sufficient. authentik default SAML Mapping: Email could be used for NameID:

image

However I don't have a zammad instance to test this on at the moment.

@tanberry tanberry changed the title website: Update Zammad SAML Instructions website/integrations: Update Zammad SAML Instructions May 30, 2025
@codecov
Copy link

codecov bot commented May 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.76%. Comparing base (8750551) to head (6d87c3c).
Report is 18 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #14774   +/-   ##
=======================================
  Coverage   92.76%   92.76%           
=======================================
  Files         817      817           
  Lines       42197    42197           
=======================================
  Hits        39142    39142           
  Misses       3055     3055           
Flag Coverage Δ
e2e 47.55% <ø> (ø)
integration 24.38% <ø> (ø)
unit 90.65% <ø> (ø)

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.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

pacohope and others added 6 commits May 31, 2025 16:25
Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>
Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>
Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>
Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>
@pacohope
Copy link
Contributor Author

pacohope commented May 31, 2025

I've accepted all the recommended changes. I saw your comment about how the custom properties might not be necessary. I went to my Zammad provider on my authentik instance and removed them, and I could still login successfully. I created a new user in authentik, signed in with that user in Zammad and it worked successfully. I know it's basically just one person saying "works on my machine" but I think you're right: the customer properties aren't necessary. I made one more change to remove the references to them.

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.

Hey @pacohope, thanks for your contribution. I added a few suggestions to conform to the style guide and a quick little rewrite of "Automatic account link on initial logon". Please do let me know if you have any questions!

pacohope and others added 6 commits June 1, 2025 08:53
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>
@pacohope
Copy link
Contributor Author

pacohope commented Jun 1, 2025

I accepted all the changes. Thanks for your help.

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.

LGTM. Thanks

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.

Thanks @pacohope and sorry it took us a while to get the build issues sorted.. should be good to go now.

@tanberry tanberry dismissed dewi-tik’s stale review June 2, 2025 18:06

I communicated with Dewi, he is good with the updates.

@tanberry tanberry merged commit fb2401c into goauthentik:main Jun 2, 2025
98 checks passed
@gergosimonyi
Copy link
Collaborator

/cherry-pick version-2025.6

gcp-cherry-pick-bot bot pushed a commit that referenced this pull request Jun 3, 2025
* Update Zammad SAML Instructions

I just configured Zammad 6.4.1 to work with Authentik 2025.4.1. There seem to have been some changes since these instructions were written. The Name ID Format cannot be left blank. The SSO URL and the logout URL were incorrect. I was getting an Error 422 from Zammad until I turned on signing assertions, so I conclude that is required and I wrote instructions for that. I saw some discussion online elsewhere that the `----BEGIN` and `---END` lines should be removed. I tested it both ways and it worked both ways. I wrote the instructions to keep those lines in because it seemed simplest and most intuitive.

Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>

* Incorporate separate instructions for certificate file

Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>

* Incorporate simplified copy/paste instructions

Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>

* Incoporate formatting change

Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>

* Incorporate formatting changes

Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>

* Removed reference to custom properties

* Capitalisation

Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>

* Formatting

Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>

* Formatting

Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>

* Updated language

Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>

* Update website/integrations/services/zammad/index.md

Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>

* Update website/integrations/services/zammad/index.md

Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>

* tweak to bump build

* bump build

* use bold font for UI labels

* my typo

* capitalization fix

---------

Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>
Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
Co-authored-by: Dominic R <dominic@sdko.org>
Co-authored-by: Tana M Berry <tana@goauthentik.io>
gergosimonyi pushed a commit that referenced this pull request Jun 3, 2025
…4774) (#14844)

website/integrations: Update Zammad SAML Instructions (#14774)

* Update Zammad SAML Instructions

I just configured Zammad 6.4.1 to work with Authentik 2025.4.1. There seem to have been some changes since these instructions were written. The Name ID Format cannot be left blank. The SSO URL and the logout URL were incorrect. I was getting an Error 422 from Zammad until I turned on signing assertions, so I conclude that is required and I wrote instructions for that. I saw some discussion online elsewhere that the `----BEGIN` and `---END` lines should be removed. I tested it both ways and it worked both ways. I wrote the instructions to keep those lines in because it seemed simplest and most intuitive.



* Incorporate separate instructions for certificate file




* Incorporate simplified copy/paste instructions




* Incoporate formatting change




* Incorporate formatting changes




* Removed reference to custom properties

* Capitalisation




* Formatting




* Formatting




* Updated language




* Update website/integrations/services/zammad/index.md




* Update website/integrations/services/zammad/index.md




* tweak to bump build

* bump build

* use bold font for UI labels

* my typo

* capitalization fix

---------

Signed-off-by: Paco Hope <pacohope@users.noreply.github.com>
Co-authored-by: Paco Hope <pacohope@users.noreply.github.com>
Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
Co-authored-by: Dominic R <dominic@sdko.org>
Co-authored-by: Tana M Berry <tana@goauthentik.io>
kensternberg-authentik added a commit that referenced this pull request Jun 6, 2025
* main: (97 commits)
  website/docs: update style guide (#14373)
  website/docs: finalize release notes for `2025.6` (#14854)
  providers/rac: apply ConnectionToken scoped-settings last (#14838)
  lib/sync: fix static incorrect label of pages (#14851)
  website/docs: Add FIDO2 references to the documentation (#14826)
  website/docs: add LDAP docs for forward deletion and `memberUid` (#14814)
  stages/authenticator_webauthn: Update FIDO MDS3 & Passkey aaguid blobs (#14801)
  core: bump structlog from 25.3.0 to 25.4.0 (#14834)
  web: bump tar-fs from 3.0.8 to 3.0.9 in /web (#14836)
  website/integrations: Update Zammad SAML Instructions (#14774)
  website/integrations: remove trailing slash from budibase redirect (#14823)
  remove fluff from release notes 2025.6 (#14819)
  web: bump @sentry/browser from 9.22.0 to 9.23.0 in /web in the sentry group across 1 directory (#14776)
  website: bump postcss from 8.5.3 to 8.5.4 in /website (#14787)
  web: bump the esbuild group across 2 directories with 4 updates (#14711)
  core: bump github.com/redis/go-redis/v9 from 9.8.0 to 9.9.0 (#14733)
  core: bump twilio from 9.6.1 to 9.6.2 (#14789)
  website: bump @types/node from 22.15.21 to 22.15.29 in /website (#14808)
  core: bump astral-sh/uv from 0.7.8 to 0.7.9 (#14806)
  core: bump uvicorn[standard] from 0.34.2 to 0.34.3 (#14811)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants