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-05-27 12:20:54 -0700

[diff] [blame^]

99

<code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, view=None, orderBy=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-05-20 12:08:20 -0700

[diff] [blame]

124

"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:

135

136

{ # Response message for KeyManagementService.AsymmetricDecrypt.

Bu Sun Kim

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

[diff] [blame]

137

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

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]

142

<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]

143

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

144

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

145

key retrieved from GetPublicKey.

146

147

Args:

148

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]

149

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

150

The object takes the form of:

151

152

{ # Request message for KeyManagementService.AsymmetricSign.

Bu Sun Kim

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

[diff] [blame]

153

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

154

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

Bu Sun Kim

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

[diff] [blame]

155

# algorithm.

Bu Sun Kim

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

[diff] [blame^]

156

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

Bu Sun Kim

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

[diff] [blame]

157

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

158

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

Bu Sun Kim

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

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

169

170

{ # Response message for KeyManagementService.AsymmetricSign.

Bu Sun Kim

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

[diff] [blame]

171

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

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]

176

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

Sai Cheemalapati

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

[diff] [blame]

177

<pre>Create a new CryptoKeyVersion in a CryptoKey.

178

179

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

185

the CryptoKeyVersions. (required)

Dan O'Meara

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

[diff] [blame]

186

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

187

The object takes the form of:

188

189

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

190

# associated key material.

191

#

Bu Sun Kim

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

[diff] [blame]

192

# An ENABLED version can be

193

# used for cryptographic operations.

194

#

195

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

196

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

197

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

198

# Cloud KMS.

Bu Sun Kim

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

[diff] [blame]

199

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

200

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

201

# CryptoKeyVersion supports.

202

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

Dan O'Meara

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

[diff] [blame]

203

# CryptoKeyVersion. Only present if the underlying key material was

204

# imported.

Bu Sun Kim

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

[diff] [blame]

205

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

Dan O'Meara

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

[diff] [blame]

206

# configuring a CryptoKeyVersion that are specific to the

207

# EXTERNAL protection level.

208

# configuring a CryptoKeyVersion that are specific to the

209

# EXTERNAL protection level.

Bu Sun Kim

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

[diff] [blame]

210

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

Dan O'Meara

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

[diff] [blame]

211

},

Bu Sun Kim

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

[diff] [blame^]

212

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

213

# destroyed. Only present if state is

214

# DESTROYED.

215

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

216

# was imported.

217

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

218

# for destruction. Only present if state is

219

# DESTROY_SCHEDULED.

220

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

221

# state is

222

# IMPORT_FAILED.

223

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

224

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

225

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

226

"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

227

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

228

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

229

# protection_level HSM.

230

# information, see [Verifying attestations]

231

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

232

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

233

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

234

# operation was performed.

235

},

236

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

237

# generated.

238

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

239

# performed with this CryptoKeyVersion.

Sai Cheemalapati

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

[diff] [blame]

240

}

241

242

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

249

250

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

251

# associated key material.

252

#

Bu Sun Kim

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

[diff] [blame]

253

# An ENABLED version can be

254

# used for cryptographic operations.

255

#

256

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

257

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

258

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

259

# Cloud KMS.

Bu Sun Kim

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

[diff] [blame]

260

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

261

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

262

# CryptoKeyVersion supports.

263

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

Dan O'Meara

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

[diff] [blame]

264

# CryptoKeyVersion. Only present if the underlying key material was

265

# imported.

Bu Sun Kim

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

[diff] [blame]

266

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

Dan O'Meara

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

[diff] [blame]

267

# configuring a CryptoKeyVersion that are specific to the

268

# EXTERNAL protection level.

269

# configuring a CryptoKeyVersion that are specific to the

270

# EXTERNAL protection level.

Bu Sun Kim

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

[diff] [blame]

271

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

Dan O'Meara

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

[diff] [blame]

272

},

Bu Sun Kim

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

[diff] [blame^]

273

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

274

# destroyed. Only present if state is

275

# DESTROYED.

276

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

277

# was imported.

278

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

279

# for destruction. Only present if state is

280

# DESTROY_SCHEDULED.

