POST login/users/reset password/email
(→JSON Parameters) |
(→Description) |
||
| Line 6: | Line 6: | ||
The redirect_url 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 redirect_url 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". | ||
| − | |||
| − | |||
== Resource URL == | == Resource URL == | ||
Revision as of 21:06, 26 June 2020
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 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".
Resource URL
POST https://api.socialidnow.com/v1/marketing/login/users/reset_password/email
- Note: The Resource URL has been updated, but the previous URL still working
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 | optional | the url to redirect the user to inform the new password. Default: the reset password link informed in the custom template. |
| from | optional | the sender email. Default: "noreply@coffeebeantech.com". |
| subject | optional | the email subject. Default: "Reset Password". |
| logo_url | optional | the logo url to display in the email template. Default: the account's logo. |
| description | optional | an introductory message to the user. Default: the description informed in the custom template. |
1 At least one of these fields must be given to identify the user.
Authentication
This API requires Social Login App authentication. See Authentication.
Language
This API supports language configuration through HTTP "Accept-language" header. The supported languages are:
| en | English (default) |
|---|---|
| pt-br | Brazilian Portuguese |
| it | Italian |
Response
Response Status
| created (201) | The email was sent successfully. |
|---|---|
| bad_request (400) | 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 and English language
Request
curl -iX POST 'https://api.socialidnow.com/v1/marketing/login/users/reset_password/email' \ -d '{ "username": "john_doe", "redirect_url":"http://www.example.com", "from":"contact@example.com", "subject":"Example.com - Reset Password", "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' \ -H 'Accept-language: en' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 201 Created Status: 201
Using email_address and Brazilian Portuguese language
Request
curl -iX POST 'https://api.socialidnow.com/v1/marketing/login/users/reset_password/email' \ -d '{ "email_address": "john_doe@domain.com", "redirect_url":"http://www.example.com", "from":"contact@example.com", "subject":"Example.com - Cadastrar Nova Senha", "logo_url":"http://www.example.com/logo.png", "description":"Nós recebemos uma requisição para recadastrar sua senha em Example.com." }' \ -H 'Content-type: application/json' \ -H 'Accept-language: pt-br' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 201 Created Status: 201
