@@ -26,5 +26,58 @@ A big *thank you* to the guys from Django REST Framework for inspiring this.
2626List of available settings
2727--------------------------
2828
29- .. settings_generator ::
30- :type: definitions
29+ ACCESS_TOKEN_EXPIRE_SECONDS
30+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
31+ The number of seconds an access token remains valid. Requesting a protected
32+ resource after this duration will fail. Keep this value high enough so clients
33+ can cache the token for a reasonable amount of time.
34+
35+ APPLICATION_MODEL
36+ ~~~~~~~~~~~~~~~~~
37+ The import string of the class (model) representing your applications. Overwrite
38+ this value if you wrote your own implementation (subclass of
39+ ``oauth2_provider.models.Application ``).
40+
41+ AUTHORIZATION_CODE_EXPIRE_SECONDS
42+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43+ The number of seconds an authorization code remains valid. Requesting an access
44+ token after this duration will fail. :rfc: `4.1.2 ` recommends a
45+ 10 minutes (600 seconds) duration.
46+
47+ CLIENT_ID_GENERATOR_CLASS
48+ ~~~~~~~~~~~~~~~~~~~~~~~~~
49+ The import string of the class responsible for generating client identifiers.
50+ These are usually random strings.
51+
52+ CLIENT_SECRET_GENERATOR_CLASS
53+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54+ The import string of the class responsible for generating client secrets.
55+ These are usually random strings.
56+
57+ CLIENT_SECRET_GENERATOR_LENGTH
58+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
59+ The length of the generated secrets, in characters. If this value is too low,
60+ secrets may become subject to bruteforce guessing.
61+
62+ OAUTH2_VALIDATOR_CLASS
63+ ~~~~~~~~~~~~~~~~~~~~~~
64+ The import string of the ``oauthlib.oauth2.RequestValidator `` subclass that
65+ validates every step of the OAuth2 process.
66+
67+ SCOPES
68+ ~~~~~~
69+ A dictionnary mapping each scope name to its human description.
70+
71+ READ_SCOPE
72+ ~~~~~~~~~~
73+ The name of the *read * scope.
74+
75+ WRITE_SCOPE
76+ ~~~~~~~~~~~
77+ The name of the *write * scope.
78+
79+ REQUEST_APPROVAL_PROMPT
80+ ~~~~~~~~~~~~~~~~~~~~~~~
81+ Can be ``'force' `` or ``'auto' ``.
82+ The strategy used to display the authorization form. Refer to :ref: `skip-auth-form `.
83+
0 commit comments