Method: groups.list

Lists groups within a customer or a domain.

HTTP request

GET https://cloudidentity.googleapis.com/v1/groups

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
parent

string

Required. Customer ID to list all groups from.

view

enum (View)

Group resource view to be returned. Defaults to View.BASIC.

pageSize

integer

The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view.

pageToken

string

The nextPageToken value returned from a previous list request, if any.

Request body

The request body must be empty.

Response body

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

Response message for groups.list operation.

JSON representation
{
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string
}
Fields
groups[]

object (Group)

Groups returned in response to list request. The results are not sorted.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results available for listing.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-identity.groups.readonly
  • https://www.googleapis.com/auth/cloud-identity.groups
  • https://www.googleapis.com/auth/cloud-identity
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.