mirror of
https://github.com/open-webui/docs
synced 2025-06-12 09:32:46 +00:00
Adding docs for oauth role management feature
This commit is contained in:
parent
a471ae69d2
commit
aaad576cc0
@ -1031,6 +1031,30 @@ account takeovers.
|
||||
- Default: `SSO`
|
||||
- Description: Sets the name for the OIDC provider.
|
||||
|
||||
#### `ENABLE_OAUTH_ROLE_MANAGEMENT`
|
||||
|
||||
- Type: `bool`
|
||||
- Default: `False`
|
||||
- Description: Enables role management to oauth delegation.
|
||||
|
||||
#### `OAUTH_ROLES_CLAIM`
|
||||
|
||||
- Type: `str`
|
||||
- Default: `roles`
|
||||
- Description: Sets the roles claim to look for in the OIDC token.
|
||||
|
||||
#### `OAUTH_ALLOWED_ROLES`
|
||||
|
||||
- Type: `str`
|
||||
- Default: `user,admin`
|
||||
- Description: Sets the roles that are allowed access to the platform.
|
||||
|
||||
#### `OAUTH_ADMIN_ROLES`
|
||||
|
||||
- Type: `str`
|
||||
- Default: `admin`
|
||||
- Description: Sets the roles that are considered administrators.
|
||||
|
||||
#### `GOOGLE_CLIENT_ID`
|
||||
|
||||
- Type: `str`
|
||||
|
@ -59,6 +59,18 @@ The following environment variables are used:
|
||||
1. `OAUTH_PROVIDER_NAME` - Name of the provider to show on the UI, defaults to SSO
|
||||
1. `OAUTH_SCOPES` - Scopes to request. Defaults to `openid email profile`
|
||||
|
||||
### OAuth Role Management
|
||||
|
||||
Any OAuth provider that can be configured to return roles in the access token can be used to manage roles in Open WebUI.
|
||||
To use this feature set `ENABLE_OAUTH_ROLE_MANAGEMENT` to `true`.
|
||||
You can configure the following environment variables to match the roles returned by the OAuth provider:
|
||||
|
||||
1. `OAUTH_ROLES_CLAIM` - The claim that contains the roles. Defaults to `roles`. Can also be nested, for example `user.roles`.
|
||||
1. `OAUTH_ALLOWED_ROLES` - A comma-separated list of roles that are allowed to log in (receive open webui role `user`).
|
||||
1. `OAUTH_ADMIN_ROLES` - A comma-separated list of roles that are allowed to log in as an admin (receive open webui role `admin`).
|
||||
|
||||
:::info If changing the role of a logged in user, they will need to log out and log back in to receive the new role. :::
|
||||
|
||||
## Trusted Header
|
||||
|
||||
Open WebUI is able to delegate authentication to an authenticating reverse proxy that passes in the user's details in HTTP headers.
|
||||
|
Loading…
Reference in New Issue
Block a user