The reset password API allows an administrator to reset a users password programatically. The ability to specify a temporary pasword, send the users password reset email, and force a password change on next login are supported on this endpoint. In order to use this endpoint a user must be previously created and have a valid email saved to their user in the system.
In order to reset the users password via API the role the API user is tied to must have the “edit user” role permission enabled.
“send_reset_email” being set to true will send a password reset button to the users currrently saved email in the system.
“reset_pw_on_login” being set to true will require the user to change thier password when they next login to the system.