Password Reset
This endpoint initiates the password reset process by sending a reset code to the user's primary authentication method (email or phone number).
POST /auth/password-reset
Initiate a password reset for a user authority.
Request
POST /auth/password-reset
Headers:
{
"Host": "api.bringyour.com",
"Content-Type": "application/json"
}Body:
{
"user_auth": "string"
}| Field | Type | Description |
|---|---|---|
user_auth | string | Required. The email address or phone number of the user. |
Response
200 Success
Status: 200 OK
Content-Type: application/json
A successful request confirms that the reset attempt was initiated.
{
"user_auth": "string"
}| Field | Type | Description |
|---|---|---|
user_auth | string | The user authentication detail where the reset code was sent. |
Example
HTTP Request
POST /auth/password-reset HTTP/1.1
Host: api.bringyour.com
Content-Type: application/json
{
"user_auth": "support@ur.io"
}Successful HTTP Response
{
"user_auth": "support@ur.io"
}