Skip to content

docs(ui): document SAML forced sign-in and Single Logout - #917

Merged
saiprasadpotdar merged 1 commit into
mainfrom
docs/saml-single-logout
Oct 30, 2026
Merged

saiprasadpotdar merged 1 commit into
mainfrom
docs/saml-single-logout

Conversation

@saiprasadpotdar

Copy link
Copy Markdown
Contributor

Documents the two opt-in SAML settings added in NudgeBee: SAML_FORCE_AUTHN (the IdP asks for credentials on every sign-in) and SAML_LOGOUT_URL (logging out of NudgeBee also ends the IdP session).

On the SAML page:

  • both variables in the optional table;
  • a section for each, with AD FS and Okta setup for Single Logout, including the warning that it signs users out of other apps behind the IdP;
  • the new /api/auth/saml/logout and /api/auth/saml/slo endpoints, and the metadata note;
  • the singleLogout / config.forceAuthn health fields;
  • troubleshooting rows for "signed straight back in after logout or an idle timeout".

npm run build passes.

Adds SAML_FORCE_AUTHN and SAML_LOGOUT_URL: what each does, AD FS and
Okta setup for Single Logout, the new logout endpoints, the health
fields, and troubleshooting for being signed straight back in.

Signed-off-by: Saiprasad Potdar <saipotdar9@gmail.com>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the SAML integration documentation to introduce two new configuration options: forcing authentication on every sign-in (SAML_FORCE_AUTHN) and enabling Single Logout (SAML_LOGOUT_URL). It provides comprehensive setup instructions for AD FS and Okta, details the updated health check endpoint responses, and adds troubleshooting guidelines. The review feedback suggests correcting British English spelling ('honours') to US English ('honors') to ensure consistency across the documentation.

@saiprasadpotdar
saiprasadpotdar merged commit 46a11d2 into main Oct 30, 2026
4 checks passed
@saiprasadpotdar
saiprasadpotdar deleted the docs/saml-single-logout branch October 30, 2026 08:12
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.

3 participants