Tivix/django-rest-auth
1
1
Fork 0
mirror of https://github.com/Tivix/django-rest-auth.git synced 2025-02-17 02:10:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #141 from sagarc03/add_jwt_token_verify_refresh_doc

Browse Source 
add documentation for token verify & refresh
This commit is contained in:
Michael 2020-09-08 20:30:46 -06:00 committed by GitHub
commit 73c7fb80af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/api_endpoints.rst
View File

@ -47,6 +47,25 @@ Basic
Returns pk, username, email, first_name, last_name Returns pk, username, email, first_name, last_name
- /dj-rest-auth/token/verify/ (POST)
- token
Returns an empty JSON object.
.. note:: ``REST_USE_JWT = True`` to use token/verify/ route.
.. note:: Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use. Will return a ``HTTP 200 OK`` in case of a valid token and ``HTTP 401 Unauthorized`` with ``{"detail": "Token is invalid or expired", "code": "token_not_valid"}`` in case of a invalid or expired token.
- /dj-rest-auth/token/refresh/ (POST) (`see also <https://django-rest-framework-simplejwt.readthedocs.io/en/latest/getting_started.html#usage>`_)
- refresh
Returns access
.. note:: ``REST_USE_JWT = True`` to use token/refresh/ route.
.. note:: Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid. ``HTTP 401 Unauthorized`` with ``{"detail": "Token is invalid or expired", "code": "token_not_valid"}`` in case of a invalid or expired token.
Registration Registration
------------ ------------