Method: users.list

Lists users in the specified Cloud SQL instance.

HTTP request

GET https://sqladmin.googleapis.com/sql/v1beta4/projects/{project}/instances/{instance}/users

The URL usesgRPC 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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

User list response.

JSON representation
{"kind":string,"items":[{object (User)}],"nextPageToken":string}
Fields
kind

string

This is alwayssql#usersList.

items[]

object (User)

instances.list of user resources in the instance.

nextPageToken
(deprecated)

string

This item is deprecated!

Unused.

Authorization Scopes

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 theAuthentication Overview.

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 2025-05-30 UTC.