Documentation > Access API > AuthController > accessapi/Auth/ForgotPassword
accessapi/Auth/ForgotPassword
Given a valid username, it resets the password and emails a notice to the user with the new password. If there is an error, it will be returned in the error message.
POST
https://cms.crownpeak.com/[Your Instance]/cpt_webservice/accessapi/Auth/ForgotPasswordRequest Information
URI Parameters
None.
Body Parameters
The parameters sent as post data.
AuthForgotPasswordRequest
| Name | Description | Type |
|---|---|---|
| username | System.String |
Request Formats
application/json
Sample:
{
"username": "username",
}
Response Information
Resource Description
AuthForgotPasswordResponse
| Name | Description | Type |
|---|---|---|
| ResultCode | eResultCodes | |
| ErrorMessage | System.String | |
| InternalCode | System.Int32 | |
| IsSuccessful | System.Boolean |
Response Formats
application/json
Sample:
{
"resultCode": "conWS_Success",
"errorMessage": "",
"internalCode": 0
}