Skip to content

QUA-1806: Correct SAML provider setup instructions#1126

Merged
RafaelOsiro merged 1 commit into
mainfrom
qua-1806-sso-saml-instructions-fix
May 22, 2026
Merged

QUA-1806: Correct SAML provider setup instructions#1126
RafaelOsiro merged 1 commit into
mainfrom
qua-1806-sso-saml-instructions-fix

Conversation

@RafaelOsiro
Copy link
Copy Markdown
Contributor

@RafaelOsiro RafaelOsiro commented May 21, 2026

Overview

Corrects the SAML provider section of the Single Sign-On setup guide. Engineering (Eric) flagged that the previous instructions listed Entity ID as something the customer sends to Qualytics, but it is actually a Service Provider identifier that Qualytics generates and provides back to the customer. The Assertion Consumer Service (ACS) URL was also missing from the values Qualytics shares.

Key Changes

  • Customer sends to Qualytics: Sign-in URL + Signing certificate. The previous table also included Entity ID here, which has been removed (it belongs to the SP side).
  • Qualytics provides back: new table listing Entity ID (the SP identifier the customer configures on their IdP) and the Assertion Consumer Service (ACS) URL (the endpoint where the IdP posts the SAML assertion).
  • IdP metadata URL or XML: kept as an optional row in the "send" table; clarified that it can be provided instead of the Sign-in URL and Signing certificate separately.

Pages to Test

Screenshots

Screenshot 2026-05-21 at 17 37 36

- Move Entity ID out of the "send" table. It is the Service Provider
  identifier that Qualytics generates, not something the customer sends.
- Add a "Qualytics will then provide" table listing Entity ID and the
  Assertion Consumer Service (ACS) URL. Both are generated by Qualytics
  for the customer to configure on their IdP.
- Mark "IdP metadata URL or XML" as optional and clarify it can be used
  instead of providing the Sign-in URL and Signing certificate separately.
@RafaelOsiro RafaelOsiro added the documentation Improvements or additions to documentation label May 21, 2026
@RafaelOsiro RafaelOsiro self-assigned this May 21, 2026
@RafaelOsiro RafaelOsiro added the documentation Improvements or additions to documentation label May 21, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 21, 2026

Greptile Summary

This PR corrects the SAML provider setup instructions in the SSO overview guide, fixing a factual error where Entity ID was incorrectly listed as something the customer sends to Qualytics (it is actually a Service Provider identifier that Qualytics generates and shares back).

  • Removes Entity ID from the "customer sends to Qualytics" table and places it in a new "Qualytics provides back" table alongside the Assertion Consumer Service (ACS) URL.
  • Moves IdP metadata URL or XML to an (optional) row within the customer-sends table, clarifying it can substitute for Sign-in URL + Signing certificate.

Confidence Score: 5/5

Documentation-only change that corrects a factual error in the SAML setup guide; no code paths are affected.

The diff is a targeted documentation correction in a single markdown file. The reorganization of the SAML tables matches the stated intent from engineering: Entity ID moves to the SP-provided section, ACS URL is added, and the metadata row is clarified as optional. The resulting tables are internally consistent and the prose flows correctly.

No files require special attention.

Important Files Changed

Filename Overview
docs/managed-deployment/sso/overview.md Reorganizes the SAML provider setup table: moves Entity ID out of the customer-sends section into a new Qualytics-provides table, adds ACS URL, and marks IdP metadata as optional with clarification text. Changes are factually accurate per engineering input.

Reviews (1): Last reviewed commit: "docs(sso): correct SAML setup value exch..." | Re-trigger Greptile

Copy link
Copy Markdown
Contributor

@ets ets 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 update.

@RafaelOsiro RafaelOsiro merged commit 80a91cc into main May 22, 2026
2 checks passed
@RafaelOsiro RafaelOsiro deleted the qua-1806-sso-saml-instructions-fix branch May 22, 2026 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants