Method: users.update

Updates an existing user in a Cloud SQL instance.

HTTP request

PUT https://sqladmin.googleapis.com/v1/projects/{project}/instances/{instance}/users

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID of the project that contains the instance.
instance

string

Database instance ID. This does not include the project ID.

Query parameters

Parameters
host

string

Optional. Host of the user in the instance.
name

string

Name of the user in the instance.
databaseRoles[]

string

Optional. users.list of database roles to grant to the user. body.database_roles will be ignored for update request.
revokeExistingRoles

boolean

Optional. Specifies whether to revoke existing roles that are not present in the databaseRoles field. If false or unset, the database roles specified in databaseRoles are added to the user's existing roles.

Request body

The request body contains an instance of User.

Response body

If successful, the response body contains an instance of Operation.

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/sqlservice.admin

For more information, see the Authentication Overview.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-03 UTC.