@maxim_mazurok/gapi.client.cloudkms-v1 0.2.20260611 → 0.3.20260702
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +228 -18
- package/package.json +1 -1
- package/readme.md +8 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://cloudkms.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260702
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -98,10 +98,7 @@ declare namespace gapi.client {
|
|
|
98
98
|
exemptedMembers?: string[];
|
|
99
99
|
/** The log type that this config enables. */
|
|
100
100
|
logType?:
|
|
101
|
-
| '
|
|
102
|
-
| 'ADMIN_READ'
|
|
103
|
-
| 'DATA_WRITE'
|
|
104
|
-
| 'DATA_READ';
|
|
101
|
+
'LOG_TYPE_UNSPECIFIED' | 'ADMIN_READ' | 'DATA_WRITE' | 'DATA_READ';
|
|
105
102
|
}
|
|
106
103
|
interface AutokeyConfig {
|
|
107
104
|
/** Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag. */
|
|
@@ -205,7 +202,8 @@ declare namespace gapi.client {
|
|
|
205
202
|
| 'ASYMMETRIC_DECRYPT'
|
|
206
203
|
| 'RAW_ENCRYPT_DECRYPT'
|
|
207
204
|
| 'MAC'
|
|
208
|
-
| 'KEY_ENCAPSULATION'
|
|
205
|
+
| 'KEY_ENCAPSULATION'
|
|
206
|
+
| 'AES_WRAPPING';
|
|
209
207
|
/** next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. */
|
|
210
208
|
rotationPeriod?: string;
|
|
211
209
|
/** A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template. */
|
|
@@ -260,7 +258,8 @@ declare namespace gapi.client {
|
|
|
260
258
|
| 'PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256'
|
|
261
259
|
| 'PQ_SIGN_ML_DSA_44_EXTERNAL_MU'
|
|
262
260
|
| 'PQ_SIGN_ML_DSA_65_EXTERNAL_MU'
|
|
263
|
-
| 'PQ_SIGN_ML_DSA_87_EXTERNAL_MU'
|
|
261
|
+
| 'PQ_SIGN_ML_DSA_87_EXTERNAL_MU'
|
|
262
|
+
| 'AES_256_KWP';
|
|
264
263
|
/** Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM. */
|
|
265
264
|
attestation?: KeyOperationAttestation;
|
|
266
265
|
/** Output only. The time at which this CryptoKeyVersion was created. */
|
|
@@ -277,6 +276,8 @@ declare namespace gapi.client {
|
|
|
277
276
|
generateTime?: string;
|
|
278
277
|
/** Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. */
|
|
279
278
|
generationFailureReason?: string;
|
|
279
|
+
/** Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. */
|
|
280
|
+
hsmTrusted?: boolean;
|
|
280
281
|
/** Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. */
|
|
281
282
|
importFailureReason?: string;
|
|
282
283
|
/** Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. */
|
|
@@ -308,6 +309,8 @@ declare namespace gapi.client {
|
|
|
308
309
|
| 'GENERATION_FAILED'
|
|
309
310
|
| 'PENDING_EXTERNAL_DESTRUCTION'
|
|
310
311
|
| 'EXTERNAL_DESTRUCTION_FAILED';
|
|
312
|
+
/** Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. */
|
|
313
|
+
trustedWrappingEnabled?: boolean;
|
|
311
314
|
}
|
|
312
315
|
interface CryptoKeyVersionTemplate {
|
|
313
316
|
/** Required. Algorithm to use when creating a CryptoKeyVersion based on this template. For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted and CryptoKey.purpose is ENCRYPT_DECRYPT. */
|
|
@@ -358,7 +361,8 @@ declare namespace gapi.client {
|
|
|
358
361
|
| 'PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256'
|
|
359
362
|
| 'PQ_SIGN_ML_DSA_44_EXTERNAL_MU'
|
|
360
363
|
| 'PQ_SIGN_ML_DSA_65_EXTERNAL_MU'
|
|
361
|
-
| 'PQ_SIGN_ML_DSA_87_EXTERNAL_MU'
|
|
364
|
+
| 'PQ_SIGN_ML_DSA_87_EXTERNAL_MU'
|
|
365
|
+
| 'AES_256_KWP';
|
|
362
366
|
/** ProtectionLevel to use when creating a CryptoKeyVersion based on this template. Immutable. Defaults to SOFTWARE. */
|
|
363
367
|
protectionLevel?:
|
|
364
368
|
| 'PROTECTION_LEVEL_UNSPECIFIED'
|
|
@@ -446,9 +450,7 @@ declare namespace gapi.client {
|
|
|
446
450
|
etag?: string;
|
|
447
451
|
/** Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL. */
|
|
448
452
|
keyManagementMode?:
|
|
449
|
-
| '
|
|
450
|
-
| 'MANUAL'
|
|
451
|
-
| 'CLOUD_KMS';
|
|
453
|
+
'KEY_MANAGEMENT_MODE_UNSPECIFIED' | 'MANUAL' | 'CLOUD_KMS';
|
|
452
454
|
/** Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`. */
|
|
453
455
|
name?: string;
|
|
454
456
|
/** Optional. A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. */
|
|
@@ -487,6 +489,12 @@ declare namespace gapi.client {
|
|
|
487
489
|
verifiedPlaintextCrc32c?: boolean;
|
|
488
490
|
}
|
|
489
491
|
interface ExecuteSingleTenantHsmInstanceProposalRequest {}
|
|
492
|
+
interface ExportTrustedKeyWrappedCryptoKeyVersionResponse {
|
|
493
|
+
/** The wrapped key material. */
|
|
494
|
+
wrappedKey?: string;
|
|
495
|
+
/** Integrity verification field. A CRC32C checksum of the returned ExportTrustedKeyWrappedCryptoKeyVersionResponse.wrapped_key. An integrity check of ExportTrustedKeyWrappedCryptoKeyVersionResponse.wrapped_key can be performed by computing the CRC32C checksum of ExportTrustedKeyWrappedCryptoKeyVersionResponse.wrapped_key and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. */
|
|
496
|
+
wrappedKeyCrc32c?: string;
|
|
497
|
+
}
|
|
490
498
|
interface Expr {
|
|
491
499
|
/** Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */
|
|
492
500
|
description?: string;
|
|
@@ -498,9 +506,11 @@ declare namespace gapi.client {
|
|
|
498
506
|
title?: string;
|
|
499
507
|
}
|
|
500
508
|
interface ExternalProtectionLevelOptions {
|
|
501
|
-
/** The
|
|
509
|
+
/** Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. */
|
|
510
|
+
ekmConnectionBackendOverride?: string;
|
|
511
|
+
/** Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. */
|
|
502
512
|
ekmConnectionKeyPath?: string;
|
|
503
|
-
/** The URI for an external resource that this CryptoKeyVersion represents. */
|
|
513
|
+
/** Optional. The URI for an external resource that this CryptoKeyVersion represents. */
|
|
504
514
|
externalKeyUri?: string;
|
|
505
515
|
}
|
|
506
516
|
interface GenerateRandomBytesRequest {
|
|
@@ -570,13 +580,16 @@ declare namespace gapi.client {
|
|
|
570
580
|
| 'PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256'
|
|
571
581
|
| 'PQ_SIGN_ML_DSA_44_EXTERNAL_MU'
|
|
572
582
|
| 'PQ_SIGN_ML_DSA_65_EXTERNAL_MU'
|
|
573
|
-
| 'PQ_SIGN_ML_DSA_87_EXTERNAL_MU'
|
|
583
|
+
| 'PQ_SIGN_ML_DSA_87_EXTERNAL_MU'
|
|
584
|
+
| 'AES_256_KWP';
|
|
574
585
|
/** Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created. If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportCryptoKeyVersionRequest.parent, have been previously created via ImportCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material. */
|
|
575
586
|
cryptoKeyVersion?: string;
|
|
576
587
|
/** Required. The name of the ImportJob that was used to wrap this key material. */
|
|
577
588
|
importJob?: string;
|
|
578
589
|
/** Optional. This field has the same meaning as wrapped_key. Prefer to use that field in new work. Either that field or this field (but not both) must be specified. */
|
|
579
590
|
rsaAesWrappedKey?: string;
|
|
591
|
+
/** Optional. Whether trusted wrapping will be enabled on the imported [CryptoKeyVersion]. This field is only supported for keys with CryptoKeyVersionTemplate.protection_level HSM_SINGLE_TENANT. This field is supported for all CryptoKeyPurposes besides ENCRYPT_DECRYPT. */
|
|
592
|
+
trustedWrappingEnabled?: boolean;
|
|
580
593
|
/** Optional. The wrapped key material to import. Before wrapping, key material must be formatted. If importing symmetric key material, the expected key material format is plain bytes. If importing asymmetric key material, the expected key material format is PKCS#8-encoded DER (the PrivateKeyInfo structure from RFC 5208). When wrapping with import methods (RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256 or RSA_OAEP_3072_SHA256_AES_256 or RSA_OAEP_4096_SHA256_AES_256), this field must contain the concatenation of: 1. An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty label. 2. The formatted key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. When wrapping with import methods (RSA_OAEP_3072_SHA256 or RSA_OAEP_4096_SHA256), this field must contain the formatted key to be imported, wrapped with the public_key using RSAES-OAEP with SHA-256, MGF1 with SHA-256, and an empty label. */
|
|
581
594
|
wrappedKey?: string;
|
|
582
595
|
}
|
|
@@ -631,6 +644,64 @@ declare namespace gapi.client {
|
|
|
631
644
|
| 'ACTIVE'
|
|
632
645
|
| 'EXPIRED';
|
|
633
646
|
}
|
|
647
|
+
interface ImportTrustedKeyWrappedCryptoKeyVersionRequest {
|
|
648
|
+
/** Required. Required - The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into. */
|
|
649
|
+
algorithm?:
|
|
650
|
+
| 'CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED'
|
|
651
|
+
| 'GOOGLE_SYMMETRIC_ENCRYPTION'
|
|
652
|
+
| 'AES_128_GCM'
|
|
653
|
+
| 'AES_256_GCM'
|
|
654
|
+
| 'AES_128_CBC'
|
|
655
|
+
| 'AES_256_CBC'
|
|
656
|
+
| 'AES_128_CTR'
|
|
657
|
+
| 'AES_256_CTR'
|
|
658
|
+
| 'RSA_SIGN_PSS_2048_SHA256'
|
|
659
|
+
| 'RSA_SIGN_PSS_3072_SHA256'
|
|
660
|
+
| 'RSA_SIGN_PSS_4096_SHA256'
|
|
661
|
+
| 'RSA_SIGN_PSS_4096_SHA512'
|
|
662
|
+
| 'RSA_SIGN_PKCS1_2048_SHA256'
|
|
663
|
+
| 'RSA_SIGN_PKCS1_3072_SHA256'
|
|
664
|
+
| 'RSA_SIGN_PKCS1_4096_SHA256'
|
|
665
|
+
| 'RSA_SIGN_PKCS1_4096_SHA512'
|
|
666
|
+
| 'RSA_SIGN_RAW_PKCS1_2048'
|
|
667
|
+
| 'RSA_SIGN_RAW_PKCS1_3072'
|
|
668
|
+
| 'RSA_SIGN_RAW_PKCS1_4096'
|
|
669
|
+
| 'RSA_DECRYPT_OAEP_2048_SHA256'
|
|
670
|
+
| 'RSA_DECRYPT_OAEP_3072_SHA256'
|
|
671
|
+
| 'RSA_DECRYPT_OAEP_4096_SHA256'
|
|
672
|
+
| 'RSA_DECRYPT_OAEP_4096_SHA512'
|
|
673
|
+
| 'RSA_DECRYPT_OAEP_2048_SHA1'
|
|
674
|
+
| 'RSA_DECRYPT_OAEP_3072_SHA1'
|
|
675
|
+
| 'RSA_DECRYPT_OAEP_4096_SHA1'
|
|
676
|
+
| 'EC_SIGN_P256_SHA256'
|
|
677
|
+
| 'EC_SIGN_P384_SHA384'
|
|
678
|
+
| 'EC_SIGN_SECP256K1_SHA256'
|
|
679
|
+
| 'EC_SIGN_ED25519'
|
|
680
|
+
| 'HMAC_SHA256'
|
|
681
|
+
| 'HMAC_SHA1'
|
|
682
|
+
| 'HMAC_SHA384'
|
|
683
|
+
| 'HMAC_SHA512'
|
|
684
|
+
| 'HMAC_SHA224'
|
|
685
|
+
| 'EXTERNAL_SYMMETRIC_ENCRYPTION'
|
|
686
|
+
| 'ML_KEM_768'
|
|
687
|
+
| 'ML_KEM_1024'
|
|
688
|
+
| 'KEM_XWING'
|
|
689
|
+
| 'PQ_SIGN_ML_DSA_44'
|
|
690
|
+
| 'PQ_SIGN_ML_DSA_65'
|
|
691
|
+
| 'PQ_SIGN_ML_DSA_87'
|
|
692
|
+
| 'PQ_SIGN_SLH_DSA_SHA2_128S'
|
|
693
|
+
| 'PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256'
|
|
694
|
+
| 'PQ_SIGN_ML_DSA_44_EXTERNAL_MU'
|
|
695
|
+
| 'PQ_SIGN_ML_DSA_65_EXTERNAL_MU'
|
|
696
|
+
| 'PQ_SIGN_ML_DSA_87_EXTERNAL_MU'
|
|
697
|
+
| 'AES_256_KWP';
|
|
698
|
+
/** Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created. If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportTrustedKeyWrappedCryptoKeyVersionRequest.parent, have been previously created via ImportTrustedKeyWrappedCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material */
|
|
699
|
+
cryptoKeyVersion?: string;
|
|
700
|
+
/** Required. Required - the CKV of the trusted key used to import. This can be the name of a CryptoKeyVersion or a CryptoKey. */
|
|
701
|
+
importingKey?: string;
|
|
702
|
+
/** Required. The target key pre-wrapped on premises. */
|
|
703
|
+
wrappedKey?: string;
|
|
704
|
+
}
|
|
634
705
|
interface KeyAccessJustificationsEnrollmentConfig {
|
|
635
706
|
/** Indicates whether the project has KAJ logging enabled. */
|
|
636
707
|
auditLogging?: boolean;
|
|
@@ -907,7 +978,8 @@ declare namespace gapi.client {
|
|
|
907
978
|
| 'PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256'
|
|
908
979
|
| 'PQ_SIGN_ML_DSA_44_EXTERNAL_MU'
|
|
909
980
|
| 'PQ_SIGN_ML_DSA_65_EXTERNAL_MU'
|
|
910
|
-
| 'PQ_SIGN_ML_DSA_87_EXTERNAL_MU'
|
|
981
|
+
| 'PQ_SIGN_ML_DSA_87_EXTERNAL_MU'
|
|
982
|
+
| 'AES_256_KWP';
|
|
911
983
|
/** The name of the CryptoKeyVersion public key. Provided here for verification. NOTE: This field is in Beta. */
|
|
912
984
|
name?: string;
|
|
913
985
|
/** The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). */
|
|
@@ -1085,8 +1157,16 @@ declare namespace gapi.client {
|
|
|
1085
1157
|
updateMask?: string;
|
|
1086
1158
|
}
|
|
1087
1159
|
interface ShowEffectiveAutokeyConfigResponse {
|
|
1088
|
-
/** Name of the key project configured in the
|
|
1160
|
+
/** Name of the key project configured in the ancestry of the project or folder. */
|
|
1089
1161
|
keyProject?: string;
|
|
1162
|
+
/** The KeyProjectResolutionMode for the AutokeyConfig. */
|
|
1163
|
+
keyProjectResolutionMode?:
|
|
1164
|
+
| 'KEY_PROJECT_RESOLUTION_MODE_UNSPECIFIED'
|
|
1165
|
+
| 'DEDICATED_KEY_PROJECT'
|
|
1166
|
+
| 'RESOURCE_PROJECT'
|
|
1167
|
+
| 'DISABLED';
|
|
1168
|
+
/** Source of the effective AutokeyConfig. */
|
|
1169
|
+
source?: Source;
|
|
1090
1170
|
}
|
|
1091
1171
|
interface ShowEffectiveKeyAccessJustificationsEnrollmentConfigResponse {
|
|
1092
1172
|
/** Contains the effective KeyAccessJustificationsEnrollmentConfig for external keys. */
|
|
@@ -1170,6 +1250,12 @@ declare namespace gapi.client {
|
|
|
1170
1250
|
| 'DELETED';
|
|
1171
1251
|
/** Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration. */
|
|
1172
1252
|
ttl?: string;
|
|
1253
|
+
/** Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the ACTIVE state to perform this operation. */
|
|
1254
|
+
upgradeKeyTrust?: UpgradeKeyTrust;
|
|
1255
|
+
}
|
|
1256
|
+
interface Source {
|
|
1257
|
+
/** Contains the resource name of the AutokeyConfig that is effective, for example, `folders/{FOLDER_NUMBER}` or `projects/{PROJECT_NUMBER}` or `organizations/{ORGANIZATION_NUMBER}`. */
|
|
1258
|
+
name?: string;
|
|
1173
1259
|
}
|
|
1174
1260
|
interface Status {
|
|
1175
1261
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
@@ -1191,6 +1277,12 @@ declare namespace gapi.client {
|
|
|
1191
1277
|
/** Required. The id of the child CryptoKeyVersion to use as primary. */
|
|
1192
1278
|
cryptoKeyVersionId?: string;
|
|
1193
1279
|
}
|
|
1280
|
+
interface UpgradeKeyTrust {
|
|
1281
|
+
/** Required. The name of the CryptoKeyVersion to promote. */
|
|
1282
|
+
name?: string;
|
|
1283
|
+
/** Required. The public key associated with the 2FA key that will sign the login nonce for this operation. */
|
|
1284
|
+
twoFactorPublicKeyPem?: string;
|
|
1285
|
+
}
|
|
1194
1286
|
interface VerifyConnectivityResponse {}
|
|
1195
1287
|
interface WrappingPublicKey {
|
|
1196
1288
|
/** Output only. Contains the public key, formatted according to the PublicKey.PublicKeyFormat specified in the KeyManagementService.GetImportJob request. */
|
|
@@ -1253,6 +1345,33 @@ declare namespace gapi.client {
|
|
|
1253
1345
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1254
1346
|
uploadType?: string;
|
|
1255
1347
|
}): Request<KeyAccessJustificationsPolicyConfig>;
|
|
1348
|
+
/** Returns the effective Cloud KMS Autokey configuration for a given project or folder. */
|
|
1349
|
+
showEffectiveAutokeyConfig(request?: {
|
|
1350
|
+
/** V1 error format. */
|
|
1351
|
+
'$.xgafv'?: '1' | '2';
|
|
1352
|
+
/** OAuth access token. */
|
|
1353
|
+
access_token?: string;
|
|
1354
|
+
/** Data format for response. */
|
|
1355
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1356
|
+
/** JSONP */
|
|
1357
|
+
callback?: string;
|
|
1358
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1359
|
+
fields?: string;
|
|
1360
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1361
|
+
key?: string;
|
|
1362
|
+
/** OAuth 2.0 token for the current user. */
|
|
1363
|
+
oauth_token?: string;
|
|
1364
|
+
/** Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project} * folders/{folder} */
|
|
1365
|
+
parent: string;
|
|
1366
|
+
/** Returns response with indentations and line breaks. */
|
|
1367
|
+
prettyPrint?: boolean;
|
|
1368
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1369
|
+
quotaUser?: string;
|
|
1370
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1371
|
+
upload_protocol?: string;
|
|
1372
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1373
|
+
uploadType?: string;
|
|
1374
|
+
}): Request<ShowEffectiveAutokeyConfigResponse>;
|
|
1256
1375
|
/** Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey. */
|
|
1257
1376
|
updateAutokeyConfig(request: {
|
|
1258
1377
|
/** V1 error format. */
|
|
@@ -2306,6 +2425,35 @@ declare namespace gapi.client {
|
|
|
2306
2425
|
},
|
|
2307
2426
|
body: DestroyCryptoKeyVersionRequest,
|
|
2308
2427
|
): Request<CryptoKeyVersion>;
|
|
2428
|
+
/** Exports a CryptoKeyVersion with a trusted key. The CryptoKeyVersion must have trusted_wrapping_enabled set to true. The CryptoKeyVersion of the [wrapping_key] must have the AES_WRAPPING purpose. The [wrapping_key] must have the AES_256_KWP algorithm. */
|
|
2429
|
+
exportTrustedKeyWrappedCryptoKeyVersion(request?: {
|
|
2430
|
+
/** V1 error format. */
|
|
2431
|
+
'$.xgafv'?: '1' | '2';
|
|
2432
|
+
/** OAuth access token. */
|
|
2433
|
+
access_token?: string;
|
|
2434
|
+
/** Data format for response. */
|
|
2435
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2436
|
+
/** JSONP */
|
|
2437
|
+
callback?: string;
|
|
2438
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2439
|
+
fields?: string;
|
|
2440
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2441
|
+
key?: string;
|
|
2442
|
+
/** Required. The name of the CryptoKeyVersion to export. The CryptoKeyVersion must have trusted_wrapping_enabled set to true. */
|
|
2443
|
+
name: string;
|
|
2444
|
+
/** OAuth 2.0 token for the current user. */
|
|
2445
|
+
oauth_token?: string;
|
|
2446
|
+
/** Returns response with indentations and line breaks. */
|
|
2447
|
+
prettyPrint?: boolean;
|
|
2448
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2449
|
+
quotaUser?: string;
|
|
2450
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2451
|
+
upload_protocol?: string;
|
|
2452
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2453
|
+
uploadType?: string;
|
|
2454
|
+
/** Required. The name of the CryptoKeyVersion to use as a wrapping key. The CryptoKeyVersion must have hsm_trusted set to true. */
|
|
2455
|
+
wrappingKey?: string;
|
|
2456
|
+
}): Request<ExportTrustedKeyWrappedCryptoKeyVersionResponse>;
|
|
2309
2457
|
/** Returns metadata for a given CryptoKeyVersion. */
|
|
2310
2458
|
get(request?: {
|
|
2311
2459
|
/** V1 error format. */
|
|
@@ -2425,6 +2573,64 @@ declare namespace gapi.client {
|
|
|
2425
2573
|
},
|
|
2426
2574
|
body: ImportCryptoKeyVersionRequest,
|
|
2427
2575
|
): Request<CryptoKeyVersion>;
|
|
2576
|
+
/** Import wrapped key material into a CryptoKeyVersion with a trusted key. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey. The CryptoKeyVersion will have trusted_wrapping_enabled set to true. */
|
|
2577
|
+
importTrustedKeyWrappedCryptoKeyVersion(request: {
|
|
2578
|
+
/** V1 error format. */
|
|
2579
|
+
'$.xgafv'?: '1' | '2';
|
|
2580
|
+
/** OAuth access token. */
|
|
2581
|
+
access_token?: string;
|
|
2582
|
+
/** Data format for response. */
|
|
2583
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2584
|
+
/** JSONP */
|
|
2585
|
+
callback?: string;
|
|
2586
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2587
|
+
fields?: string;
|
|
2588
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2589
|
+
key?: string;
|
|
2590
|
+
/** OAuth 2.0 token for the current user. */
|
|
2591
|
+
oauth_token?: string;
|
|
2592
|
+
/** Required. The name of the CryptoKey to be imported into. */
|
|
2593
|
+
parent: string;
|
|
2594
|
+
/** Returns response with indentations and line breaks. */
|
|
2595
|
+
prettyPrint?: boolean;
|
|
2596
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2597
|
+
quotaUser?: string;
|
|
2598
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2599
|
+
upload_protocol?: string;
|
|
2600
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2601
|
+
uploadType?: string;
|
|
2602
|
+
/** Request body */
|
|
2603
|
+
resource: ImportTrustedKeyWrappedCryptoKeyVersionRequest;
|
|
2604
|
+
}): Request<CryptoKeyVersion>;
|
|
2605
|
+
importTrustedKeyWrappedCryptoKeyVersion(
|
|
2606
|
+
request: {
|
|
2607
|
+
/** V1 error format. */
|
|
2608
|
+
'$.xgafv'?: '1' | '2';
|
|
2609
|
+
/** OAuth access token. */
|
|
2610
|
+
access_token?: string;
|
|
2611
|
+
/** Data format for response. */
|
|
2612
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2613
|
+
/** JSONP */
|
|
2614
|
+
callback?: string;
|
|
2615
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2616
|
+
fields?: string;
|
|
2617
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2618
|
+
key?: string;
|
|
2619
|
+
/** OAuth 2.0 token for the current user. */
|
|
2620
|
+
oauth_token?: string;
|
|
2621
|
+
/** Required. The name of the CryptoKey to be imported into. */
|
|
2622
|
+
parent: string;
|
|
2623
|
+
/** Returns response with indentations and line breaks. */
|
|
2624
|
+
prettyPrint?: boolean;
|
|
2625
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2626
|
+
quotaUser?: string;
|
|
2627
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2628
|
+
upload_protocol?: string;
|
|
2629
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2630
|
+
uploadType?: string;
|
|
2631
|
+
},
|
|
2632
|
+
body: ImportTrustedKeyWrappedCryptoKeyVersionRequest,
|
|
2633
|
+
): Request<CryptoKeyVersion>;
|
|
2428
2634
|
/** Lists CryptoKeyVersions. */
|
|
2429
2635
|
list(request?: {
|
|
2430
2636
|
/** V1 error format. */
|
|
@@ -2842,6 +3048,8 @@ declare namespace gapi.client {
|
|
|
2842
3048
|
quotaUser?: string;
|
|
2843
3049
|
/** If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey. */
|
|
2844
3050
|
skipInitialVersionCreation?: boolean;
|
|
3051
|
+
/** Optional. Whether trusted wrapping will be enabled on the first CryptoKeyVersions created for this CryptoKey. This field is only supported for keys with CryptoKeyVersionTemplate.protection_level HSM_SINGLE_TENANT. This field is supported for all CryptoKeyPurposes except ENCRYPT_DECRYPT. */
|
|
3052
|
+
trustedWrappingEnabled?: boolean;
|
|
2845
3053
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2846
3054
|
upload_protocol?: string;
|
|
2847
3055
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -2875,6 +3083,8 @@ declare namespace gapi.client {
|
|
|
2875
3083
|
quotaUser?: string;
|
|
2876
3084
|
/** If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey. */
|
|
2877
3085
|
skipInitialVersionCreation?: boolean;
|
|
3086
|
+
/** Optional. Whether trusted wrapping will be enabled on the first CryptoKeyVersions created for this CryptoKey. This field is only supported for keys with CryptoKeyVersionTemplate.protection_level HSM_SINGLE_TENANT. This field is supported for all CryptoKeyPurposes except ENCRYPT_DECRYPT. */
|
|
3087
|
+
trustedWrappingEnabled?: boolean;
|
|
2878
3088
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2879
3089
|
upload_protocol?: string;
|
|
2880
3090
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -4501,7 +4711,7 @@ declare namespace gapi.client {
|
|
|
4501
4711
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4502
4712
|
uploadType?: string;
|
|
4503
4713
|
}): Request<KeyAccessJustificationsPolicyConfig>;
|
|
4504
|
-
/** Returns the effective Cloud KMS Autokey configuration for a given project. */
|
|
4714
|
+
/** Returns the effective Cloud KMS Autokey configuration for a given project or folder. */
|
|
4505
4715
|
showEffectiveAutokeyConfig(request?: {
|
|
4506
4716
|
/** V1 error format. */
|
|
4507
4717
|
'$.xgafv'?: '1' | '2';
|
|
@@ -4517,7 +4727,7 @@ declare namespace gapi.client {
|
|
|
4517
4727
|
key?: string;
|
|
4518
4728
|
/** OAuth 2.0 token for the current user. */
|
|
4519
4729
|
oauth_token?: string;
|
|
4520
|
-
/** Required. Name of the resource project to the
|
|
4730
|
+
/** Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project} * folders/{folder} */
|
|
4521
4731
|
parent: string;
|
|
4522
4732
|
/** Returns response with indentations and line breaks. */
|
|
4523
4733
|
prettyPrint?: boolean;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -94,6 +94,13 @@ Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, o
|
|
|
94
94
|
*/
|
|
95
95
|
await gapi.client.cloudkms.folders.getKajPolicyConfig({name: 'name'});
|
|
96
96
|
|
|
97
|
+
/*
|
|
98
|
+
Returns the effective Cloud KMS Autokey configuration for a given project or folder.
|
|
99
|
+
*/
|
|
100
|
+
await gapi.client.cloudkms.folders.showEffectiveAutokeyConfig({
|
|
101
|
+
parent: 'parent',
|
|
102
|
+
});
|
|
103
|
+
|
|
97
104
|
/*
|
|
98
105
|
Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.
|
|
99
106
|
*/
|
|
@@ -125,7 +132,7 @@ Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, o
|
|
|
125
132
|
await gapi.client.cloudkms.projects.getKajPolicyConfig({name: 'name'});
|
|
126
133
|
|
|
127
134
|
/*
|
|
128
|
-
Returns the effective Cloud KMS Autokey configuration for a given project.
|
|
135
|
+
Returns the effective Cloud KMS Autokey configuration for a given project or folder.
|
|
129
136
|
*/
|
|
130
137
|
await gapi.client.cloudkms.projects.showEffectiveAutokeyConfig({
|
|
131
138
|
parent: 'parent',
|