API documentation for kms_v1.types
package.
Classes
AsymmetricDecryptRequest
Request message for KeyManagementService.AsymmetricDecrypt.
AsymmetricDecryptResponse
Response message for KeyManagementService.AsymmetricDecrypt.
AsymmetricSignRequest
Request message for KeyManagementService.AsymmetricSign.
AsymmetricSignResponse
Response message for KeyManagementService.AsymmetricSign.
CreateCryptoKeyRequest
Request message for KeyManagementService.CreateCryptoKey.
CreateCryptoKeyVersionRequest
Request message for KeyManagementService.CreateCryptoKeyVersion.
CreateImportJobRequest
Request message for KeyManagementService.CreateImportJob.
CreateKeyRingRequest
Request message for KeyManagementService.CreateKeyRing.
CryptoKey
A CryptoKey represents a logical key that can be used for cryptographic operations.
A CryptoKey is made up of one or more versions, which represent the actual key material used in cryptographic operations.
CryptoKeyVersion
A CryptoKeyVersion represents an individual cryptographic key, and the associated key material.
An ENABLED version can be used for cryptographic operations.
For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
CryptoKeyVersionTemplate
A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation.
DecryptRequest
Request message for KeyManagementService.Decrypt.
DecryptResponse
Response message for KeyManagementService.Decrypt.
DestroyCryptoKeyVersionRequest
Request message for KeyManagementService.DestroyCryptoKeyVersion.
Digest
A Digest holds a cryptographic message digest.
EncryptRequest
Request message for KeyManagementService.Encrypt.
EncryptResponse
Response message for KeyManagementService.Encrypt.
ExternalProtectionLevelOptions
ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level.
GetCryptoKeyRequest
Request message for KeyManagementService.GetCryptoKey.
GetCryptoKeyVersionRequest
Request message for KeyManagementService.GetCryptoKeyVersion.
GetImportJobRequest
Request message for KeyManagementService.GetImportJob.
GetKeyRingRequest
Request message for KeyManagementService.GetKeyRing.
GetPublicKeyRequest
Request message for KeyManagementService.GetPublicKey.
ImportCryptoKeyVersionRequest
Request message for KeyManagementService.ImportCryptoKeyVersion.
ImportJob
An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing key material, generated outside of Cloud KMS.
When an ImportJob is created, Cloud KMS will generate a "wrapping key", which is a public/private key pair. You use the wrapping key to encrypt (also known as wrap) the pre-existing key material to protect it during the import process. The nature of the wrapping key depends on the choice of import_method. When the wrapping key generation is complete, the state will be set to ACTIVE and the public_key can be fetched. The fetched public key can then be used to wrap your pre-existing key material.
Once the key material is wrapped, it can be imported into a new CryptoKeyVersion in an existing CryptoKey by calling ImportCryptoKeyVersion. Multiple CryptoKeyVersions can be imported with a single ImportJob. Cloud KMS uses the private key portion of the wrapping key to unwrap the key material. Only Cloud KMS has access to the private key.
An ImportJob expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the ImportJob's public key.
For more information, see Importing a
key <https://cloud.google.com/kms/docs/importing-a-key>
__.
KeyOperationAttestation
Contains an HSM-generated attestation about a key operation. For more information, see Verifying attestations.
KeyRing
A KeyRing is a toplevel logical grouping of CryptoKeys.
ListCryptoKeyVersionsRequest
Request message for KeyManagementService.ListCryptoKeyVersions.
ListCryptoKeyVersionsResponse
Response message for KeyManagementService.ListCryptoKeyVersions.
ListCryptoKeysRequest
Request message for KeyManagementService.ListCryptoKeys.
ListCryptoKeysResponse
Response message for KeyManagementService.ListCryptoKeys.
ListImportJobsRequest
Request message for KeyManagementService.ListImportJobs.
ListImportJobsResponse
Response message for KeyManagementService.ListImportJobs.
ListKeyRingsRequest
Request message for KeyManagementService.ListKeyRings.
ListKeyRingsResponse
Response message for KeyManagementService.ListKeyRings.
LocationMetadata
Cloud KMS metadata for the given google.cloud.location.Location.
PublicKey
The public key for a given CryptoKeyVersion. Obtained via GetPublicKey.
RestoreCryptoKeyVersionRequest
Request message for KeyManagementService.RestoreCryptoKeyVersion.
UpdateCryptoKeyPrimaryVersionRequest
Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.
UpdateCryptoKeyRequest
Request message for KeyManagementService.UpdateCryptoKey.
UpdateCryptoKeyVersionRequest
Request message for KeyManagementService.UpdateCryptoKeyVersion.