Method: groups.search

Stay organized with collections Save and categorize content based on your preferences.

Searches for Group resources matching a specified query.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
query

string

Required. The search query.

  • Must be specified in Common Expression Language.
  • Must contain equality operators on the parent, e.g. parent == 'customers/{customerId}'. The customerId must begin with "C" (for example, 'C046psxkn'). Find your customer ID.
  • Can contain optional inclusion operators on labels such as cloudidentity.googleapis.com/groups.discussion_forum' in labels).
  • Can contain an optional equality operator on domain_name or startsWith/contains/equality operator on groupKey, e.g. domain_name == 'abc.com', groupKey.startsWith('dev'), groupKey.contains('dev'), groupKey == 'dev@abc.com'
  • Can contain an optional startsWith/contains/equality operator on displayName, such as displayName.startsWith('dev') , displayName.contains('dev'), displayName == 'dev'
view

enum (GroupView)

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 GroupView.BASIC and to 50 for GroupView.FULL.

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

pageToken

string

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

orderBy

string

The ordering of groups for the display name or email in the search groups response. The syntax for this field can be found at https://cloud.google.com/apis/design/design_patterns#sorting_order. Example: Sort by the ascending name: orderBy="displayName" Sort by the descending group key email: orderBy="groupKey desc"

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

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

object (Group)

The Group resources that match the search query.

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.

GroupView

The view options for the GroupsService.SearchGroups method.

Enums
BASIC Default. Only basic resource information is returned.
FULL All resource information is returned.