Document password reset route
This commit is contained in:
parent
41e1359516
commit
1e685187df
|
@ -191,6 +191,41 @@ Change Password
|
||||||
{"detail":"New password has been saved."}
|
{"detail":"New password has been saved."}
|
||||||
|
|
||||||
|
|
||||||
|
Reset Password
|
||||||
|
++++++++++++++
|
||||||
|
|
||||||
|
.. http:post:: /rest-auth/password/reset/
|
||||||
|
|
||||||
|
:json email:
|
||||||
|
|
||||||
|
**Example response**:
|
||||||
|
|
||||||
|
.. sourcecode:: json
|
||||||
|
|
||||||
|
{"detail":"Password reset e-mail has been sent."}
|
||||||
|
|
||||||
|
|
||||||
|
Confirm Reset
|
||||||
|
+++++++++++++
|
||||||
|
|
||||||
|
.. http:post:: /rest-auth/password/reset/confirm/
|
||||||
|
|
||||||
|
The uid and token are found in the email sent:
|
||||||
|
|
||||||
|
``/password-reset/confirm/{uid}/{token}/``
|
||||||
|
|
||||||
|
:json uid:
|
||||||
|
:json token:
|
||||||
|
:json new_password1:
|
||||||
|
:json new_password2:
|
||||||
|
|
||||||
|
**Example response**:
|
||||||
|
|
||||||
|
.. sourcecode:: json
|
||||||
|
|
||||||
|
{"detail":"Password has been reset with the new password."}
|
||||||
|
|
||||||
|
|
||||||
Members
|
Members
|
||||||
-------
|
-------
|
||||||
|
|
||||||
|
|
|
@ -40,6 +40,8 @@ Quick Reference
|
||||||
.. http:post:: /rest-auth/login/
|
.. http:post:: /rest-auth/login/
|
||||||
.. http:get:: /user/
|
.. http:get:: /user/
|
||||||
.. http:post:: /password/change/
|
.. http:post:: /password/change/
|
||||||
|
.. http:post:: /rest-auth/password/reset/
|
||||||
|
.. http:post:: /rest-auth/password/reset/confirm/
|
||||||
.. http:get:: /members/(id)/
|
.. http:get:: /members/(id)/
|
||||||
.. http:post:: /members/
|
.. http:post:: /members/
|
||||||
.. http:patch:: /members/(id)/
|
.. http:patch:: /members/(id)/
|
||||||
|
|
Loading…
Reference in New Issue
Block a user