force reset password group
|API Support||Available since||Last updated||Output|
Reset password as admin within a group.
Resets the password for the user if all parameters are correct.
To identify the member, either the member-username or member-email address is required.
The reset password is done in two steps:
- The system sends an email asking for confirmation of reset password (with a token) to the user.
- The user then confirms the request by sending the token to the system. If everything matches, a new password is set and a notification email sent to the user to confirm the password update.
This service can be used for both steps.
- If no member-password is specified, this service sends one by email to the member.
- Otherwise, this service attempts to update the password as specified in the member-password parameter.
If the group defines specific email templates, the emails sent use the group’s style.
To customize the email templates, create the following email 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|
This service requires administrator.
When no member-password is 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 and the member has the correct confirmation token, then the new password is set, notification is emailed to the member and the XML output is:
<reset-password status="password-changed" />
|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|
|0x102A||If the reset password token is invalid|