NAME

gcloud pubsub subscriptions add-iam-policy-binding - add IAM policy binding to a subscription

SYNOPSIS

gcloud pubsub subscriptions add-iam-policy-binding SUBSCRIPTION --member=PRINCIPAL --role=ROLE [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

Add an IAM policy binding to a Cloud Pub/Sub Subscription.

EXAMPLES

To add an IAM policy binding with the role of 'roles/editor' for the user 'test-user@example.com' on the subscription 'my-subscription', run:

$ gcloud pubsub subscriptions add-iam-policy-binding \ my-subscription --member='user:test-user@example.com' \ --role='roles/editor'

To add an IAM policy binding with the role of 'roles/editor' for the service account 'my-iam-account@my-project.iam.gserviceaccount.com' on the subscription 'my-subscription', run:

$ gcloud pubsub subscriptions add-iam-policy-binding \ my-subscription \ --member='serviceAccount:my-iam-account@my-project.iam.gservicea\ ccount.com' --role='roles/editor'

See https://cloud.google.com/iam/docs/managing-policies for details of policy role and member types.

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. To set the subscription attribute:

  • provide the argument subscription 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.

API REFERENCE

This command uses the pubsub/v1 API. The full documentation for this API can be found at: https://cloud.google.com/pubsub/docs

NOTES

These variants are also available:

$ gcloud alpha pubsub subscriptions add-iam-policy-binding

$ gcloud beta pubsub subscriptions add-iam-policy-binding