Method: keyHandles.get

Full name: projects.locations.keyHandles.get

Returns theKeyHandle.

HTTP request


GET https://cloudkms.googleapis.com/v1/{name=projects/*/locations/*/keyHandles/*}

The URLs usegRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance ofKeyHandle.

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 theAuthentication Overview.

IAM Permissions

Requires the followingIAM permission on thename resource:

  • cloudkms.keyHandles.get

For more information, see theIAM documentation.

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-12-24 UTC.