imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-20 04:58:26 +00:00
Code Activity

gcloud: Tue Mar 1 04:29:52 UTC 2022

Browse source
This commit is contained in:
Automated 2022-03-01 04:29:52 +00:00
parent aab53307a8
commit 1456dab6c7
9791 changed files with 814712 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

128
gcloud/beta/identity/groups/create Normal file
View file

@ -0,0 +1,128 @@
NAME
gcloud beta identity groups create - create a new group
SYNOPSIS
gcloud beta identity groups create EMAIL --organization=ORGANIZATION
[--description=DESCRIPTION] [--display-name=DISPLAY_NAME]
[--dynamic-user-query=DYNAMIC_USER_QUERY] [--posix-group=POSIX_GROUP]
[--with-initial-owner=WITH_INITIAL_OWNER]
[--group-type=GROUP_TYPE; default="discussion" | --labels=LABELS]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Create a new group.
EXAMPLES
To quickly create a new Google Groups discussion group with default
settings:
$ gcloud beta identity groups create eng-discuss@example.com \
--organization="example.com"
To create a new Google Groups discussion group with a display name and
descripton:
$ gcloud beta identity groups create eng-discuss@example.com \
--organization="example.com" \
--display-name="Engineer Discuss" \
--description="Group for engineering discussions"
To create a new security group:
$ gcloud beta identity groups create security-group@example.com \
--organization="example.com" \
--group-type="security" \
--display-name="Security Group" \
--description="Description of Security Group"
To create a new POSIX group:
$ gcloud beta identity groups create eng-discuss@example.com \
--organization="example.com" \
--posix-group=name=eng,gid=1005
POSITIONAL ARGUMENTS
EMAIL
The email address of the group to be created.
REQUIRED FLAGS
--organization=ORGANIZATION
The organization the Group being created belongs to. This can be
specified either as an ID ("123456789") or as the associated domain
("example.com").
OPTIONAL FLAGS
--description=DESCRIPTION
An extended description to help users determine the purpose of a Group.
For example, you can include information about who should join the
Group, the types of messages to send to the Group, links to FAQs about
the Group, or related Groups. Maximum length is 4,096 characters.
--display-name=DISPLAY_NAME
The Group's display name.
--dynamic-user-query=DYNAMIC_USER_QUERY
Query that determines the memberships of the dynamic group.
Example of a query:
--dynamic-user-query="user.organizations.exists(org,org.title=='SWE')"
--posix-group=POSIX_GROUP
Group ID (gid) and name of the POSIX group that you want to associate
with the specified Cloud Identity group. You can specify multiple POSIX
groups with multiple instances of this flag.
For example, use '--posix-group=gid=1005,name=eng' to add a single
group, or '--posix-group=gid=1005,name=eng
--posix-group=gid=1006,name=docs' to add multiple groups.
--with-initial-owner=WITH_INITIAL_OWNER
If specified the user making the request will be added as the initial
owner of the group being created. WITH_INITIAL_OWNER must be one of:
empty
The creator of the group will not be the owner of the group. This
is the default for dynamic groups.
with-initial-owner
The creator of the group will be the owner of the group. This is
the default for non-dynamic groups.
At most one of these can be specified:
--group-type=GROUP_TYPE; default="discussion"
The type of group to create. Setting group-type will add the
appropriate labels for the type of group being created. GROUP_TYPE
must be one of:
discussion
Creates a Google Groups discussion group.
dynamic
Creates a dynamic group.
security
Creates a security group.
--labels=LABELS
Labels for group resource. Example of labels "--labels
cloudidentity.googleapis.com/groups.discussion_forum"
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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups create
$ gcloud alpha identity groups create

38
gcloud/beta/identity/groups/delete Normal file
View file

