SFTPGo Octri Preview
PUT/user/changepwd

Change the authenticated user's password

Changes the password for the authenticated user. Provide current_password so the existing password can be verified, along with the new_password to set. The response contains the operation result.

2 body fields

Password change details for the authenticated user.

current_passwordstringoptional
The authenticated user's existing password, used for verification.
new_passwordstringoptional
The replacement password to set.

6 status codes
200Returns an operation result object containing `message` and `error` fields.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Returned when the request is not authenticated.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Returned when the authenticated user is not permitted to change the password.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
409Returned when the password change conflicts with the account's current state.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Returned when the server encounters an internal error while changing the password.
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 401 is returned when authentication is missing or invalid. A 403 is returned when the authenticated user is not permitted to change the password. A 409 is returned when the password change conflicts with the account's current state. A 500 is returned when the server encounters an internal error. Provide current_password for verification and new_password as the replacement password.