Searches for Group
resources matching a specified query.
HTTP request
GET https://cloudidentity.googleapis.com/v1/groups:search
The URL uses gRPC Transcoding syntax.
Query 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/{customer_id}'. Thecustomer_idmust begin with "C" (for example, 'C046psxkn'). Find your customer ID. - Can contain optional inclusion operators on
labelssuch as'cloudidentity.googleapis.com/groups.discussion_forum' in labels). - Can contain an optional equality operator on
domain_name. e.g.domain_name == 'examplepetstore.com' - Can contain optional
startsWith/contains/equalityoperators ongroup_key, e.g.group_key.startsWith('dev'),group_key.contains('dev'), group_key == 'dev@examplepetstore.com' - Can contain optional
startsWith/contains/equalityoperators ondisplay_name, such asdisplay_name.startsWith('dev'),display_name.contains('dev'),display_name == 'dev'
view
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 next_page_token
.
If unspecified, defaults to 200 for GroupView.BASIC
and 50 for GroupView.FULL
.
Must not be greater than 1000 for GroupView.BASIC
or 500 for GroupView.FULL
.
pageToken
string
The next_page_token
value returned from a previous search request, if any.
Request body
The request body must be empty.
Response body
The response message for GroupsService.SearchGroups
.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"groups"
:
[
{
object (
|
| Fields | |
|---|---|
groups[]
|
The |
nextPageToken
|
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 Authorization guide .
