Method: groups.list

Lists the Groups under a customer or namespace.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
parent

string

Required. The parent resource under which to list all Groups.

Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.

view

enum (View)

The level of detail to be returned.

If unspecified, defaults to View.BASIC.

pageSize

integer

The maximum number of results to return.

Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a nextPageToken.

If unspecified, defaults to 200 for View.BASIC and to 50 for View.FULL.

Must not be greater than 1000 for View.BASIC or 500 for View.FULL.

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:

The response message for GroupsService.ListGroups.

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

object (Group)

The Groups under the specified parent.

nextPageToken

string

A continuation token to retrieve the next page of results, or empty if there are no more results available.

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.

View

The view options for the GroupsService.ListGroups method.

Enums
VIEW_UNSPECIFIED Default. Should not be used.
BASIC Only basic resource information is returned.
FULL All resource information is returned.