NAME

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

SYNOPSIS

gcloud alpha api-gateway gateways add-iam-policy-binding (GATEWAY : --location=LOCATION) --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 'test-user@gmail.com' on the gateway 'my-gateway', run:

$ gcloud alpha api-gateway gateways add-iam-policy-binding \ my-gateway --member='user:test-user@gmail.com' \ --role='roles/editor

POSITIONAL ARGUMENTS

Gateway resource - Name for gateway which will be IAM policy binding will be

added to. 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 project attribute:

provide the argument gateway on the command line with a fully specified name;

provide the argument --project on the command line;

set the property core/project.

This must be specified.

GATEWAY

ID of the gateway or fully qualified identifier for the gateway. To set the gateway attribute:

  • provide the argument gateway on the command line.

This positional argument must be specified if any of the other arguments in this group are specified.

--location=LOCATION

Cloud location for gateway. To set the location attribute:

  • provide the argument gateway on the command line with a fully specified name;

  • provide the argument --location 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:test-user@gmail.com, group:admins@example.com, serviceAccount:test123@example.domain.com, 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 gateways add-iam-policy-binding

$ gcloud beta api-gateway gateways add-iam-policy-binding