- NAME
-
- gcloud beta workstations get-iam-policy - get the IAM policy for a workstation
- SYNOPSIS
-
-
gcloud beta workstations get-iam-policy(WORKSTATION:--cluster=CLUSTER--config=CONFIG--region=REGION) [--endpoint-mode=ENDPOINT_MODE] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,…]] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(BETA)gcloud beta workstations get-iam-policydisplays the IAM policy associated with a given workstation. If formatted as JSON, the output can be edited and used as a policy file for set-iam-policy. The output includes an "etag" field identifying the version emitted and allowing detection of concurrent policy updates; see $ {parent} set-iam-policy for additional details. - EXAMPLES
-
To get the IAM policy for a given workstation, run:
gcloud beta workstations get-iam-policy WORKSTATION - POSITIONAL ARGUMENTS
-
-
Workstation resource - The workstation for which to display the IAM policy. The
arguments in this group can be used to specify the attributes of this resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways.
To set the
projectattribute:-
provide the argument
workstationon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
WORKSTATION-
ID of the workstation or fully qualified identifier for the workstation.
To set the
workstationattribute:-
provide the argument
workstationon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--cluster=CLUSTER-
The name of the cluster containing the workstation.
To set the
clusterattribute:-
provide the argument
workstationon the command line with a fully specified name; -
provide the argument
--clusteron the command line; -
set the property
workstations/cluster.
-
provide the argument
--config=CONFIG-
The name of the config containing the workstation.
To set the
configattribute:-
provide the argument
workstationon the command line with a fully specified name; -
provide the argument
--configon the command line; -
set the property
workstations/config.
-
provide the argument
--region=REGION-
The name of the region of the workstation.
To set the
regionattribute:-
provide the argument
workstationon the command line with a fully specified name; -
provide the argument
--regionon the command line; -
set the property
workstations/region.
-
provide the argument
-
provide the argument
-
Workstation resource - The workstation for which to display the IAM policy. The
arguments in this group can be used to specify the attributes of this resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways.
- FLAGS
-
--endpoint-mode=ENDPOINT_MODE-
Specifies endpoint mode for a given command. Regional endpoints provide enhanced
data residency and reliability by ensuring your request is handled entirely
within the specified Google Cloud region. This differs from global endpoints,
which may process parts of the request outside the target region. Overrides the
default
regional/endpoint_modeproperty value for this command invocation.ENDPOINT_MODEmust be one of:global- (Default) Use global rather than regional endpoints.
regional- Only use regional endpoints. An error will be raised if a regional endpoint is not available for a given command.
regional-preferred- Use regional endpoints when available, otherwise use global endpoints. Recommended for most users.
- LIST COMMAND FLAGS
-
--filter=EXPRESSION-
Apply a Boolean filter
EXPRESSIONto each resource item to be listed. If the expression evaluatesTrue, 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--filterand--limitdepending 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 helpfor details. - API REFERENCE
-
This command uses the
workstations/v1betaAPI. The full documentation for this API can be found at: https://cloud.google.com/workstations - REGIONAL ENDPOINTS
-
This command supports regional endpoints. To use regional endpoints for this
command, use the
--endpoint-mode=regional-preferredflag. To use regional endpoints by default, run$ gcloud config set regional/endpoint_mode regional-preferred. - NOTES
-
This command is currently in beta and might change without notice. These
variants are also available:
gcloud workstations get-iam-policygcloud alpha workstations get-iam-policy
gcloud beta workstations get-iam-policy
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-09-29 UTC.