[PR #18083] [CLOSED] Feat 18016 - Standardize auth group management #24666

Closed
opened 2026-04-20 05:31:49 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/18083
Author: @cmbaatz
Created: 10/6/2025
Status: ❌ Closed

Base: dev ← Head: feat-18016


📝 Commits (3)

📊 Changes

6 files changed (+784 additions, -136 deletions)

View changed files

📝 backend/open_webui/config.py (+25 -1)
📝 backend/open_webui/main.py (+12 -0)
📝 backend/open_webui/routers/auths.py (+9 -11)
➕ backend/open_webui/test/utils/test_group.py (+440 -0)
➕ backend/open_webui/utils/group.py (+296 -0)
📝 backend/open_webui/utils/oauth.py (+2 -124)

📄 Description

Moving all group management logic that occurs during user authentication for LDAP, Oauth, and trusted header paths into a single location in order to have an approach that's standard across all three auth paths.

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.

Before submitting, make sure you've checked the following:

  • Target branch: Please verify that the pull request targets the dev branch.
  • Description: Provide a concise description of the changes made in this pull request.
  • Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
  • Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
  • Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
  • Testing: Have you written and run sufficient tests to validate the changes?
  • Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
  • Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
    • BREAKING CHANGE: Significant changes that may affect compatibility
    • build: Changes that affect the build system or external dependencies
    • ci: Changes to our continuous integration processes or workflows
    • chore: Refactor, cleanup, or other non-functional code changes
    • docs: Documentation update or addition
    • feat: Introduces a new feature or enhancement to the codebase
    • fix: Bug fix or error correction
    • i18n: Internationalization or localization changes
    • perf: Performance improvement
    • refactor: Code restructuring for better maintainability, readability, or scalability
    • style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
    • test: Adding missing tests or correcting existing tests
    • WIP: Work in progress, a temporary label for incomplete or ongoing work

Changelog Entry

🔧 Standarized the authentication group management for OAuth, LDAP and Trusted Header authentication. Added ability to create groups via trusted header authenticaiton. #18016

Description

  • Standardized group management capabilities across all authentication paths

Added

  • Group creation when using trusted header authentication
  • Ability to add blocked groups in both trusted header and LDAP authentication
  • New config values
    • ENABLE_GROUP_MANAGEMENT
      If false then group management is not performed
    • ENABLE_GROUP_CREATION
      If false then unrecognized groups will not be created.
    • BLOCKED_GROUPS
      A list of groups that will not be sync'ed with the application

Changed

  • Group management code from oauth.py was consolidated into a new util class and made generic for the other auth mechanisms.
  • The current config values for each auth mechanism were preserved, but should be deprecated to favor newer generic variables.
  • auths.py was updated to use new group management util class

Deprecated

This code change deprecates the following configuration values

  • ENABLE_OAUTH_GROUP_MANAGEMENT
  • ENABLE_OAUTH_GROUP_CREATION
  • OAUTH_BLOCKED_GROUPS
  • ENABLE_LDAP_GROUP_MANAGEMENT
  • ENABLE_LDAP_GROUP_CREATION

Removed

  • No existing features or config values were removed

Fixed

  • None

Security

  • None

Breaking Changes

  • None

Additional Information

This started out as an effort to provide the ability to create user groups with trusted header authentication, but realized that the group management logic could be centralized to provide a single experience regardless of auth process.

Screenshots or Videos

None

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.


🔄 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/open-webui/pull/18083 **Author:** [@cmbaatz](https://github.com/cmbaatz) **Created:** 10/6/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `feat-18016` --- ### 📝 Commits (3) - [`0dbb8b7`](https://github.com/open-webui/open-webui/commit/0dbb8b7fa83dbafc5b26541c57b694f5519f842c) Feat_18016: - [`696c6e7`](https://github.com/open-webui/open-webui/commit/696c6e78144b83be184d3887c105928ea9c1c0ae) Feat_18016: - [`07b66c9`](https://github.com/open-webui/open-webui/commit/07b66c9d5431a9b2352e43fe9970b87b4e2a4d0a) Feat_18016: ### 📊 Changes **6 files changed** (+784 additions, -136 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+25 -1) 📝 `backend/open_webui/main.py` (+12 -0) 📝 `backend/open_webui/routers/auths.py` (+9 -11) ➕ `backend/open_webui/test/utils/test_group.py` (+440 -0) ➕ `backend/open_webui/utils/group.py` (+296 -0) 📝 `backend/open_webui/utils/oauth.py` (+2 -124) </details> ### 📄 Description Moving all group management logic that occurs during user authentication for LDAP, Oauth, and trusted header paths into a single location in order to have an approach that's standard across all three auth paths. # Pull Request Checklist ### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request. **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Please verify that the pull request targets the `dev` branch. - [X] **Description:** Provide a concise description of the changes made in this pull request. - [X] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. - [x] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? - [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [x] **Testing:** Have you written and run sufficient tests to validate the changes? - [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? - [x] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following: - **BREAKING CHANGE**: Significant changes that may affect compatibility - **build**: Changes that affect the build system or external dependencies - **ci**: Changes to our continuous integration processes or workflows - **chore**: Refactor, cleanup, or other non-functional code changes - **docs**: Documentation update or addition - **feat**: Introduces a new feature or enhancement to the codebase - **fix**: Bug fix or error correction - **i18n**: Internationalization or localization changes - **perf**: Performance improvement - **refactor**: Code restructuring for better maintainability, readability, or scalability - **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.) - **test**: Adding missing tests or correcting existing tests - **WIP**: Work in progress, a temporary label for incomplete or ongoing work # Changelog Entry 🔧 Standarized the authentication group management for OAuth, LDAP and Trusted Header authentication. Added ability to create groups via trusted header authenticaiton. [#18016](https://github.com/open-webui/open-webui/discussions/18016) ### Description - Standardized group management capabilities across all authentication paths ### Added - Group creation when using trusted header authentication - Ability to add blocked groups in both trusted header and LDAP authentication - New config values - ENABLE_GROUP_MANAGEMENT If false then group management is not performed - ENABLE_GROUP_CREATION If false then unrecognized groups will not be created. - BLOCKED_GROUPS A list of groups that will not be sync'ed with the application ### Changed - Group management code from oauth.py was consolidated into a new util class and made generic for the other auth mechanisms. - The current config values for each auth mechanism were preserved, but should be deprecated to favor newer generic variables. - auths.py was updated to use new group management util class ### Deprecated This code change deprecates the following configuration values - ENABLE_OAUTH_GROUP_MANAGEMENT - ENABLE_OAUTH_GROUP_CREATION - OAUTH_BLOCKED_GROUPS - ENABLE_LDAP_GROUP_MANAGEMENT - ENABLE_LDAP_GROUP_CREATION ### Removed - No existing features or config values were removed ### Fixed - None ### Security - None ### Breaking Changes - None --- ### Additional Information This started out as an effort to provide the ability to create user groups with trusted header authentication, but realized that the group management logic could be centralized to provide a single experience regardless of auth process. ### Screenshots or Videos None ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-20 05:31:49 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#24666