POST
/admins/{username}/reset-passwordReset an administrator password
Resets an administrator's password using a code received by email. Supply the administrator's username, the email code, and the new password to complete the reset.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
usernamestringrequired
The username of the administrator whose password you are resetting.
Password reset details containing the code received by email and the new password.
codestringoptional
The password reset code received by email.
passwordstringoptional
The new administrator password.
200Returns an object containing an `error` description, if any, and a `message`, which can be empty.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
400Returned when the request is invalid.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Returned when authentication is missing or invalid.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Returned when the request is forbidden.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
404Returned when the specified administrator cannot be found.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Returned when an internal server error occurs.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultUnexpected Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty
Error handling
A 400 is returned for an invalid request. A 401 indicates that authentication is missing or invalid, and a 403 indicates that the request is forbidden. A 404 is returned when the specified administrator cannot be found, and a 500 indicates a server error. Use the email code and new password for the administrator identified by the username path parameter.