POST api/auth/forgot-password

Initiates a password reset process by sending a reset link to the user's email address.

Request Information

URI Parameters

None.

Body Parameters

Request containing the email address for password reset.

ForgotPasswordRequestDTO
NameDescriptionTypeAdditional information
Email

string

Required

Request Formats

application/json, text/json

Sample: 
{
  "email": "sample string 1"
}

application/xml, text/xml

Sample: 
<ForgotPasswordRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CruiseParking.Website.API.Models">
  <Email>sample string 1</Email>
</ForgotPasswordRequestDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Success message (always returns success to prevent email enumeration).

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.