281

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

282

# state is

283

# IMPORT_FAILED.

284

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

285

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

286

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

287

"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

288

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

289

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

290

# protection_level HSM.

291

# information, see [Verifying attestations]

292

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

293

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

294

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

295

# operation was performed.

296

},

297

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

298

# generated.

299

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

300

# performed with this CryptoKeyVersion.

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]

305

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

Sai Cheemalapati

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

[diff] [blame]

306

<pre>Schedule a CryptoKeyVersion for destruction.

307

308

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

309

DESTROY_SCHEDULED

310

and destroy_time will be set to a time 24

311

hours in the future, at which point the state

312

will be changed to

313

DESTROYED, and the key

314

material will be irrevocably destroyed.

315

316

Before the destroy_time is reached,

317

RestoreCryptoKeyVersion may be called to reverse the process.

318

319

Args:

Dan O'Meara

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

[diff] [blame]

320

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

Bu Sun Kim

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

[diff] [blame]

321

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

322

The object takes the form of:

323

324

{ # Request message for KeyManagementService.DestroyCryptoKeyVersion.

325

}

326

327

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

334

335

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

336

# associated key material.

337

#

Bu Sun Kim

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

[diff] [blame]

338

# An ENABLED version can be

339

# used for cryptographic operations.

340

#

341

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

342

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

343

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

344

# Cloud KMS.

Bu Sun Kim

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

[diff] [blame]

345

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

346

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

347

# CryptoKeyVersion supports.

348

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

Dan O'Meara

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

[diff] [blame]

349

# CryptoKeyVersion. Only present if the underlying key material was

350

# imported.

Bu Sun Kim

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

[diff] [blame]

351

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

Dan O'Meara

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

[diff] [blame]

352

# configuring a CryptoKeyVersion that are specific to the

353

# EXTERNAL protection level.

354

# configuring a CryptoKeyVersion that are specific to the

355

# EXTERNAL protection level.

Bu Sun Kim

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

[diff] [blame]

356

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

Dan O'Meara

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

[diff] [blame]

357

},

Bu Sun Kim

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

[diff] [blame^]

358

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

359

# destroyed. Only present if state is

360

# DESTROYED.

361

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

362

# was imported.

363

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

364

# for destruction. Only present if state is

365

# DESTROY_SCHEDULED.

366

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

367

# state is

368

# IMPORT_FAILED.

369

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

370

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

371

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

372

"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

373

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

374

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

375

# protection_level HSM.

376

# information, see [Verifying attestations]

377

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

378

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

379

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

380

# operation was performed.

381

},

382

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

383

# generated.

384

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

385

# performed with this CryptoKeyVersion.

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

391

<pre>Returns metadata for a given CryptoKeyVersion.

392

393

Args:

Dan O'Meara

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

[diff] [blame]

394

Sai Cheemalapati

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

[diff] [blame]

395

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

402

403

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

404

# associated key material.

405

#

Bu Sun Kim

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

[diff] [blame]

406

# An ENABLED version can be

407

# used for cryptographic operations.

408

#

409

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

410

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

411

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

412

# Cloud KMS.

Bu Sun Kim

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

[diff] [blame]

413

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

414

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

415

# CryptoKeyVersion supports.

416

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

Dan O'Meara

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

[diff] [blame]

417

# CryptoKeyVersion. Only present if the underlying key material was

418

# imported.

Bu Sun Kim

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

[diff] [blame]

419

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

Dan O'Meara

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

[diff] [blame]

420

# configuring a CryptoKeyVersion that are specific to the

421

# EXTERNAL protection level.

422

# configuring a CryptoKeyVersion that are specific to the

423

# EXTERNAL protection level.

Bu Sun Kim

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

[diff] [blame]

424

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

Dan O'Meara

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

[diff] [blame]

425

},

Bu Sun Kim

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

[diff] [blame^]

426

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

427

# destroyed. Only present if state is

428

# DESTROYED.

429

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

430

# was imported.

431

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

432

# for destruction. Only present if state is

433

# DESTROY_SCHEDULED.

434

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

435

# state is

436

