Skip to content

docs: add OAUTH_AUTHORIZE_PARAMS env var documentation#1146

Draft
rndmcnlly wants to merge 1 commit intoopen-webui:devfrom
rndmcnlly:docs/oauth-authorize-params
Draft

docs: add OAUTH_AUTHORIZE_PARAMS env var documentation#1146
rndmcnlly wants to merge 1 commit intoopen-webui:devfrom
rndmcnlly:docs/oauth-authorize-params

Conversation

@rndmcnlly
Copy link
Copy Markdown

Summary

  • Documents the new OAUTH_AUTHORIZE_PARAMS environment variable in the SSO page and env-config reference
  • This variable accepts a JSON object of extra query parameters appended to the OIDC authorization redirect URL
  • Useful for OIDC brokers (CILogon, Keycloak, Dex) that support parameters to pre-select or restrict the upstream identity provider

Depends on

This docs PR depends on open-webui/open-webui#22867, which adds the feature to the codebase. Marking as draft per the docs contribution guidelines until that PR merges.

Files changed

  • docs/features/access-security/auth/sso/index.mdx — added OAUTH_AUTHORIZE_PARAMS to the OIDC env var list (item 8, after OAUTH_AUDIENCE)
  • docs/reference/env-configuration.mdx — added full reference entry with type, default, description, and examples table for common brokers

Document the new OAUTH_AUTHORIZE_PARAMS environment variable, which
accepts a JSON object of extra query parameters appended to the OIDC
authorization redirect URL. Useful for OIDC brokers (CILogon, Keycloak,
Dex) that support parameters to pre-select or restrict the upstream
identity provider.

Depends on open-webui/open-webui#22867
@pr-validator-bot
Copy link
Copy Markdown

ℹ️ Documentation PR Guidelines

👋 Welcome! This is an automated message posted on all new documentation PRs to help guide our contributors. Just because this comment appeared doesn't mean you have done anything wrong!

Please ensure you're using the correct branches:

Target branch (where you're merging TO):

  • dev branch: For documentation related to upcoming Open WebUI releases (new features, new environment variables, anything dependent on unreleased versions and unreleased features/fixes/changes)
  • main branch: For content that can go live immediately (fixes, tutorials, documentation not dependent on unreleased features)

Source branch (where you're merging FROM):

  • If targeting dev, create your branch from your fork's dev branch
  • If targeting main, create your branch from your fork's main branch
  • ⚠️ Mismatched branches can and will result in unwanted file changes being included in your PR!

If your docs PR depends on a pending PR in open-webui/open-webui:

  • Convert this PR to DRAFT mode!
  • Link to the related main repo PR in your description for clarity
  • We'll review both together once the PR on the main repo is merged

Please adjust your PR target branch, source branch, and/or draft status accordingly if needed.

@rndmcnlly
Copy link
Copy Markdown
Author

Human confirming: I'm targeting dev, here in draft mode because this documents a feature still in PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants