[PR #4439] [MERGED] feat: Add OAuth Email Claim Variable #21490

New Issue

GiteaMirror · 2026-04-20T03:33:06-05:00

GiteaMirror commented

2026-04-20 03:33:06 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/4439
Author: @cdgco
Created: 8/7/2024
Status: ✅ Merged
Merged: 8/7/2024
Merged by: @tjbck

Base: dev ← Head: dev

📝 Commits (1)

d72d5d0 feat: Add OAuth Email Claim Variable

📊 Changes

3 files changed (+10 additions, -1 deletions)

View changed files

📝 backend/apps/webui/main.py (+2 -0)
📝 backend/config.py (+6 -0)
📝 backend/main.py (+2 -1)

📄 Description

Add an OAUTH_EMAIL_CLAIM variable to override the default "email" claim value.

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

The current OAuth implementation uses email as the value for the OAuth email claim, while some providers use alternative claims in their ID tokens. Users can now override this value to specify an alternative claim containing the user's email address.

Added

Added OAUTH_EMAIL_CLAIM variable to override default claim value.

Closes #4435

_{🔄 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/4439 **Author:** [@cdgco](https://github.com/cdgco) **Created:** 8/7/2024 **Status:** ✅ Merged **Merged:** 8/7/2024 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `dev` --- ### 📝 Commits (1) - [`d72d5d0`](https://github.com/open-webui/open-webui/commit/d72d5d0e8eef814553466eb0b1daf4568816274d) feat: Add OAuth Email Claim Variable ### 📊 Changes **3 files changed** (+10 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `backend/apps/webui/main.py` (+2 -0) 📝 `backend/config.py` (+6 -0) 📝 `backend/main.py` (+2 -1) </details> ### 📄 Description Add an `OAUTH_EMAIL_CLAIM` variable to override the default "email" claim value. # 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 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: - **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 - The current OAuth implementation uses `email` as the value for the OAuth email claim, while some providers use alternative claims in their ID tokens. Users can now override this value to specify an alternative claim containing the user's email address. ### Added - Added `OAUTH_EMAIL_CLAIM` variable to override default claim value. --- Closes #4435 --- <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-20 03:33:06 -05:00

GiteaMirror closed this issue

2026-04-20 03:33:07 -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#21490