gcloud_alpha_pubsub_subscriptions_add-iam-policy-binding (1)
NAME
- gcloud alpha pubsub subscriptions add-iam-policy-binding - add IAM policy binding to a subscription
SYNOPSIS
-
gcloud alpha pubsub subscriptions add-iam-policy-binding SUBSCRIPTION --member=MEMBER --role=ROLE [--condition=[KEY=VALUE,...] | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Add an IAM policy binding to the IAM policy of a Cloud Pub/Sub
POSITIONAL ARGUMENTS
-
-
Subscription resource - The subscription to add the IAM policy binding. 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 [subscription] 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.
-
- SUBSCRIPTION
-
ID of the subscription or fully qualified identifier for the subscription.
-
-
Subscription resource - The subscription to add the IAM policy binding. 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 [subscription] 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.
REQUIRED FLAGS
-
- --member=MEMBER
-
The member 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.
Can also be one of the following special values:-
- ---
- allUsers - anyone who is on the internet, with or without a Google account.
- ---
- allAuthenticatedUsers - anyone who is authenticated with a Google account or a service account.
-
-
- --role=ROLE
-
Define the role of the member.
OPTIONAL FLAGS
-
-
At most one of these may be specified:
-
- --condition=[KEY=VALUE,...]
-
Condition of the binding to be added. When condition is explicitly specified as None (e.g. --condition=None), a binding without a condition is added. When --condition is specified and is not a None condition, --role cannot be a primitive role. Primitive roles are roles/editor, roles/owner, and roles/viewer.
- expression
-
(Required) Expression of the condition which evaluates to True or False. This
uses a subset of Common Expression Language syntax.
- title
-
(Required) Title for the expression, i.e. a short string describing its purpose.
- description
-
(Optional) Description for the expression. This is a longer text which describes
the expression.
NOTE: An unsatisfied condition will not allow access via this binding.
- --condition-from-file=CONDITION_FROM_FILE
-
Path to a local JSON or YAML file that defines the condition. To see available
fields, see the help for --condition.
-
-
At most one of these may be specified:
GCLOUD WIDE FLAGS
These flags are available to all commands: --account, --configuration, --flags-file, --flatten, --format, --help, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity. Run $ gcloud help for details.
API REFERENCE
This command uses the pubsub/v1 API. The full documentation for this API can be found at: cloud.google.com/pubsub/docs
EXAMPLES
To add an IAM policy binding for the role of 'roles/editor' for the user 'test-user@gmail.com' with subscription 'my-subscription', run:
-
$ gcloud alpha pubsub subscriptions add-iam-policy-binding \
my-subscription --member='user:test-user@gmail.com' \
--role='roles/editor'
For a service account test-proj1@example.domain.com, the following command will add an IAM policy binding for the role of 'roles/editor' to the given service account:.RS 2m $ gcloud alpha pubsub subscriptions add-iam-policy-binding \
test-proj1@example.domain.com \
--member='serviceAccount:test-proj1@example.domain.com' \
--role='roles/editor'
The following command will add an IAM policy binding for the role of 'roles/editor' for all authenticated users on a subscription with identifier 'my-subscription':
-
$ gcloud alpha pubsub subscriptions add-iam-policy-binding \
my-subscription --member='allAuthenticatedUsers' \
--role='roles/editor
To add an IAM policy binding which expires at the end of the year 2018 for the role of 'roles/pubsub.subscriber' and the user 'test-user@gmail.com' with subscription 'my-subscription', run:
-
$ gcloud alpha pubsub subscriptions add-iam-policy-binding \
my-subscription --member='user:test-user@gmail.com' \
--role='roles/pubsub.subscriber' \
--condition='expression=request.time <
timestamp("2019-01-01T00:00:00Z"),title=expires_end_of_2018,descrip\ tion=Expires at midnight on 2018-12-31'
See cloud.google.com/iam/docs/managing-policies for details of policy role and member types.
NOTES
This command is currently in ALPHA and may change without notice. If this command fails with API permission errors despite specifying the right project, you will have to apply for early access and have your projects registered on the API whitelist to use it. To do so, contact Support at cloud.google.com/support This variant is also available:
- $ gcloud beta pubsub subscriptions add-iam-policy-binding