gcloud api-gateway apis add-iam-policy-binding

NAME
gcloud api-gateway apis add-iam-policy-binding - add IAM policy binding to a gateway
SYNOPSIS
gcloud api-gateway apis add-iam-policy-bindingAPI--member=PRINCIPAL--role=ROLE[GCLOUD_WIDE_FLAG]
DESCRIPTION
Add IAM policy binding to a gateway.
EXAMPLES
To add an IAM policy binding for the role of 'roles/editor' for the user'test-user@gmail.com' on the API 'my-api', run:
gcloudapi-gatewayapisadd-iam-policy-bindingmy-api--member='user:test-user@gmail.com'--role='roles/editor
POSITIONAL ARGUMENTS
Api resource - Name for API which IAM policy binding will be added to. Thisrepresents a Cloud resource. (NOTE) Some attributes are not given arguments inthis group but can be set in other ways.

To set theproject attribute:

  • provide the argumentapi on the command line with a fully specifiedname;
  • provide the argument--project on the command line;
  • set the propertycore/project.

To set thelocation attribute:

  • provide the argumentapi on 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 theapi attribute:

  • provide the argumentapi on the command line.
REQUIRED FLAGS
--member=PRINCIPAL
The principal to add the binding for. Should be of the formuser|group|serviceAccount:email ordomain:domain.

Examples:user:test-user@gmail.com,group:admins@example.com,serviceAccount:test123@example.domain.com, ordomain:example.domain.com.

Some resources also accept the following special values:

  • allUsers - Special identifier that represents anyone who is on theinternet, with or without a Google account.
  • allAuthenticatedUsers - Special identifier that represents anyonewho is authenticated with a Google account or a service account.
--role=ROLE
Role name to assign to the principal. The role name is the complete path of apredefined role, such asroles/logging.viewer, or the role ID for acustom role, such asorganizations/{ORGANIZATION_ID}/roles/logging.viewer.
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
These variants are also available:
gcloudalphaapi-gatewayapisadd-iam-policy-binding
gcloudbetaapi-gatewayapisadd-iam-policy-binding

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.