[PR #14898] [MERGED] feat: Configure LDAP group synchronization with Open WebUI #62490

New Issue

GiteaMirror · 2026-05-06T06:39:31-05:00

GiteaMirror commented

2026-05-06 06:39:31 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/14898
Author: @jackthgu
Created: 6/11/2025
Status: ✅ Merged
Merged: 6/11/2025
Merged by: @tjbck

Base: dev ← Head: ldap-group-sync

📝 Commits (1)

ba591d8 Configure LDAP group synchronization with Open WebUI

📊 Changes

4 files changed (+123 additions, -6 deletions)

View changed files

📝 backend/open_webui/config.py (+20 -0)
📝 backend/open_webui/main.py (+9 -0)
📝 backend/open_webui/routers/auths.py (+93 -5)
📝 backend/open_webui/utils/access_control.py (+1 -1)

📄 Description

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

Description

This pull request implements comprehensive LDAP group synchronization functionality for Open WebUI, enabling automatic synchronization of user groups from LDAP directory services. The implementation allows users authenticated via LDAP to have their group memberships automatically synchronized with Open WebUI groups, with optional automatic group creation.

Added

LDAP Group Management Configuration: New configuration options to enable/disable LDAP group synchronization
- ENABLE_LDAP_GROUP_MANAGEMENT: Master switch for LDAP group synchronization
- ENABLE_LDAP_GROUP_CREATION: Option to automatically create groups from LDAP
- LDAP_ATTRIBUTE_FOR_GROUPS: Configurable LDAP attribute for group information (default: "memberOf")
Automatic Group Synchronization: Users' LDAP group memberships are automatically synchronized with Open WebUI groups during authentication
Group Extraction Logic: Robust parsing of LDAP group Distinguished Names (DNs) to extract group names
Comprehensive Logging: Detailed logging for LDAP group operations for debugging and monitoring purposes

Changed

LDAP Authentication Flow: Enhanced LDAP authentication to include group attribute retrieval when group management is enabled
Search Attributes: Dynamically includes group attributes in LDAP search when group management is enabled
User Group Assignment: Non-admin users have their group memberships synchronized automatically based on LDAP groups

Deprecated

None

Removed

None

Fixed

Access Control Null Pointer: Fixed potential null pointer exception in group permissions handling by ensuring group permissions default to empty object when null

Security

Group-based Access Control: Enhanced security through proper LDAP group-based access control integration
Safe Group DN Parsing: Implemented robust parsing of LDAP group DNs with proper error handling

Breaking Changes

BREAKING CHANGE: [List any breaking changes affecting compatibility or functionality]

Additional Information

[Insert any additional context, notes, or explanations for the changes]
- [Reference any related issues, commits, or other relevant information]

Screenshots or Videos

[Attach any relevant screenshots or videos demonstrating the changes]

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/14898 **Author:** [@jackthgu](https://github.com/jackthgu) **Created:** 6/11/2025 **Status:** ✅ Merged **Merged:** 6/11/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `ldap-group-sync` --- ### 📝 Commits (1) - [`ba591d8`](https://github.com/open-webui/open-webui/commit/ba591d8c41b3de649ef854d3d92faa787bcbf010) Configure LDAP group synchronization with Open WebUI ### 📊 Changes **4 files changed** (+123 additions, -6 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+20 -0) 📝 `backend/open_webui/main.py` (+9 -0) 📝 `backend/open_webui/routers/auths.py` (+93 -5) 📝 `backend/open_webui/utils/access_control.py` (+1 -1) </details> ### 📄 Description # 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. - [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? - [ ] **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 ### Description - This pull request implements comprehensive LDAP group synchronization functionality for Open WebUI, enabling automatic synchronization of user groups from LDAP directory services. The implementation allows users authenticated via LDAP to have their group memberships automatically synchronized with Open WebUI groups, with optional automatic group creation. ### Added - **LDAP Group Management Configuration**: New configuration options to enable/disable LDAP group synchronization - `ENABLE_LDAP_GROUP_MANAGEMENT`: Master switch for LDAP group synchronization - `ENABLE_LDAP_GROUP_CREATION`: Option to automatically create groups from LDAP - `LDAP_ATTRIBUTE_FOR_GROUPS`: Configurable LDAP attribute for group information (default: "memberOf") - **Automatic Group Synchronization**: Users' LDAP group memberships are automatically synchronized with Open WebUI groups during authentication - **Group Extraction Logic**: Robust parsing of LDAP group Distinguished Names (DNs) to extract group names - **Comprehensive Logging**: Detailed logging for LDAP group operations for debugging and monitoring purposes ### Changed - **LDAP Authentication Flow**: Enhanced LDAP authentication to include group attribute retrieval when group management is enabled - **Search Attributes**: Dynamically includes group attributes in LDAP search when group management is enabled - **User Group Assignment**: Non-admin users have their group memberships synchronized automatically based on LDAP groups ### Deprecated - None ### Removed - None ### Fixed - **Access Control Null Pointer**: Fixed potential null pointer exception in group permissions handling by ensuring group permissions default to empty object when null ### Security - **Group-based Access Control**: Enhanced security through proper LDAP group-based access control integration - **Safe Group DN Parsing**: Implemented robust parsing of LDAP group DNs with proper error handling ### Breaking Changes - **BREAKING CHANGE**: [List any breaking changes affecting compatibility or functionality] --- ### Additional Information - [Insert any additional context, notes, or explanations for the changes] - [Reference any related issues, commits, or other relevant information] ### Screenshots or Videos - [Attach any relevant screenshots or videos demonstrating the changes] ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](/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-05-06 06:39:31 -05:00

GiteaMirror closed this issue

2026-05-06 06:39:35 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#62490