gcloud alpha identity groups search

NAME
gcloud alpha identity groups search - searches for Groups matching a specified query
SYNOPSIS
gcloud alpha identity groups search--labels=LABELS--organization=ORGANIZATION[--page-size=PAGE_SIZE][--page-token=PAGE_TOKEN][--view=VIEW; default="basic"][GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) Searches for Groups matching a specified query.
EXAMPLES
To Search groups:
gcloudalphaidentitygroupssearch--organization="5149234212"--labels="cloudidentity.googleapis.com/groups.discussion_forum"--page-size=3--page-token="ala9glealanal908"
REQUIRED FLAGS
--labels=LABELS
One or more label entries that apply to the Group. Currently supported labelscontain a key with an empty value.

Google Groups are the default type of group and have a label with a key of'cloudidentity.googleapis.com/groups.discussion_forum' and an empty value.

Existing Google Groups can have an additional label with a key of'cloudidentity.googleapis.com/groups.security' and an empty value added to them.This is an immutable change and the security label cannot be removed onceadded.

POSIX groups have a label with a key of'cloudidentity.googleapis.com/groups.posix'.

Dynamic groups have a label with a key of'cloudidentity.googleapis.com/groups.dynamic'.

Identity-mapped groups for Cloud Search have a label with a key of'system/groups/external' and an empty value.

Examples: {"cloudidentity.googleapis.com/groups.discussion_forum": ""} or{"system/groups/external": ""}.

--organization=ORGANIZATION
The organization ID for the groups being searched.
OPTIONAL FLAGS
--page-size=PAGE_SIZE
The maximum number of results to return.

Note that the number of results returned may be less than this value even ifthere are more available results. To fetch all results, clients must continuecalling this method repeatedly until the response no longer contains anextPageToken.

If unspecified, defaults to 200 'basic' view and to 50 for 'full' view.

Must not be greater than 1000 for 'basic' view or 500 for 'full' view.

--page-token=PAGE_TOKEN
The nextPageToken value returned from a previous search request, if any.
--view=VIEW; default="basic"
The level of detail to be returned. There are two possible views: 'basic' and'full'. If unspecified, default to 'basic'.VIEW must beone of:
basic
Default. Only basic group information is returned.
full
All group information is returned.
GCLOUD WIDE FLAGS
These flags are available to all commands:--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.

Run$gcloud help for details.

API REFERENCE
This command uses thecloudidentity/v1alpha1 API. The fulldocumentation for this API can be found at:https://cloud.google.com/identity/
NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudidentitygroupssearch
gcloudbetaidentitygroupssearch

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-07 UTC.