POST
/v2/databases/{database_cluster_uuid}/users/{username}/reset_authReset a database user's password or authentication method
Resets the password or authentication method for a user in a database cluster. For MySQL users, supply mysql_settings.auth_plugin to choose the authentication method. The response includes the updated user object and its standard database user attributes.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
database_cluster_uuidstringrequired
The unique identifier of the database cluster, in UUID format.
usernamestringrequired
The name of the database user whose password or authentication method to reset.
Authentication settings for the database user. If mysql_settings is provided, auth_plugin is required.
mysql_settingsobjectoptional
MySQL-specific authentication settings for the user.
200Returns a `user` object containing the updated user's standard database attributes.
userobjectrequired
401Returned when authentication fails because the credentials are invalid.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404Returned when the requested resource is not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when a server error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
Error handling
A 401 is returned when credentials are invalid. A 404 is returned when the database cluster or user cannot be found. A 429 indicates that the API rate limit has been exceeded, and a 500 indicates a server error. The database_cluster_uuid path parameter must be a valid UUID, and the username path parameter must identify the database user; if you provide mysql_settings, its auth_plugin must be mysql_native_password or caching_sha2_password.