POST User/reset-password

Request password reset for a user. Initiates the process used to reset a user's password.

Request Information

URI Parameters

Name Description Type Additional information

Body Parameters

UserCredential
Name Description Type Additional information
Username The username. For example, someone@emailhost.com. string

None.

_links Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. Collection of Link

None.

Request Formats

application/json, text/json

Sample:
{
  "Username": "someone@emailhost.com",
  "_links": []
}

application/xml, text/xml

Sample:
<UserCredential xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links />
  <Username>someone@emailhost.com</Username>
</UserCredential>

Response Information

Resource Description

BaseResponseModel
Name Description Type Additional information
StatusMessage Status message from the response (if any). string

None.

_links Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. Collection of Link

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusMessage": "A password reset email has been sent.",
  "_links": []
}

application/xml, text/xml

Sample:
<PasswordResetResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links />
  <StatusMessage>A password reset email has been sent.</StatusMessage>
</PasswordResetResponse>