Skip to content

Add SCIM 2.0 configuration and setup documentation #620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

dieu-bis
Copy link

@dieu-bis dieu-bis commented Jul 13, 2025

Summary

This PR adds documentation for the SCIM 2.0 feature in Open WebUI, covering environment configuration and setup instructions for identity providers.

Changes

Environment Configuration

  • Added SCIM environment variables (SCIM_ENABLED and SCIM_TOKEN) to /docs/getting-started/env-configuration.md
  • Documented that both are PersistentConfig variables
  • Included security recommendations for token generation

SCIM Feature Documentation

  • Created comprehensive SCIM documentation at /docs/features/scim.mdx
  • Covered:
    • SCIM overview and benefits
    • Configuration via environment variables
    • API endpoint details (base URL and authentication)
    • Setup guides for Okta, Azure AD, and Google Workspace
    • Supported operations and attributes
    • Filtering capabilities
    • Troubleshooting common issues
    • Security considerations
    • Integration with SSO

Key Information Documented

  • SCIM Base URL: <openwebui-base-url>/api/v1/scim/v2/
  • Authentication: Bearer Token format Bearer <your-token>
  • Supported Operations: Full CRUD for users and groups
  • Identity Provider Examples: Step-by-step setup for major providers

Feature PR

15694

This documentation enables administrators to properly configure SCIM for automated user provisioning from their identity management systems.

This PR description focuses specifically on the documentation additions rather than the implementation details.

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.

1 participant