Skip to content

Update SAML documentation#1084

Open
maartenba wants to merge 9 commits into
release/is-v8.0from
v8-saml
Open

Update SAML documentation#1084
maartenba wants to merge 9 commits into
release/is-v8.0from
v8-saml

Conversation

@maartenba
Copy link
Copy Markdown
Member

No description provided.

khalidabuhakmeh and others added 4 commits April 28, 2026 20:27
…pgrade guide (#1080)

* Add changes from products repository (PR 255 and 256), optimize for readability in docs site

* Reorganize IdentityServer upgrade guide overview for improved clarity and consistency

* Add IdentityServer4 to Duende IdentityServer v8.0 upgrade guide detailing migration steps, breaking changes, and schema updates.
@maartenba maartenba self-assigned this May 5, 2026
@maartenba maartenba added the documentation Improvements or additions to documentation label May 5, 2026
@maartenba maartenba changed the base branch from main to release/is-v8.0 May 5, 2026 10:16
@maartenba maartenba added this to the 2026-Q2 milestone May 5, 2026
@maartenba maartenba marked this pull request as ready for review May 5, 2026 10:36
Comment thread astro/src/content/docs/identityserver/saml/concepts.md
Comment thread astro/src/content/docs/identityserver/saml/concepts.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/concepts.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/configuration.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/configuration.md
Comment thread astro/src/content/docs/identityserver/saml/endpoints.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/extensibility.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/extensibility.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/extensibility.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/index.md
@khalidabuhakmeh
Copy link
Copy Markdown
Contributor

@maartenba the SAML 2.0 Concepts page was meant to be a general overview of SAML (with maybe some light linking into our implementation). Not sure if adding code blocks and implementation details is right for that page.

Comment thread astro/src/content/docs/identityserver/saml/concepts.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/configuration.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/configuration.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/configuration.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/configuration.md
…ards-compat language, add mermaid diagrams for SP-initiated SSO and SLO flows, code-block protocol terms in prose, fix ambiguous pronouns
@maartenba
Copy link
Copy Markdown
Member Author

Addressed review feedback in 21c08bf:

  • Removed InCommon example from concepts.md
  • Trimmed IdentityServer-specific content on the concepts page (kept brief cross-links)
  • Removed all "backwards compatibility" language (this is a new package, no prior version)
  • Removed "(not an enum)" from SamlEndpointType
  • Changed "request ages" → "request lifetimes"
  • Fixed ambiguous "it" in endpoints.md SLO note
  • Code-blocked AuthnRequest, AuthnContext, and NameID everywhere in extensibility.md prose
  • Added mermaid sequence diagrams for SP-initiated SSO flow and Single Logout flow
  • Reviewed "What's Included" section — looks comprehensive, no changes needed

Not addressed (not a docs change): __Host- cookie prefix implementation question (item 11)

Comment thread astro/src/content/docs/identityserver/saml/extensibility.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/extensibility.md Outdated
…ed envs, correct reasons are size limits, client exposure, and auditability
Comment thread astro/src/content/docs/identityserver/saml/concepts.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/concepts.md
Comment thread astro/src/content/docs/identityserver/saml/configuration.md
Comment thread astro/src/content/docs/identityserver/saml/configuration.md
Comment thread astro/src/content/docs/identityserver/saml/configuration.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/extensibility.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/index.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/index.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/index.md Outdated
Comment thread astro/src/content/docs/identityserver/saml/service-providers.md Outdated
…ceProviderAdmin, ServiceProviderEntityId, encryption), fix NameID formats (email+unspecified only), correct ISamlSigninStateStore (in-memory default, EF for prod), rename ISamlSigninInteractionResponseGenerator, update ISamlInteractionService deprecation, add EF Core store docs
@maartenba
Copy link
Copy Markdown
Member Author

Addressed bhazen's review feedback in c9d2d9b:

Removed (platform-only / not in v8):

  • ISamlServiceProviderAdmin — entire section + all references
  • ServiceProviderEntityId value object — replaced with plain string
  • SigninStateCookieName — property being removed from code
  • Encryption section (not making v1)
  • EncryptionCertificates, EncryptAssertions properties
  • RequireConsent (consent doesn't exist in SAML)
  • ISamlFrontChannelLogout section (going away)
  • Obsolete AssertionConsumerServiceBinding

Fixed:

  • ISamlSigninInteractionResponseGeneratorISaml2SsoInteractionResponseGenerator (no consent)
  • ISamlInteractionService — added deprecation note, describes GetAuthenticationContextAsync pattern
  • ISamlSigninStateStore — default is in-memory (not cookie), EF for production
  • ISamlNameIdGenerator — only email + unspecified (no persistent for v1)
  • NameID formats — clarified only email/unspecified supported, persistent planned
  • Login Page Compatibility — removed IAuthenticationContext, describes returnUrl + GetAuthenticationContextAsync
  • Saml2Options.EntityId — most deployments don't need to set it, default is {host}/saml
  • AllowedScopes — simplified description per bhazen's note

Added:

  • EF Core store documentation (Duende.IdentityServer.EntityFramework.Stores) in service-providers.md and index.md

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.

4 participants