django-rest-auth/docs/api_endpoints.rst

81 lines
1.7 KiB
ReStructuredText
Raw Normal View History

2014-10-09 15:01:47 +04:00
API endpoints
=============
Basic
-----
2020-03-01 03:10:25 +03:00
- /dj-rest-auth/login/ (POST)
2014-10-09 15:01:47 +04:00
- username
- email
- password
2014-10-09 15:01:47 +04:00
Returns Token key
2014-10-09 15:01:47 +04:00
2020-03-01 03:10:25 +03:00
- /dj-rest-auth/logout/ (POST)
2016-02-09 01:35:37 +03:00
.. note:: ``ACCOUNT_LOGOUT_ON_GET = True`` to allow logout using GET - this is the exact same configuration from allauth. NOT recommended, see: http://django-allauth.readthedocs.io/en/latest/views.html#logout
2020-03-01 03:10:25 +03:00
- /dj-rest-auth/password/reset/ (POST)
2014-10-09 15:01:47 +04:00
- email
2020-03-01 03:10:25 +03:00
- /dj-rest-auth/password/reset/confirm/ (POST)
2014-10-09 15:01:47 +04:00
- uid
- token
- new_password1
- new_password2
2020-03-01 03:10:25 +03:00
.. note:: uid and token are sent in email after calling /dj-rest-auth/password/reset/
2014-10-09 16:16:39 +04:00
2020-03-01 03:10:25 +03:00
- /dj-rest-auth/password/change/ (POST)
2014-10-09 15:01:47 +04:00
- new_password1
- new_password2
2015-05-22 22:47:06 +03:00
- old_password
2015-05-22 22:58:40 +03:00
.. note:: ``OLD_PASSWORD_FIELD_ENABLED = True`` to use old_password.
.. note:: ``LOGOUT_ON_PASSWORD_CHANGE = False`` to keep the user logged in after password change
2014-10-09 15:01:47 +04:00
2020-03-01 03:10:25 +03:00
- /dj-rest-auth/user/ (GET, PUT, PATCH)
2014-10-09 15:01:47 +04:00
- username
- first_name
- last_name
Returns pk, username, email, first_name, last_name
2014-10-09 15:01:47 +04:00
Registration
------------
2014-10-09 16:16:39 +04:00
2020-03-01 03:10:25 +03:00
- /dj-rest-auth/registration/ (POST)
2014-10-09 16:16:39 +04:00
- username
- password1
- password2
- email
2020-03-01 03:10:25 +03:00
- /dj-rest-auth/registration/verify-email/ (POST)
2014-10-09 16:16:39 +04:00
- key
Social Media Authentication
---------------------------
Basing on example from installation section :doc:`Installation </installation>`
2020-03-01 03:10:25 +03:00
- /dj-rest-auth/facebook/ (POST)
2014-10-09 16:16:39 +04:00
- access_token
- code
2020-03-01 03:10:25 +03:00
.. note:: ``access_token`` OR ``code`` can be used as standalone arguments, see https://github.com/iMerica/dj-rest-auth/blob/master/dj_rest_auth/registration/views.py
2020-03-01 03:10:25 +03:00
- /dj-rest-auth/twitter/ (POST)
- access_token
- token_secret