Method: keyRings.list

Full name: projects.locations.keyRings.list

Lists KeyRings.

HTTP request


The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the location associated with the KeyRings, in the format projects/*/locations/*.

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

  • cloudkms.keyRings.list

Query parameters

Parameters
pageSize

integer

Optional. Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.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 ListKeyRingsResponse.next_page_token.
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.ListKeyRings.

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

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

object (KeyRing)

The list of KeyRings.
nextPageToken

string

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

integer

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