[PR #620] [MERGED] Add SCIM 2.0 configuration and setup documentation #665

Closed
opened 2026-02-15 18:15:26 -05:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/620
Author: @dieu-bis
Created: 7/13/2025
Status: Merged
Merged: 8/13/2025
Merged by: @Classic298

Base: devHead: main


📝 Commits (10+)

📊 Changes

2 files changed (+205 additions, -0 deletions)

View changed files

docs/features/scim.mdx (+189 -0)
📝 docs/getting-started/env-configuration.md (+16 -0)

📄 Description

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.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/docs/pull/620 **Author:** [@dieu-bis](https://github.com/dieu-bis) **Created:** 7/13/2025 **Status:** ✅ Merged **Merged:** 8/13/2025 **Merged by:** [@Classic298](https://github.com/Classic298) **Base:** `dev` ← **Head:** `main` --- ### 📝 Commits (10+) - [`0f96a4a`](https://github.com/open-webui/docs/commit/0f96a4a0e7799dcbfa22c9a94b8919234e0278bb) test - [`43d13ae`](https://github.com/open-webui/docs/commit/43d13ae2c3b645021285ab0f2528c360fbcfa320) Update docusaurus.config.ts - [`0116340`](https://github.com/open-webui/docs/commit/0116340816604ae55f9f38732d0ce411602ad7fd) add scim env documentation - [`57a5531`](https://github.com/open-webui/docs/commit/57a553118c65682b9848788d9657acb966522b3f) Create scim.mdx - [`3a83ea7`](https://github.com/open-webui/docs/commit/3a83ea73f5ea6cea8c8946846462ada68143fb2b) Update scim.mdx - [`897e3fe`](https://github.com/open-webui/docs/commit/897e3fece0a00c07f477cf5f38f344224e575642) remove vscode - [`2e25ad4`](https://github.com/open-webui/docs/commit/2e25ad400cd259084d85204a31f876898ec84da3) Delete .vscode/settings.json - [`845a428`](https://github.com/open-webui/docs/commit/845a42890de45e6170cf1d138dfcfeeb5c139dd7) Update gh-pages.yml - [`83dca30`](https://github.com/open-webui/docs/commit/83dca30512c54d183b8bc3b6341e7ed792b5c242) Update .gitignore - [`8b83235`](https://github.com/open-webui/docs/commit/8b83235c1991432c1f0b373dfc3b3e8af218e857) Update .gitignore ### 📊 Changes **2 files changed** (+205 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `docs/features/scim.mdx` (+189 -0) 📝 `docs/getting-started/env-configuration.md` (+16 -0) </details> ### 📄 Description ## 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](https://github.com/open-webui/open-webui/pull/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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-15 18:15:26 -05:00
yindo closed this issue 2026-02-15 18:15:26 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: open-webui/docs#665