Lists Users in a given project and location.
HTTP request
GET https://alloydb.googleapis.com/v1/{parent=projects/*/locations/*/clusters/*}/users
The URL uses gRPC Transcoding syntax.
Path parameters
parent
string
Required. Parent value for ListUsersRequest
Authorization requires the following IAM
permission on the specified resource parent
:
-
alloydb.users.list
Query parameters
| Parameters | |
|---|---|
pageSize
|
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
pageToken
|
Optional. A token identifying a page of results the server should return. |
filter
|
Optional. Filtering results |
orderBy
|
Optional. Hint for how to order the results |
Request body
The request body must be empty.
Response body
Message for response to listing Users
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"users"
:
[
{
object (
|
| Fields | |
|---|---|
users[]
|
The list of User |
nextPageToken
|
A token identifying a page of results the server should return. |
unreachable[]
|
Locations that could not be reached. |
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .

