REST Resource: projects.locations.keyHandles

Resource: KeyHandle

Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of aCryptoKey.

JSON representation
{"name":string,"kmsKey":string,"resourceTypeSelector":string}
Fields
name

string

Identifier. Name of theKeyHandle resource, e.g.projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}.

kmsKey

string

Output only. Name of aCryptoKey that has been provisioned for Customer Managed Encryption Key (CMEK) use in theKeyHandle project and location for the requested resource type. TheCryptoKey project will reflect the value configured in theAutokeyConfig on the resource project's ancestor folder at the time of theKeyHandle creation. If more than one ancestor folder has a configuredAutokeyConfig, the nearest of these configurations is used.

resourceTypeSelector

string

Required. Indicates the resource type that the resultingCryptoKey is meant to protect, e.g.{SERVICE}.googleapis.com/{TYPE}. See documentation for supported resource types.

Methods

create

 Creates a newKeyHandle, triggering the provisioning of a newCryptoKey for CMEK use with the given resource type in the configured key project and the same location.

get

 Returns theKeyHandle.

list

 ListsKeyHandles.

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-30 UTC.