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 onlabelssuch as'cloudidentity.googleapis.com/groups.discussion_forum' in labels).
Can contain an optional equality operator ondomain_name. e.g.domain_name == 'examplepetstore.com'
Can contain optionalstartsWith/contains/equalityoperators ongroup_key, e.g.group_key.startsWith('dev'),group_key.contains('dev'), group_key == 'dev@examplepetstore.com'
Can contain optionalstartsWith/contains/equalityoperators ondisplay_name, such asdisplay_name.startsWith('dev'),display_name.contains('dev'),display_name == 'dev'
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 anext_page_token.
If unspecified, defaults to 200 forGroupView.BASICand to 50 forGroupView.FULL.
Must not be greater than 1000 forGroupView.BASICor 500 forGroupView.FULL.
pageToken
string
Thenext_page_tokenvalue 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 athttps://cloud.google.com/apis/design/design_patterns#sorting_order. Example: Sort by the ascending name: order_by="display_name" Sort by the descending group key email: order_by="group_key desc"
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThis endpoint searches for \u003ccode\u003eGroup\u003c/code\u003e resources based on a specified query using the \u003ccode\u003eGET\u003c/code\u003e method: \u003ccode\u003ehttps://cloudidentity.googleapis.com/v1beta1/groups:search\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe search query must be written in Common Expression Language and include an equality operator on the \u003ccode\u003eparent\u003c/code\u003e, it can also include inclusion operators on \u003ccode\u003elabels\u003c/code\u003e, equality on \u003ccode\u003edomain_name\u003c/code\u003e and start/contains/equality operators on \u003ccode\u003egroup_key\u003c/code\u003e and \u003ccode\u003edisplay_name\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe search results can be paginated using the \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters, with a maximum page size of 1000 for \u003ccode\u003eGroupView.BASIC\u003c/code\u003e and 500 for \u003ccode\u003eGroupView.FULL\u003c/code\u003e, defaulting to 200 and 50 respectively.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eview\u003c/code\u003e parameter allows to specify the level of detail returned in the response, allowing to select between \u003ccode\u003eBASIC\u003c/code\u003e and \u003ccode\u003eFULL\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eorderBy\u003c/code\u003e parameter allows to specify how the groups are ordered for display name or email.\u003c/p\u003e\n"]]],[],null,["# Method: groups.search\n\nSearches for `Group` resources matching a specified query.\n\n### HTTP request\n\n`GET https://cloudidentity.googleapis.com/v1beta1/groups:search`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response message for [GroupsService.SearchGroups](/identity/docs/reference/rest/v1beta1/groups/search#google.apps.cloudidentity.groups.v1beta1.GroupsService.SearchGroups).\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-identity.groups.readonly`\n- `https://www.googleapis.com/auth/cloud-identity.groups`\n- `https://www.googleapis.com/auth/cloud-identity`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nGroupView\n---------\n\nThe view options for the [GroupsService.SearchGroups](/identity/docs/reference/rest/v1beta1/groups/search#google.apps.cloudidentity.groups.v1beta1.GroupsService.SearchGroups) method."]]
