Method: keyRings.list

Full name: projects.locations.keyRings.list

Lists KeyRings.

HTTP request

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

The URL uses 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 Google IAM permission on the specified resource parent:

  • cloudkms.keyRings.list

Query parameters

Parameters
pageSize

number

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 pagination token, returned earlier via ListKeyRingsResponse.next_page_token.

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

JSON representation
{
  "keyRings": [
    {
      object(KeyRing)
    }
  ],
  "nextPageToken": string,
  "totalSize": number
}
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

number

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.

Try it!

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

Send feedback about...

Cloud KMS Documentation