Skip to content

docs(enterprise): align Authentik SAML setup with managed profile mappings - #968

Draft
rajshah4 wants to merge 1 commit into
codex/generic-sso-guidefrom
codex/authentik-saml-consistency
Draft

rajshah4 wants to merge 1 commit into
codex/generic-sso-guidefrom
codex/authentik-saml-consistency

Conversation

@rajshah4

Copy link
Copy Markdown
Member

Authentik's default Email property mapping emits a URI-named attribute, while the managed OpenHands SAML profile importers read the simple attributes email, firstName and lastName. Document an explicit email mapping and optional structured name mappings so administrators can configure the intended profile contract. This is a source-verified documentation mismatch; this PR does not claim a newly reproduced live login failure.

Also clarify the default realm versus managed broker alias, restrict application access before rollout, use an employee identity for verification, and link the shared sign-in, repository, offboarding and certificate-renewal guidance. Keep IdP eligibility separate from OpenHands memberships, repository grants, corporate-only policy and credential revocation.

Dependencies and Publication Gates

  • Stacked on docs PR965 for the shared lifecycle sections. After PR965 merges, retarget to main and confirm the diff contains only Authentik changes.
  • Keep draft until the release containing OpenHands/OpenHands-Cloud PR1422 and PR1423 is identified and the managed customer setup is qualified for the deployment paths being advertised. Do not infer standalone Helm acceptance from Replicated testing.
  • Validate a fresh Authentik user's claims, profile, repeat account/history and intended application bindings on that release. Refresh affected screenshots and review the Mintlify preview before publication.
  • No minimum fixed version, automatic profile synchronization, SCIM, group-to-role synchronization, complete offboarding or corporate-only enforcement is promised.

Related tracking: OHE-3617 and OHE-3626. No new implementation issue is requested.

Validation

  • Authentik MDX syntax compilation and whitespace checks passed locally.
  • New shared lifecycle links resolve against the edited PR965 guide; they are not available on current main.
  • Source inspection verified the attribute-name mismatch and managed IMPORT behavior. No live Authentik deployment, certificate rotation, session-revocation acceptance or updated screenshot validation was performed for this change.

Source Verification

@ak684

ak684 commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Holding (stacked on #965, gated on the release). Before taking this out of draft:

  1. After docs(enterprise): clarify generic SAML setup and access management #965 merges, retarget to main; no Mintlify preview has run on this PR yet.
  2. Keycloak requests the first NameID format in the imported metadata, which may not be the Persistent policy set in Authentik. Verify on a live Authentik and state the format actually used.
  3. Refresh the property-mapping screenshot; it still shows only the defaults.

This branch has not been deployed

No deployments
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.

2 participants