force reset password
|API Support||Available since||Last updated||Output|
Reset password as an administrator.
Resets the password for the user if all parameters are correct.
In order to identify the user, either the username or email address is required.
For a normal user, reset password is done in two steps:
- The system sends an email asking for confirmation of reset password (with a key/token) to the user.
- The user then confirms the request by sending the key/token to the system. If everything matches, a new password is set and a notification email sent to the user.
This service will use the default PageSeeder templates.
|The member's email address.||yes, if no username|
|member-password||The member's new password.||no||string|
|member-username||The member's username.||yes, if no email||string|
|notify-async||Whether emails should be sent asynchronously (for slow email servers).||no||boolean|
When no key/token is specified and member-password not specified, then an email confirming the reset password request is sent to the member (step 1) and the XML output is:
<reset-password status="request-successful" />
If member-password is specified, then the new password is set, notification is emailed to the member and the XML output is:
<reset-password status="password-changed" />
If member-password="" or not specified, then whether the user is an admin is returned in the XML output for password strength:
<reset-password status="pending" [admin="true"] />
|Code||Cause / Description|
|0x1008||If the email and username are empty (for admins only).|
|0x1002||If the email address is invalid.|
|0x100E||If no member was found (for admins only).|
|0x1018||If the member is an API account|
|0x1019||If the account is locked|
|0x100F||If the member has no email address|
|0x1024||If the reset password key is invalid|
Created on , last edited on