# IMPORT_FAILED.

437

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

438

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

439

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

440

"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

441

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

442

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

443

# protection_level HSM.

444

# information, see [Verifying attestations]

445

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

446

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

447

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

448

# operation was performed.

449

},

450

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

451

# generated.

452

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

453

# performed with this CryptoKeyVersion.

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]

458

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

459

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

460

CryptoKey.purpose must be

ASYMMETRIC_SIGN or

ASYMMETRIC_DECRYPT.

Args:

Dan O'Meara

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

[diff] [blame]

465

Bu Sun Kim

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

[diff] [blame]

466

get. (required)

467

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

474

475

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

476

# GetPublicKey.

Bu Sun Kim

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

[diff] [blame]

477

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

478

# with this key.

479

"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]

480

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

481

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

482

# [Textual Encoding of Subject Public Key Info]

483

# (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]

488

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

489

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

490

wrapped key material provided in the request.

491

492

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

CryptoKey.

Args:

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

497

be imported into. (required)

498

body: object, The request body.

499

The object takes the form of:

500

501

{ # Request message for KeyManagementService.ImportCryptoKeyVersion.

Bu Sun Kim

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

[diff] [blame]

502

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

Dan O'Meara

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

[diff] [blame]

503

# RSA_OAEP_3072_SHA1_AES_256

504

# or

505

# RSA_OAEP_4096_SHA1_AES_256.

506

#

507

# This field contains the concatenation of two wrapped keys:

508

# <ol>

509

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

510

# public_key using RSAES-OAEP with SHA-1,

511

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

512

# </li>

513

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

514

# using AES-KWP (RFC 5649).

# </li>

# </ol>

#

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

519

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

520

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

521

# PrivateKeyInfo structure from RFC 5208).

522

#

523

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

524

# CKM_RSA_AES_KEY_WRAP.

Bu Sun Kim

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

[diff] [blame]

525

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

526

# wrap this key material.

Bu Sun Kim

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

[diff] [blame^]

527

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

528

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

529

# version_template of the CryptoKey this

530

# version imports into.

Dan O'Meara

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

[diff] [blame]

531

}

532

533

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

540

541

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

542

# associated key material.

543

#

544

# An ENABLED version can be

545

# used for cryptographic operations.

546

#

547

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

548

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

549

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

550

# Cloud KMS.

Bu Sun Kim

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

[diff] [blame]

551

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

552

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

553

# CryptoKeyVersion supports.

554

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

Dan O'Meara

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

[diff] [blame]

555

# CryptoKeyVersion. Only present if the underlying key material was

556

# imported.

Bu Sun Kim

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

[diff] [blame]

557

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

Dan O'Meara

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

[diff] [blame]

558

# configuring a CryptoKeyVersion that are specific to the

559

# EXTERNAL protection level.

560

# configuring a CryptoKeyVersion that are specific to the

561

# EXTERNAL protection level.

Bu Sun Kim

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

[diff] [blame]

562

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

Dan O'Meara

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

[diff] [blame]

563

},

Bu Sun Kim

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

[diff] [blame^]

564

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

565

# destroyed. Only present if state is

566

# DESTROYED.

567

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

568

# was imported.

569

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

570

# for destruction. Only present if state is

571

# DESTROY_SCHEDULED.

572

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

573

# state is

574

# IMPORT_FAILED.

575

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

576

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

577

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

578

"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

579

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

580

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

581

# protection_level HSM.

582

# information, see [Verifying attestations]

583

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

584

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

585

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

586

# operation was performed.

587

},

588

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

589

# generated.

590

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

591

# performed with this CryptoKeyVersion.

Dan O'Meara

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

596

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

Sai Cheemalapati

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

[diff] [blame]

597

<pre>Lists CryptoKeyVersions.

598

599

Args:

600

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

601

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

Bu Sun Kim

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

[diff] [blame^]

602

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

603

more information, see

604

