Tolgee Octri Demo
PUT/v2/user

Update authenticated user information

Updates profile information for the authenticated user. Provide email and name, and include currentPassword when needed to authorize the change; callbackUrl can be used to set the link target in verification email. The response contains the updated user profile.

4 body fields

Profile information to update. Include the required email and name; callbackUrl and currentPassword are optional.

callbackUrlstringoptional
Callback url for link sent in e-mail. This may be omitted, when server has set frontEndUrl in properties.
currentPasswordstringoptional
The user's current password. Maximum 50 characters.
emailstringrequired
The user's email address. Must contain at least one character.
namestringrequired
The user's name. Must contain at least one character.

5 status codes
200Returns the updated user profile, including account type, deletable status, global server role, numeric user ID, MFA status, super-token requirement, and username; optional fields may include avatar, domain, email awaiting verification, name, and third-party authentication type.
accountTypestringrequired
Allowed:LOCALMANAGEDTHIRD_PARTY
avatarobjectoptional
deletablebooleanrequired
domainstringoptional
emailAwaitingVerificationstringoptional
globalServerRolestringrequired
Allowed:USERADMINSUPPORTER
idintegerrequired
mfaEnabledbooleanrequired
namestringoptional
needsSuperJwtTokenbooleanrequired
thirdPartyAuthTypestringoptional
Allowed:GOOGLEGITHUBOAUTH2SSOSSO_GLOBAL
usernamestringrequired
400Returned when required profile fields are missing or a value fails validation.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user is not permitted to update the profile.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the requested resource is not found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request is invalid; email and name are required, and each must contain at least one character. currentPassword must not exceed 50 characters. A 401 is returned when the request has no valid authentication, a 403 when the authenticated user is not permitted to update the profile, and a 404 when the requested resource is not found.