Blame - docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html - platform/external/python/google-api-python-client

2017-03-13 12:12:03 -0400

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

78

<code><a href="#asymmetricDecrypt">asymmetricDecrypt(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Decrypts data that was encrypted with a public key retrieved from</p>

80

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

81

<code><a href="#asymmetricSign">asymmetricSign(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

82

<p class="firstline">Signs data using a CryptoKeyVersion with CryptoKey.purpose</p>

83

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

84

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

85

<p class="firstline">Create a new CryptoKeyVersion in a CryptoKey.</p>

86

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

87

<code><a href="#destroy">destroy(name, body=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

88

<p class="firstline">Schedule a CryptoKeyVersion for destruction.</p>

89

90

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

91

<p class="firstline">Returns metadata for a given CryptoKeyVersion.</p>

92

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

93

<code><a href="#getPublicKey">getPublicKey(name, x__xgafv=None)</a></code></p>

94

<p class="firstline">Returns the public key for the given CryptoKeyVersion. The</p>

95

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

<code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>

97

<p class="firstline">Imports a new CryptoKeyVersion into an existing CryptoKey using the</p>

98

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

99

<code><a href="#list">list(parent, filter=None, orderBy=None, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

100

<p class="firstline">Lists CryptoKeyVersions.</p>

101

102

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

103

<p class="firstline">Retrieves the next page of results.</p>

104

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

106

<p class="firstline">Update a CryptoKeyVersion's metadata.</p>

107

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

108

<code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

109

<p class="firstline">Restore a CryptoKeyVersion in the</p>

110

<h3>Method Details</h3>

111

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

112

<code class="details" id="asymmetricDecrypt">asymmetricDecrypt(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

<pre>Decrypts data that was encrypted with a public key retrieved from

114

GetPublicKey corresponding to a CryptoKeyVersion with

115

CryptoKey.purpose ASYMMETRIC_DECRYPT.

Args:

decryption. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

120

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

121

The object takes the form of:

122

123

{ # Request message for KeyManagementService.AsymmetricDecrypt.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

124

"ciphertextCrc32c": "A String", # Optional. An optional CRC32C checksum of the AsymmetricDecryptRequest.ciphertext.

125

# If specified, KeyManagementService will verify the integrity of the

126

# received AsymmetricDecryptRequest.ciphertext using this checksum.

127

# KeyManagementService will report an error if the checksum verification

128

# fails. If you receive a checksum error, your client should verify that

129

# CRC32C(AsymmetricDecryptRequest.ciphertext) is equal to

130

# AsymmetricDecryptRequest.ciphertext_crc32c, and if so, perform a

131

# limited number of retries. A persistent mismatch may indicate an issue in

132

# your computation of the CRC32C checksum.

133

# Note: This field is defined as int64 for reasons of compatibility across

134

# different languages. However, it is a non-negative integer, which will

135

# never exceed 2^32-1, and can be safely downconverted to uint32 in languages

136

# that support this type.

137

#

138

# NOTE: This field is in Beta.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

139

"ciphertext": "A String", # Required. The data encrypted with the named CryptoKeyVersion's public

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

# key using OAEP.

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

150

151

{ # Response message for KeyManagementService.AsymmetricDecrypt.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

152

"plaintext": "A String", # The decrypted data originally encrypted with the matching public key.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

153

"verifiedCiphertextCrc32c": True or False, # Integrity verification field. A flag indicating whether

154

# AsymmetricDecryptRequest.ciphertext_crc32c was received by

155

# KeyManagementService and used for the integrity verification of the

156

# ciphertext. A false value of this

157

# field indicates either that AsymmetricDecryptRequest.ciphertext_crc32c

158

# was left unset or that it was not delivered to KeyManagementService. If

159

# you've set AsymmetricDecryptRequest.ciphertext_crc32c but this field is

160

# still false, discard the response and perform a limited number of retries.

161

#

162

# NOTE: This field is in Beta.

163

"plaintextCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned

164

# AsymmetricDecryptResponse.plaintext. An integrity check of

165

# AsymmetricDecryptResponse.plaintext can be performed by computing the

166

# CRC32C checksum of AsymmetricDecryptResponse.plaintext and comparing

167

# your results to this field. Discard the response in case of non-matching

168

# checksum values, and perform a limited number of retries. A persistent

169

# mismatch may indicate an issue in your computation of the CRC32C checksum.

170

# Note: This field is defined as int64 for reasons of compatibility across

171

# different languages. However, it is a non-negative integer, which will

172

# never exceed 2^32-1, and can be safely downconverted to uint32 in languages

173

# that support this type.

174

#

175

# NOTE: This field is in Beta.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

180

<code class="details" id="asymmetricSign">asymmetricSign(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

181

<pre>Signs data using a CryptoKeyVersion with CryptoKey.purpose

182

ASYMMETRIC_SIGN, producing a signature that can be verified with the public

183

key retrieved from GetPublicKey.

184

185

Args:

186

name: string, Required. The resource name of the CryptoKeyVersion to use for signing. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

187

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

188

The object takes the form of:

189

190

{ # Request message for KeyManagementService.AsymmetricSign.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

191

"digest": { # A Digest holds a cryptographic message digest. # Required. The digest of the data to sign. The digest must be produced with

192

# the same digest algorithm as specified by the key version's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

193

# algorithm.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

194

"sha384": "A String", # A message digest produced with the SHA-384 algorithm.

195

"sha256": "A String", # A message digest produced with the SHA-256 algorithm.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

196

"sha512": "A String", # A message digest produced with the SHA-512 algorithm.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

197

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

198

"digestCrc32c": "A String", # Optional. An optional CRC32C checksum of the AsymmetricSignRequest.digest. If

199

# specified, KeyManagementService will verify the integrity of the

200

# received AsymmetricSignRequest.digest using this checksum.

201

# KeyManagementService will report an error if the checksum verification

202

# fails. If you receive a checksum error, your client should verify that

203

# CRC32C(AsymmetricSignRequest.digest) is equal to

204

# AsymmetricSignRequest.digest_crc32c, and if so, perform a limited

205

# number of retries. A persistent mismatch may indicate an issue in your

206

# computation of the CRC32C checksum.

207

# Note: This field is defined as int64 for reasons of compatibility across

208

# different languages. However, it is a non-negative integer, which will

209

# never exceed 2^32-1, and can be safely downconverted to uint32 in languages

210

# that support this type.

211

#

212

# NOTE: This field is in Beta.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

213

}

214

215

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

222

223

{ # Response message for KeyManagementService.AsymmetricSign.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

224

"signatureCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned

225

# AsymmetricSignResponse.signature. An integrity check of

226

# AsymmetricSignResponse.signature can be performed by computing the

227

# CRC32C checksum of AsymmetricSignResponse.signature and comparing your

228

# results to this field. Discard the response in case of non-matching

229

# checksum values, and perform a limited number of retries. A persistent

230

# mismatch may indicate an issue in your computation of the CRC32C checksum.

231

# Note: This field is defined as int64 for reasons of compatibility across

232

# different languages. However, it is a non-negative integer, which will

233

# never exceed 2^32-1, and can be safely downconverted to uint32 in languages

234

# that support this type.

235

#

236

# NOTE: This field is in Beta.

237

"verifiedDigestCrc32c": True or False, # Integrity verification field. A flag indicating whether

238

# AsymmetricSignRequest.digest_crc32c was received by

239

# KeyManagementService and used for the integrity verification of the

240

# digest. A false value of this field

241

# indicates either that AsymmetricSignRequest.digest_crc32c was left

242

# unset or that it was not delivered to KeyManagementService. If you've

243

# set AsymmetricSignRequest.digest_crc32c but this field is still false,

244

# discard the response and perform a limited number of retries.

245

#

246

# NOTE: This field is in Beta.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

247

"signature": "A String", # The created signature.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

248

"name": "A String", # The resource name of the CryptoKeyVersion used for signing. Check

249

# this field to verify that the intended resource was used for signing.

250

#

251

# NOTE: This field is in Beta.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

256

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

257

<pre>Create a new CryptoKeyVersion in a CryptoKey.

258

259

The server will assign the next sequential id. If unset,

state will be set to

ENABLED.

Args:

parent: string, Required. The name of the CryptoKey associated with

265

the CryptoKeyVersions. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

266

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

267

The object takes the form of:

268

269

{ # A CryptoKeyVersion represents an individual cryptographic key, and the

270

# associated key material.

271

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

272

# An ENABLED version can be

273

# used for cryptographic operations.

274

#

275

# For security reasons, the raw cryptographic key material represented by a

276

# CryptoKeyVersion can never be viewed or exported. It can only be used to

277

# encrypt, decrypt, or sign data when an authorized user or application invokes

278

# Cloud KMS.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

279

"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

280

# generated.

281

"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format

282

# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

283

"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material

284

# was imported.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

285

"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if

286

# state is

287

# IMPORT_FAILED.

288

"state": "A String", # The current state of the CryptoKeyVersion.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

289

"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key

290

# creation time. Use this statement to verify attributes of the key as stored

291

# on the HSM, independently of Google. Only provided for key versions with

292

# protection_level HSM.

293

# information, see [Verifying attestations]

294

# (https://cloud.google.com/kms/docs/attest-key).

295

"format": "A String", # Output only. The format of the attestation data.

296

"content": "A String", # Output only. The attestation data provided by the HSM when the key

297

# operation was performed.

298

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

299

"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.

300

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled

301

# for destruction. Only present if state is

302

# DESTROY_SCHEDULED.

303

"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

304

# destroyed. Only present if state is

305

# DESTROYED.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

306

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are

307

# performed with this CryptoKeyVersion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

308

"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for

309

# configuring a CryptoKeyVersion that are specific to the

310

# EXTERNAL protection level.

311

# configuring a CryptoKeyVersion that are specific to the

312

# EXTERNAL protection level.

313

"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.

314

},

315

"importJob": "A String", # Output only. The name of the ImportJob used to import this

316

# CryptoKeyVersion. Only present if the underlying key material was

317

# imported.

318

"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this

319

# CryptoKeyVersion supports.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

320

}

321

322

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

329

330

{ # A CryptoKeyVersion represents an individual cryptographic key, and the

331

# associated key material.

332

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

333

# An ENABLED version can be

334

# used for cryptographic operations.

335

#

336

# For security reasons, the raw cryptographic key material represented by a

337

# CryptoKeyVersion can never be viewed or exported. It can only be used to

338

# encrypt, decrypt, or sign data when an authorized user or application invokes

339

# Cloud KMS.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

340

"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

341

# generated.

342

"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format

343

# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

344

"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material

345

# was imported.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

346

"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if

347

# state is

348

# IMPORT_FAILED.

349

"state": "A String", # The current state of the CryptoKeyVersion.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

350

"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key

351

# creation time. Use this statement to verify attributes of the key as stored

352

# on the HSM, independently of Google. Only provided for key versions with

353

# protection_level HSM.

354

# information, see [Verifying attestations]

355

# (https://cloud.google.com/kms/docs/attest-key).

356

"format": "A String", # Output only. The format of the attestation data.

357

"content": "A String", # Output only. The attestation data provided by the HSM when the key

358

# operation was performed.

359

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

360

"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.

361

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled

362

# for destruction. Only present if state is

363

# DESTROY_SCHEDULED.

364

"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

365

# destroyed. Only present if state is

366

# DESTROYED.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

367

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are

368

# performed with this CryptoKeyVersion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

369

"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for

370

# configuring a CryptoKeyVersion that are specific to the

371

# EXTERNAL protection level.

372

# configuring a CryptoKeyVersion that are specific to the

373

# EXTERNAL protection level.

374

"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.

375

},

376

"importJob": "A String", # Output only. The name of the ImportJob used to import this

377

# CryptoKeyVersion. Only present if the underlying key material was

378

# imported.

379

"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this

380

# CryptoKeyVersion supports.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

385

<code class="details" id="destroy">destroy(name, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

386

<pre>Schedule a CryptoKeyVersion for destruction.

387

388

Upon calling this method, CryptoKeyVersion.state will be set to

389

DESTROY_SCHEDULED

390

and destroy_time will be set to a time 24

391

hours in the future, at which point the state

392

will be changed to

393

DESTROYED, and the key

394

material will be irrevocably destroyed.

395

396

Before the destroy_time is reached,

397

RestoreCryptoKeyVersion may be called to reverse the process.

398

399

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

400

name: string, Required. The resource name of the CryptoKeyVersion to destroy. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

401

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

402

The object takes the form of:

403

404

{ # Request message for KeyManagementService.DestroyCryptoKeyVersion.

405

}

406

407

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

414

415

{ # A CryptoKeyVersion represents an individual cryptographic key, and the

416

# associated key material.

417

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

418

# An ENABLED version can be

419

# used for cryptographic operations.

420

#

421

# For security reasons, the raw cryptographic key material represented by a

422

# CryptoKeyVersion can never be viewed or exported. It can only be used to

423

# encrypt, decrypt, or sign data when an authorized user or application invokes

424

# Cloud KMS.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

425

"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

426

# generated.

427

"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format

428

# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

429

"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material

430

# was imported.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

431

"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if

432

# state is

433

# IMPORT_FAILED.

434

"state": "A String", # The current state of the CryptoKeyVersion.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

435

"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key

436

# creation time. Use this statement to verify attributes of the key as stored

437

# on the HSM, independently of Google. Only provided for key versions with

438

# protection_level HSM.

439

# information, see [Verifying attestations]

440

# (https://cloud.google.com/kms/docs/attest-key).

441

"format": "A String", # Output only. The format of the attestation data.

442

"content": "A String", # Output only. The attestation data provided by the HSM when the key

443

# operation was performed.

444

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

445

"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.

446

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled

447

# for destruction. Only present if state is

448

# DESTROY_SCHEDULED.

449

"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

450

# destroyed. Only present if state is

451

# DESTROYED.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

452

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are

453

# performed with this CryptoKeyVersion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

454

"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for

455

# configuring a CryptoKeyVersion that are specific to the

456

# EXTERNAL protection level.

457

# configuring a CryptoKeyVersion that are specific to the

458

# EXTERNAL protection level.

459

"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.

460

},

461

"importJob": "A String", # Output only. The name of the ImportJob used to import this

462

# CryptoKeyVersion. Only present if the underlying key material was

463

# imported.

464

"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this

465

# CryptoKeyVersion supports.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

471

<pre>Returns metadata for a given CryptoKeyVersion.

472

473

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

474

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

475

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

482

483

{ # A CryptoKeyVersion represents an individual cryptographic key, and the

484

# associated key material.

485

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

486

# An ENABLED version can be

487

# used for cryptographic operations.

488

#

489

# For security reasons, the raw cryptographic key material represented by a

490

# CryptoKeyVersion can never be viewed or exported. It can only be used to

491

# encrypt, decrypt, or sign data when an authorized user or application invokes

492

# Cloud KMS.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

493

"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

494

# generated.

495

"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format

496

# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

497

"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material

498

# was imported.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

499

"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if

500

# state is

501

# IMPORT_FAILED.

502

"state": "A String", # The current state of the CryptoKeyVersion.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

503

"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key

504

# creation time. Use this statement to verify attributes of the key as stored

505

# on the HSM, independently of Google. Only provided for key versions with

506

# protection_level HSM.

507

# information, see [Verifying attestations]

508

# (https://cloud.google.com/kms/docs/attest-key).

509

"format": "A String", # Output only. The format of the attestation data.

510

"content": "A String", # Output only. The attestation data provided by the HSM when the key

511

# operation was performed.

512

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

513

"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.

514

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled

515

# for destruction. Only present if state is

516

# DESTROY_SCHEDULED.

517

"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

518

# destroyed. Only present if state is

519

# DESTROYED.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

520

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are

521

# performed with this CryptoKeyVersion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

522

"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for

523

# configuring a CryptoKeyVersion that are specific to the

524

# EXTERNAL protection level.

525

# configuring a CryptoKeyVersion that are specific to the

526

# EXTERNAL protection level.

527

"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.

528

},

529

"importJob": "A String", # Output only. The name of the ImportJob used to import this

530

# CryptoKeyVersion. Only present if the underlying key material was

531

# imported.

532

"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this

533

# CryptoKeyVersion supports.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

538

<code class="details" id="getPublicKey">getPublicKey(name, x__xgafv=None)</code>

539

<pre>Returns the public key for the given CryptoKeyVersion. The

540

CryptoKey.purpose must be

ASYMMETRIC_SIGN or

ASYMMETRIC_DECRYPT.

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

545

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

546

get. (required)

547

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

554

555

{ # The public key for a given CryptoKeyVersion. Obtained via

556

# GetPublicKey.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

557

"pemCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned

558

# PublicKey.pem. An integrity check of PublicKey.pem can be performed

559

# by computing the CRC32C checksum of PublicKey.pem and

560

# comparing your results to this field. Discard the response in case of

561

# non-matching checksum values, and perform a limited number of retries. A

562

# persistent mismatch may indicate an issue in your computation of the CRC32C

563

# checksum.

564

# Note: This field is defined as int64 for reasons of compatibility across

565

# different languages. However, it is a non-negative integer, which will

566

# never exceed 2^32-1, and can be safely downconverted to uint32 in languages

567

# that support this type.

568

#

569

# NOTE: This field is in Beta.

570

"name": "A String", # The name of the CryptoKeyVersion public key.

571

# Provided here for verification.

572

#

573

# NOTE: This field is in Beta.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

574

"algorithm": "A String", # The Algorithm associated

575

# with this key.

576

"pem": "A String", # The public key, encoded in PEM format. For more information, see the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

577

# [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for

578

# [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and

579

# [Textual Encoding of Subject Public Key Info]

580

# (https://tools.ietf.org/html/rfc7468#section-13).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

585

<code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code>

586

<pre>Imports a new CryptoKeyVersion into an existing CryptoKey using the

587

wrapped key material provided in the request.

588

589

The version ID will be assigned the next sequential id within the

CryptoKey.

Args:

parent: string, Required. The name of the CryptoKey to

594

be imported into. (required)

595

body: object, The request body.

596

The object takes the form of:

597

598

{ # Request message for KeyManagementService.ImportCryptoKeyVersion.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

599

"rsaAesWrappedKey": "A String", # Wrapped key material produced with

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

600

# RSA_OAEP_3072_SHA1_AES_256

601

# or

602

# RSA_OAEP_4096_SHA1_AES_256.

603

#

604

# This field contains the concatenation of two wrapped keys:

605

# <ol>

606

# <li>An ephemeral AES-256 wrapping key wrapped with the

607

# public_key using RSAES-OAEP with SHA-1,

608

# MGF1 with SHA-1, and an empty label.

609

# </li>

610

# <li>The key to be imported, wrapped with the ephemeral AES-256 key

611

# using AES-KWP (RFC 5649).

# </li>

# </ol>

#

# If importing symmetric key material, it is expected that the unwrapped

616

# key contains plain bytes. If importing asymmetric key material, it is

617

# expected that the unwrapped key is in PKCS#8-encoded DER format (the

618

# PrivateKeyInfo structure from RFC 5208).

619

#

620

# This format is the same as the format produced by PKCS#11 mechanism

621

# CKM_RSA_AES_KEY_WRAP.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

622

"importJob": "A String", # Required. The name of the ImportJob that was used to

623

# wrap this key material.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

624

"algorithm": "A String", # Required. The algorithm of

625

# the key being imported. This does not need to match the

626

# version_template of the CryptoKey this

627

# version imports into.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

628

}

629

630

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

637

638

{ # A CryptoKeyVersion represents an individual cryptographic key, and the

639

# associated key material.

640

#

641

# An ENABLED version can be

642

# used for cryptographic operations.

643

#

644

# For security reasons, the raw cryptographic key material represented by a

645

# CryptoKeyVersion can never be viewed or exported. It can only be used to

646

# encrypt, decrypt, or sign data when an authorized user or application invokes

647

# Cloud KMS.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

648

"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

649

# generated.

650

"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format

651

# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

652

"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material

653

# was imported.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

654

"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if

655

# state is

656

# IMPORT_FAILED.

657

"state": "A String", # The current state of the CryptoKeyVersion.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

658

"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key

659

# creation time. Use this statement to verify attributes of the key as stored

660

# on the HSM, independently of Google. Only provided for key versions with

661

# protection_level HSM.

662

# information, see [Verifying attestations]

663

# (https://cloud.google.com/kms/docs/attest-key).

664

"format": "A String", # Output only. The format of the attestation data.

665

"content": "A String", # Output only. The attestation data provided by the HSM when the key

666

# operation was performed.

667

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

668

"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.

669

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled

670

# for destruction. Only present if state is

671

# DESTROY_SCHEDULED.

672

"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

673

# destroyed. Only present if state is

674

# DESTROYED.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

675

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are

676

# performed with this CryptoKeyVersion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

677

"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for

678

# configuring a CryptoKeyVersion that are specific to the

679

# EXTERNAL protection level.

680

# configuring a CryptoKeyVersion that are specific to the

681

# EXTERNAL protection level.

682

"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.

683

},

684

"importJob": "A String", # Output only. The name of the ImportJob used to import this

685

# CryptoKeyVersion. Only present if the underlying key material was

686

# imported.

687

"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this

688

# CryptoKeyVersion supports.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

693

<code class="details" id="list">list(parent, filter=None, orderBy=None, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

694

<pre>Lists CryptoKeyVersions.

695

696

Args:

697

parent: string, Required. The resource name of the CryptoKey to list, in the format

698

`projects/*/locations/*/keyRings/*/cryptoKeys/*`. (required)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

699

filter: string, Optional. Only include resources that match the filter in the response. For

700

more information, see

701

[Sorting and filtering list

702

results](https://cloud.google.com/kms/docs/sorting-and-filtering).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

703

orderBy: string, Optional. Specify how the results should be sorted. If not specified, the

704

results will be sorted in the default order. For more information, see

705

[Sorting and filtering list

706

results](https://cloud.google.com/kms/docs/sorting-and-filtering).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

707

pageToken: string, Optional. Optional pagination token, returned earlier via

708

ListCryptoKeyVersionsResponse.next_page_token.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

709

pageSize: integer, Optional. Optional limit on the number of CryptoKeyVersions to

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

710

include in the response. Further CryptoKeyVersions can

711

subsequently be obtained by including the

712

ListCryptoKeyVersionsResponse.next_page_token in a subsequent request.

713

If unspecified, the server will pick an appropriate default.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

714

view: string, The fields to include in the response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

715

x__xgafv: string, V1 error format.

716

Allowed values

717

1 - v1 error format

718

2 - v2 error format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

719

720

Returns:

721

An object of the form:

722

723

{ # Response message for KeyManagementService.ListCryptoKeyVersions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

724

"cryptoKeyVersions": [ # The list of CryptoKeyVersions.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

725

{ # A CryptoKeyVersion represents an individual cryptographic key, and the

726

# associated key material.

727

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

728

# An ENABLED version can be

729

# used for cryptographic operations.

730

#

731

# For security reasons, the raw cryptographic key material represented by a

732

# CryptoKeyVersion can never be viewed or exported. It can only be used to

733

# encrypt, decrypt, or sign data when an authorized user or application invokes

734

# Cloud KMS.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

735

"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

736

# generated.

737

"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format

738

# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

739

"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material

740

# was imported.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

741

"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if

742

# state is

743

# IMPORT_FAILED.

744

"state": "A String", # The current state of the CryptoKeyVersion.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

745

"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key

746

# creation time. Use this statement to verify attributes of the key as stored

747

# on the HSM, independently of Google. Only provided for key versions with

748

# protection_level HSM.

749

# information, see [Verifying attestations]

750

# (https://cloud.google.com/kms/docs/attest-key).

751

"format": "A String", # Output only. The format of the attestation data.

752

"content": "A String", # Output only. The attestation data provided by the HSM when the key

753

# operation was performed.

754

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

755

"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.

756

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled

757

# for destruction. Only present if state is

758

# DESTROY_SCHEDULED.

759

"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

760

# destroyed. Only present if state is

761

# DESTROYED.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

762

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are

763

# performed with this CryptoKeyVersion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

764

"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for

765

# configuring a CryptoKeyVersion that are specific to the

766

# EXTERNAL protection level.

767

# configuring a CryptoKeyVersion that are specific to the

768

# EXTERNAL protection level.

769

"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.

770

},

771

"importJob": "A String", # Output only. The name of the ImportJob used to import this

772

# CryptoKeyVersion. Only present if the underlying key material was

773

# imported.

774

"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this

775

# CryptoKeyVersion supports.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

776

},

777

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

778

"totalSize": 42, # The total number of CryptoKeyVersions that matched the

779

# query.

780

"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in

781

# ListCryptoKeyVersionsRequest.page_token to retrieve the next page of

782

# results.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

788

<pre>Retrieves the next page of results.

789

790

Args:

791

previous_request: The request for the previous page. (required)

792

previous_response: The response from the request for the previous page. (required)

793

794

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

795

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

796

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

801

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

802

<pre>Update a CryptoKeyVersion's metadata.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

803

804

state may be changed between

805

ENABLED and

806

DISABLED using this

807

method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to

808

move between other states.

809

810

Args:

811

name: string, Output only. The resource name for this CryptoKeyVersion in the format

812

`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

813

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

814

The object takes the form of:

815

816

{ # A CryptoKeyVersion represents an individual cryptographic key, and the

817

# associated key material.

818

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

819

# An ENABLED version can be

820

# used for cryptographic operations.

821

#

822

# For security reasons, the raw cryptographic key material represented by a

823

# CryptoKeyVersion can never be viewed or exported. It can only be used to

824

# encrypt, decrypt, or sign data when an authorized user or application invokes

825

# Cloud KMS.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

826

"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

827

# generated.

828

"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format

829

# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

830

"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material

831

# was imported.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

832

"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if

833

# state is

834

# IMPORT_FAILED.

835

"state": "A String", # The current state of the CryptoKeyVersion.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

836

"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key

837

# creation time. Use this statement to verify attributes of the key as stored

838

# on the HSM, independently of Google. Only provided for key versions with

839

# protection_level HSM.

840

# information, see [Verifying attestations]

841

# (https://cloud.google.com/kms/docs/attest-key).

842

"format": "A String", # Output only. The format of the attestation data.

843

"content": "A String", # Output only. The attestation data provided by the HSM when the key

844

# operation was performed.

845

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

846

"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.

847

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled

848

# for destruction. Only present if state is

849

# DESTROY_SCHEDULED.

850

"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

851

# destroyed. Only present if state is

852

# DESTROYED.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

853

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are

854

# performed with this CryptoKeyVersion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

855

"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for

856

# configuring a CryptoKeyVersion that are specific to the

857

# EXTERNAL protection level.

858

# configuring a CryptoKeyVersion that are specific to the

859

# EXTERNAL protection level.

860

"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.

861

},

862

"importJob": "A String", # Output only. The name of the ImportJob used to import this

863

# CryptoKeyVersion. Only present if the underlying key material was

864

# imported.

865

"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this

866

# CryptoKeyVersion supports.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

867

}

868

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

869

updateMask: string, Required. List of fields to be updated in this request.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

870

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

877

878

{ # A CryptoKeyVersion represents an individual cryptographic key, and the

879

# associated key material.

880

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

881

# An ENABLED version can be

882

# used for cryptographic operations.

883

#

884

# For security reasons, the raw cryptographic key material represented by a

885

# CryptoKeyVersion can never be viewed or exported. It can only be used to

886

# encrypt, decrypt, or sign data when an authorized user or application invokes

887

# Cloud KMS.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

888

"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

889

# generated.

890

"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format

891

# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

892

"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material

893

# was imported.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

894

"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if

895

# state is

896

# IMPORT_FAILED.

897

"state": "A String", # The current state of the CryptoKeyVersion.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

898

"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key

899

# creation time. Use this statement to verify attributes of the key as stored

900

# on the HSM, independently of Google. Only provided for key versions with

901

# protection_level HSM.

902

# information, see [Verifying attestations]

903

# (https://cloud.google.com/kms/docs/attest-key).

904

"format": "A String", # Output only. The format of the attestation data.

905

"content": "A String", # Output only. The attestation data provided by the HSM when the key

906

# operation was performed.

907

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

908

"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.

909

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled

910

# for destruction. Only present if state is

911

# DESTROY_SCHEDULED.

912

"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

913

# destroyed. Only present if state is

914

# DESTROYED.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

915

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are

916

# performed with this CryptoKeyVersion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

917

"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for

918

# configuring a CryptoKeyVersion that are specific to the

919

# EXTERNAL protection level.

920

# configuring a CryptoKeyVersion that are specific to the

921

# EXTERNAL protection level.

922

"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.

923

},

924

"importJob": "A String", # Output only. The name of the ImportJob used to import this

925

# CryptoKeyVersion. Only present if the underlying key material was

926

# imported.

927

"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this

928

# CryptoKeyVersion supports.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

933

<code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

934

<pre>Restore a CryptoKeyVersion in the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

935

DESTROY_SCHEDULED

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

936

state.

937

938

Upon restoration of the CryptoKeyVersion, state

939

will be set to DISABLED,

940

and destroy_time will be cleared.

941

942

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

943

name: string, Required. The resource name of the CryptoKeyVersion to restore. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

944

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

945

The object takes the form of:

946

947

{ # Request message for KeyManagementService.RestoreCryptoKeyVersion.

948

}

949

950

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

957

958

{ # A CryptoKeyVersion represents an individual cryptographic key, and the

959

# associated key material.

960

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

961

# An ENABLED version can be

962

# used for cryptographic operations.

963

#

964

# For security reasons, the raw cryptographic key material represented by a

965

# CryptoKeyVersion can never be viewed or exported. It can only be used to

966

# encrypt, decrypt, or sign data when an authorized user or application invokes

967

# Cloud KMS.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

968

"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

969

# generated.

970

"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format

971

# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

972

"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material

973

# was imported.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

974

"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if

975

# state is

976

# IMPORT_FAILED.

977

"state": "A String", # The current state of the CryptoKeyVersion.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

978

"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key

979

# creation time. Use this statement to verify attributes of the key as stored

980

# on the HSM, independently of Google. Only provided for key versions with

981

# protection_level HSM.

982

# information, see [Verifying attestations]

983

# (https://cloud.google.com/kms/docs/attest-key).

984

"format": "A String", # Output only. The format of the attestation data.

985

"content": "A String", # Output only. The attestation data provided by the HSM when the key

986

# operation was performed.

987

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

988

"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.

989

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled

990

# for destruction. Only present if state is

991

# DESTROY_SCHEDULED.

992

"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was

993

# destroyed. Only present if state is

994

# DESTROYED.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

995

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are

996

# performed with this CryptoKeyVersion.

Bu Sun Kim