- NAME
-
- gcloud api-gateway apis add-iam-policy-binding - add IAM policy binding to a gateway
- SYNOPSIS
-
-
gcloud api-gateway apis add-iam-policy-binding
API
--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:
gcloud api-gateway apis add-iam-policy-binding my-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. 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.
-
provide the argument
-
provide the argument
-
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.
- REQUIRED FLAGS
-
--member
=PRINCIPAL
-
The principal to add the binding for. Should be of the form
user|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 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 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:
gcloud alpha api-gateway apis add-iam-policy-binding
gcloud beta api-gateway apis add-iam-policy-binding
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 2024-02-06 UTC.