1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="cloudkms_v1.html">Cloud Key Management Service (KMS) API</a> . <a href="cloudkms_v1.projects.html">projects</a> . <a href="cloudkms_v1.projects.locations.html">locations</a> . <a href="cloudkms_v1.projects.locations.keyRings.html">keyRings</a> . <a href="cloudkms_v1.projects.locations.keyRings.cryptoKeys.html">cryptoKeys</a> . <a href="cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html">cryptoKeyVersions</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#asymmetricDecrypt">asymmetricDecrypt(name, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.</p> 80<p class="toc_element"> 81 <code><a href="#asymmetricSign">asymmetricSign(name, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.</p> 83<p class="toc_element"> 84 <code><a href="#close">close()</a></code></p> 85<p class="firstline">Close httplib2 connections.</p> 86<p class="toc_element"> 87 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED.</p> 89<p class="toc_element"> 90 <code><a href="#destroy">destroy(name, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.</p> 92<p class="toc_element"> 93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 94<p class="firstline">Returns metadata for a given CryptoKeyVersion.</p> 95<p class="toc_element"> 96 <code><a href="#getPublicKey">getPublicKey(name, x__xgafv=None)</a></code></p> 97<p class="firstline">Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.</p> 98<p class="toc_element"> 99 <code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Import wrapped key material into a CryptoKeyVersion. 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.</p> 101<p class="toc_element"> 102 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Lists CryptoKeyVersions.</p> 104<p class="toc_element"> 105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 106<p class="firstline">Retrieves the next page of results.</p> 107<p class="toc_element"> 108 <code><a href="#macSign">macSign(name, body=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Signs data using a CryptoKeyVersion with CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key.</p> 110<p class="toc_element"> 111 <code><a href="#macVerify">macVerify(name, body=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Verifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful.</p> 113<p class="toc_element"> 114 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states.</p> 116<p class="toc_element"> 117 <code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p> 118<p class="firstline">Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared.</p> 119<h3>Method Details</h3> 120<div class="method"> 121 <code class="details" id="asymmetricDecrypt">asymmetricDecrypt(name, body=None, x__xgafv=None)</code> 122 <pre>Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT. 123 124Args: 125 name: string, Required. The resource name of the CryptoKeyVersion to use for decryption. (required) 126 body: object, The request body. 127 The object takes the form of: 128 129{ # Request message for KeyManagementService.AsymmetricDecrypt. 130 "ciphertext": "A String", # Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP. 131 "ciphertextCrc32c": "A String", # Optional. An optional CRC32C checksum of the AsymmetricDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received AsymmetricDecryptRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(AsymmetricDecryptRequest.ciphertext) is equal to AsymmetricDecryptRequest.ciphertext_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. 132} 133 134 x__xgafv: string, V1 error format. 135 Allowed values 136 1 - v1 error format 137 2 - v2 error format 138 139Returns: 140 An object of the form: 141 142 { # Response message for KeyManagementService.AsymmetricDecrypt. 143 "plaintext": "A String", # The decrypted data originally encrypted with the matching public key. 144 "plaintextCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned AsymmetricDecryptResponse.plaintext. An integrity check of AsymmetricDecryptResponse.plaintext can be performed by computing the CRC32C checksum of AsymmetricDecryptResponse.plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. 145 "protectionLevel": "A String", # The ProtectionLevel of the CryptoKeyVersion used in decryption. 146 "verifiedCiphertextCrc32c": True or False, # Integrity verification field. A flag indicating whether AsymmetricDecryptRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that AsymmetricDecryptRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set AsymmetricDecryptRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries. 147}</pre> 148</div> 149 150<div class="method"> 151 <code class="details" id="asymmetricSign">asymmetricSign(name, body=None, x__xgafv=None)</code> 152 <pre>Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey. 153 154Args: 155 name: string, Required. The resource name of the CryptoKeyVersion to use for signing. (required) 156 body: object, The request body. 157 The object takes the form of: 158 159{ # Request message for KeyManagementService.AsymmetricSign. 160 "data": "A String", # Optional. The data to sign. It can't be supplied if AsymmetricSignRequest.digest is supplied. 161 "dataCrc32c": "A String", # Optional. An optional CRC32C checksum of the AsymmetricSignRequest.data. If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(AsymmetricSignRequest.data) is equal to AsymmetricSignRequest.data_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. 162 "digest": { # A Digest holds a cryptographic message digest. # Optional. The digest of the data to sign. The digest must be produced with the same digest algorithm as specified by the key version's algorithm. This field may not be supplied if AsymmetricSignRequest.data is supplied. 163 "sha256": "A String", # A message digest produced with the SHA-256 algorithm. 164 "sha384": "A String", # A message digest produced with the SHA-384 algorithm. 165 "sha512": "A String", # A message digest produced with the SHA-512 algorithm. 166 }, 167 "digestCrc32c": "A String", # Optional. An optional CRC32C checksum of the AsymmetricSignRequest.digest. If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.digest using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(AsymmetricSignRequest.digest) is equal to AsymmetricSignRequest.digest_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. 168} 169 170 x__xgafv: string, V1 error format. 171 Allowed values 172 1 - v1 error format 173 2 - v2 error format 174 175Returns: 176 An object of the form: 177 178 { # Response message for KeyManagementService.AsymmetricSign. 179 "name": "A String", # The resource name of the CryptoKeyVersion used for signing. Check this field to verify that the intended resource was used for signing. 180 "protectionLevel": "A String", # The ProtectionLevel of the CryptoKeyVersion used for signing. 181 "signature": "A String", # The created signature. 182 "signatureCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned AsymmetricSignResponse.signature. An integrity check of AsymmetricSignResponse.signature can be performed by computing the CRC32C checksum of AsymmetricSignResponse.signature and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. 183 "verifiedDataCrc32c": True or False, # Integrity verification field. A flag indicating whether AsymmetricSignRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that AsymmetricSignRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set AsymmetricSignRequest.data_crc32c but this field is still false, discard the response and perform a limited number of retries. 184 "verifiedDigestCrc32c": True or False, # Integrity verification field. A flag indicating whether AsymmetricSignRequest.digest_crc32c was received by KeyManagementService and used for the integrity verification of the digest. A false value of this field indicates either that AsymmetricSignRequest.digest_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set AsymmetricSignRequest.digest_crc32c but this field is still false, discard the response and perform a limited number of retries. 185}</pre> 186</div> 187 188<div class="method"> 189 <code class="details" id="close">close()</code> 190 <pre>Close httplib2 connections.</pre> 191</div> 192 193<div class="method"> 194 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 195 <pre>Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED. 196 197Args: 198 parent: string, Required. The name of the CryptoKey associated with the CryptoKeyVersions. (required) 199 body: object, The request body. 200 The object takes the form of: 201 202{ # 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. 203 "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. 204 "attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # 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 protection_level HSM. 205 "certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation 206 "caviumCerts": [ # Cavium certificate chain corresponding to the attestation. 207 "A String", 208 ], 209 "googleCardCerts": [ # Google card certificate chain corresponding to the attestation. 210 "A String", 211 ], 212 "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation. 213 "A String", 214 ], 215 }, 216 "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed. 217 "format": "A String", # Output only. The format of the attestation data. 218 }, 219 "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. 220 "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. 221 "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. 222 "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. 223 "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. 224 }, 225 "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. 226 "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. 227 "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. 228 "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. 229 "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. 230 "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. 231 "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. 232 "state": "A String", # The current state of the CryptoKeyVersion. 233} 234 235 x__xgafv: string, V1 error format. 236 Allowed values 237 1 - v1 error format 238 2 - v2 error format 239 240Returns: 241 An object of the form: 242 243 { # 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. 244 "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. 245 "attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # 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 protection_level HSM. 246 "certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation 247 "caviumCerts": [ # Cavium certificate chain corresponding to the attestation. 248 "A String", 249 ], 250 "googleCardCerts": [ # Google card certificate chain corresponding to the attestation. 251 "A String", 252 ], 253 "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation. 254 "A String", 255 ], 256 }, 257 "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed. 258 "format": "A String", # Output only. The format of the attestation data. 259 }, 260 "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. 261 "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. 262 "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. 263 "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. 264 "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. 265 }, 266 "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. 267 "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. 268 "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. 269 "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. 270 "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. 271 "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. 272 "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. 273 "state": "A String", # The current state of the CryptoKeyVersion. 274}</pre> 275</div> 276 277<div class="method"> 278 <code class="details" id="destroy">destroy(name, body=None, x__xgafv=None)</code> 279 <pre>Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process. 280 281Args: 282 name: string, Required. The resource name of the CryptoKeyVersion to destroy. (required) 283 body: object, The request body. 284 The object takes the form of: 285 286{ # Request message for KeyManagementService.DestroyCryptoKeyVersion. 287} 288 289 x__xgafv: string, V1 error format. 290 Allowed values 291 1 - v1 error format 292 2 - v2 error format 293 294Returns: 295 An object of the form: 296 297 { # 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. 298 "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. 299 "attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # 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 protection_level HSM. 300 "certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation 301 "caviumCerts": [ # Cavium certificate chain corresponding to the attestation. 302 "A String", 303 ], 304 "googleCardCerts": [ # Google card certificate chain corresponding to the attestation. 305 "A String", 306 ], 307 "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation. 308 "A String", 309 ], 310 }, 311 "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed. 312 "format": "A String", # Output only. The format of the attestation data. 313 }, 314 "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. 315 "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. 316 "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. 317 "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. 318 "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. 319 }, 320 "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. 321 "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. 322 "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. 323 "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. 324 "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. 325 "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. 326 "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. 327 "state": "A String", # The current state of the CryptoKeyVersion. 328}</pre> 329</div> 330 331<div class="method"> 332 <code class="details" id="get">get(name, x__xgafv=None)</code> 333 <pre>Returns metadata for a given CryptoKeyVersion. 334 335Args: 336 name: string, Required. The name of the CryptoKeyVersion to get. (required) 337 x__xgafv: string, V1 error format. 338 Allowed values 339 1 - v1 error format 340 2 - v2 error format 341 342Returns: 343 An object of the form: 344 345 { # 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. 346 "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. 347 "attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # 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 protection_level HSM. 348 "certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation 349 "caviumCerts": [ # Cavium certificate chain corresponding to the attestation. 350 "A String", 351 ], 352 "googleCardCerts": [ # Google card certificate chain corresponding to the attestation. 353 "A String", 354 ], 355 "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation. 356 "A String", 357 ], 358 }, 359 "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed. 360 "format": "A String", # Output only. The format of the attestation data. 361 }, 362 "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. 363 "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. 364 "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. 365 "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. 366 "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. 367 }, 368 "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. 369 "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. 370 "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. 371 "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. 372 "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. 373 "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. 374 "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. 375 "state": "A String", # The current state of the CryptoKeyVersion. 376}</pre> 377</div> 378 379<div class="method"> 380 <code class="details" id="getPublicKey">getPublicKey(name, x__xgafv=None)</code> 381 <pre>Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT. 382 383Args: 384 name: string, Required. The name of the CryptoKeyVersion public key to get. (required) 385 x__xgafv: string, V1 error format. 386 Allowed values 387 1 - v1 error format 388 2 - v2 error format 389 390Returns: 391 An object of the form: 392 393 { # The public key for a given CryptoKeyVersion. Obtained via GetPublicKey. 394 "algorithm": "A String", # The Algorithm associated with this key. 395 "name": "A String", # The name of the CryptoKeyVersion public key. Provided here for verification. NOTE: This field is in Beta. 396 "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). 397 "pemCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta. 398 "protectionLevel": "A String", # The ProtectionLevel of the CryptoKeyVersion public key. 399}</pre> 400</div> 401 402<div class="method"> 403 <code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code> 404 <pre>Import wrapped key material into a CryptoKeyVersion. 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. 405 406Args: 407 parent: string, Required. The name of the CryptoKey to be imported into. The create permission is only required on this key when creating a new CryptoKeyVersion. (required) 408 body: object, The request body. 409 The object takes the form of: 410 411{ # Request message for KeyManagementService.ImportCryptoKeyVersion. 412 "algorithm": "A String", # Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into. 413 "cryptoKeyVersion": "A String", # Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created. If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportCryptoKeyVersionRequest.parent, have been previously created via ImportCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material. 414 "importJob": "A String", # Required. The name of the ImportJob that was used to wrap this key material. 415 "rsaAesWrappedKey": "A String", # Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256. This field contains the concatenation of two wrapped keys: 1. An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1, MGF1 with SHA-1, and an empty label. 2. The key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). 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. 416} 417 418 x__xgafv: string, V1 error format. 419 Allowed values 420 1 - v1 error format 421 2 - v2 error format 422 423Returns: 424 An object of the form: 425 426 { # 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. 427 "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. 428 "attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # 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 protection_level HSM. 429 "certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation 430 "caviumCerts": [ # Cavium certificate chain corresponding to the attestation. 431 "A String", 432 ], 433 "googleCardCerts": [ # Google card certificate chain corresponding to the attestation. 434 "A String", 435 ], 436 "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation. 437 "A String", 438 ], 439 }, 440 "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed. 441 "format": "A String", # Output only. The format of the attestation data. 442 }, 443 "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. 444 "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. 445 "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. 446 "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. 447 "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. 448 }, 449 "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. 450 "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. 451 "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. 452 "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. 453 "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. 454 "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. 455 "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. 456 "state": "A String", # The current state of the CryptoKeyVersion. 457}</pre> 458</div> 459 460<div class="method"> 461 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code> 462 <pre>Lists CryptoKeyVersions. 463 464Args: 465 parent: string, Required. The resource name of the CryptoKey to list, in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. (required) 466 filter: string, Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering). 467 orderBy: string, 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](https://cloud.google.com/kms/docs/sorting-and-filtering). 468 pageSize: integer, Optional. Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. 469 pageToken: string, Optional. Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token. 470 view: string, The fields to include in the response. 471 Allowed values 472 CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED - Default view for each CryptoKeyVersion. Does not include the attestation field. 473 FULL - Provides all fields in each CryptoKeyVersion, including the attestation. 474 x__xgafv: string, V1 error format. 475 Allowed values 476 1 - v1 error format 477 2 - v2 error format 478 479Returns: 480 An object of the form: 481 482 { # Response message for KeyManagementService.ListCryptoKeyVersions. 483 "cryptoKeyVersions": [ # The list of CryptoKeyVersions. 484 { # 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. 485 "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. 486 "attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # 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 protection_level HSM. 487 "certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation 488 "caviumCerts": [ # Cavium certificate chain corresponding to the attestation. 489 "A String", 490 ], 491 "googleCardCerts": [ # Google card certificate chain corresponding to the attestation. 492 "A String", 493 ], 494 "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation. 495 "A String", 496 ], 497 }, 498 "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed. 499 "format": "A String", # Output only. The format of the attestation data. 500 }, 501 "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. 502 "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. 503 "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. 504 "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. 505 "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. 506 }, 507 "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. 508 "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. 509 "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. 510 "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. 511 "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. 512 "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. 513 "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. 514 "state": "A String", # The current state of the CryptoKeyVersion. 515 }, 516 ], 517 "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in ListCryptoKeyVersionsRequest.page_token to retrieve the next page of results. 518 "totalSize": 42, # The total number of CryptoKeyVersions that matched the query. 519}</pre> 520</div> 521 522<div class="method"> 523 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 524 <pre>Retrieves the next page of results. 525 526Args: 527 previous_request: The request for the previous page. (required) 528 previous_response: The response from the request for the previous page. (required) 529 530Returns: 531 A request object that you can call 'execute()' on to request the next 532 page. Returns None if there are no more items in the collection. 533 </pre> 534</div> 535 536<div class="method"> 537 <code class="details" id="macSign">macSign(name, body=None, x__xgafv=None)</code> 538 <pre>Signs data using a CryptoKeyVersion with CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key. 539 540Args: 541 name: string, Required. The resource name of the CryptoKeyVersion to use for signing. (required) 542 body: object, The request body. 543 The object takes the form of: 544 545{ # Request message for KeyManagementService.MacSign. 546 "data": "A String", # Required. The data to sign. The MAC tag is computed over this data field based on the specific algorithm. 547 "dataCrc32c": "A String", # Optional. An optional CRC32C checksum of the MacSignRequest.data. If specified, KeyManagementService will verify the integrity of the received MacSignRequest.data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacSignRequest.data) is equal to MacSignRequest.data_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. 548} 549 550 x__xgafv: string, V1 error format. 551 Allowed values 552 1 - v1 error format 553 2 - v2 error format 554 555Returns: 556 An object of the form: 557 558 { # Response message for KeyManagementService.MacSign. 559 "mac": "A String", # The created signature. 560 "macCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned MacSignResponse.mac. An integrity check of MacSignResponse.mac can be performed by computing the CRC32C checksum of MacSignResponse.mac and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. 561 "name": "A String", # The resource name of the CryptoKeyVersion used for signing. Check this field to verify that the intended resource was used for signing. 562 "protectionLevel": "A String", # The ProtectionLevel of the CryptoKeyVersion used for signing. 563 "verifiedDataCrc32c": True or False, # Integrity verification field. A flag indicating whether MacSignRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that MacSignRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set MacSignRequest.data_crc32c but this field is still false, discard the response and perform a limited number of retries. 564}</pre> 565</div> 566 567<div class="method"> 568 <code class="details" id="macVerify">macVerify(name, body=None, x__xgafv=None)</code> 569 <pre>Verifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful. 570 571Args: 572 name: string, Required. The resource name of the CryptoKeyVersion to use for verification. (required) 573 body: object, The request body. 574 The object takes the form of: 575 576{ # Request message for KeyManagementService.MacVerify. 577 "data": "A String", # Required. The data used previously as a MacSignRequest.data to generate the MAC tag. 578 "dataCrc32c": "A String", # Optional. An optional CRC32C checksum of the MacVerifyRequest.data. If specified, KeyManagementService will verify the integrity of the received MacVerifyRequest.data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacVerifyRequest.data) is equal to MacVerifyRequest.data_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. 579 "mac": "A String", # Required. The signature to verify. 580 "macCrc32c": "A String", # Optional. An optional CRC32C checksum of the MacVerifyRequest.mac. If specified, KeyManagementService will verify the integrity of the received MacVerifyRequest.mac using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacVerifyRequest.tag) is equal to MacVerifyRequest.mac_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. 581} 582 583 x__xgafv: string, V1 error format. 584 Allowed values 585 1 - v1 error format 586 2 - v2 error format 587 588Returns: 589 An object of the form: 590 591 { # Response message for KeyManagementService.MacVerify. 592 "name": "A String", # The resource name of the CryptoKeyVersion used for verification. Check this field to verify that the intended resource was used for verification. 593 "protectionLevel": "A String", # The ProtectionLevel of the CryptoKeyVersion used for verification. 594 "success": True or False, # This field indicates whether or not the verification operation for MacVerifyRequest.mac over MacVerifyRequest.data was successful. 595 "verifiedDataCrc32c": True or False, # Integrity verification field. A flag indicating whether MacVerifyRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that MacVerifyRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set MacVerifyRequest.data_crc32c but this field is still false, discard the response and perform a limited number of retries. 596 "verifiedMacCrc32c": True or False, # Integrity verification field. A flag indicating whether MacVerifyRequest.mac_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that MacVerifyRequest.mac_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set MacVerifyRequest.mac_crc32c but this field is still false, discard the response and perform a limited number of retries. 597 "verifiedSuccessIntegrity": True or False, # Integrity verification field. This value is used for the integrity verification of [MacVerifyResponse.success]. If the value of this field contradicts the value of [MacVerifyResponse.success], discard the response and perform a limited number of retries. 598}</pre> 599</div> 600 601<div class="method"> 602 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 603 <pre>Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states. 604 605Args: 606 name: string, Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. (required) 607 body: object, The request body. 608 The object takes the form of: 609 610{ # 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. 611 "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. 612 "attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # 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 protection_level HSM. 613 "certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation 614 "caviumCerts": [ # Cavium certificate chain corresponding to the attestation. 615 "A String", 616 ], 617 "googleCardCerts": [ # Google card certificate chain corresponding to the attestation. 618 "A String", 619 ], 620 "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation. 621 "A String", 622 ], 623 }, 624 "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed. 625 "format": "A String", # Output only. The format of the attestation data. 626 }, 627 "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. 628 "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. 629 "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. 630 "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. 631 "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. 632 }, 633 "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. 634 "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. 635 "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. 636 "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. 637 "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. 638 "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. 639 "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. 640 "state": "A String", # The current state of the CryptoKeyVersion. 641} 642 643 updateMask: string, Required. List of fields to be updated in this request. 644 x__xgafv: string, V1 error format. 645 Allowed values 646 1 - v1 error format 647 2 - v2 error format 648 649Returns: 650 An object of the form: 651 652 { # 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. 653 "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. 654 "attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # 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 protection_level HSM. 655 "certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation 656 "caviumCerts": [ # Cavium certificate chain corresponding to the attestation. 657 "A String", 658 ], 659 "googleCardCerts": [ # Google card certificate chain corresponding to the attestation. 660 "A String", 661 ], 662 "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation. 663 "A String", 664 ], 665 }, 666 "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed. 667 "format": "A String", # Output only. The format of the attestation data. 668 }, 669 "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. 670 "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. 671 "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. 672 "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. 673 "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. 674 }, 675 "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. 676 "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. 677 "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. 678 "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. 679 "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. 680 "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. 681 "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. 682 "state": "A String", # The current state of the CryptoKeyVersion. 683}</pre> 684</div> 685 686<div class="method"> 687 <code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code> 688 <pre>Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared. 689 690Args: 691 name: string, Required. The resource name of the CryptoKeyVersion to restore. (required) 692 body: object, The request body. 693 The object takes the form of: 694 695{ # Request message for KeyManagementService.RestoreCryptoKeyVersion. 696} 697 698 x__xgafv: string, V1 error format. 699 Allowed values 700 1 - v1 error format 701 2 - v2 error format 702 703Returns: 704 An object of the form: 705 706 { # 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. 707 "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. 708 "attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # 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 protection_level HSM. 709 "certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation 710 "caviumCerts": [ # Cavium certificate chain corresponding to the attestation. 711 "A String", 712 ], 713 "googleCardCerts": [ # Google card certificate chain corresponding to the attestation. 714 "A String", 715 ], 716 "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation. 717 "A String", 718 ], 719 }, 720 "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed. 721 "format": "A String", # Output only. The format of the attestation data. 722 }, 723 "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. 724 "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. 725 "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. 726 "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. 727 "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. 728 }, 729 "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. 730 "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. 731 "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. 732 "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. 733 "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. 734 "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. 735 "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. 736 "state": "A String", # The current state of the CryptoKeyVersion. 737}</pre> 738</div> 739 740</body></html>