POST
/v1/user/forceChangePasswordChange a user's password
Updates a user's password after validating the supplied login credentials. Send username, password, newPassword, and confirmPassword as form-encoded fields, with matching new and confirmation passwords.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
Form-encoded login credentials and the new password with its confirmation.
confirmPasswordstringoptional
The confirmation of the new password; it must match `newPassword`.
newPasswordstringoptional
The password to set for the user.
passwordstringoptional
The user's current login password.
usernamestringoptional
The username whose credentials are being validated.
200Returns confirmation that the password was changed successfully.
401Returned when the request is unauthorized.
403Returned when the request is forbidden.
Error handling
A 401 is returned when the login credentials are not accepted. A 403 indicates that the request is forbidden; provide username and password credentials and matching newPassword and confirmPassword values.