Index
KeyManagementService
(interface)AsymmetricDecryptRequest
(message)AsymmetricDecryptResponse
(message)AsymmetricSignRequest
(message)AsymmetricSignResponse
(message)CreateCryptoKeyRequest
(message)CreateCryptoKeyVersionRequest
(message)CreateImportJobRequest
(message)CreateKeyRingRequest
(message)CryptoKey
(message)CryptoKey.CryptoKeyPurpose
(enum)CryptoKeyVersion
(message)CryptoKeyVersion.CryptoKeyVersionAlgorithm
(enum)CryptoKeyVersion.CryptoKeyVersionState
(enum)CryptoKeyVersion.CryptoKeyVersionView
(enum)CryptoKeyVersionTemplate
(message)DecryptRequest
(message)DecryptResponse
(message)DestroyCryptoKeyVersionRequest
(message)Digest
(message)EncryptRequest
(message)EncryptResponse
(message)ExternalProtectionLevelOptions
(message)GetCryptoKeyRequest
(message)GetCryptoKeyVersionRequest
(message)GetImportJobRequest
(message)GetKeyRingRequest
(message)GetPublicKeyRequest
(message)ImportCryptoKeyVersionRequest
(message)ImportJob
(message)ImportJob.ImportJobState
(enum)ImportJob.ImportMethod
(enum)ImportJob.WrappingPublicKey
(message)KeyOperationAttestation
(message)KeyOperationAttestation.AttestationFormat
(enum)KeyRing
(message)ListCryptoKeyVersionsRequest
(message)ListCryptoKeyVersionsResponse
(message)ListCryptoKeysRequest
(message)ListCryptoKeysResponse
(message)ListImportJobsRequest
(message)ListImportJobsResponse
(message)ListKeyRingsRequest
(message)ListKeyRingsResponse
(message)LocationMetadata
(message)ProtectionLevel
(enum)PublicKey
(message)RestoreCryptoKeyVersionRequest
(message)UpdateCryptoKeyPrimaryVersionRequest
(message)UpdateCryptoKeyRequest
(message)UpdateCryptoKeyVersionRequest
(message)
KeyManagementService
Google Cloud Key Management Service
Manages cryptographic keys and operations using those keys. Implements a REST model with the following objects:
If you are using manual gRPC libraries, see Using gRPC with Cloud KMS.
AsymmetricDecrypt | |
---|---|
Decrypts data that was encrypted with a public key retrieved from
|
AsymmetricSign | |
---|---|
Signs data using a
|
CreateCryptoKey | |
---|---|
Create a new
|
CreateCryptoKeyVersion | |
---|---|
Create a new The server will assign the next sequential id. If unset,
|
CreateImportJob | |
---|---|
Create a new
|
CreateKeyRing | |
---|---|
Create a new
|
Decrypt | |
---|---|
Decrypts data that was protected by
|
DestroyCryptoKeyVersion | |
---|---|
Schedule a Upon calling this method, Before the
|
Encrypt | |
---|---|
Encrypts data, so that it can only be recovered by a call to
|
GetCryptoKey | |
---|---|
Returns metadata for a given
|
GetCryptoKeyVersion | |
---|---|
Returns metadata for a given
|
GetImportJob | |
---|---|
Returns metadata for a given
|
GetKeyRing | |
---|---|
Returns metadata for a given
|
GetPublicKey | |
---|---|
Returns the public key for the given
|
ImportCryptoKeyVersion | |
---|---|
Imports a new The version ID will be assigned the next sequential id within the
|
ListCryptoKeyVersions | |
---|---|
Lists
|
ListCryptoKeys | |
---|---|
Lists
|
ListImportJobs | |
---|---|
Lists
|
ListKeyRings | |
---|---|
Lists
|
RestoreCryptoKeyVersion | |
---|---|
Restore a Upon restoration of the CryptoKeyVersion,
|
UpdateCryptoKey | |
---|---|
Update a
|
UpdateCryptoKeyPrimaryVersion | |
---|---|
Update the version of a Returns an error if called on an asymmetric key.
|
UpdateCryptoKeyVersion | |
---|---|
Update a
|
AsymmetricDecryptRequest
Request message for KeyManagementService.AsymmetricDecrypt
.
Fields | |
---|---|
name |
Required. The resource name of the Authorization requires the following IAM permission on the specified resource
|
ciphertext |
Required. The data encrypted with the named |
ciphertext_crc32c |
Optional. An optional CRC32C checksum of the NOTE: This field is in Beta. |
AsymmetricDecryptResponse
Response message for KeyManagementService.AsymmetricDecrypt
.
Fields | |
---|---|
plaintext |
The decrypted data originally encrypted with the matching public key. |
plaintext_crc32c |
Integrity verification field. A CRC32C checksum of the returned NOTE: This field is in Beta. |
verified_ciphertext_crc32c |
Integrity verification field. A flag indicating whether NOTE: This field is in Beta. |
AsymmetricSignRequest
Request message for KeyManagementService.AsymmetricSign
.
Fields | |
---|---|
name |
Required. The resource name of the Authorization requires the following IAM permission on the specified resource
|
digest |
Required. The digest of the data to sign. The digest must be produced with the same digest algorithm as specified by the key version's |
digest_crc32c |
Optional. An optional CRC32C checksum of the NOTE: This field is in Beta. |
AsymmetricSignResponse
Response message for KeyManagementService.AsymmetricSign
.
Fields | |
---|---|
signature |
The created signature. |
signature_crc32c |
Integrity verification field. A CRC32C checksum of the returned NOTE: This field is in Beta. |
verified_digest_crc32c |
Integrity verification field. A flag indicating whether NOTE: This field is in Beta. |
name |
The resource name of the NOTE: This field is in Beta. |
CreateCryptoKeyRequest
Request message for KeyManagementService.CreateCryptoKey
.
Fields | |
---|---|
parent |
Required. The Authorization requires the following IAM permission on the specified resource
|
crypto_key_id |
Required. It must be unique within a KeyRing and match the regular expression |
crypto_key |
Required. A |
skip_initial_version_creation |
If set to true, the request will create a |
CreateCryptoKeyVersionRequest
Request message for KeyManagementService.CreateCryptoKeyVersion
.
Fields | |
---|---|
parent |
Required. The Authorization requires the following IAM permission on the specified resource
|
crypto_key_version |
Required. A |
CreateImportJobRequest
Request message for KeyManagementService.CreateImportJob
.
Fields | |
---|---|
parent |
Required. The Authorization requires the following IAM permission on the specified resource
|
import_job_id |
Required. It must be unique within a KeyRing and match the regular expression |
import_job |
Required. An |
CreateKeyRingRequest
Request message for KeyManagementService.CreateKeyRing
.
Fields | |
---|---|
parent |
Required. The resource name of the location associated with the Authorization requires the following IAM permission on the specified resource
|
key_ring_id |
Required. It must be unique within a location and match the regular expression |
key_ring |
Required. A |
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.
Fields | |
---|---|
name |
Output only. The resource name for this |
primary |
Output only. A copy of the "primary" The Keys with |
purpose |
Immutable. The immutable purpose of this |
create_time |
Output only. The time at which this |
next_rotation_time |
At
Key rotations performed manually via Keys with |
version_template |
A template describing settings for new |
labels |
Labels with user-defined metadata. For more information, see Labeling Keys. |
rotation_period |
If Keys with |
CryptoKeyPurpose
CryptoKeyPurpose
describes the cryptographic capabilities of a CryptoKey
. A given key can only be used for the operations allowed by its purpose. For more information, see Key purposes.
Enums | |
---|---|
CRYPTO_KEY_PURPOSE_UNSPECIFIED |
Not specified. |
ENCRYPT_DECRYPT |
CryptoKeys with this purpose may be used with Encrypt and Decrypt . |
ASYMMETRIC_SIGN |
CryptoKeys with this purpose may be used with AsymmetricSign and GetPublicKey . |
ASYMMETRIC_DECRYPT |
CryptoKeys with this purpose may be used with AsymmetricDecrypt and GetPublicKey . |
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.
Fields | |
---|---|
name |
Output only. The resource name for this |
state |
The current state of the |
protection_level |
Output only. The |
algorithm |
Output only. The |
attestation |
Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with |
create_time |
Output only. The time at which this |
generate_time |
Output only. The time this |
destroy_time |
Output only. The time this |
destroy_event_time |
Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if |
import_job |
Output only. The name of the |
import_time |
Output only. The time at which this |
import_failure_reason |
Output only. The root cause of an import failure. Only present if |
external_protection_level_options |
ExternalProtectionLevelOptions stores a group of additional fields for configuring a |
CryptoKeyVersionAlgorithm
The algorithm of the CryptoKeyVersion
, indicating what parameters must be used for each cryptographic operation.
The GOOGLE_SYMMETRIC_ENCRYPTION
algorithm is usable with CryptoKey.purpose
ENCRYPT_DECRYPT
.
Algorithms beginning with "RSA_SIGN_" are usable with CryptoKey.purpose
ASYMMETRIC_SIGN
.
The fields in the name after "RSA_SIGN_" correspond to the following parameters: padding algorithm, modulus bit length, and digest algorithm.
For PSS, the salt length used is equal to the length of digest algorithm. For example, RSA_SIGN_PSS_2048_SHA256
will use PSS with a salt length of 256 bits or 32 bytes.
Algorithms beginning with "RSA_DECRYPT_" are usable with CryptoKey.purpose
ASYMMETRIC_DECRYPT
.
The fields in the name after "RSA_DECRYPT_" correspond to the following parameters: padding algorithm, modulus bit length, and digest algorithm.
Algorithms beginning with "EC_SIGN_" are usable with CryptoKey.purpose
ASYMMETRIC_SIGN
.
The fields in the name after "EC_SIGN_" correspond to the following parameters: elliptic curve, digest algorithm.
For more information, see Key purposes and algorithms.
Enums | |
---|---|
CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED |
Not specified. |
GOOGLE_SYMMETRIC_ENCRYPTION |
Creates symmetric encryption keys. |
RSA_SIGN_PSS_2048_SHA256 |
RSASSA-PSS 2048 bit key with a SHA256 digest. |
RSA_SIGN_PSS_3072_SHA256 |
RSASSA-PSS 3072 bit key with a SHA256 digest. |
RSA_SIGN_PSS_4096_SHA256 |
RSASSA-PSS 4096 bit key with a SHA256 digest. |
RSA_SIGN_PSS_4096_SHA512 |
RSASSA-PSS 4096 bit key with a SHA512 digest. |
RSA_SIGN_PKCS1_2048_SHA256 |
RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest. |
RSA_SIGN_PKCS1_3072_SHA256 |
RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest. |
RSA_SIGN_PKCS1_4096_SHA256 |
RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest. |
RSA_SIGN_PKCS1_4096_SHA512 |
RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest. |
RSA_DECRYPT_OAEP_2048_SHA256 |
RSAES-OAEP 2048 bit key with a SHA256 digest. |
RSA_DECRYPT_OAEP_3072_SHA256 |
RSAES-OAEP 3072 bit key with a SHA256 digest. |
RSA_DECRYPT_OAEP_4096_SHA256 |
RSAES-OAEP 4096 bit key with a SHA256 digest. |
RSA_DECRYPT_OAEP_4096_SHA512 |
RSAES-OAEP 4096 bit key with a SHA512 digest. |
EC_SIGN_P256_SHA256 |
ECDSA on the NIST P-256 curve with a SHA256 digest. |
EC_SIGN_P384_SHA384 |
ECDSA on the NIST P-384 curve with a SHA384 digest. |
EXTERNAL_SYMMETRIC_ENCRYPTION |
Algorithm representing symmetric encryption by an external key manager. |
CryptoKeyVersionState
The state of a CryptoKeyVersion
, indicating if it can be used.
Enums | |
---|---|
CRYPTO_KEY_VERSION_STATE_UNSPECIFIED |
Not specified. |
PENDING_GENERATION |
This version is still being generated. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready. |
ENABLED |
This version may be used for cryptographic operations. |
DISABLED |
This version may not be used, but the key material is still available, and the version can be placed back into the ENABLED state. |
DESTROYED |
This version is destroyed, and the key material is no longer stored. A version may not leave this state once entered. |
DESTROY_SCHEDULED |
This version is scheduled for destruction, and will be destroyed soon. Call RestoreCryptoKeyVersion to put it back into the DISABLED state. |
PENDING_IMPORT |
This version is still being imported. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready. |
IMPORT_FAILED |
This version was not imported successfully. It may not be used, enabled, disabled, or destroyed. The submitted key material has been discarded. Additional details can be found in CryptoKeyVersion.import_failure_reason . |
CryptoKeyVersionView
A view for CryptoKeyVersion
s. Controls the level of detail returned for CryptoKeyVersions
in KeyManagementService.ListCryptoKeyVersions
and KeyManagementService.ListCryptoKeys
.
Enums | |
---|---|
CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED |
Default view for each CryptoKeyVersion . Does not include the attestation field. |
FULL |
Provides all fields in each CryptoKeyVersion , including the attestation . |
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.
Fields | |
---|---|
protection_level |
|
algorithm |
Required. For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted and |
DecryptRequest
Request message for KeyManagementService.Decrypt
.
Fields | |
---|---|
name |
Required. The resource name of the Authorization requires the following IAM permission on the specified resource
|
ciphertext |
Required. The encrypted data originally returned in |
additional_authenticated_data |
Optional. Optional data that must match the data originally supplied in |
ciphertext_crc32c |
Optional. An optional CRC32C checksum of the NOTE: This field is in Beta. |
additional_authenticated_data_crc32c |
Optional. An optional CRC32C checksum of the NOTE: This field is in Beta. |
DecryptResponse
Response message for KeyManagementService.Decrypt
.
Fields | |
---|---|
plaintext |
The decrypted data originally supplied in |
plaintext_crc32c |
Integrity verification field. A CRC32C checksum of the returned NOTE: This field is in Beta. |
DestroyCryptoKeyVersionRequest
Request message for KeyManagementService.DestroyCryptoKeyVersion
.
Fields | |
---|---|
name |
Required. The resource name of the Authorization requires the following IAM permission on the specified resource
|
Digest
A Digest
holds a cryptographic message digest.
Fields | ||
---|---|---|
Union field digest . Required. The message digest. digest can be only one of the following: |
||
sha256 |
A message digest produced with the SHA-256 algorithm. |
|
sha384 |
A message digest produced with the SHA-384 algorithm. |
|
sha512 |
A message digest produced with the SHA-512 algorithm. |
EncryptRequest
Request message for KeyManagementService.Encrypt
.
Fields | |
---|---|
name |
Required. The resource name of the If a Authorization requires the following IAM permission on the specified resource
|
plaintext |
Required. The data to encrypt. Must be no larger than 64KiB. The maximum size depends on the key version's |
additional_authenticated_data |
Optional. Optional data that, if specified, must also be provided during decryption through The maximum size depends on the key version's |
plaintext_crc32c |
Optional. An optional CRC32C checksum of the NOTE: This field is in Beta. |
additional_authenticated_data_crc32c |
Optional. An optional CRC32C checksum of the NOTE: This field is in Beta. |
EncryptResponse
Response message for KeyManagementService.Encrypt
.
Fields | |
---|---|
name |
The resource name of the |
ciphertext |
The encrypted data. |
ciphertext_crc32c |
Integrity verification field. A CRC32C checksum of the returned NOTE: This field is in Beta. |
verified_plaintext_crc32c |
Integrity verification field. A flag indicating whether NOTE: This field is in Beta. |
verified_additional_authenticated_data_crc32c |
Integrity verification field. A flag indicating whether NOTE: This field is in Beta. |
ExternalProtectionLevelOptions
ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion
that are specific to the EXTERNAL
protection level.
Fields | |
---|---|
external_key_uri |
The URI for an external resource that this |
GetCryptoKeyRequest
Request message for KeyManagementService.GetCryptoKey
.
Fields | |
---|---|
name |
Required. The Authorization requires the following IAM permission on the specified resource
|
GetCryptoKeyVersionRequest
Request message for KeyManagementService.GetCryptoKeyVersion
.
Fields | |
---|---|
name |
Required. The Authorization requires the following IAM permission on the specified resource
|
GetImportJobRequest
Request message for KeyManagementService.GetImportJob
.
Fields | |
---|---|
name |
Required. The Authorization requires the following IAM permission on the specified resource
|
GetKeyRingRequest
Request message for KeyManagementService.GetKeyRing
.
Fields | |
---|---|
name |
Required. The Authorization requires the following IAM permission on the specified resource
|
GetPublicKeyRequest
Request message for KeyManagementService.GetPublicKey
.
Fields | |
---|---|
name |
Required. The Authorization requires the following IAM permission on the specified resource
|
ImportCryptoKeyVersionRequest
Request message for KeyManagementService.ImportCryptoKeyVersion
.
Fields | |
---|---|
parent |
Required. The Authorization requires the following IAM permission on the specified resource
|
algorithm |
Required. The |
import_job |
Required. The Authorization requires the following IAM permission on the specified resource
|
rsa_aes_wrapped_key |
Wrapped key material produced with This field contains the concatenation of two wrapped keys:
If importing symmetric key material, it is expected that the unwrapped key contains plain bytes. If importing asymmetric key material, it is expected that the unwrapped key is in PKCS#8-encoded DER format (the PrivateKeyInfo structure from RFC 5208). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. |
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.
Fields | |
---|---|
name |
Output only. The resource name for this |
import_method |
Required. Immutable. The wrapping method to be used for incoming key material. |
protection_level |
Required. Immutable. The protection level of the |
create_time |
Output only. The time at which this |
generate_time |
Output only. The time this |
expire_time |
Output only. The time at which this |
expire_event_time |
Output only. The time this |
state |
Output only. The current state of the |
public_key |
Output only. The public key with which to wrap key material prior to import. Only returned if |
attestation |
Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen |
ImportJobState
The state of the ImportJob
, indicating if it can be used.
Enums | |
---|---|
IMPORT_JOB_STATE_UNSPECIFIED |
Not specified. |
PENDING_GENERATION |
The wrapping key for this job is still being generated. It may not be used. Cloud KMS will automatically mark this job as ACTIVE as soon as the wrapping key is generated. |
ACTIVE |
This job may be used in CreateCryptoKey and CreateCryptoKeyVersion requests. |
EXPIRED |
This job can no longer be used and may not leave this state once entered. |
ImportMethod
ImportMethod
describes the key wrapping method chosen for this ImportJob
.
Enums | |
---|---|
IMPORT_METHOD_UNSPECIFIED |
Not specified. |
RSA_OAEP_3072_SHA1_AES_256 |
This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key wrapping scheme defined in the PKCS #11 standard. In summary, this involves wrapping the raw key with an ephemeral AES key, and wrapping the ephemeral AES key with a 3072 bit RSA key. For more details, see RSA AES key wrap mechanism. |
RSA_OAEP_4096_SHA1_AES_256 |
This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key wrapping scheme defined in the PKCS #11 standard. In summary, this involves wrapping the raw key with an ephemeral AES key, and wrapping the ephemeral AES key with a 4096 bit RSA key. For more details, see RSA AES key wrap mechanism. |
WrappingPublicKey
The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod
.
Fields | |
---|---|
pem |
The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info. |
KeyOperationAttestation
Contains an HSM-generated attestation about a key operation. For more information, see Verifying attestations.
Fields | |
---|---|
format |
Output only. The format of the attestation data. |
content |
Output only. The attestation data provided by the HSM when the key operation was performed. |
AttestationFormat
Attestation formats provided by the HSM.
Enums | |
---|---|
ATTESTATION_FORMAT_UNSPECIFIED |
Not specified. |
CAVIUM_V1_COMPRESSED |
Cavium HSM attestation compressed with gzip. Note that this format is defined by Cavium and subject to change at any time. |
CAVIUM_V2_COMPRESSED |
Cavium HSM attestation V2 compressed with gzip. This is a new format introduced in Cavium's version 3.2-08. |
KeyRing
A KeyRing
is a toplevel logical grouping of CryptoKeys
.
Fields | |
---|---|
name |
Output only. The resource name for the |
create_time |
Output only. The time at which this |
ListCryptoKeyVersionsRequest
Request message for KeyManagementService.ListCryptoKeyVersions
.
Fields | |
---|---|
parent |
Required. The resource name of the Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. Optional limit on the number of |
page_token |
Optional. Optional pagination token, returned earlier via |
view |
The fields to include in the response. |
filter |
Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results. |
order_by |
Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results. |
ListCryptoKeyVersionsResponse
Response message for KeyManagementService.ListCryptoKeyVersions
.
Fields | |
---|---|
crypto_key_versions[] |
The list of |
next_page_token |
A token to retrieve next page of results. Pass this value in |
total_size |
The total number of |
ListCryptoKeysRequest
Request message for KeyManagementService.ListCryptoKeys
.
Fields | |
---|---|
parent |
Required. The resource name of the Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. Optional limit on the number of |
page_token |
Optional. Optional pagination token, returned earlier via |
version_view |
The fields of the primary version to include in the response. |
filter |
Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results. |
order_by |
Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results. |
ListCryptoKeysResponse
Response message for KeyManagementService.ListCryptoKeys
.
Fields | |
---|---|
crypto_keys[] |
The list of |
next_page_token |
A token to retrieve next page of results. Pass this value in |
total_size |
The total number of |
ListImportJobsRequest
Request message for KeyManagementService.ListImportJobs
.
Fields | |
---|---|
parent |
Required. The resource name of the Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. Optional limit on the number of |
page_token |
Optional. Optional pagination token, returned earlier via |
filter |
Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results. |
order_by |
Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results. |
ListImportJobsResponse
Response message for KeyManagementService.ListImportJobs
.
Fields | |
---|---|
import_jobs[] |
The list of |
next_page_token |
A token to retrieve next page of results. Pass this value in |
total_size |
The total number of |
ListKeyRingsRequest
Request message for KeyManagementService.ListKeyRings
.
Fields | |
---|---|
parent |
Required. The resource name of the location associated with the Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. Optional limit on the number of |
page_token |
Optional. Optional pagination token, returned earlier via |
filter |
Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results. |
order_by |
Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results. |
ListKeyRingsResponse
Response message for KeyManagementService.ListKeyRings
.
Fields | |
---|---|
key_rings[] |
The list of |
next_page_token |
A token to retrieve next page of results. Pass this value in |
total_size |
The total number of |
LocationMetadata
Cloud KMS metadata for the given google.cloud.location.Location
.
Fields | |
---|---|
hsm_available |
Indicates whether |
ekm_available |
Indicates whether |
ProtectionLevel
ProtectionLevel
specifies how cryptographic operations are performed. For more information, see Protection levels.
Enums | |
---|---|
PROTECTION_LEVEL_UNSPECIFIED |
Not specified. |
SOFTWARE |
Crypto operations are performed in software. |
HSM |
Crypto operations are performed in a Hardware Security Module. |
EXTERNAL |
Crypto operations are performed by an external key manager. |
PublicKey
The public key for a given CryptoKeyVersion
. Obtained via GetPublicKey
.
Fields | |
---|---|
pem |
The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info. |
algorithm |
The |
pem_crc32c |
Integrity verification field. A CRC32C checksum of the returned NOTE: This field is in Beta. |
name |
The NOTE: This field is in Beta. |
RestoreCryptoKeyVersionRequest
Request message for KeyManagementService.RestoreCryptoKeyVersion
.
Fields | |
---|---|
name |
Required. The resource name of the Authorization requires the following IAM permission on the specified resource
|
UpdateCryptoKeyPrimaryVersionRequest
Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion
.
Fields | |
---|---|
name |
Required. The resource name of the Authorization requires the following IAM permission on the specified resource
|
crypto_key_version_id |
Required. The id of the child |
UpdateCryptoKeyRequest
Request message for KeyManagementService.UpdateCryptoKey
.
Fields | |
---|---|
crypto_key |
Required. Authorization requires the following IAM permission on the specified resource
|
update_mask |
Required. List of fields to be updated in this request. |
UpdateCryptoKeyVersionRequest
Request message for KeyManagementService.UpdateCryptoKeyVersion
.
Fields | |
---|---|
crypto_key_version |
Required. Authorization requires the following IAM permission on the specified resource
|
update_mask |
Required. List of fields to be updated in this request. |