Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add OIDC_REDIRECT_ALLOWED_HOSTS to Settings Documentation #544

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,18 @@ of ``mozilla-django-oidc``.
Sets the maximum number of State / Nonce combinations stored in the session.
Multiple combinations are used when the user does multiple concurrent login sessions.

.. py:attribute:: OIDC_REDIRECT_ALLOWED_HOSTS

:default: ``None``

List of hosts which are allowed to be redirected to (must be of List type).
The redirect URL specified by the OIDC_REDIRECT_FIELD_NAME field must match a host
in this list.

.. note::

Whilst there is no default, a request's host is always allowed.

.. py:attribute:: OIDC_REDIRECT_FIELD_NAME

:default: ``next``
Expand Down