gcloud alpha kms keys set-iam-policy

NAME
gcloud alpha kms keys set-iam-policy - set the IAM policy for a key
SYNOPSIS
gcloud alpha kms keys set-iam-policy(KEY :--keyring=KEYRING--location=LOCATION)POLICY_FILE[GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Sets the IAM policy for the given key as defined in a JSONor YAML file.

Seehttps://cloud.google.com/iam/docs/managing-policiesfor details of the policy file format and contents.

EXAMPLES
The following command will read am IAM policy defined in a JSON file'policy.json' and set it for the keyfrodo with the keyringfellowship and locationglobal:
gcloudalphakmskeysset-iam-policyfrodopolicy.json--keyringfellowship--locationglobal

Seehttps://cloud.google.com/iam/docs/managing-policiesfor details of the policy file format and contents.

POSITIONAL ARGUMENTS
Key resource - The key whose IAM policy to update. The arguments in this groupcan be used to specify the attributes of this resource. (NOTE) Some attributesare not given arguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentkey on the command line with a fully specifiedname;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

KEY
ID of the key or fully qualified identifier for the key.

To set thekey attribute:

  • provide the argumentkey on the command line.

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

--keyring=KEYRING
The containing keyring.

To set thekeyring attribute:

  • provide the argumentkey on the command line with a fully specifiedname;
  • provide the argument--keyring on the command line.
--location=LOCATION
The location of the resource.

To set thelocation attribute:

  • provide the argumentkey on the command line with a fully specifiedname;
  • provide the argument--location on the command line.
POLICY_FILE
Path to a local JSON or YAML formatted file containing a valid policy.

The output of theget-iam-policy command is a valid file, as is anyJSON or YAML file conforming to the structure of aPolicy.

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 thecloudkms/v1 API. 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:
gcloudkmskeysset-iam-policy
gcloudbetakmskeysset-iam-policy

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.