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 |
Required. The search query.
|
view |
The level of detail to be returned. If unspecified, defaults to |
pageSize |
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 If unspecified, defaults to 200 for Must not be greater than 1000 for |
pageToken |
The |
orderBy |
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
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 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. |