gcloud api-gateway apis get-iam-policy Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud api-gateway apis get-iam-policy - get the IAM policy for an API
- SYNOPSIS
gcloud api-gateway apis get-iam-policyAPI[--filter=EXPRESSION][--limit=LIMIT][--page-size=PAGE_SIZE][--sort-by=[FIELD,…]][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Get the IAM policy for an API.
- EXAMPLES
- To print the IAM policy for a given API, run:
gcloudapi-gatewayapisget-iam-policymy-api - POSITIONAL ARGUMENTS
- Api resource - Name for API which for which to get IAM policy. This represents aCloud resource. (NOTE) Some attributes are not given arguments in this group butcan be set in other ways.
To set the
projectattribute:- provide the argument
apion the command line with a fully specifiedname; - provide the argument
--projecton the command line; - set the property
core/project.
To set the
locationattribute:- provide the argument
apion the command line with a fully specifiedname; - Location for API and API Configs. Defaults to global.
This must be specified.
API- ID of the api or fully qualified identifier for the api.
To set the
apiattribute:- provide the argument
apion the command line.
- provide the argument
- provide the argument
- Api resource - Name for API which for which to get IAM policy. This represents aCloud resource. (NOTE) Some attributes are not given arguments in this group butcan be set in other ways.
- LIST COMMAND FLAGS
--filter=EXPRESSION- Apply a Boolean filter
EXPRESSIONto each resource itemto be listed. If the expression evaluatesTrue, then that item islisted. For more details and examples of filter expressions, run $gcloud topic filters. This flaginteracts 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. Thisflag 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 themaximum number of resources per page. The default is determined by the serviceif 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 orderis ascending. Prefix a field with ``~´´ for descending order on thatfield. 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. - NOTES
- These variants are also available:
gcloudalphaapi-gatewayapisget-iam-policygcloudbetaapi-gatewayapisget-iam-policy
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.