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

▼ ▲ cloudkms.projects.locations.keyRings.cryptoKeys.create

Parameters :

trustedWrappingEnabled

Location : query

Description : Optional. Whether trusted wrapping will be enabled on the first CryptoKeyVersions created for this CryptoKey. This field is only supported for keys with CryptoKeyVersionTemplate.protection_level HSM_SINGLE_TENANT. This field is supported for all CryptoKeyPurposes except ENCRYPT_DECRYPT.

Type : boolean

▼ ▲ cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.importTrustedKeyWrappedCryptoKeyVersion

Parameter Order : parent

Scopes :

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

HTTP Method : POST

Parameters :

parent

Description : Required. The name of the CryptoKey to be imported into.

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

Required : Yes

Type : string

Location : path

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

Description : Import wrapped key material into a CryptoKeyVersion with a trusted key. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey. The CryptoKeyVersion will have trusted_wrapping_enabled set to true.

Path : v1/{+parent}/cryptoKeyVersions:importTrustedKeyWrappedCryptoKeyVersion

▼ ▲ cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.exportTrustedKeyWrappedCryptoKeyVersion

Parameter Order : name

Scopes :

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

HTTP Method : GET

Parameters :

wrappingKey

Location : query

Description : Required. The name of the CryptoKeyVersion to use as a wrapping key. The CryptoKeyVersion must have hsm_trusted set to true.

Type : string

name

Location : path

Description : Required. The name of the CryptoKeyVersion to export. The CryptoKeyVersion must have trusted_wrapping_enabled set to true.

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

Required : Yes

Type : string

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

Description : Exports a CryptoKeyVersion with a trusted key. The CryptoKeyVersion must have trusted_wrapping_enabled set to true. The CryptoKeyVersion of the [wrapping_key] must have the AES_WRAPPING purpose. The [wrapping_key] must have the AES_256_KWP algorithm.

Path : v1/{+name}:exportTrustedKeyWrappedCryptoKeyVersion

▼ ▲ cloudkms.folders.showEffectiveAutokeyConfig

HTTP Method : GET

Parameters :

parent

Location : path

Description : Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project} * folders/{folder}

Pattern : ^folders/[^/]+$

Required : Yes

Type : string

Scopes :

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

Parameter Order : parent

Path : v1/{+parent}:showEffectiveAutokeyConfig

Description : Returns the effective Cloud KMS Autokey configuration for a given project or folder.

Flat Path : v1/folders/{foldersId}:showEffectiveAutokeyConfig

▼ ▲ cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.importTrustedKeyWrappedCryptoKeyVersion

Parameter Order : parent

Scopes :

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

HTTP Method : POST

Parameters :

parent

Description : Required. The name of the CryptoKey to be imported into.

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

Required : Yes

Type : string

Location : path

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

Description : Import wrapped key material into a CryptoKeyVersion with a trusted key. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey. The CryptoKeyVersion will have trusted_wrapping_enabled set to true.

Path : v1/{+parent}/cryptoKeyVersions:importTrustedKeyWrappedCryptoKeyVersion

▼ ▲ cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.exportTrustedKeyWrappedCryptoKeyVersion

Parameter Order : name

Scopes :

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

HTTP Method : GET

Parameters :

wrappingKey

Location : query

Description : Required. The name of the CryptoKeyVersion to use as a wrapping key. The CryptoKeyVersion must have hsm_trusted set to true.

Type : string

name

Location : path

Description : Required. The name of the CryptoKeyVersion to export. The CryptoKeyVersion must have trusted_wrapping_enabled set to true.

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

Required : Yes

Type : string

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

Description : Exports a CryptoKeyVersion with a trusted key. The CryptoKeyVersion must have trusted_wrapping_enabled set to true. The CryptoKeyVersion of the [wrapping_key] must have the AES_WRAPPING purpose. The [wrapping_key] must have the AES_256_KWP algorithm.

Path : v1/{+name}:exportTrustedKeyWrappedCryptoKeyVersion

▼ ▲ cloudkms.folders.showEffectiveAutokeyConfig

HTTP Method : GET

Parameters :

parent

Location : path

Description : Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project} * folders/{folder}

Pattern : ^folders/[^/]+$

Required : Yes

Type : string

Scopes :

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

Parameter Order : parent

Path : v1/{+parent}:showEffectiveAutokeyConfig

Description : Returns the effective Cloud KMS Autokey configuration for a given project or folder.

Flat Path : v1/folders/{foldersId}:showEffectiveAutokeyConfig

▼ ▲ cloudkms.projects.locations.keyRings.cryptoKeys.create

Parameters :

trustedWrappingEnabled

Location : query

Description : Optional. Whether trusted wrapping will be enabled on the first CryptoKeyVersions created for this CryptoKey. This field is only supported for keys with CryptoKeyVersionTemplate.protection_level HSM_SINGLE_TENANT. This field is supported for all CryptoKeyPurposes except ENCRYPT_DECRYPT.

Type : boolean