[PR #24806] [CLOSED] fix: populate OAuth scopes from RFC 9728 protected resource metadata in static MCP flow (#24730) #131525

New Issue

GiteaMirror · 2026-05-21T17:07:50-05:00

GiteaMirror commented

2026-05-21 17:07:50 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/24806
Author: @IVVI0927
Created: 5/16/2026
Status: ❌ Closed

Base: dev ← Head: fix/24730-oauth-scopes-in-authorize-url

📝 Commits (1)

7e965fb fix: include scopes_supported from RFC 9728 protected-resource metadata in OAuth static authorize URL

📊 Changes

1 file changed (+26 additions, -7 deletions)

View changed files

📝 backend/open_webui/utils/oauth.py (+26 -7)

📄 Description

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:

Linked Issue/Discussion: This PR references an existing Issue or Discussion — Closes #___ / Relates to #___. If one does not exist, create one first. PRs without a linked issue or discussion may be closed without review.
Target branch: Verify that the pull request targets the dev branch. PRs targeting main will be immediately closed.
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: Add docs in Open WebUI Docs Repository. Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps.
Dependencies: Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash.
Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to make screenshots of the feature/fix and include them 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?
Design & Architecture: Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes.
Git Hygiene: Keep PRs atomic (one logical change). Clean up commits and rebase on dev to ensure no unrelated commits (e.g. from main) are included. Push updates to the existing PR branch instead of closing and reopening.
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

Fixes the OAuth 2.1 (Static) authorize URL for MCP connections, which was missing the scope parameter. The scopes_supported array advertised in the RFC 9728 .well-known/oauth-protected-resource metadata document is now parsed and forwarded into the authorize request, resolving sign-in failures with providers like Microsoft Entra v2 that reject scope-less authorization requests (AADSTS900144).

Added

scopes_supported: list[str] field on the ProtectedResourceMetadata dataclass in backend/open_webui/utils/oauth.py, populated from the protected-resource metadata document during OAuth discovery.

Changed

get_protected_resource_metadata() now reads scopes_supported from the .well-known/oauth-protected-resource JSON response and returns it on the resulting ProtectedResourceMetadata.
get_oauth_client_info_with_static_credentials() no longer hardcodes scope = None. When the discovered ProtectedResourceMetadata.scopes_supported is non-empty, scopes are joined into a space-separated scope value on the resulting OAuthClientInformationFull. When absent, the previous behaviour (scope = None) is preserved.

Deprecated

None

Removed

None

Fixed

OAuth 2.1 (Static) authorize URL for MCP connections was missing the scope parameter, causing sign-in to fail with AADSTS900144: The request body must contain the following parameter: 'scope' on Microsoft Entra v2 and similar providers that require explicit scopes. (#24730)

Security

None

Breaking Changes

None

Additional Information

Testing notes: Did not add automated unit tests in this PR. Importing backend/open_webui/utils/oauth.py triggers database initialization at module load, which would require non-trivial test-infrastructure mocking outside the scope of this fix. Happy to add tests in a follow-up if maintainers can point to the recommended test setup for this module.

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.

Note

Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.

_{🔄 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/24806 **Author:** [@IVVI0927](https://github.com/IVVI0927) **Created:** 5/16/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `fix/24730-oauth-scopes-in-authorize-url` --- ### 📝 Commits (1) - [`7e965fb`](https://github.com/open-webui/open-webui/commit/7e965fb83bcc732359c5306cd4e61efe2a5dd132) fix: include scopes_supported from RFC 9728 protected-resource metadata in OAuth static authorize URL ### 📊 Changes **1 file changed** (+26 additions, -7 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/utils/oauth.py` (+26 -7) </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) 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:** - [x] **Linked Issue/Discussion:** This PR references an existing [Issue](https://github.com/open-webui/open-webui/issues) or [Discussion](https://github.com/open-webui/open-webui/discussions) — `Closes #___` / `Relates to #___`. If one does not exist, create one first. PRs without a linked issue or discussion may be closed without review. - [x] **Target branch:** Verify that the pull request targets the `dev` branch. **PRs targeting `main` will be immediately closed.** - [x] **Description:** Provide a concise description of the changes made in this pull request down below. - [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:** Add docs in [Open WebUI Docs Repository](https://github.com/open-webui/docs). Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps. - [x] **Dependencies:** Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash. - [x] **Testing:** Perform manual tests to **verify the implemented fix/feature works as intended AND does not break any other functionality**. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to **make screenshots of the feature/fix and include them in the PR description**. - [x] **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. - [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] **Design & Architecture:** Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes. - [x] **Git Hygiene:** Keep PRs atomic (one logical change). Clean up commits and rebase on `dev` to ensure no unrelated commits (e.g. from `main`) are included. Push updates to the existing PR branch instead of closing and reopening. - [x] **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 Fixes the OAuth 2.1 (Static) authorize URL for MCP connections, which was missing the `scope` parameter. The `scopes_supported` array advertised in the RFC 9728 `.well-known/oauth-protected-resource` metadata document is now parsed and forwarded into the authorize request, resolving sign-in failures with providers like Microsoft Entra v2 that reject `scope`-less authorization requests (`AADSTS900144`). ### Added - `scopes_supported: list[str]` field on the `ProtectedResourceMetadata` dataclass in `backend/open_webui/utils/oauth.py`, populated from the protected-resource metadata document during OAuth discovery. ### Changed - `get_protected_resource_metadata()` now reads `scopes_supported` from the `.well-known/oauth-protected-resource` JSON response and returns it on the resulting `ProtectedResourceMetadata`. - `get_oauth_client_info_with_static_credentials()` no longer hardcodes `scope = None`. When the discovered `ProtectedResourceMetadata.scopes_supported` is non-empty, scopes are joined into a space-separated `scope` value on the resulting `OAuthClientInformationFull`. When absent, the previous behaviour (`scope = None`) is preserved. ### Deprecated - None ### Removed - None ### Fixed - OAuth 2.1 (Static) authorize URL for MCP connections was missing the `scope` parameter, causing sign-in to fail with `AADSTS900144: The request body must contain the following parameter: 'scope'` on Microsoft Entra v2 and similar providers that require explicit scopes. (#24730) ### Security - None ### Breaking Changes - None --- ### Additional Information **Testing notes:** Did not add automated unit tests in this PR. Importing `backend/open_webui/utils/oauth.py` triggers database initialization at module load, which would require non-trivial test-infrastructure mocking outside the scope of this fix. Happy to add tests in a follow-up if maintainers can point to the recommended test setup for this module. ### Screenshots or Videos - None --- ### Contributor License Agreement  - [x] 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. > [!NOTE] > Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in. --- <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-21 17:07:50 -05:00

GiteaMirror closed this issue

2026-05-21 17:07:54 -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#131525