/password_reset_tokens

This endpoint allows you to manage password reset tokens.


Request Headers

Content-Type: application/json
Accept: application/json
Host: example.org
Cookie: 

Request Example

curl "http://shares.example.com/password_reset_tokens" -d '{"email":"no_user@example.com"}' -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Host: example.org" \
-H "Cookie: "

Request Parameters

Name Required/Optional Type Description
email Required acceptance Email address of the user

Success Response Codes

Method Code
POST 204 No Content
PUT 204 No Content

Error Response Codes

Description of error is included in response body.

Method Error Reason
POST 422 Unprocessable Entity Requested a reset token with a non-existing email
POST 422 Unprocessable Entity Request a reset token with an invalid email
PUT 422 Unprocessable Entity Reset password using a password reset token with previously used password
PUT 422 Unprocessable Entity Reset password using a password reset token with a weak password
PUT 422 Unprocessable Entity Reset password using a password reset token with invalid token
PUT 422 Unprocessable Entity Reset password using a password reset token with mismatching passwords

Request a reset token with a valid email

POST /password_reset_tokens

Request Example

curl "http://shares.example.com/password_reset_tokens" -d '{"email":"the_current_user@example.com"}' -X POST

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Cache-Control: no-cache
X-Request-Id: 8f3934b8-3afa-4738-b082-5bcc03344c73
X-Runtime: 0.034144

Success Response Example

204 No Content


Reset password using a password reset token

PUT /password_reset_tokens/{token}

Request Example

curl "http://shares.example.com/password_reset_tokens/vQ_g6eZn30IbzFoJtRVM7hhgEDzm5Bwfe1joArX343M" -d '{"local_user":{"password":"NewPassword123_","password_confirmation":"NewPassword123_"}}' -X PUT

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Cache-Control: no-cache
X-Request-Id: 5c68315c-e40b-4b1d-8212-1a5270dd1f32
X-Runtime: 0.029107

Success Response Example

204 No Content

Video player

Video

×