PUT/v2/user/password

Update the account password

Updates the authenticated user's account password. Provide the existing currentPassword and a new password between 8 and 50 characters. Successful requests invalidate all previous sessions and return a new access token.

2 body fields

The existing account password and the new password.

currentPasswordstringrequired
The current account password. Must be no more than 50 characters.
passwordstringrequired
The new account password. Must be between 8 and 50 characters.

5 status codes
200Returns an object containing the new `accessToken` and its `tokenType`.
accessTokenstringoptional
tokenTypestringoptional
400Returned when a required password is 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 current password or authentication is rejected.
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 change the password.
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 associated user or resource cannot be 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 a required password is missing or a value fails validation. A 401 is returned when the current password or authentication is rejected, a 403 when the authenticated user is not permitted to change the password, and a 404 when the associated user or resource cannot be found. currentPassword must be no more than 50 characters, and password must be between 8 and 50 characters.