Skip to content

Commit ca576a4

Browse files
committed
Add option documentation
1 parent b37dba5 commit ca576a4

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,23 @@ The available loader functions are:
321321
* revoked_token_loader (see Blacklist and Token Revoking bellow)
322322

323323
### Options
324-
TODO
324+
You can change many options for how this extension works via
325+
```python
326+
app.config[OPTION_NAME] = new_options
327+
```
328+
The available options are:
329+
* JWT_ACCESS_TOKEN_EXPIRES: datetime.timedelta of how long an access token should
330+
live before it expires (Defaults to 15 minutes)
331+
* JWT_REFRESH_TOKEN_EXPIRES: datetime.timedelta of how long a refresh token should
332+
live before it expires (Defaults to 30 days)
333+
* JWT_ALGORITHM: Which algorithm to use with the JWT. See [here] (https://pyjwt.readthedocs.io/en/latest/algorithms.html)
334+
for options (Defaults to HS256)
335+
* JWT_BLACKLIST_ENABLED: If token blacklist/revoking should be enabled (Default False)
336+
* JWT_BLACKLIST_STORE: Where to save blacklisted tokens. See [here] (http://pythonhosted.org/simplekv/)
337+
for options (Default None)
338+
* JWT_BLACKLIST_CHECKS: What tokens to check against the blacklist. Options are 'refresh' which
339+
will only check refresh tokens, and 'all' which will check refresh and access tokens. Defaults
340+
to 'refresh'
325341

326342
### Blacklist and Token Revoking
327343
TODO

0 commit comments

Comments
 (0)