[Sorting and filtering list

605

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

Bu Sun Kim

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

[diff] [blame]

606

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

607

ListCryptoKeyVersionsResponse.next_page_token.

Dan O'Meara

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

[diff] [blame]

608

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

Sai Cheemalapati

4ba8c23

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

[diff] [blame]

609

include in the response. Further CryptoKeyVersions can

610

subsequently be obtained by including the

611

ListCryptoKeyVersionsResponse.next_page_token in a subsequent request.

612

If unspecified, the server will pick an appropriate default.

Bu Sun Kim

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

[diff] [blame]

613

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

614

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

615

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

616

[Sorting and filtering list

617

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

Bu Sun Kim

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

[diff] [blame]

618

x__xgafv: string, V1 error format.

619

Allowed values

620

1 - v1 error format

621

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

622

623

Returns:

624

An object of the form:

625

626

{ # Response message for KeyManagementService.ListCryptoKeyVersions.

Bu Sun Kim

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

[diff] [blame^]

627

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

628

# ListCryptoKeyVersionsRequest.page_token to retrieve the next page of

629

# results.

630

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

631

# query.

Bu Sun Kim

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

[diff] [blame]

632

"cryptoKeyVersions": [ # The list of CryptoKeyVersions.

Sai Cheemalapati

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

[diff] [blame]

633

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

634

# associated key material.

635

#

Bu Sun Kim

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

[diff] [blame]

636

# An ENABLED version can be

637

# used for cryptographic operations.

638

#

639

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

640

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

641

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

642

# Cloud KMS.

Bu Sun Kim

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

[diff] [blame]

643

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

644

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

645

# CryptoKeyVersion supports.

646

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

Dan O'Meara

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

[diff] [blame]

647

# CryptoKeyVersion. Only present if the underlying key material was

648

# imported.

Bu Sun Kim

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

[diff] [blame]

649

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

Dan O'Meara

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

[diff] [blame]

650

# configuring a CryptoKeyVersion that are specific to the

651

# EXTERNAL protection level.

652

# configuring a CryptoKeyVersion that are specific to the

653

# EXTERNAL protection level.

Bu Sun Kim

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

[diff] [blame]

654

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

Dan O'Meara

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

[diff] [blame]

655

},

Bu Sun Kim

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

[diff] [blame^]

656

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

657

# destroyed. Only present if state is

658

# DESTROYED.

659

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

660

# was imported.

661

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

662

# for destruction. Only present if state is

663

# DESTROY_SCHEDULED.

664

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

665

# state is

666

# IMPORT_FAILED.

667

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

668

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

669

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

670

"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

671

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

672

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

673

# protection_level HSM.

674

# information, see [Verifying attestations]

675

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

676

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

677

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

678

# operation was performed.

679

},

680

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

681

# generated.

682

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

683

# performed with this CryptoKeyVersion.

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>

691

<pre>Retrieves the next page of results.

692

693

Args:

694

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

695

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

696

697

Returns:

Bu Sun Kim

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

[diff] [blame]

698

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

Sai Cheemalapati

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

[diff] [blame]

699

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]

704

<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]

705

<pre>Update a CryptoKeyVersion's metadata.

Sai Cheemalapati

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

[diff] [blame]

706

707

state may be changed between

708

ENABLED and

709

DISABLED using this

710

method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to

711

move between other states.

712

713

Args:

714

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

715

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

Dan O'Meara

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

[diff] [blame]

716

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

717

The object takes the form of:

718

719

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

720

# associated key material.

721

#

Bu Sun Kim

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

[diff] [blame]

722

# An ENABLED version can be

723

# used for cryptographic operations.

724

#

725

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

726

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

727

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

728

# Cloud KMS.

Bu Sun Kim

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

[diff] [blame]

729

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

730

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

731

# CryptoKeyVersion supports.

732

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

Dan O'Meara

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

[diff] [blame]

733

# CryptoKeyVersion. Only present if the underlying key material was

734

# imported.

Bu Sun Kim

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

[diff] [blame]

735

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

Dan O'Meara

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

[diff] [blame]

736

# configuring a CryptoKeyVersion that are specific to the

737

# EXTERNAL protection level.

738

# configuring a CryptoKeyVersion that are specific to the

739

# EXTERNAL protection level.

Bu Sun Kim

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

