Function passwordReset

POST /users/password-reset - Initiates a password reset process for a user.

---

📥 Request

Body:

• Refer to PasswordResetRequest

Path Parameters:

• None

Query Parameters:

• None

---

📤 Response

• 200 OK – Password reset response. See examples for specific auth providers.

---

❗ Errors

Status Code	Meaning	When it Happens
400	Bad Request	Missing or invalid parameters
401	Unauthorized	Missing or invalid authentication token
404	Not Found	User not found
429	Too Many Requests	Rate limit exceeded
500	Internal Server Error	Unexpected error

Error Response Format

{
  "error": "Detailed error message here"
}
Copy

---

📦 Examples

📥 Auth0 Request

POST /users/password-reset
{
 "provider": "auth0-user",
 "userId": "exampleUserId",
 "clientId": "client_xyz",
}
Copy

📤 Auth0 Response Example

• This response contains a URL for the user to reset their password.

{
	"url": "password reset url"
}
Copy

📥 Cognito Request

POST /users/password-reset
{
 "provider": "cognito-user",
 "userId": "exampleUserId",
 "userPoolId": "us-east-1_1234test",
 "password": "password that fits requirements",
}
Copy

📤 Cognito Response

• This response indicates that a password reset email has been sent to the user.

 {
 	"message": "Password reset initiated successfully",
 	"status": "success",
 	"$metadata": {
 		"httpStatusCode": 200,
 		"requestId": "guid id",
         "attempts": 1,
         "totalRetryDelay": 0
       }
     }
  }
Copy

---