django-rest-auth/docs/api_endpoints.rst
2016-02-26 13:38:01 +01:00

82 lines
1.4 KiB
ReStructuredText

API endpoints
=============
Basic
-----
- /rest-auth/login/ (POST)
- username (string)
- email (string)
- password (string)
- /rest-auth/logout/ (POST, GET)
.. note:: ``ACCOUNT_LOGOUT_ON_GET = True`` to allow logout using GET (this is the exact same conf from allauth)
- token
- /rest-auth/password/reset/ (POST)
- email
- /rest-auth/password/reset/confirm/ (POST)
- uid
- token
- new_password1
- new_password2
.. note:: uid and token are sent in email after calling /rest-auth/password/reset/
- /rest-auth/password/change/ (POST)
- new_password1
- new_password2
- old_password
.. 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
- /rest-auth/user/ (GET)
- /rest-auth/user/ (PUT/PATCH)
- username
- first_name
- last_name
- email
Registration
------------
- /rest-auth/registration/ (POST)
- username
- password1
- password2
- email
- /rest-auth/registration/verify-email/ (POST)
- key
Social Media Authentication
---------------------------
Basing on example from installation section :doc:`Installation </installation>`
- /rest-auth/facebook/ (POST)
- access_token
- code
- /rest-auth/twitter/ (POST)
- access_token
- token_secret