docs: Update SSO and SCIM documentation with Entra ID setup details and misconfiguration guidance#9693
Draft
docs: Update SSO and SCIM documentation with Entra ID setup details and misconfiguration guidance#9693
Conversation
- auth_setup.md: Add Entra ID SAML walkthrough (Enterprise App creation, SAML configuration, attribute mapping), SP URL formats, SLO note, group name vs Object ID warning, SAML Settings API reference with curl example, JIT provisioning behavior, NameID format, SAML user lifecycle table, SAML+SCIM interaction section, manual management flags table, troubleshooting section, advanced pysaml2 env vars - scim_setup.md: Expand Entra ID section with detailed step-by-step provisioning (enable provisioning, required/recommended/optional attribute mappings, mappings to remove with 501 warning, group provisioning, group mapping API example, start provisioning), add shared group mapping reference (roles_groups, workspaces_groups, projects_groups with formats and behavior), SCIM user lifecycle table, SAML+SCIM interaction section, comprehensive troubleshooting, update prerequisites to note PAT support Co-authored-by: niklub <niklub@users.noreply.github.com>
✅ Deploy Preview for label-studio-docs-new-theme ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for label-studio-storybook canceled.
|
✅ Deploy Preview for label-studio-playground canceled.
|
✅ Deploy Preview for heartex-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
cursor
bot
changed the title
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
2 participants
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.
Reason for change
The existing SSO (
auth_setup.md) and SCIM (scim_setup.md) documentation was missing critical configuration details for Microsoft Entra ID, and lacked guidance on common misconfiguration pitfalls. Users setting up Entra ID SAML SSO or SCIM provisioning with Label Studio Enterprise had to piece together information from multiple sources, leading to avoidable setup errors.Changes
docs/source/guide/auth_setup.mdhttps://<your-host>/saml/<token>/acs, etc.) to the SP URL descriptions.GET/POST/DELETE /api/saml/settings, validate-metadata-url) with a curl example for programmatic configuration.DELETE /api/saml/settingson SCIM assignments, sharedmanual_role_management, and potential role override conflicts.MANUAL_ROLE_MANAGEMENT,MANUAL_WORKSPACE_MANAGEMENT,MANUAL_PROJECT_MEMBER_MANAGEMENTwith per-org override note.docs/source/guide/scim_setup.mduserName/UPN email derivation.displayName,members) and instructions for assigning groups to the Enterprise Application.roles_groups,workspaces_groups, andprojects_groupsvia/api/scim/settings.Testing
Documentation-only change. Verified:
auth_setup.mdandscim_setup.mdare consistent and bidirectionalRisks
Low risk—documentation-only change. No code modifications.
Reviewer notes
The source material for the Entra ID additions was a comprehensive internal reference document covering both SAML SSO and SCIM provisioning with Microsoft Entra ID. The information has been integrated into the existing doc structure while preserving all existing Okta-specific content.