docs: define core SSO architecture for OIDC domains - #1271
Draft
DavidePrincipi wants to merge 8 commits into
Draft
docs: define core SSO architecture for OIDC domains#1271DavidePrincipi wants to merge 8 commits into
DavidePrincipi wants to merge 8 commits into
Conversation
Add docs/sso.md describing the OIDC domain abstraction that mirrors the existing LDAP account domain model (internal/external, backed by a broker provider such as Keycloak), covering discovery, per-app client credentials, capability contracts, and its relation to existing LDAP domains. Cross-link it from docs/design.md. Assisted-by: Claude Code:claude-sonnet-5
Some broker products (e.g. Keycloak's request-based hostname provider) can present multiple FQDNs from one instance without touching the OIDC domain model, since the FQDN already lives on the domain's own srv/http/oidc key. Clarify this stays out of scope for now. Assisted-by: Claude Code:claude-sonnet-5
Agent-driven delegated access is a machine-to-machine flow (e.g. OAuth token exchange, RFC 8693), not the browser-based authorization code flow this document assumes. Note it as a future per-domain broker capability rather than reopening the domain/broker model now. Assisted-by: Claude Code:claude-sonnet-5
An auth-proxy sidecar can front a non-OIDC-native application, running the auth code flow against the broker and forwarding identity via headers. This is an app-integration pattern, not a change to the broker architecture. Assisted-by: Claude Code:claude-sonnet-5
- Internal domains expose user/group management as NS8 actions (an illustrative, non-exhaustive set), which may drive the broker's admin API internally but never expose it directly. - External domains are read-only to NS8, matching external LDAP domains: core only registers applications against them. - User federation and identity brokering are scoped to the OIDC domain (a realm, in Keycloak's terms), not shared across other domains a broker instance hosts, and are optional and managed independently of the domain's own lifecycle. - Client registration follows RFC 7591 DCR; authorizing it (e.g. Keycloak's Initial Access Token) is broker-specific. External domains need a scoped-down admin credential able to mint IATs on demand, not a single pre-minted token, alongside the OIDC discovery manifest. - Note that combining identity sources in one domain requires an explicit, admin-surfaced choice for email-based auto-linking. Assisted-by: Claude Code:claude-sonnet-5
The paragraph covering user federation and identity brokering was packed into the broker cardinality section, mixing two different relations: domain-to-broker and domain-to-upstream-sources. Give the upstream sources their own subsection and expand it: name the two mechanisms separately, state why the federation/brokering distinction matters for LDAP-only applications, and spell out what survives adding or removing an upstream. Also state the problem the broker layer avoids before the solution. Assisted-by: Claude Code:claude-opus-5[1m]
A domain draws identities from many upstream sources, so wording that treated the two as synonyms no longer holds: drop it from the Keycloak realm aside and from the capability contract. The srv key now advertises the sources a domain serves, which contradicted the claim that adding or removing a source leaves the key untouched. State instead what stays stable across the change, and note that capabilities follow the upstream sources. Assisted-by: Claude Code:claude-opus-5[1m]
Adopt Keycloak as the broker product instead of leaving the choice open, and reduce what core owns to a one-shot provisioning procedure: create the realm, optionally federate one existing LDAP domain, grant realm administration, then step back. Everything else is configured by the administrator in the Keycloak console. This keeps the implementation cost of an MVP bounded. Mirroring Keycloak's configuration surface in core would mean tracking its schema forever, and a core view of the realm would need a reconciliation loop to stay accurate. Two consequences follow. The srv/http/oidc key becomes write-once, so capabilities cannot live on it: applications discover domains through the existing agent.list_service_providers() and then ask the broker itself what it provides, filtering out domains that fall short. And since an OIDC domain is a user domain, its creation and removal fire the existing user-domain-changed event rather than a new one. Assisted-by: Claude Code:claude-opus-5
DavidePrincipi
force-pushed
the
feat-8080
branch
from
August 7, 2026 15:42
73aefe5 to
f96d40e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add docs/sso.md describing the OIDC domain abstraction that mirrors the existing LDAP account domain model (internal/external, backed by a broker provider such as Keycloak), covering discovery, per-app client credentials, capability contracts, and its relation to existing LDAP domains. Cross-link it from docs/design.md.
Assisted-by: Claude Code:claude-sonnet-5