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

NAME

gcloud alpha api-gateway apis add-iam-policy-binding - add IAM policy binding to a gateway

SYNOPSIS

gcloud alpha api-gateway apis add-iam-policy-binding API --member=PRINCIPAL --role=ROLE [GCLOUD_WIDE_FLAG …]

DESCRIPTION

(ALPHA) Add IAM policy binding to a gateway.

EXAMPLES

To add an IAM policy binding for the role of 'roles/editor' for the user '[e-mail]' on the API 'my-api', run:

gcloud alpha api-gateway apis add-iam-policy-binding my-api --member='user:[e-mail]' --role='roles/editor

POSITIONAL ARGUMENTS

Api resource - Name for API which IAM policy binding will be added to. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.

To set the project attribute:

• provide the argument api on the command line with a fully specified name;
• provide the argument --project on the command line;
• set the property core/project.

To set the location attribute:

• provide the argument api on the command line with a fully specified name;
• 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 api attribute:

• provide the argument api on the command line.

REQUIRED FLAGS

--member=PRINCIPAL

The principal to add the binding for. Should be of the form user|group|serviceAccount:email or domain:domain.

Examples: user:[e-mail], group:[e-mail], serviceAccount:[e-mail], or domain:example.domain.com.

Some resources also accept the following special values:

• allUsers - Special identifier that represents anyone who is on the internet, with or without a Google account.
• allAuthenticatedUsers - Special identifier that represents anyone who 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 a predefined role, such as roles/logging.viewer, or the role ID for a custom role, such as organizations/{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

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. These variants are also available:

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

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