SendResetPassword
Note: You must enable the password reset feature and SMTP server on your FintechOS platform for this feature to work.
This request sends a password reset token to the email address associated with a user account. You can then use this token in conjunction with the ChangePassword API endpoint to change the account's password. The request's response replicates the password reset email while masking any sensitive information (the reset token and user name).
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/SendResetPassword?username=<username>&linkReset=<reset_address>&siteName=<site_address>
| Parameter | Description |
|---|---|
host_address
|
URL of the FintechOS platform server. |
username
|
Username of an existing user account on the FintechOS platform. |
reset_address
|
Allows you to customize the sender email address of the password reset email. |
site_address
|
Allows you to customize the password reset link sent in the password reset email. |
Response
{
"from": "noreply@fintechos.me",
"to": "administrator@fintechos.com",
"subject": "Reset Password",
"body": "<p><strong>Hello,</strong></p>\r\n\t<p> </p>\r\n\t<p>No need to worry, you can reset your password by clicking the link below:</p>\r\n\t<p><a title=\"Reset password\" href=\"https://FintechOSStudio?token={generatedToken}\">Reset password</a></p>\r\n\t<p>Your username is: {userName}.</p>\r\n\t<p>If you didn't request a password reset, feel free to delete this email.</p>\r\n\t<p> </p>\r\n\t<p>Thanks,</p>\r\n\t<p>FintechOS Team.</p>\r\n\t<p> </p>\r\n\t<p> </p>\r\n\t<p> </p>"
}
| Key | Description |
|---|---|
from
|
Sender email address as configured on the FintechOS platform's SMTP server. |
to
|
Email address associated with the user account. |
subject
|
Email subject as set up in the reset password email template. |
body
|
Email body in HTML format as set up in the reset password email template with sensitive information masked (reset token and user name). |
Examples
How to get a password reset token via email
In this example:
- The admin user forgot his account password.
- The user requests server https://FintechOSStudio to send a password request token to his email address.
- The password reset token is sent to the admin@fintechos.com email address.
Request
GET https://FintechOSStudio/api/Authorize/SendResetPassword?username=admin&linkReset=https://FintechOSStudio&siteName=https://FintechOSStudio Content-Type: application/json
Response
{
"from": "noreply@fintechos.me",
"to": "admin@fintechos.com",
"subject": "Reset your FintechOS password",
"body": "<p><strong>Hello,</strong></p>\r\n\t<p> </p>\r\n\t<p>No need to worry, you can reset your password by clicking the link below:</p>\r\n\t<p><a title=\"Reset password\" href=\"https://FintechOSStudio?token={generatedToken}\">Reset password</a></p>\r\n\t<p>Your username is: {userName}.</p>\r\n\t<p>If you didn't request a password reset, feel free to delete this email.</p>\r\n\t<p> </p>\r\n\t<p>Thanks,</p>\r\n\t<p>FintechOS Team.</p>\r\n\t<p> </p>\r\n\t<p> </p>\r\n\t<p> </p>"
}