Skip to content

Commit

Permalink
Merge pull request #507 from akatsoulas/docs-formatting
Browse files Browse the repository at this point in the history
Document OIDC_USERNAME_ALGO
  • Loading branch information
akatsoulas authored Nov 24, 2023
2 parents adea094 + c8bee0c commit 5450e40
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions docs/settings.rst
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

0 comments on commit 5450e40

Please sign in to comment.