POST api/v1/users/lostpassword

Changes the users password.

Request Information

URI Parameters

None.

Body Parameters

The PasswordResetRequest which includes username or notification email address as search term.

LostPasswordRequest
NameDescriptionTypeAdditional information
UsernameOrNotificationEmailAddress

string

Required

String length: inclusive between 0 and 255
SearchForUsernameOnly

boolean

None.
PasswordResetLink

string

Required

String length: inclusive between 0 and 256

Request Formats

application/json, text/json

Sample: 
{
  "UsernameOrNotificationEmailAddress": "sample string 1",
  "SearchForUsernameOnly": true,
  "PasswordResetLink": "sample string 3"
}

text/html

Sample: 
{"UsernameOrNotificationEmailAddress":"sample string 1","SearchForUsernameOnly":true,"PasswordResetLink":"sample string 3"}

application/xml, text/xml

Sample: 
<LostPasswordRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.User">
  <PasswordResetLink>sample string 3</PasswordResetLink>
  <SearchForUsernameOnly>true</SearchForUsernameOnly>
  <UsernameOrNotificationEmailAddress>sample string 1</UsernameOrNotificationEmailAddress>
</LostPasswordRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'LostPasswordRequest'.

Response Information

Resource Description

None.