OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-20 19:26:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #375 from elliotmoso/patch-1

Browse Source 
Add OAuth/OIDC group management documentation
This commit is contained in:
Timothy Jaeryang Baek 2025-02-10 13:30:36 -08:00 committed by GitHub
commit e1f9accadb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/features/sso.md
View File

@ -75,6 +75,24 @@ If changing the role of a logged in user, they will need to log out and log back
::: :::
### OAuth Group Management
Any OAuth provider that can be configured to return groups in the access token can be used to manage user groups in Open WebUI.
To use this feature set `ENABLE_OAUTH_GROUP_MANAGEMENT` to `true`.
You can configure the following environment variables to match the groups returned by the OAuth provider:
1. `OAUTH_GROUP_CLAIM` - The claim that contains the groups. Defaults to `groups`. Can also be nested, for example `user.memberOf`.
:::warning
Admin users do not get their groups updated
:::
:::info
If changing the group of a logged in user, they will need to log out and log back in to receive the new group.
:::
## Trusted Header ## Trusted Header
Open WebUI is able to delegate authentication to an authenticating reverse proxy that passes in the user's details in HTTP headers. Open WebUI is able to delegate authentication to an authenticating reverse proxy that passes in the user's details in HTTP headers.