POST 17.0/app/auth/forgotpassword

Description

Creates a Forgot Password email for the User

URI Parameters

None.

Acquaint reset password request

ResetPasswordRequest
Name Description Type Additional information
UserName

string

Required
SitePrefix

string

Required

String length: inclusive between 4 and 4
AppPassword

string

Required

application/json, text/json
Sample: 
{
  "userName": "sample string 1",
  "sitePrefix": "sample string 2",
  "appPassword": "sample string 3"
}

application/xml, text/xml
Sample: 
<ResetPasswordRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SitePrefix>sample string 2</SitePrefix>
  <AppPassword>sample string 3</AppPassword>
  <UserName>sample string 1</UserName>
</ResetPasswordRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

True/false depending on if an email has been successfully sent to User

BooleanSuccessMessage
Name Description Type Additional information
Success

boolean

None.
Message

string

None.

application/json, text/json
Sample: 
{
  "success": true,
  "message": "sample string 2"
}

application/xml, text/xml
Sample: 
<BooleanSuccessMessage xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <Message>sample string 2</Message>
</BooleanSuccessMessage>