Skip to content

Latest commit

 

History

History
87 lines (70 loc) · 3.24 KB

_change-password.md

File metadata and controls

87 lines (70 loc) · 3.24 KB

Change Password

POST https://${account.namespace}/dbconnections/change_password
Content-Type: application/json
{
  "client_id": "${account.clientId}",
  "email": "EMAIL",
  "connection": "CONNECTION",
  "organization": "ORGANIZATION_ID"
}
curl --request POST \
  --url https://${account.namespace}/dbconnections/change_password \
  --header 'content-type: application/json' \
  --data '{"client_id": "${account.clientId}","email": "EMAIL", "connection": "CONNECTION", "organization": "ORGANIZATION_ID"}'
// Script uses auth0.js. See Remarks for details.
<script src="${auth0js_url}"></script>
<script type="text/javascript">
  var webAuth = new auth0.WebAuth({
    domain:       '${account.namespace}',
    clientID:     '${account.clientId}'
  });
  
  webAuth.changePassword({
    connection: 'CONNECTION',
    email:   'EMAIL',
    organization: 'ORGANIZATION_ID'
  }, function (err, resp) {
    if(err){
      console.log(err.message);
    }else{
      console.log(resp);
    }
  });
</script>

<%= include('../../_includes/_http-method', { "http_badge": "badge-success", "http_method": "POST", "path": "/dbconnections/change_password", "link": "#change-password" }) %>

RESPONSE SAMPLE:

"We've just sent you an email to reset your password."

Send a change password email to the user's provided email address and connection.

Optionally, you may provide an Organization ID to support Organization-specific variables in customized email templates and to include the organization_id and organization_name parameters in the Redirect To URL.

Note: This endpoint only works for database connections.

Request Parameters

Parameter Description
client_id The client_id of your client.
email
Required		 The user's email address.
connection
Required		 The name of the database connection configured to your client.
organization The organization_id of the Organization associated with the user.

Remarks

  • When the user clicks on the password change link they will be redirected to a page asking them for a new password.
  • This endpoint will return three HTTP Response Headers, that provide relevant data on its rate limits:
    • X-RateLimit-Limit: Number of requests allowed per minute.
    • X-RateLimit-Remaining: Number of requests available. Each new request reduces this number by 1. For each minute that passes, requests are added back, so this number increases by 1 each time.
    • X-RateLimit-Reset: Remaining time until the rate limit (X-RateLimit-Limit) resets. The value is in UTC epoch seconds.

Learn More