gcloud alpha kms keys remove-iam-policy-binding Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha kms keys remove-iam-policy-binding - remove IAM policy binding for a kms key
- SYNOPSIS
gcloud alpha kms keys remove-iam-policy-binding(KEY:--keyring=KEYRING--location=LOCATION)--member=PRINCIPAL--role=ROLE[--all|--condition=[KEY=VALUE,…] |--condition-from-file=PATH_TO_FILE][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Removes a policy binding from the IAM policy of a kms key.A binding consists of at least one member, a role, and an optional condition.- EXAMPLES
- To remove an IAM policy binding for the role of 'roles/editor' for the user'test-user@gmail.com' on the key frodo with the keyring fellowship and locationglobal, run:
gcloudalphakmskeysremove-iam-policy-bindingfrodo--keyring='fellowship'--location='global'--member='user:test-user@gmail.com'--role='roles/editor'To remove an IAM policy binding with a condition of expression='request.time< timestamp("2019-01-01T00:00:00Z")', title='expires_end_of_2018', anddescription='Expires at midnight on 2018-12-31' for the role of'roles/cloudkms.signer' for the user 'test-user@gmail.com' on a the key frodowith the keyring fellowship and location global, run:
gcloudalphakmskeysremove-iam-policy-bindingfrodo--keyring='fellowship'--location='global'--member='user:test-user@gmail.com'--role='roles/cloudkms.signer'--condition='expression=request.time<timestamp("2019-01-01T00:00:00Z"),title=expires_end_of_2018,descrip\tion=Expires at midnight on 2018-12-31'To remove all IAM policy bindings regardless of the condition for the role of'roles/cloudkms.signer' and for the user 'test-user@gmail.com' on a the keyfrodo with the keyring fellowship and location global, run:
gcloudalphakmskeysremove-iam-policy-bindingfrodo--keyring='fellowship'--location='global'--member='user:test-user@gmail.com'--role='roles/cloudkms.signer'--allSeehttps://cloud.google.com/iam/docs/managing-policiesfor details of policy role and member types.
- POSITIONAL ARGUMENTS
- Key resource - The key to remove the IAM policy binding. The arguments in thisgroup can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
keyon the command line with a fully specifiedname; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
KEY- ID of the key or fully qualified identifier for the key.
To set the
keyattribute:- provide the argument
keyon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--keyring=KEYRING- The containing keyring.
To set the
keyringattribute:- provide the argument
keyon the command line with a fully specifiedname; - provide the argument
--keyringon the command line.
- provide the argument
--location=LOCATION- The location of the resource.
To set the
locationattribute:- provide the argument
keyon the command line with a fully specifiedname; - provide the argument
--locationon the command line.
- provide the argument
- provide the argument
- Key resource - The key to remove the IAM policy binding. The arguments in thisgroup can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.
- REQUIRED FLAGS
--member=PRINCIPAL- The principal to remove the binding for. Should be of the form
user|group|serviceAccount:emailordomain:domain.Examples:
user:test-user@gmail.com,group:admins@example.com,serviceAccount:test123@example.domain.com, ordomain:example.domain.com.Deleted principals have an additional
deleted:prefix and a?uid=UIDsuffix, whereisa unique identifier for the principal. Example:UIDdeleted:user:test-user@gmail.com?uid=123456789012345678901.Some resources also accept the following special values:
allUsers- Special identifier that represents anyone who is on theinternet, with or without a Google account.allAuthenticatedUsers- Special identifier that represents anyonewho is authenticated with a Google account or a service account.
--role=ROLE- The role to remove the principal from.
- OPTIONAL FLAGS
- At most one of these can be specified:
--all- Remove all bindings with this role and principal, irrespective of anyconditions.
--condition=[KEY=VALUE,…]- The condition of the binding that you want to remove. When the condition isexplicitly specified as
None(--condition=None), abinding without a condition is removed. Otherwise, only a binding with acondition that exactly matches the specified condition (including the optionaldescription) is removed. For more on conditions, refer to the conditionsoverview guide:https://cloud.google.com/iam/docs/conditions-overviewWhen using the
--conditionflag, include the following key-valuepairs:expression- (Required) Condition expression that evaluates to True or False. This uses asubset of Common Expression Language syntax.
If the condition expression includes a comma, use a different delimiter toseparate the key-value pairs. Specify the delimiter before listing the key-valuepairs. For example, to specify a colon (
:) as the delimiter, do thefollowing:--condition=^:^title=TITLE:expression=EXPRESSION. Formore information, seehttps://cloud.google.com/sdk/gcloud/reference/topic/escaping. title- (Required) A short string describing the purpose of the expression.
description- (Optional) Additional description for the expression.
--condition-from-file=PATH_TO_FILE- Path to a local JSON or YAML file that defines the condition. To see availablefields, see the help for
--condition. Use a full or relative pathto a local file containing the value of condition.
- At most one of these can be specified:
- 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 helpfor details. - API REFERENCE
- This command uses the
cloudkms/v1API. The full documentation forthis API can be found at:https://cloud.google.com/kms/ - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudkmskeysremove-iam-policy-bindinggcloudbetakmskeysremove-iam-policy-binding
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.