Method: keyHandles.list

Full name: projects.locations.keyHandles.list

Lists KeyHandles.

HTTP request


The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the resource project and location from which to list KeyHandles, e.g. projects/{PROJECT_ID}/locations/{LOCATION}.

Query parameters

Parameters
pageSize

integer

Optional. Optional limit on the number of KeyHandles to include in the response. The service may return fewer than this value. Further KeyHandles can subsequently be obtained by including the ListKeyHandlesResponse.next_page_token in a subsequent request. If unspecified, at most 100 KeyHandles will be returned.
pageToken

string

Optional. Optional pagination token, returned earlier via ListKeyHandlesResponse.next_page_token.
filter

string

Optional. Filter to apply when listing KeyHandles, e.g. resourceTypeSelector="{SERVICE}.googleapis.com/{TYPE}".

Request body

The request body must be empty.

Response body

Response message for Autokey.ListKeyHandles.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "keyHandles": [
    {
      object (KeyHandle)
    }
  ],
  "nextPageToken": string
}
Fields
keyHandles[]

object (KeyHandle)

Resulting KeyHandles.
nextPageToken

string

A token to retrieve next page of results. Pass this value in ListKeyHandlesRequest.page_token to retrieve the next page of results.

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.list

For more information, see the IAM documentation.