Skip to content

Comments

feat: add OAUTH_GROUPS_SEPARATOR for configurable group parsing#18987

Merged
tjbck merged 1 commit intoopen-webui:devfrom
rndmcnlly:feat/oauth-groups-separator-v2
Nov 6, 2025
Merged

feat: add OAUTH_GROUPS_SEPARATOR for configurable group parsing#18987
tjbck merged 1 commit intoopen-webui:devfrom
rndmcnlly:feat/oauth-groups-separator-v2

Conversation

@rndmcnlly
Copy link
Contributor

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.

This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.

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

  • Target branch: Verify that the pull request targets the dev branch. Not targeting the dev branch will lead to immediate closure of the PR.
  • Description: Provide a concise description of the changes made in this pull request down below.
  • Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
  • Documentation: If necessary, update relevant documentation Open WebUI Docs like environment variables, the tutorials, or other documentation sources.
  • Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
  • Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Take this as an opportunity to make screenshots of the feature/fix and include it in the PR description.
  • Agentic AI Code: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review AND manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
  • 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?
  • Title 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 PR implements support for semicolon-separated OAuth group claims, addressing issue #18979.

Added

  • Added OAUTH_GROUPS_SEPARATOR environment variable in config.py with default value of semicolon

Changed

  • Updated update_user_groups function in oauth.py to split string claims by the configured separator

Deprecated

n/a

Removed

n/a

Fixed

Security

n/a

Breaking Changes

n/a


Additional Information

Many OIDC providers like CILogon (supporting thousands of universities worldwide) return group membership as semicolon-separated strings in the affiliation claim (e.g., [email protected];[email protected];[email protected]).

Previously, this was treated as a single monolithic group name. Now it's properly parsed into individual groups.

Screenshots or Videos

510978009-02694490-27df-44d9-ab46-ae8464a542ae

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.

@Classic298
Copy link
Collaborator

Thanks! Let me do a brief code review

@Classic298
Copy link
Collaborator

looks correct, perhaps the env var can be retrieved within the oauth.py file then it does not have to get defined in the config.py and imported, it isn't used anywhere else after all (similar to the role separator env var).

@tjbck
Copy link
Contributor

tjbck commented Nov 6, 2025

LGTM, Thanks!

@tjbck tjbck merged commit 4754108 into open-webui:dev Nov 6, 2025
6 checks passed
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.

3 participants