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

• Added Google Cloud Identity API support for OAuth role assignment since Google SSO does not include group or role claims in JWT tokens like other OAuth2 identity providers

Added

• Google Cloud Identity API integration to fetch user groups for role assignment
• Support for https://www.googleapis.com/auth/cloud-identity.groups.readonly scope in Google OAuth
• Automatic fallback to traditional claims-based authentication for non-Google providers
• Enhanced role assignment logic that works with Google Cloud Identity API groups
• Comprehensive test coverage for Google Cloud Identity API integration
• Documentation for configuring Google OAuth with Cloud Identity groups

Changed

• Modified OAuth role determination to fetch groups via Google Cloud Identity API when Google OAuth is used with the appropriate scope
• Updated group management to support both traditional OAuth claims and Google Cloud Identity API groups

Fixed

• Enabled proper role assignment for Google SSO users by fetching groups via API instead of relying on missing JWT claims

Security

• Added proper URL encoding for Google Cloud Identity API queries
• Implemented secure token handling for Google Cloud Identity API requests

Additional Information

This enhancement enables proper role assignment for Google SSO by addressing the fact that Google OAuth does not include group or role claims in JWT tokens like other OAuth2 identity providers.

Why this is needed:

• Google OAuth JWT tokens do not contain group membership information in claims
  -Other OAuth providers (like Azure AD, Auth0, etc.) typically include group/role information in JWT claims
• Without group information, Google SSO users cannot be properly assigned roles based on their group membership

How it works:

• When Google OAuth is configured with cloud-identity.groups.readonly scope, the system fetches user groups via Google Cloud Identity API
• For other OAuth providers, the system continues to use traditional claims-based role assignment
• Graceful fallback ensures compatibility with existing configurations

#Configuration Requirements:

• Add https://www.googleapis.com/auth/cloud-identity.groups.readonly to GOOGLE_OAUTH_SCOPE
• Configure OAUTH_ADMIN_ROLES with Google group email addresses
• Ensure OAuth client has necessary permissions for Cloud Identity API

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.