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.

Sign up for GitHub

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

Document OIDC_USERNAME_ALGO #507

Merged
merged 2 commits into from
Nov 24, 2023
+12 −5
Merged

Document OIDC_USERNAME_ALGO #507

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cca6d8b
Adds OIDC_USERNAME_ALGO to the documentation
polyccon Jun 1, 2023
c8bee0c
fixed formatting for OIDC_TIMEOUT docs
EduardRosert Jun 1, 2023
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
17 changes: 12 additions & 5 deletions docs/settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,11 @@ of ``mozilla-django-oidc``.

:default: ``None``

Defines a timeout for all requests to the OpenID Connect provider (fetch JWS,
retrieve JWT tokens, Userinfo Endpoint). The default is set to `None` which means
the library will wait indefinitely. The time can be defined as seconds (integer).
More information about possible configuration values, see Python `requests`:
https://requests.readthedocs.io/en/master/user/quickstart/#timeouts
Defines a timeout for all requests to the OpenID Connect provider (fetch JWS,
retrieve JWT tokens, Userinfo Endpoint). The default is set to `None` which means
the library will wait indefinitely. The time can be defined as seconds (integer).
More information about possible configuration values, see Python `requests`:
https://requests.readthedocs.io/en/master/user/quickstart/#timeouts

.. py:attribute:: OIDC_PROXY

Expand All @@ -101,6 +101,13 @@ of ``mozilla-django-oidc``.

Enables or disables automatic user creation during authentication

.. py:attribute:: OIDC_USERNAME_ALGO

:default: ``None``

It enables using a custom method to generate the django username from the user's
email and OIDC claims.

.. py:attribute:: OIDC_STATE_SIZE

:default: ``32``
Expand Down
Loading