[diff] [blame]

740

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

Dan O'Meara

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

[diff] [blame]

741

},

Bu Sun Kim

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

[diff] [blame^]

742

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

743

# destroyed. Only present if state is

744

# DESTROYED.

745

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

746

# was imported.

747

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

748

# for destruction. Only present if state is

749

# DESTROY_SCHEDULED.

750

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

751

# state is

752

# IMPORT_FAILED.

753

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

754

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

755

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

756

"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

757

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

758

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

759

# protection_level HSM.

760

# information, see [Verifying attestations]

761

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

762

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

763

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

764

# operation was performed.

765

},

766

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

767

# generated.

768

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

769

# performed with this CryptoKeyVersion.

Sai Cheemalapati

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

[diff] [blame]

770

}

771

Dan O'Meara

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

[diff] [blame]

772

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

Sai Cheemalapati

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

[diff] [blame]

773

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

780

781

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

782

# associated key material.

783

#

Bu Sun Kim

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

[diff] [blame]

784

# An ENABLED version can be

785

# used for cryptographic operations.

786

#

787

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

788

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

789

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

790

# Cloud KMS.

Bu Sun Kim

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

[diff] [blame]

791

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

792

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

793

# CryptoKeyVersion supports.

794

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

Dan O'Meara

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

[diff] [blame]

795

# CryptoKeyVersion. Only present if the underlying key material was

796

# imported.

Bu Sun Kim

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

[diff] [blame]

797

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

Dan O'Meara

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

[diff] [blame]

798

# configuring a CryptoKeyVersion that are specific to the

799

# EXTERNAL protection level.

800

# configuring a CryptoKeyVersion that are specific to the

801

# EXTERNAL protection level.

Bu Sun Kim

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

[diff] [blame]

802

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

Dan O'Meara

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

[diff] [blame]

803

},

Bu Sun Kim

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

[diff] [blame^]

804

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

805

# destroyed. Only present if state is

806

# DESTROYED.

807

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

808

# was imported.

809

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

810

# for destruction. Only present if state is

811

# DESTROY_SCHEDULED.

812

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

813

# state is

814

# IMPORT_FAILED.

815

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

816

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

817

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

818

"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

819

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

820

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

821

# protection_level HSM.

822

# information, see [Verifying attestations]

823

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

824

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

825

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

826

# operation was performed.

827

},

828

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

829

# generated.

830

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

831

# performed with this CryptoKeyVersion.

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]

836

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

Sai Cheemalapati

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

[diff] [blame]

837

<pre>Restore a CryptoKeyVersion in the

Bu Sun Kim

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

[diff] [blame]

838

DESTROY_SCHEDULED

Sai Cheemalapati

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

[diff] [blame]

839

state.

840

841

Upon restoration of the CryptoKeyVersion, state

842

will be set to DISABLED,

843

and destroy_time will be cleared.

844

845

Args:

Dan O'Meara

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

[diff] [blame]

846

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

Bu Sun Kim

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

[diff] [blame]

847

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

848

The object takes the form of:

849

850

{ # Request message for KeyManagementService.RestoreCryptoKeyVersion.

851

}

852

853

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

860

861

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

862

# associated key material.

863

#

Bu Sun Kim

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

[diff] [blame]

864

# An ENABLED version can be

865

# used for cryptographic operations.

866

#

867

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

868

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

869

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

870

# Cloud KMS.

Bu Sun Kim

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

[diff] [blame]

871

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

872

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

873

# CryptoKeyVersion supports.

874

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

Dan O'Meara

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

[diff] [blame]

875

# CryptoKeyVersion. Only present if the underlying key material was

876

# imported.

Bu Sun Kim

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

[diff] [blame]

877

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

Dan O'Meara

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

[diff] [blame]

878

# configuring a CryptoKeyVersion that are specific to the

879

# EXTERNAL protection level.

880

# configuring a CryptoKeyVersion that are specific to the

881

# EXTERNAL protection level.

Bu Sun Kim

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

[diff] [blame]

882

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

Dan O'Meara

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

[diff] [blame]

883

},

Bu Sun Kim