- 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 JSON or YAML file.See https://cloud.google.com/iam/docs/managing-policies for 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 key
frodowith the keyringfellowshipand locationglobal:gcloud alpha kms keys set-iam-policy frodo policy.json --keyring fellowship --location globalSee https://cloud.google.com/iam/docs/managing-policies for details of the policy file format and contents.
- POSITIONAL ARGUMENTS
-
-
Key resource - The key whose IAM policy to update. The arguments in this group
can be used to specify the attributes of this resource. (NOTE) Some attributes
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 specified name; -
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 this group are specified.
-
provide the argument
--keyring=KEYRING-
The containing keyring.
To set the
keyringattribute:-
provide the argument
keyon the command line with a fully specified name; -
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 specified name; -
provide the argument
--locationon the command line.
-
provide the argument
-
provide the argument
POLICY_FILE-
Path to a local JSON or YAML formatted file containing a valid policy.
The output of the
get-iam-policycommand is a valid file, as is any JSON or YAML file conforming to the structure of a Policy.
-
Key resource - The key whose IAM policy to update. The arguments in this group
can be used to specify the attributes of this resource. (NOTE) Some attributes
are not given arguments in this group but can be set in other ways.
- 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 for this API can be found at: https://cloud.google.com/kms/ - NOTES
-
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation-only early access
allowlist. These variants are also available:
gcloud kms keys set-iam-policygcloud beta kms keys set-iam-policy
gcloud alpha kms keys set-iam-policy
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 2025-05-07 UTC.