Method: cryptoKeys.list

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

Lists CryptoKeys.

HTTP request

GET https://cloudkms.googleapis.com/v1/{parent=projects/*/locations/*/keyRings/*}/cryptoKeys

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

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

  • cloudkms.cryptoKeys.list

Query parameters

Parameters
pageSize

number

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

pageToken

string

Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token.

versionView

enum(CryptoKeyVersionView)

The fields of the primary version to include in the response.

Request body

The request body must be empty.

Response body

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

Response message for KeyManagementService.ListCryptoKeys.

JSON representation
{
  "cryptoKeys": [
    {
      object(CryptoKey)
    }
  ],
  "nextPageToken": string,
  "totalSize": number
}
Fields
cryptoKeys[]

object(CryptoKey)

The list of CryptoKeys.

nextPageToken

string

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

totalSize

number

The total number of CryptoKeys 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.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud KMS Documentation