[PR #16699] [CLOSED] Feat: oauth role claim single str or int #39843

New Issue

GiteaMirror · 2026-04-25T12:16:33-05:00

GiteaMirror commented

2026-04-25 12:16:33 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/16699
Author: @Ark-Levy
Created: 8/18/2025
Status: ❌ Closed

Base: dev ← Head: feat/oauth-role-claim-single-str-or-int

📝 Commits (2)

d50332a feat(oauth): allow single string or int in oauth roles claims
9efc974 test(oauth): Test the oauth

📊 Changes

2 files changed (+216 additions, -1 deletions)

View changed files

➕ backend/open_webui/test/utils/test_oauth.py (+209 -0)
📝 backend/open_webui/utils/oauth.py (+7 -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.
[ x] 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

Enhanced OAuth role claim handling to support multiple data types from identity providers. The system now automatically normalizes role claims regardless of whether they're sent as arrays, strings, or integers.

Changed

OAuth role claim handling: Enhanced to accept string and integer role claims in addition to arrays. The system now automatically normalizes single-value claims (strings/integers) into arrays for consistent processing, improving compatibility with diverse OAuth providers that send role data in different formats. This removes the requirement for role claims to be arrays, making Open WebUI compatible with more identity providers without additional configuration.

Additional Information

https://github.com/open-webui/open-webui/discussions/16471

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/16699 **Author:** [@Ark-Levy](https://github.com/Ark-Levy) **Created:** 8/18/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `feat/oauth-role-claim-single-str-or-int` --- ### 📝 Commits (2) - [`d50332a`](https://github.com/open-webui/open-webui/commit/d50332ac93c59e8e65aad7de8353b731a4bddf92) feat(oauth): allow single string or int in oauth roles claims - [`9efc974`](https://github.com/open-webui/open-webui/commit/9efc97402d3e88c790e7fa8e6e5cc96544409ee9) test(oauth): Test the oauth ### 📊 Changes **2 files changed** (+216 additions, -1 deletions) <details> <summary>View changed files</summary> ➕ `backend/open_webui/test/utils/test_oauth.py` (+209 -0) 📝 `backend/open_webui/utils/oauth.py` (+7 -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. - [ 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 ### Description - Enhanced OAuth role claim handling to support multiple data types from identity providers. The system now automatically normalizes role claims regardless of whether they're sent as arrays, strings, or integers. ### Changed - **OAuth role claim handling:** Enhanced to accept string and integer role claims in addition to arrays. The system now automatically normalizes single-value claims (strings/integers) into arrays for consistent processing, improving compatibility with diverse OAuth providers that send role data in different formats. This removes the requirement for role claims to be arrays, making Open WebUI compatible with more identity providers without additional configuration. --- ### Additional Information - https://github.com/open-webui/open-webui/discussions/16471 ### 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-04-25 12:16:33 -05:00

GiteaMirror closed this issue

2026-04-25 12:16: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#39843