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 for validating 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 cleary categorize this pull request, prefix the pull request title, using one of the following:
fix: Bug fix or error correction
Changelog Entry
Description
This PR targets the OIDC OAuth validation error when the name field is not present, is empty or a wrong unexpected type in the OIDC provider's response.
Original poster refers to OIDC providers which do not return a name field by default.
Tested with Okta as OIDC provider, with custom claims
🔄 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/8493
**Author:** [@kyunwang](https://github.com/kyunwang)
**Created:** 1/12/2025
**Status:** ✅ Merged
**Merged:** 1/30/2025
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `fix/oidc-500-error-name-field`
---
### 📝 Commits (9)
- [`1ad9be9`](https://github.com/open-webui/open-webui/commit/1ad9be9c07ddc91ffb1c5a40b9a044fd3fa305e9) Check OAuth name type with fallback
- [`568dbc5`](https://github.com/open-webui/open-webui/commit/568dbc545cdd7e1d08e0db7851bace82db04a418) Merge pull request #8351 from open-webui/dev
- [`36b9bce`](https://github.com/open-webui/open-webui/commit/36b9bcee0f70868f2a74234a419bec36f993fe00) Merge pull request #8770 from open-webui/dev
- [`e3ae30e`](https://github.com/open-webui/open-webui/commit/e3ae30e42f5283c9ca9a1797485021068c87f7a9) Merge pull request #8776 from open-webui/dev
- [`9dd45dd`](https://github.com/open-webui/open-webui/commit/9dd45ddf7c5cea09be434278edf68f3fdb23dcfd) Merge pull request #8779 from open-webui/dev
- [`6c8d68b`](https://github.com/open-webui/open-webui/commit/6c8d68b6fc4ba25f02627c21552a726c0bd2b36e) Merge pull request #8793 from open-webui/dev
- [`b72150c`](https://github.com/open-webui/open-webui/commit/b72150c881955721a63ae7f4ea1b9ea293816fc1) Merge pull request #8835 from open-webui/dev
- [`9eaf01c`](https://github.com/open-webui/open-webui/commit/9eaf01c32343f0a1f462f1f1c71b8a1cdc8ead64) Merge branch 'open-webui:main' into fix/oidc-500-error-name-field
- [`564c0fe`](https://github.com/open-webui/open-webui/commit/564c0fed95aeca43eb24b637faf8e986931f8f70) Fallback using email
### 📊 Changes
**1 file changed** (+6 additions, -1 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/utils/oauth.py` (+6 -1)
</details>
### 📄 Description
# Pull Request Checklist
**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?
- [ ] **Testing:** Have you written and run sufficient tests for validating 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 cleary categorize this pull request, prefix the pull request title, using one of the following:
- **fix**: Bug fix or error correction
# Changelog Entry
### Description
This PR targets the OIDC OAuth validation error when the `name` field is not present, is empty or a wrong unexpected type in the OIDC provider's response.
- Issue: #8319
### Changed
- Added a check on the `name` field with a fallback if the Type is not correct or value is None.
### Fixed
- #8319
---
### Additional Information
- Original poster refers to OIDC providers which do not return a `name` field by default.
- Tested with Okta as OIDC provider, with custom claims
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/8493
Author: @kyunwang
Created: 1/12/2025
Status: ✅ Merged
Merged: 1/30/2025
Merged by: @tjbck
Base:
dev← Head:fix/oidc-500-error-name-field📝 Commits (9)
1ad9be9Check OAuth name type with fallback568dbc5Merge pull request #8351 from open-webui/dev36b9bceMerge pull request #8770 from open-webui/deve3ae30eMerge pull request #8776 from open-webui/dev9dd45ddMerge pull request #8779 from open-webui/dev6c8d68bMerge pull request #8793 from open-webui/devb72150cMerge pull request #8835 from open-webui/dev9eaf01cMerge branch 'open-webui:main' into fix/oidc-500-error-name-field564c0feFallback using email📊 Changes
1 file changed (+6 additions, -1 deletions)
View changed files
📝
backend/open_webui/utils/oauth.py(+6 -1)📄 Description
Pull Request Checklist
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
This PR targets the OIDC OAuth validation error when the
namefield is not present, is empty or a wrong unexpected type in the OIDC provider's response.Changed
namefield with a fallback if the Type is not correct or value is None.Fixed
Additional Information
namefield by default.🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.