POST api/v1/users/forgotpassword

Send a password reset request to the registered Eclipse Web API user.

Request Information

URI Parameters

None.

Body Parameters

The password reset request.

PasswordResetRequest
NameDescriptionTypeAdditional information
EmailAddress

The email address for the password reset request to be sent.

string

Required

String length: inclusive between 0 and 255

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<PasswordResetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <EmailAddress>sample string 1</EmailAddress>
</PasswordResetRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns response message.

globally unique identifier

Response Formats

application/json, text/json

Sample:
"68f5ae05-ad1f-4f88-b610-bbb04e4fdcb2"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">68f5ae05-ad1f-4f88-b610-bbb04e4fdcb2</guid>