API documentation for kms_v1.types package.
Classes
AccessReason
Describes the reason for a data access. Please refer to https://cloud.google.com/assured-workloads/key-access-justifications/docs/justification-codes for the detailed semantic meaning of justification reason codes.
- A Google administrator has reset the root-access account
associated with the user's organization within the past 7
days.
- A Google-initiated emergency access operation has
interacted with a resource in the same project or folder
as the currently accessed resource within the past 7
days.
MODIFIED_GOOGLE_INITIATED_SYSTEM_OPERATION (9):
Google systems access customer data to help optimize the
structure of the data or quality for future uses by the
customer, and one of the following is true:
- A Google administrator has reset the root-access account
associated with the user's organization within the past 7
days.
- A Google-initiated emergency access operation has
interacted with a resource in the same project or folder
as the currently accessed resource within the past 7
days.
GOOGLE_RESPONSE_TO_PRODUCTION_ALERT (10):
Google-initiated access to maintain system
reliability.
CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING (11):
One of the following operations is being executed while
simultaneously encountering an internal technical issue
which prevented a more precise justification code from being
generated:
- Your account has been used to perform any access to your
own data which your IAM policy authorizes.
- An automated Google system operates on encrypted customer
data which your IAM policy authorizes.
- Customer-initiated Google support access.
- Google-initiated support access to protect system
reliability.
AsymmetricDecryptRequest
Request message for KeyManagementService.AsymmetricDecrypt.
AsymmetricDecryptResponse
Response message for KeyManagementService.AsymmetricDecrypt.
AsymmetricSignRequest
Request message for KeyManagementService.AsymmetricSign.
AsymmetricSignResponse
Response message for KeyManagementService.AsymmetricSign.
AutokeyConfig
Cloud KMS Autokey configuration for a folder.
Certificate
A Certificate represents an X.509 certificate used to authenticate HTTPS connections to EKM replicas.
CreateCryptoKeyRequest
Request message for KeyManagementService.CreateCryptoKey.
CreateCryptoKeyVersionRequest
Request message for KeyManagementService.CreateCryptoKeyVersion.
CreateEkmConnectionRequest
Request message for EkmService.CreateEkmConnection.
CreateImportJobRequest
Request message for KeyManagementService.CreateImportJob.
CreateKeyHandleMetadata
Metadata message for CreateKeyHandle long-running operation response.
CreateKeyHandleRequest
Request message for Autokey.CreateKeyHandle.
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 zero or more versions, which represent the actual key material used in cryptographic operations.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
EkmConfig
An EkmConfig is a singleton
resource that represents configuration parameters that apply to all
CryptoKeys and
CryptoKeyVersions with a
ProtectionLevel of
EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC] in a
given project and location.
EkmConnection
An EkmConnection represents an
individual EKM connection. It can be used for creating
CryptoKeys and
CryptoKeyVersions with a
ProtectionLevel of
EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], as
well as performing cryptographic operations using keys created
within the EkmConnection.
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 and EXTERNAL_VPC protection levels.
GenerateRandomBytesRequest
Request message for KeyManagementService.GenerateRandomBytes.
GenerateRandomBytesResponse
Response message for KeyManagementService.GenerateRandomBytes.
GetAutokeyConfigRequest
Request message for GetAutokeyConfig.
GetCryptoKeyRequest
Request message for KeyManagementService.GetCryptoKey.
GetCryptoKeyVersionRequest
Request message for KeyManagementService.GetCryptoKeyVersion.
GetEkmConfigRequest
Request message for EkmService.GetEkmConfig.
GetEkmConnectionRequest
Request message for EkmService.GetEkmConnection.
GetImportJobRequest
Request message for KeyManagementService.GetImportJob.
GetKeyHandleRequest
Request message for GetKeyHandle.
GetKeyRingRequest
Request message for KeyManagementService.GetKeyRing.
GetPublicKeyRequest
Request message for KeyManagementService.GetPublicKey.
ImportCryptoKeyVersionRequest
Request message for KeyManagementService.ImportCryptoKeyVersion.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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>__.
KeyAccessJustificationsPolicy
A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey.
KeyHandle
Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of a CryptoKey.
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.
ListEkmConnectionsRequest
Request message for EkmService.ListEkmConnections.
ListEkmConnectionsResponse
Response message for EkmService.ListEkmConnections.
ListImportJobsRequest
Request message for KeyManagementService.ListImportJobs.
ListImportJobsResponse
Response message for KeyManagementService.ListImportJobs.
ListKeyHandlesRequest
Request message for Autokey.ListKeyHandles.
ListKeyHandlesResponse
Response message for Autokey.ListKeyHandles.
ListKeyRingsRequest
Request message for KeyManagementService.ListKeyRings.
ListKeyRingsResponse
Response message for KeyManagementService.ListKeyRings.
LocationMetadata
Cloud KMS metadata for the given google.cloud.location.Location.
MacSignRequest
Request message for KeyManagementService.MacSign.
MacSignResponse
Response message for KeyManagementService.MacSign.
MacVerifyRequest
Request message for KeyManagementService.MacVerify.
MacVerifyResponse
Response message for KeyManagementService.MacVerify.
ProtectionLevel
ProtectionLevel specifies how cryptographic operations are performed. For more information, see Protection levels.
PublicKey
The public keys for a given CryptoKeyVersion. Obtained via GetPublicKey.
RawDecryptRequest
Request message for KeyManagementService.RawDecrypt.
RawDecryptResponse
Response message for KeyManagementService.RawDecrypt.
RawEncryptRequest
Request message for KeyManagementService.RawEncrypt.
RawEncryptResponse
Response message for KeyManagementService.RawEncrypt.
RestoreCryptoKeyVersionRequest
Request message for KeyManagementService.RestoreCryptoKeyVersion.
ShowEffectiveAutokeyConfigRequest
Request message for ShowEffectiveAutokeyConfig.
ShowEffectiveAutokeyConfigResponse
Response message for ShowEffectiveAutokeyConfig.
UpdateAutokeyConfigRequest
Request message for UpdateAutokeyConfig.
UpdateCryptoKeyPrimaryVersionRequest
Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.
UpdateCryptoKeyRequest
Request message for KeyManagementService.UpdateCryptoKey.
UpdateCryptoKeyVersionRequest
Request message for KeyManagementService.UpdateCryptoKeyVersion.
UpdateEkmConfigRequest
Request message for EkmService.UpdateEkmConfig.
UpdateEkmConnectionRequest
Request message for EkmService.UpdateEkmConnection.
VerifyConnectivityRequest
Request message for EkmService.VerifyConnectivity.
VerifyConnectivityResponse
Response message for EkmService.VerifyConnectivity.