Skip to content

Fix: Add comprehensive Single Logout (SLO) documentation for all affected versions (Product IS issue #26466)#5826

Open
wso2-engineering-bot wants to merge 1 commit intomasterfrom
fixing-product-is-issue-26466-1767945924
Open

Fix: Add comprehensive Single Logout (SLO) documentation for all affected versions (Product IS issue #26466)#5826
wso2-engineering-bot wants to merge 1 commit intomasterfrom
fixing-product-is-issue-26466-1767945924

Conversation

@wso2-engineering-bot
Copy link

@wso2-engineering-bot wso2-engineering-bot commented Jan 9, 2026

This PR was automatically generated by Claude AI.

  • Fixes Doc Feedback: product-is#26466
  • Type: Documentation / Suggestions
  • Summary: Enhanced Single Logout (SLO) documentation for both SAML and OIDC protocols, adding comprehensive sections that clearly outline supported SLO scenarios including cross-protocol logout.

Changes Made

1. Enhanced OIDC IdP Settings Documentation

Added a comprehensive "Single Logout (SLO) support" note section to en/includes/references/idp-settings/oidc-settings-for-idp.md that documents:

  • RP-Initiated Logout mechanism
  • Back-Channel Logout support with endpoint details (/identity/oidc/slo)
  • Federated IdP-Initiated Logout capability
  • References to detailed OIDC logout guides

2. Enhanced SAML Settings Documentation

Added a comprehensive "Single Logout (SLO) support in WSO2 Identity Server" note section to en/includes/references/app-settings/saml-settings-for-app.md that documents:

  • SAML-based SLO support (Back Channel, Front Channel HTTP Redirect, Front Channel HTTP Post)
  • OIDC-based SLO support (RP-initiated logout and back-channel logout)
  • Cross-Protocol SLO capability (logout propagation across SAML and OIDC applications)
  • Federated IdP-Initiated SLO support for both protocols
  • Reference to OIDC logout documentation

Affected Versions

Since the changes were made to common include files, this PR affects ALL WSO2 Identity Server version directories:

  • 5.9.0
  • 5.10.0
  • 5.11.0
  • 6.0.0
  • 6.1.0
  • 7.0.0
  • 7.1.0
  • 7.2.0
  • next

Style Scope Verification

Microsoft Style Guidelines have been applied only to the newly added content without modifying existing content style unless specifically requested.

Verification

  • ✅ Documentation builds successfully with mkdocs build (completed in 78.42 seconds)
  • ✅ Rendered HTML confirmed to display the new SLO documentation sections correctly
  • ✅ All new content follows Microsoft Writing Style Guide
  • ✅ Links to related guides are properly formatted and functional

Issue Resolution

This PR addresses the concern raised in product-is#26466 where the user noted that:

  • SAML SLO configurations were mentioned but OIDC SLO was not clearly documented
  • Earlier versions had better documentation about SLO support
  • There was no clear outline of which Single Logout scenarios are supported (SAML, OIDC, cross-protocol)

The enhanced documentation now provides comprehensive, clear information about all supported SLO scenarios in WSO2 Identity Server.

Summary by CodeRabbit

  • Documentation
    • Expanded SAML settings documentation with comprehensive Single Logout (SLO) support information covering SAML, OIDC, cross-protocol, and federated IdP-initiated scenarios with reference links.
    • Enhanced OIDC settings documentation to include SLO capabilities such as RP-Initiated Logout, Back-Channel Logout, and Federated IdP-Initiated Logout support details.

✏️ Tip: You can customize this high-level summary in your review settings.

… OIDC for all affected versions (product-is#26466)

This commit addresses the documentation feedback in product-is issue #26466 by:

1. Enhanced OIDC IdP Settings Documentation:
   - Added comprehensive Single Logout (SLO) support section to OIDC IdP settings
   - Documented RP-Initiated Logout mechanism
   - Documented Back-Channel Logout support with endpoint details
   - Documented Federated IdP-Initiated Logout capability
   - Added references to OIDC logout guides

2. Enhanced SAML Settings Documentation:
   - Added comprehensive SLO support clarification section
   - Explicitly documented SAML-based SLO support
   - Explicitly documented OIDC-based SLO support
   - Documented Cross-Protocol SLO capability (SAML + OIDC)
   - Documented Federated IdP-Initiated SLO support
   - Added reference to OIDC logout documentation

These changes apply to all WSO2 Identity Server versions as the updates
were made to the common include files that are used across all version
directories (5.9.0, 5.10.0, 5.11.0, 6.0.0, 6.1.0, 7.0.0, 7.1.0, 7.2.0, and next).

The documentation now clearly outlines which Single Logout scenarios are
supported in WSO2 Identity Server, addressing the concern that SLO support
was not clearly documented in version 7.2 compared to earlier versions.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


wso2-engineering-bot seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 9, 2026

Walkthrough

This pull request updates documentation for WSO2 Identity Server to clarify Single Logout (SLO) support. Two documentation files are modified to add comprehensive notes explaining SLO capabilities across SAML, OIDC, cross-protocol, and federated IdP-initiated scenarios under relevant configuration sections.

Changes

Cohort / File(s) Summary
Documentation: SLO Support Notes
en/includes/references/app-settings/saml-settings-for-app.md, en/includes/references/idp-settings/oidc-settings-for-idp.md
Added "Single Logout (SLO) support" clarification notes under respective sections. SAML settings note documents SAML SLO, cross-protocol, and federated IdP-initiated scenarios. OIDC settings note documents RP-Initiated Logout, Back-Channel Logout, and Federated IdP-Initiated Logout with reference links.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hoppy hops through docs so fine,
SLO support in every line!
SAML, OIDC, cross-protocol care,
Clarity blooms in the air! 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The PR title clearly summarizes the main change: adding comprehensive Single Logout documentation for SAML and OIDC, directly addressing issue #26466.
Description check ✅ Passed The PR description is comprehensive and well-structured, covering the purpose, changes made, affected versions, verification, and issue resolution, though it deviates from the repository template.
Linked Issues check ✅ Passed The PR successfully addresses all objectives from issue #26466: documenting OIDC and SAML SLO support, explaining supported mechanisms, clarifying cross-protocol behavior, and adding SLO information to OIDC IdP pages.
Out of Scope Changes check ✅ Passed All changes are strictly documentation updates focused on Single Logout (SLO) support documentation for SAML and OIDC protocols, directly aligned with the linked issue requirements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c6b2cf6 and 6ccb1a6.

📒 Files selected for processing (2)
  • en/includes/references/app-settings/saml-settings-for-app.md
  • en/includes/references/idp-settings/oidc-settings-for-idp.md
🔇 Additional comments (2)
en/includes/references/idp-settings/oidc-settings-for-idp.md (1)

37-46: Well-structured SLO documentation for OIDC IdP settings.

The new note clearly explains OIDC-based Single Logout mechanisms in the context of external IdP federation, including RP-Initiated Logout, Back-Channel Logout, and Federated IdP-Initiated scenarios. The documentation aligns with the PR objectives and improves clarity for users configuring OIDC enterprise IdPs.

Both referenced guide files (add-logout.md and add-back-channel-logout.md) exist in the documentation structure, and the endpoint path /identity/oidc/slo is correct and consistent with existing backend documentation and guides. The template variable usage for {{ product_url_format }} properly resolves to the correct endpoint URLs across Asgardeo and WSO2 Identity Server configurations.

en/includes/references/app-settings/saml-settings-for-app.md (1)

217-226: Comprehensive and well-organized SLO documentation.

The new note provides thorough coverage of all SLO scenarios (SAML-based, OIDC-based, cross-protocol, and federated IdP-initiated) addressing the PR objectives to clarify supported logout mechanisms. Documentation quality is high with clear bullet points and accurate reference links. Both the cross-protocol SLO propagation capability and the OIDC logout guide reference are verified and correctly documented throughout the codebase.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

Doc Feedback:

2 participants