POST account/forgot

Validates and initiates the password reset process. This can fail if the hostname in the URL format is not recognized by the system.

Request Information

URI Parameters

None.

Body Parameters

The data needed to initiate the password reset.

ForgotPassword

Name	Description	Type	Additional information
EmailAddress	Gets or sets the user's email address that is used at login.	string	Required Data type: EmailAddress Matching regular expression pattern: .+@.+\..+
UrlFormat	Gets or sets the format of the URL to include in the recovery email. HTTPS is required. Example: https://example.com/reset?id={0}	string	Required

Name

Description

Type

Additional information

EmailAddress

Gets or sets the user's email address that is used at login.

string

Required

Data type: EmailAddress

Matching regular expression pattern: .+@.+\..+

UrlFormat

Gets or sets the format of the URL to include in the recovery email. HTTPS is required. Example: https://example.com/reset?id={0}

string

Required

Request Formats

application/json, text/json, text/html

Sample:

{
  "emailAddress": "sample string 1",
  "urlFormat": "sample string 2"
}

application/xml, text/xml

Sample:

<ForgotPassword xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tricycle.Studio.Api.Catalog.Models">
  <EmailAddress>sample string 1</EmailAddress>
  <UrlFormat>sample string 2</UrlFormat>
</ForgotPassword>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An HTTP status code indicating success or failure. Information will be returned along with failure when validation fails.

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.