API ReferencePasswordsEmail
POST
/v1/auth/password/reset

Sent a password reset email to an existing user utilizing the password API.

Next Steps

You will then need to verify the user after the password reset is sent via email, this would need to be done via Verify Magic Link.

See Also

  • See The User Object for further details on how to identify users and their contact information such as email addresses and phone number.
  • You can also utilize Update Password or Replace Password as alternatives to change a user's password.

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<Project ID\>

Try it

/v1/auth/password/reset

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

loginIdstring

redirectUrlstring

providerIdstring

templateOptionsobject

localestring

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/auth/password/reset" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <Project ID>" \
  -d '{
  "loginId": "string",
  "redirectUrl": "string",
  "providerId": "string",
  "templateOptions": {
    "property1": "string",
    "property2": "string"
  },
  "locale": "string"
}'

{
  "resetMethod": "string",
  "pendingRef": "string",
  "linkId": "string",
  "maskedEmail": "string"
}

Was this helpful?

Previous

Get Password Policy

Next

Exchange Key