Users: list

Requires authorization

Retrieves a list of users contained within the specified project. Try it now.


HTTP request



Parameter name Value Description
Path parameters
project string Project ID for this request.
Optional query parameters
filter string Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.

The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, filter=name ne example-instance.
maxResults unsigned integer Maximum count of results to be returned. Acceptable values are 0 to 500, inclusive. (Default: 500)
orderBy string Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
pageToken string Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.


This request requires authorization with at least one of the following scopes (read more about authentication and authorization).


Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "clouduseraccounts#userList",
  "selfLink": string,
  "id": string,
  "items": [
    users Resource
  "nextPageToken": string
Property name Value Description Notes
kind string [Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.
id string [Output Only] Unique identifier for the resource; defined by the server.
items[] list [Output Only] A list of User resources.
nextPageToken string [Output Only] A token used to continue a truncated list request.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Compute Engine Documentation