Cloud Key Management Service (KMS) API (cloudkms:v1)

Additions

Methods


• ▼ ▲ cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.delete

  Description : Permanently deletes the given CryptoKeyVersion. Only possible if the version has not been previously imported and if its state is one of DESTROYED, IMPORT_FAILED, or GENERATION_FAILED. Successfully imported CryptoKeyVersions cannot be deleted at this time. The specified version will be immediately and permanently deleted upon calling this method. This action cannot be undone.

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

  Parameters :

  name

  Description : Required. The name of the CryptoKeyVersion to delete.

  Required : Yes

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$

  Parameter Order : name

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}

  HTTP Method : DELETE

  Path : v1/{+name}

• ▼ ▲ cloudkms.projects.locations.keyRings.cryptoKeys.delete

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

  Path : v1/{+name}

  Parameters :

  name

  Description : Required. The name of the CryptoKey to delete.

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$

  Required : Yes

  Location : path

  Parameter Order : name

  HTTP Method : DELETE

  Description : Permanently deletes the given CryptoKey. All child CryptoKeyVersions must have been previously deleted using KeyManagementService.DeleteCryptoKeyVersion. The specified crypto key will be immediately and permanently deleted upon calling this method. This action cannot be undone.

• ▼ ▲ cloudkms.projects.locations.retiredResources.list

  Path : v1/{+parent}/retiredResources

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/retiredResources

  HTTP Method : GET

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

  Description : Lists the RetiredResources which are the records of deleted CryptoKeys. RetiredResources prevent the reuse of these resource names after deletion.

  Parameters :

  parent

  Description : Required. The project-specific location holding the RetiredResources, in the format `projects/*/locations/*`.

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Location : path

  Type : string

  Required : Yes

  pageSize

  Description : Optional. Optional limit on the number of RetiredResources to be included in the response. Further RetiredResources can subsequently be obtained by including the ListRetiredResourcesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

  Location : query

  Type : integer

  Format : int32

  pageToken

  Location : query

  Description : Optional. Optional pagination token, returned earlier via ListRetiredResourcesResponse.next_page_token.

  Type : string

  Parameter Order : parent

• ▼ ▲ cloudkms.projects.locations.retiredResources.get

  Parameter Order : name

  HTTP Method : GET

  Parameters :

  name

  Required : Yes

  Type : string

  Location : path

  Description : Required. The name of the RetiredResource to get.

  Pattern : ^projects/[^/]+/locations/[^/]+/retiredResources/[^/]+$

  Description : Retrieves a specific RetiredResource resource, which represents the record of a deleted CryptoKey.

  Path : v1/{+name}

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/retiredResources/{retiredResourcesId}