mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-08 18:45:13 +00:00
73 lines
2.7 KiB
Text
73 lines
2.7 KiB
Text
NAME
|
|
gcloud alpha identity groups preview - retrieve a list of users in a
|
|
customer account using CEL query
|
|
|
|
SYNOPSIS
|
|
gcloud alpha identity groups preview --customer=CUSTOMER
|
|
[--custom-field-mask=[custom-mask,...]]
|
|
[--max-results=MAX_RESULTS; default=100] [--page-token=PAGE_TOKEN]
|
|
[--projection=PROJECTION; default="basic"] [--query=QUERY]
|
|
[--view-type=VIEW_TYPE; default="admin-view"] [GCLOUD_WIDE_FLAG ...]
|
|
|
|
DESCRIPTION
|
|
(ALPHA) Retrieve a list of users in a customer account using CEL query.
|
|
|
|
EXAMPLES
|
|
To retrieve a list of user in a customer and filter it with a query, run:
|
|
|
|
$ gcloud alpha identity groups preview \
|
|
--query="user.locations.exists(loc, loc.desk_code == 'abc')" \
|
|
--customer=A1234abcd
|
|
|
|
To retrieve a list of users with only fullName and primaryEMail fields,
|
|
run:
|
|
|
|
$ gcloud alpha identity groups preview \
|
|
--query="user.locations.exists(loc, loc.desk_code == 'abc')" \
|
|
--customer=A1234abcd \
|
|
--format="flattened(nextPageToken, users[].primaryEmail, \
|
|
users[].name.fullName)"
|
|
|
|
REQUIRED FLAGS
|
|
--customer=CUSTOMER
|
|
The customer ID for the customer's G Suite account.
|
|
|
|
OPTIONAL FLAGS
|
|
--custom-field-mask=[custom-mask,...]
|
|
A comma-separated list of schema names. All fields from these schemas
|
|
are fetched. This should only be set when --projection=custom.
|
|
|
|
--max-results=MAX_RESULTS; default=100
|
|
Maximum number of results to return. Acceptable values are 1 to 500,
|
|
inclusive.
|
|
|
|
--page-token=PAGE_TOKEN
|
|
Token to specify next page in the list.
|
|
|
|
--projection=PROJECTION; default="basic"
|
|
Subsets of fields to fetch for this user. PROJECTION must be one of:
|
|
basic, full, custom.
|
|
|
|
--query=QUERY
|
|
Query string using CEL and supported user attributes
|
|
|
|
--view-type=VIEW_TYPE; default="admin-view"
|
|
Whether to fetch the administrator-only or domain-wide public view of
|
|
the user. VIEW_TYPE must be one of: admin-view, domain-public.
|
|
|
|
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.
|
|
|
|
NOTES
|
|
This command is currently in alpha and might change without notice. If this
|
|
command fails with API permission errors despite specifying the correct
|
|
project, you might be trying to access an API with an invitation-only early
|
|
access allowlist. This variant is also available:
|
|
|
|
$ gcloud beta identity groups preview
|
|
|