Method: users.list

Lists users in the specified Cloud SQL instance.

HTTP request

GET 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.

Request body

The request body must be empty.

Response body

User list response.

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

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

string

This is always sql#usersList.
items[]

object (User)

users.list of user resources in the instance.
nextPageToken
(deprecated)

string

Unused.

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 2025-10-23 UTC.