Method: cryptoKeyVersions.list

Full name: projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list

Lists CryptoKeyVersions.

HTTP request


The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the CryptoKey to list, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

Authorization requires the following IAM permission on the specified resource parent:

  • cloudkms.cryptoKeyVersions.list

Query parameters

Parameters
pageSize

integer

Optional. Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken

string

Optional. Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token.
view

enum (CryptoKeyVersionView)

The fields to include in the response.
filter

string

Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.
orderBy

string

Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results.

Request body

The request body must be empty.

Response body

Response message for KeyManagementService.ListCryptoKeyVersions.

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

JSON representation 
{
  "cryptoKeyVersions": [
    {
      object (CryptoKeyVersion)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
cryptoKeyVersions[]

object (CryptoKeyVersion)

The list of CryptoKeyVersions.
nextPageToken

string

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

integer

The total number of CryptoKeyVersions that matched the query.

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.