@ -0,0 +1,38 @@
NAME
gcloud beta identity groups delete - delete an existing group
SYNOPSIS
gcloud beta identity groups delete EMAIL [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Delete an existing group.
EXAMPLES
To delete a group:
$ gcloud beta identity groups delete eng-discuss@foo.com
POSITIONAL ARGUMENTS
EMAIL
The email address of the group being deleted.
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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups delete
$ gcloud alpha identity groups delete

38
gcloud/beta/identity/groups/describe Normal file
View file

@ -0,0 +1,38 @@
NAME
gcloud beta identity groups describe - describe an existing group
SYNOPSIS
gcloud beta identity groups describe EMAIL [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Describe an existing group.
EXAMPLES
To describe a group:
$ gcloud beta identity groups describe eng-discuss@foo.com
POSITIONAL ARGUMENTS
EMAIL
The email address of the group being described.
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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups describe
$ gcloud alpha identity groups describe

49
gcloud/beta/identity/groups/help Normal file
View file

@ -0,0 +1,49 @@
NAME
gcloud beta identity groups - manage Cloud Identity Groups
SYNOPSIS
gcloud beta identity groups GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Commands for managing Cloud Identity Groups.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
memberships
(BETA) Manage Cloud Identity Groups Memberships.
COMMANDS
COMMAND is one of the following:
create
(BETA) Create a new group.
delete
(BETA) Delete an existing group.
describe
(BETA) Describe an existing group.
preview
(BETA) Retrieve a list of users in a customer account using CEL query.
search
(BETA) Searches for Groups matching a specified query.
update
(BETA) Update a group.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups
$ gcloud alpha identity groups

60
gcloud/beta/identity/groups/memberships/add Normal file
View file

@ -0,0 +1,60 @@
NAME
gcloud beta identity groups memberships add - create a new membership in an
existing group
SYNOPSIS
gcloud beta identity groups memberships add --group-email=GROUP_EMAIL
--member-email=MEMBER_EMAIL [--expiration=EXPIRATION]
[--organization=ORGANIZATION] [--roles=[ROLES,...]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Create a new membership in an existing group.
EXAMPLES
To create a new membership in a group:
$ gcloud beta identity groups memberships add \
--group-email="eng-discuss@foo.com" \
--member-email="user@foo.com"
REQUIRED FLAGS
--group-email=GROUP_EMAIL
The email address of the group the new membership is being added to.
--member-email=MEMBER_EMAIL
The email address of the group or user being added to a group.
OPTIONAL FLAGS
--expiration=EXPIRATION
Optional time of expiration for the membership. This is given as a
duration from now, for example '30d', '6m', '3y' for 30 days, 6 months,
or 3 years respectively.
--organization=ORGANIZATION
The organization ID of the group the new membership is being added to.
--roles=[ROLES,...]
A comma-separated list of roles for a member within the Group. If not
specified, MEMBER will be used as a default value.
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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups memberships add
$ gcloud alpha identity groups memberships add

47
gcloud/beta/identity/groups/memberships/check-transitive-membership Normal file
View file

@ -0,0 +1,47 @@
NAME
gcloud beta identity groups memberships check-transitive-membership - check
a potential member for transitive membership in a group
SYNOPSIS
gcloud beta identity groups memberships check-transitive-membership
--group-email=GROUP_EMAIL --member-email=MEMBER_EMAIL
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Check a potential member for transitive membership in a group.
EXAMPLES
To check if a potential member has a transitive membership in a group.
$ gcloud beta identity groups memberships \
check-transitive-membership --group-email=eng@foo.com \
--member-email=eng-discuss@foo.com
REQUIRED FLAGS
--group-email=GROUP_EMAIL
The email address of the group to check transitive membership for.
--member-email=MEMBER_EMAIL
The email address of the member to check transitive membership for.
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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups memberships check-transitive-membership
$ gcloud alpha identity groups memberships \
check-transitive-membership

47
gcloud/beta/identity/groups/memberships/delete Normal file
View file

@ -0,0 +1,47 @@
NAME
gcloud beta identity groups memberships delete - delete a membership from
an existing group
SYNOPSIS
gcloud beta identity groups memberships delete --group-email=GROUP_EMAIL
--member-email=MEMBER_EMAIL [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Delete a membership from an existing group.
EXAMPLES
To delete a memberships from a group:
$ gcloud beta identity groups memberships delete \
--group-email="eng-discuss@foo.com" \
--member-email="user@foo.com"
REQUIRED FLAGS
--group-email=GROUP_EMAIL
The email address of the group the new membership is being removed
from.
--member-email=MEMBER_EMAIL
The email address of the group or user being removed from the group
identified by group-email.
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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups memberships delete
$ gcloud alpha identity groups memberships delete

45
gcloud/beta/identity/groups/memberships/describe Normal file
View file

@ -0,0 +1,45 @@
NAME
gcloud beta identity groups memberships describe - describe a membership in
a group
SYNOPSIS
gcloud beta identity groups memberships describe --group-email=GROUP_EMAIL
--member-email=MEMBER_EMAIL [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Describe a membership in a group.
EXAMPLES
To describe a membership in a group:
$ gcloud beta identity groups memberships describe \
--group-email="eng-discuss@foo.com" \
--member-email="user@foo.com"
REQUIRED FLAGS
--group-email=GROUP_EMAIL
The email address of the group whose membership is being described.
--member-email=MEMBER_EMAIL
The email address of the member whose membership is being described.
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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups memberships describe
$ gcloud alpha identity groups memberships describe

57
gcloud/beta/identity/groups/memberships/get-membership-graph Normal file
View file

@ -0,0 +1,57 @@
NAME
gcloud beta identity groups memberships get-membership-graph - get a
membership graph of just a member or both a member and a group
SYNOPSIS
gcloud beta identity groups memberships get-membership-graph
--labels=LABELS --member-email=MEMBER_EMAIL [--group-email=GROUP_EMAIL]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Get a membership graph of just a member or both a member and a
group.
EXAMPLES
To get a membership graph of just a member.
$ gcloud beta identity groups memberships get-membership-graph \
--member-email=eng-discuss@foo.com \
--labels=cloudidentity.googleapis.com/groups.discussion_forum
To get a membership graph between a member and a group.
$ gcloud beta identity groups memberships get-membership-graph \
--member-email=eng-discuss@foo.com --group-email=eng@foo.com \
--labels=cloudidentity.googleapis.com/groups.discussion_forum
REQUIRED FLAGS
--labels=LABELS
The labels of the groups in the membership graph.
--member-email=MEMBER_EMAIL
The email address of the member to get the membership graph for.
OPTIONAL FLAGS
--group-email=GROUP_EMAIL
The email address of the group to constrain the membership graph with.
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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups memberships get-membership-graph
$ gcloud alpha identity groups memberships get-membership-graph

54
gcloud/beta/identity/groups/memberships/help Normal file
View file

@ -0,0 +1,54 @@
NAME
gcloud beta identity groups memberships - manage Cloud Identity Groups
Memberships
SYNOPSIS
gcloud beta identity groups memberships COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Commands for managing Cloud Identity Groups Memberships.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
add
(BETA) Create a new membership in an existing group.
check-transitive-membership
(BETA) Check a potential member for transitive membership in a group.
delete
(BETA) Delete a membership from an existing group.
describe
(BETA) Describe a membership in a group.
get-membership-graph
(BETA) Get a membership graph of just a member or both a member and a
group.
list
(BETA) List memberships in an existing group.
modify-membership-roles
(BETA) Add/remove/modify membership roles of a membership in a group.
search-transitive-groups
(BETA) Search transitive groups of a member.
search-transitive-memberships
(BETA) Search transitive memberships of a group.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups memberships
$ gcloud alpha identity groups memberships

85
gcloud/beta/identity/groups/memberships/list Normal file
View file

@ -0,0 +1,85 @@
NAME
gcloud beta identity groups memberships list - list memberships in an
existing group
SYNOPSIS
gcloud beta identity groups memberships list --group-email=GROUP_EMAIL
[--page-token=PAGE_TOKEN] [--view=VIEW; default="basic"]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) List memberships in an existing group.
EXAMPLES
To list memberships of a group:
$ gcloud beta identity groups memberships list \
--group-email="eng-discuss@foo.com" --limit=50
REQUIRED FLAGS
--group-email=GROUP_EMAIL
The email address of the group to show members for.
FLAGS
--page-token=PAGE_TOKEN
The next_page_token value returned from a previous list request, if
any.
--view=VIEW; default="basic"
There are two possible views, 'basic' and 'full', default is 'basic'.
VIEW must be one of:
basic
Response only basic information of the Groups. (e.g.
'display_name', 'name')
full
Response includes all the fields of the Groups
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups memberships list
$ gcloud alpha identity groups memberships list

67
gcloud/beta/identity/groups/memberships/modify-membership-roles Normal file
View file

@ -0,0 +1,67 @@
NAME
gcloud beta identity groups memberships modify-membership-roles -
add/remove/modify membership roles of a membership in a group
SYNOPSIS
gcloud beta identity groups memberships modify-membership-roles
--group-email=GROUP_EMAIL --member-email=MEMBER_EMAIL
[--update-roles-params=UPDATE_ROLES_PARAMS
| --add-roles=ADD_ROLES --remove-roles=[REMOVE_ROLES,...]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Add/remove/modify membership roles OR update expiry details of
membership in a group.
EXAMPLES
To add a new membership role to an existing group-member pair.
$ gcloud beta identity groups memberships modify-membership-roles \
--group-email="eng-discuss@foo.com" \
--member-email="user@foo.com" \
--add-roles=OWNER
REQUIRED FLAGS
--group-email=GROUP_EMAIL
The email address of the group that member-email belongs to.
--member-email=MEMBER_EMAIL
The email address of the group or user that is being updated
OPTIONAL FLAGS
At most one of these can be specified:
--update-roles-params=UPDATE_ROLES_PARAMS
Resource representing the parameters to update membership roles. An
example would be --update-roles-params
MEMBER=expiry_details.expire_time.
--add-roles=ADD_ROLES
Membership roles to be added. Currently supported MembershipRole:
'MEMBER', 'OWNER', 'MANAGER'.
--remove-roles=[REMOVE_ROLES,...]
Membership role names to be removed. Currently supported
MembershipRole: 'OWNER', 'MANAGER'. MEMBER-less owner is not
supported so removing just MEMBER role won't be possible.
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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups memberships modify-membership-roles
$ gcloud alpha identity groups memberships modify-membership-roles

54
gcloud/beta/identity/groups/memberships/search-transitive-groups Normal file
View file

@ -0,0 +1,54 @@
NAME
gcloud beta identity groups memberships search-transitive-groups - search
transitive groups of a member
SYNOPSIS
gcloud beta identity groups memberships search-transitive-groups
--labels=LABELS --member-email=MEMBER_EMAIL [--page-size=PAGE_SIZE]
[--page-token=PAGE_TOKEN] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Search transitive groups of a member.
EXAMPLES
To search transitive groups of a member.
$ gcloud beta identity groups memberships search-transitive-groups \
--labels=cloudidentity.googleapis.com/groups.discussion_forum \
--member-email=eng-discuss@foo.com --page-size=10
REQUIRED FLAGS
--labels=LABELS
The labels of the transitive groups.
--member-email=MEMBER_EMAIL
The email address of the member to search transitive groups for.
OPTIONAL FLAGS
--page-size=PAGE_SIZE
The maximum number of results to return.
--page-token=PAGE_TOKEN
The next_page_token value returned from a previous search request, if
any.
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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups memberships search-transitive-groups
$ gcloud alpha identity groups memberships search-transitive-groups

50
gcloud/beta/identity/groups/memberships/search-transitive-memberships Normal file
View file

@ -0,0 +1,50 @@
NAME
gcloud beta identity groups memberships search-transitive-memberships -
search transitive memberships of a group
SYNOPSIS
gcloud beta identity groups memberships search-transitive-memberships
--group-email=GROUP_EMAIL [--page-size=PAGE_SIZE]
[--page-token=PAGE_TOKEN] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Search transitive memberships of a group.
EXAMPLES
To search transitive memberships of a group. $ gcloud beta identity groups memberships \
search-transitive-memberships --group-email=eng@foo.com \
--page-size=10
REQUIRED FLAGS
--group-email=GROUP_EMAIL
The email address of the group to search transitive memberships for.
OPTIONAL FLAGS
--page-size=PAGE_SIZE
The maximum number of results to return.
--page-token=PAGE_TOKEN
The next_page_token value returned from a previous search request, if
any.
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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups memberships search-transitive-memberships
$ gcloud alpha identity groups memberships \
search-transitive-memberships

71
gcloud/beta/identity/groups/preview Normal file
View file

@ -0,0 +1,71 @@
NAME
gcloud beta identity groups preview - retrieve a list of users in a
customer account using CEL query
SYNOPSIS
gcloud beta 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
(BETA) 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 beta 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 beta 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 beta and might change without notice. This
variant is also available:
$ gcloud alpha identity groups preview

98
gcloud/beta/identity/groups/search Normal file
View file

@ -0,0 +1,98 @@
NAME
gcloud beta identity groups search - searches for Groups matching a
specified query
SYNOPSIS
gcloud beta identity groups search --labels=LABELS
--organization=ORGANIZATION [--page-size=PAGE_SIZE]
[--page-token=PAGE_TOKEN] [--view=VIEW; default="basic"]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Searches for Groups matching a specified query.
EXAMPLES
To Search groups:
$ gcloud beta identity groups search --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
labels contain 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 once added.
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 if there are more available results. To fetch all results, clients
must continue calling this method repeatedly until the response no
longer contains a nextPageToken.
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 be
one 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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups search
$ gcloud alpha identity groups search

125
gcloud/beta/identity/groups/update Normal file
View file

@ -0,0 +1,125 @@
NAME
gcloud beta identity groups update - update a group
SYNOPSIS
gcloud beta identity groups update EMAIL
[--dynamic-user-query=DYNAMIC_USER_QUERY] [--labels=LABELS]
[--add-posix-group=POSIX_GROUP | --clear-posix-groups
| --remove-posix-groups=[POSIX_GROUP,...]]
[--clear-description | --description=DESCRIPTION]
[--clear-display-name | --display-name=DISPLAY_NAME]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Update a group.
EXAMPLES
To update a group:
$ gcloud beta identity groups update eng-discuss@foo.com \
--display-name="New Engineer Discuss" \
--description="Group for engineering discussions"
To create a POSIX group from an existing Google Group:
$ gcloud beta identity groups update eng-discuss@foo.com \
--add-posix-group=name=eng,gid=1005
To remove POSIX information from a Google Group:
$ gcloud beta identity groups update eng-discuss@foo.com \
--remove-posix-groups=eng
POSITIONAL ARGUMENTS
EMAIL
The email address of the group to be updated.
FLAGS
--dynamic-user-query=DYNAMIC_USER_QUERY
Query that determines the memberships of the dynamic group.
Example of a query:
--dynamic-user-query="user.organizations.exists(org,org.title=='SWE')"
--labels=LABELS
One or more label entries that apply to the group. Currently supported
labels contain 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 once added.
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": ""}.
At most one of these can be specified:
--add-posix-group=POSIX_GROUP
Group id (gid) and a name for a POSIX group that you want to add to
the specified Cloud Identity group. You can specify multiple POSIX
groups to add with multiple instances of this flag.
For example, use '--add-posix-group=gid=1005,name=eng' to add a
single group, or '--add-posix-group=gid=1005,name=eng
--add-posix-group=gid=1006,name=docs' to add multiple groups.
--clear-posix-groups
Clear all POSIX groups from the specified Cloud Identity group.
--remove-posix-groups=[POSIX_GROUP,...]
Remove POSIX groups from the specified Cloud Identity group. You can
specify multiple POSIX groups by either name or gid by using a
comma-separated list.
For example, use '--remove-posix-groups=1005,1006' to remove POSIX
groups with group ids '1005' and '1006', or use
'--remove-posix-groups=eng,docs' to remove POSIX groups named 'eng'
and 'docs'.
At most one of these can be specified:
--clear-description
Clear existing description on group being updated.
--description=DESCRIPTION
Replace existing description on group being updated.
At most one of these can be specified:
--clear-display-name
Clear existing display name on group being updated.
--display-name=DISPLAY_NAME
Replace existing display name on group being updated.
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 the cloudidentity/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/identity/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud identity groups update
$ gcloud alpha identity groups update