Method: keyHandles.create

Full name: projects.locations.keyHandles.create

Creates a new KeyHandle, triggering the provisioning of a new CryptoKey for CMEK use with the given resource type in the configured key project and the same location. operations.get should be used to resolve the resulting long-running operation and get the resulting KeyHandle and CryptoKey.

HTTP request


POST https://cloudkms.googleapis.com/v1/{parent=projects/*/locations/*}/keyHandles

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the resource project and location to create the KeyHandle in, e.g. projects/{PROJECT_ID}/locations/{LOCATION}.

Query parameters

Parameters
keyHandleId

string

Optional. Id of the KeyHandle. Must be unique to the resource project and location. If not provided by the caller, a new UUID is used.

Request body

The request body contains an instance of KeyHandle.

Response body

If successful, the response body contains a newly created instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • cloudkms.keyHandles.create

For more information, see the IAM documentation.