POST login/users/reset password/email
Renato.neves (Talk | contribs) (→Examples) |
Renato.neves (Talk | contribs) (→Description) |
||
Line 5: | Line 5: | ||
The reset password email has a default template that allows to configure some properties, such as the sender email, the logo url, a message and the url the user will be redirected to inform the new password. | The reset password email has a default template that allows to configure some properties, such as the sender email, the logo url, a message and the url the user will be redirected to inform the new password. | ||
− | The redirect_url is the only required parameter (along with email or username) and is used to redirect the user to your site in order to provide reliability to the user inform his new password. You should create the redirect url page with password and confirm password fields, validate the password and confirm password according to your restrictions and call our API to reset the password given the reset password token sent to the redirect url in the query parameter called "token". | + | The redirect_url is the only required parameter (along with email or username) and is used to redirect the user to your site in order to provide reliability to the user inform his new password. You should create the redirect url page with password and confirm password fields, validate the password and confirm password according to your restrictions and call our API to [[POST login/users/reset_password|reset the password]] given the reset password token sent to the redirect url in the query parameter called "token". |
+ | |||
+ | The reset password email supports two languages: English (en) and Brazilian Portuguese (pt-br). You can set the language using the HTTP header "Accept-Language". | ||
== Resource URL == | == Resource URL == |
Revision as of 12:40, 10 December 2014
Contents |
Description
Sends a reset password email for a user given its username or e-mail.
The reset password email has a default template that allows to configure some properties, such as the sender email, the logo url, a message and the url the user will be redirected to inform the new password.
The redirect_url is the only required parameter (along with email or username) and is used to redirect the user to your site in order to provide reliability to the user inform his new password. You should create the redirect url page with password and confirm password fields, validate the password and confirm password according to your restrictions and call our API to reset the password given the reset password token sent to the redirect url in the query parameter called "token".
The reset password email supports two languages: English (en) and Brazilian Portuguese (pt-br). You can set the language using the HTTP header "Accept-Language".
Resource URL
POST https://api.socialidnow.com/v1/marketing/login/users/reset_password_email
Parameters
JSON Parameters
username 1 | optional | username. |
---|---|---|
email_address 1 | optional | user e-mail. |
redirect_url | required | the url to redirect the user to inform the new password |
from | optional | the sender email |
logo_url | optional | the logo url to display in the email template |
description | optional | an introductory message to the user |
1 At least one of these fields must be given to identify the user.
Authentication
This API requires Social Login App authentication. See Authentication.
Response
Response Status
created (201) | The email was sent successfully. |
---|---|
unprocessable_entity (422) | Some required parameter was not informed. |
unauthorized (401) | The authentication is wrong. See Authentication. |
internal_server_error (500) | An unknown error happened. |
Examples
Using username
Request
curl -iX POST 'https://api.socialidnow.com/v1/marketing/login/users/reset_password_email' \ -d '{ "username": "new_user", "redirect_url":"http://www.example.com", "from":"contact@example.com", "logo_url":"http://www.example.com/logo.png", "description":"We received a request to reset your password for Example.com account." }' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 201 Created Status: 201
Using email_address
Request
curl -iX POST 'https://api.socialidnow.com/v1/marketing/login/users/reset_password_email' \ -d '{ "email_address": "new_user@user_domain.com", "redirect_url":"http://www.example.com", "from":"contact@example.com", "logo_url":"http://www.example.com/logo.png", "description":"We received a request to reset your password for Example.com account." }' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 201 Created Status: 201