Skip to content

Commit 1c33bfc

Browse files
charleswhchann2ygk
andauthored
Document OIDC_ENABLED in settings.rst (#1408)
* Document OIDC_ENABLED in settings.rst * change settings to ref oidc.rst and from there ref the openid.net site. --------- Co-authored-by: Alan Crosswell <[email protected]>
1 parent bdc578f commit 1c33bfc

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

docs/oidc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ OpenID Connect
44
OpenID Connect support
55
======================
66

7-
``django-oauth-toolkit`` supports OpenID Connect (OIDC), which standardizes
8-
authentication flows and provides a plug and play integration with other
7+
``django-oauth-toolkit`` supports `OpenID Connect <https://openid.net/specs/openid-connect-core-1_0.html>`_
8+
(OIDC), which standardizes authentication flows and provides a plug and play integration with other
99
systems. OIDC is built on top of OAuth 2.0 to provide:
1010

1111
* Generating ID tokens as part of the login process. These are JWT that

docs/settings.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ OAUTH2_SERVER_CLASS
146146
~~~~~~~~~~~~~~~~~~~
147147
The import string for the ``server_class`` (or ``oauthlib.oauth2.Server`` subclass)
148148
used in the ``OAuthLibMixin`` that implements OAuth2 grant types. It defaults
149-
to ``oauthlib.oauth2.Server``, except when OIDC support is enabled, when the
149+
to ``oauthlib.oauth2.Server``, except when :doc:`oidc` is enabled, when the
150150
default is ``oauthlib.openid.Server``.
151151

152152
OAUTH2_VALIDATOR_CLASS
@@ -287,6 +287,13 @@ According to `OAuth 2.0 Security Best Current Practice <https://oauth.net/2/oaut
287287
- Public clients MUST use PKCE `RFC7636 <https://datatracker.ietf.org/doc/html/rfc7636>`_
288288
- For confidential clients, the use of PKCE `RFC7636 <https://datatracker.ietf.org/doc/html/rfc7636>`_ is RECOMMENDED.
289289

290+
OIDC_ENABLED
291+
~~~~~~~~~~~~
292+
Default: ``False``
293+
294+
Whether or not :doc:`oidc` support is enabled.
295+
296+
290297
OIDC_RSA_PRIVATE_KEY
291298
~~~~~~~~~~~~~~~~~~~~
292299
Default: ``""``

0 commit comments

Comments
 (0)