gcloud sql users assign-roles Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud sql users assign-roles - updates a user's database roles in a given instance
- SYNOPSIS
gcloud sql users assign-rolesUSERNAME--instance=INSTANCE,-iINSTANCE--type=TYPE[--async][--database-roles=[ROLE,…]][--host=HOST][--revoke-existing-roles][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Updates a user's database roles in a given instance with a specified usernameand host.
- EXAMPLES
- To grant database roles
androle1forrole2in instancemy-user, run:prod-instancegcloudsqlusersassign-rolesmy-user--instance=prod-instance--database-roles=role1,role2--type=BUILT_INTo revoke existing database roles and grant new database roles
androle3forrole4in instancemy-user, run:prod-instancegcloudsqlusersassign-rolesmy-user--instance=prod-instance--revoke-existing-roles--database-roles=role3,role4--type=BUILT_IN - POSITIONAL ARGUMENTS
USERNAME- Cloud SQL username.
- REQUIRED FLAGS
--instance=INSTANCE,-iINSTANCE- Cloud SQL instance ID.
--type=TYPE- Cloud SQL user's type. It determines the method to authenticate the user duringlogin. See the list of user types athttps://cloud.google.com/sql/docs/postgres/admin-api/rest/v1beta4/SqlUserType
- OPTIONAL FLAGS
--async- Return immediately, without waiting for the operation in progress to complete.
--database-roles=[ROLE,…]- A comma-separated list of database roles to be assigned to the user. This optionis only available for MySQL and PostgreSQL instances. You can include predefinedCloud SQL roles, like cloudsqlsuperuser, or your own custom roles. Custom rolesmust be created in the database before you can assign them. You can create rolesusing the CREATE ROLE statement for both MySQL and PostgreSQL.
--host=HOST- Cloud SQL user's hostname expressed as a specific IP address or address range.
%denotes an unrestricted hostname. Applicable flag for MySQLinstances; ignored for all other engines. Note, if you connect to your instanceusing IP addresses, you must add your client IP address as an authorizedaddress, even if your hostname is unrestricted. For more information, seeConfigure IP. --revoke-existing-roles- A boolean flag for revoking existing database roles from the user. This optionis only available for MySQL and PostgreSQL instances.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - NOTES
- These variants are also available:
gcloudalphasqlusersassign-rolesgcloudbetasqlusersassign-roles
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-02-03 UTC.