SFTPGo Octri Preview
PUT/user/profile

Update the authenticated user's profile

Updates the profile for the authenticated user. Use the body fields to change profile details, API key authentication settings, or public keys; public keys must use OpenSSH authorized_keys format. The response contains the operation result.

4 body fields

Profile fields to update for the authenticated user.

allow_api_key_authbooleanoptional
If enabled, you can impersonate this user, in REST API, using an API key. If disabled user credentials are required for impersonation
descriptionstringoptional
Free-form description for the user profile.
emailstringoptional
The user's email address in email format.
public_keysarray<string>optional
Array of public keys in OpenSSH authorized_keys format. A key may use the supported `from="<CIDR>[,<CIDR>...]"` prefix to restrict authentication to listed networks.

7 status codes
200Returns an operation result object containing `message` and `error` fields.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
400Returned when a profile field is invalid, including an email address or public key that does not match the expected format.
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 update the profile.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
409Returned when the profile update conflicts with the current profile state.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Returned when the server encounters an internal error while updating the profile.
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 when a profile value is invalid, such as an invalid email address or public key. A 401 is returned when authentication is missing or invalid. A 403 is returned when the authenticated user is not permitted to update the profile. A 409 is returned when the update conflicts with the current profile state. A 500 is returned when the server encounters an internal error. email must use email format, and each public_keys entry must use OpenSSH authorized_keys format.