ChangePassword
Note: You must enable the password reset feature and SMTP server on your FintechOS platform for this feature to work.
This request changes your user account password. You will need a password reset token that you can obtain by email either by clicking the Forgot Password link on the login page or by using the SendResetPassword API endpoint.
You can use the reset token only once before it expires. The token expiry time is set by the PasswordResetExpiration parameter in the web.config file.
Syntax
Copy
GET <host_address>/api/Authorize/ChangePassword?username=<username>&resetToken=<password_reset_token>&newPassword=<password>
| Parameter | Description |
|---|---|
host_address
|
URL of the FintechOS platform server. |
username
|
Username of an existing user account on the FintechOS platform. |
password_reset_token
|
Password reset token received by email. For details, see SendResetPassword. |
password
|
New account password. |
Response
{
"1": "Success",
}
| Key | Description |
|---|---|
1
|
Success - Indicates the password has been reset successfully. |
2
|
UserNotFound - Indicates the user account was not found. Make sure you entered the correct username. |
3
|
PasswordExpired - The password reset token has expired. See SendResetPassword for information on how to get a new password reset token. |
4
|
UserUnauthorized |
5
|
UserBlocked |
6
|
MembershipError |
7
|
Error |
8
|
SuccessRedirect |
Examples
Using a password reset token received via email to change a password
The admin user uses the 0bea6520-aaf8-466b-80e8-00e4b0aace28 password reset token received via email to reset his password on the https://FintechOSStudio server to abcd1234567.
The password update is successful.
Request
Copy
GET https://FintechOSStudio/api/Authorize/ChangePassword?username=admin&newPassword={password}&resetToken=0bea6520-aaf8-466b-80e8-00e4b0aace28&newPassword=abcd1234567
Content-Type: application/json
Response
{
"1": "succeeded",
}