github-starred/open-webui
2
0
Fork 0
mirror of https://github.com/open-webui/open-webui.git synced 2026-07-28 17:59:25 -05:00
Code Issues 2.4k Packages Projects Releases 129 Wiki Activity

[PR #21787] [CLOSED] feat: sync OIDC name/email for existing users on login #81151

New Issue
Closed
opened 2026-05-13 15:29:21 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-05-13 15:29:21 -05:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/21787
Author: @jannikstdl
Created: 2/23/2026
Status: ❌ Closed

Base: dev ← Head: feat/oidc-sync-profile

📝 Commits (1)

  • ae52918 feat: sync OIDC name and email on login

📊 Changes

2 files changed (+40 additions, -0 deletions)

View changed files

📝 backend/open_webui/config.py (+6 -0)
📝 backend/open_webui/utils/oauth.py (+34 -0)

📄 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:

  • 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

  • Add an opt-in OAuth/OIDC profile sync switch for existing users: OAUTH_SYNC_PROFILE_ON_LOGIN (default False).
  • When enabled, update name and email on login for accounts matched by provider + sub.
  • Keep profile picture sync behavior unchanged (OAUTH_UPDATE_PICTURE_ON_LOGIN).
  • Keep auth/user email consistent by updating auth.email when user.email is synced.

Added

  • New config key: OAUTH_SYNC_PROFILE_ON_LOGIN (oauth.sync_profile_on_login, default False).

Changed

  • Existing-user OAuth callback now runs name/email sync only when OAUTH_SYNC_PROFILE_ON_LOGIN is enabled.
  • Email sync now updates both user.email and auth.email.

Deprecated

  • None.

Removed

  • None.

Fixed

  • Prevent stale profile data (name/email) for existing OAuth/OIDC users when IdP attributes change.

Security

  • Existing email conflict protection remains: if incoming email belongs to another account, login continues and email is not overwritten.

Breaking Changes

  • BREAKING CHANGE: None.

Additional Information

  • Implementation updates:
    • backend/open_webui/config.py
    • backend/open_webui/utils/oauth.py
  • Validation performed:
    • python3 -m py_compile backend/open_webui/config.py backend/open_webui/utils/oauth.py

Screenshots or Videos

  • Not applicable (backend-only change).

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/21787 **Author:** [@jannikstdl](https://github.com/jannikstdl) **Created:** 2/23/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `feat/oidc-sync-profile` --- ### 📝 Commits (1) - [`ae52918`](https://github.com/open-webui/open-webui/commit/ae52918ef17092c9fc78afe79bf2f4d4628b8d7c) feat: sync OIDC name and email on login ### 📊 Changes **2 files changed** (+40 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+6 -0) 📝 `backend/open_webui/utils/oauth.py` (+34 -0) </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] **Target branch:** Verify that the pull request targets the `dev` branch. **Not targeting the `dev` branch will lead to immediate closure of the PR.** - [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:** If necessary, update relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs) like environment variables, the tutorials, or other documentation sources. - [x] **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. - [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] **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 - Add an opt-in OAuth/OIDC profile sync switch for existing users: `OAUTH_SYNC_PROFILE_ON_LOGIN` (default `False`). - When enabled, update `name` and `email` on login for accounts matched by provider + `sub`. - Keep profile picture sync behavior unchanged (`OAUTH_UPDATE_PICTURE_ON_LOGIN`). - Keep auth/user email consistent by updating `auth.email` when `user.email` is synced. ### Added - New config key: `OAUTH_SYNC_PROFILE_ON_LOGIN` (`oauth.sync_profile_on_login`, default `False`). ### Changed - Existing-user OAuth callback now runs name/email sync only when `OAUTH_SYNC_PROFILE_ON_LOGIN` is enabled. - Email sync now updates both `user.email` and `auth.email`. ### Deprecated - None. ### Removed - None. ### Fixed - Prevent stale profile data (name/email) for existing OAuth/OIDC users when IdP attributes change. ### Security - Existing email conflict protection remains: if incoming email belongs to another account, login continues and email is not overwritten. ### Breaking Changes - **BREAKING CHANGE**: None. --- ### Additional Information - Implementation updates: - `backend/open_webui/config.py` - `backend/open_webui/utils/oauth.py` - Validation performed: - `python3 -m py_compile backend/open_webui/config.py backend/open_webui/utils/oauth.py` ### Screenshots or Videos - Not applicable (backend-only change). ### Contributor License Agreement 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-13 15:29:21 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
confirmed
confirmed issue
core
documentation
enhancement
good first issue
help wanted
non-core
pull-request
Mirrored from GitHub Pull Request
 python
question
testing wanted
No labels pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
GiteaMirror ninjasurge (Kaehlen Rog)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#81151