@ibm-cloud/secrets-manager 2.0.3 → 2.0.5
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/CHANGELOG.md +4 -0
- package/README.md +1 -2
- package/examples/secrets-manager.v2.test.js +15 -26
- package/package.json +2 -2
- package/secrets-manager/v2.d.ts +821 -293
- package/secrets-manager/v2.js +138 -78
- package/secrets-manager/v2.js.map +1 -1
package/secrets-manager/v2.d.ts
CHANGED
|
@@ -201,6 +201,18 @@ declare class SecretsManagerV2 extends BaseService {
|
|
|
201
201
|
*
|
|
202
202
|
* **Usage:** To retrieve a list of secrets that are associated with an existing secret group or the default group,
|
|
203
203
|
* use `..?groups={secret_group_ID},default`.
|
|
204
|
+
* @param {string[]} [params.secretTypes] - Filter secrets by types.
|
|
205
|
+
*
|
|
206
|
+
* You can apply multiple filters by using a comma-separated list of secret types.
|
|
207
|
+
*
|
|
208
|
+
* **Usage:** To retrieve a list of imported certificates and public certificates use
|
|
209
|
+
* `..?secret_types=imported_cert,public_cert`.
|
|
210
|
+
* @param {string[]} [params.matchAllLabels] - Filter secrets by labels.
|
|
211
|
+
*
|
|
212
|
+
* You can use a comma-separated list of labels to filter secrets that include all of the labels in the list.
|
|
213
|
+
*
|
|
214
|
+
* **Usage:** To retrieve a list of secrets that include both the label "dev" and the label "us-south" in their list
|
|
215
|
+
* of labels, use `..?labels=dev,us-south`.
|
|
204
216
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
205
217
|
* @returns {Promise<SecretsManagerV2.Response<SecretsManagerV2.SecretMetadataPaginatedCollection>>}
|
|
206
218
|
*/
|
|
@@ -650,6 +662,13 @@ declare class SecretsManagerV2 extends BaseService {
|
|
|
650
662
|
*
|
|
651
663
|
* **Usage:** If you want to list only the configurations that contain the string `text`, use
|
|
652
664
|
* `../configurations?search=text`.
|
|
665
|
+
* @param {string[]} [params.secretTypes] - Filter configurations by secret types, iam_credentials, public_cert or
|
|
666
|
+
* private_cert.
|
|
667
|
+
*
|
|
668
|
+
* You can apply multiple filters by using a comma-separated list of secret types.
|
|
669
|
+
*
|
|
670
|
+
* **Usage:** To retrieve a list of configurations that are associated with all secret types, use
|
|
671
|
+
* `..?secret_types=iam_credentials,public_cert,private_cert`.
|
|
653
672
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
654
673
|
* @returns {Promise<SecretsManagerV2.Response<SecretsManagerV2.ConfigurationMetadataPaginatedCollection>>}
|
|
655
674
|
*/
|
|
@@ -893,8 +912,38 @@ declare namespace SecretsManagerV2 {
|
|
|
893
912
|
* use `..?groups={secret_group_ID},default`.
|
|
894
913
|
*/
|
|
895
914
|
groups?: string[];
|
|
915
|
+
/** Filter secrets by types.
|
|
916
|
+
*
|
|
917
|
+
* You can apply multiple filters by using a comma-separated list of secret types.
|
|
918
|
+
*
|
|
919
|
+
* **Usage:** To retrieve a list of imported certificates and public certificates use
|
|
920
|
+
* `..?secret_types=imported_cert,public_cert`.
|
|
921
|
+
*/
|
|
922
|
+
secretTypes?: ListSecretsConstants.SecretTypes[] | string[];
|
|
923
|
+
/** Filter secrets by labels.
|
|
924
|
+
*
|
|
925
|
+
* You can use a comma-separated list of labels to filter secrets that include all of the labels in the list.
|
|
926
|
+
*
|
|
927
|
+
* **Usage:** To retrieve a list of secrets that include both the label "dev" and the label "us-south" in their
|
|
928
|
+
* list of labels, use `..?labels=dev,us-south`.
|
|
929
|
+
*/
|
|
930
|
+
matchAllLabels?: string[];
|
|
896
931
|
headers?: OutgoingHttpHeaders;
|
|
897
932
|
}
|
|
933
|
+
/** Constants for the `listSecrets` operation. */
|
|
934
|
+
namespace ListSecretsConstants {
|
|
935
|
+
/** Filter secrets by types. You can apply multiple filters by using a comma-separated list of secret types. **Usage:** To retrieve a list of imported certificates and public certificates use `..?secret_types=imported_cert,public_cert`. */
|
|
936
|
+
enum SecretTypes {
|
|
937
|
+
ARBITRARY = "arbitrary",
|
|
938
|
+
IAM_CREDENTIALS = "iam_credentials",
|
|
939
|
+
IMPORTED_CERT = "imported_cert",
|
|
940
|
+
KV = "kv",
|
|
941
|
+
PRIVATE_CERT = "private_cert",
|
|
942
|
+
PUBLIC_CERT = "public_cert",
|
|
943
|
+
SERVICE_CREDENTIALS = "service_credentials",
|
|
944
|
+
USERNAME_PASSWORD = "username_password"
|
|
945
|
+
}
|
|
946
|
+
}
|
|
898
947
|
/** Parameters for the `getSecret` operation. */
|
|
899
948
|
interface GetSecretParams {
|
|
900
949
|
/** The v4 UUID that uniquely identifies your secret. */
|
|
@@ -1239,8 +1288,25 @@ declare namespace SecretsManagerV2 {
|
|
|
1239
1288
|
* `../configurations?search=text`.
|
|
1240
1289
|
*/
|
|
1241
1290
|
search?: string;
|
|
1291
|
+
/** Filter configurations by secret types, iam_credentials, public_cert or private_cert.
|
|
1292
|
+
*
|
|
1293
|
+
* You can apply multiple filters by using a comma-separated list of secret types.
|
|
1294
|
+
*
|
|
1295
|
+
* **Usage:** To retrieve a list of configurations that are associated with all secret types, use
|
|
1296
|
+
* `..?secret_types=iam_credentials,public_cert,private_cert`.
|
|
1297
|
+
*/
|
|
1298
|
+
secretTypes?: ListConfigurationsConstants.SecretTypes[] | string[];
|
|
1242
1299
|
headers?: OutgoingHttpHeaders;
|
|
1243
1300
|
}
|
|
1301
|
+
/** Constants for the `listConfigurations` operation. */
|
|
1302
|
+
namespace ListConfigurationsConstants {
|
|
1303
|
+
/** Filter configurations by secret types, iam_credentials, public_cert or private_cert. You can apply multiple filters by using a comma-separated list of secret types. **Usage:** To retrieve a list of configurations that are associated with all secret types, use `..?secret_types=iam_credentials,public_cert,private_cert`. */
|
|
1304
|
+
enum SecretTypes {
|
|
1305
|
+
IAM_CREDENTIALS = "iam_credentials",
|
|
1306
|
+
PRIVATE_CERT = "private_cert",
|
|
1307
|
+
PUBLIC_CERT = "public_cert"
|
|
1308
|
+
}
|
|
1309
|
+
}
|
|
1244
1310
|
/** Parameters for the `getConfiguration` operation. */
|
|
1245
1311
|
interface GetConfigurationParams {
|
|
1246
1312
|
/** The name that uniquely identifies a configuration. */
|
|
@@ -1253,13 +1319,13 @@ declare namespace SecretsManagerV2 {
|
|
|
1253
1319
|
namespace GetConfigurationConstants {
|
|
1254
1320
|
/** The configuration type of this configuration - use this header to resolve 300 error responses. */
|
|
1255
1321
|
enum XSmAcceptConfigurationType {
|
|
1256
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1257
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1258
1322
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
1259
|
-
|
|
1323
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1324
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1260
1325
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
1261
1326
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
1262
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
1327
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
1328
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
1263
1329
|
}
|
|
1264
1330
|
}
|
|
1265
1331
|
/** Parameters for the `updateConfiguration` operation. */
|
|
@@ -1275,13 +1341,13 @@ declare namespace SecretsManagerV2 {
|
|
|
1275
1341
|
namespace UpdateConfigurationConstants {
|
|
1276
1342
|
/** The configuration type of this configuration - use this header to resolve 300 error responses. */
|
|
1277
1343
|
enum XSmAcceptConfigurationType {
|
|
1278
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1279
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1280
1344
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
1281
|
-
|
|
1345
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1346
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1282
1347
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
1283
1348
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
1284
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
1349
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
1350
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
1285
1351
|
}
|
|
1286
1352
|
}
|
|
1287
1353
|
/** Parameters for the `deleteConfiguration` operation. */
|
|
@@ -1296,13 +1362,13 @@ declare namespace SecretsManagerV2 {
|
|
|
1296
1362
|
namespace DeleteConfigurationConstants {
|
|
1297
1363
|
/** The configuration type of this configuration - use this header to resolve 300 error responses. */
|
|
1298
1364
|
enum XSmAcceptConfigurationType {
|
|
1299
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1300
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1301
1365
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
1302
|
-
|
|
1366
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1367
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1303
1368
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
1304
1369
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
1305
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
1370
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
1371
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
1306
1372
|
}
|
|
1307
1373
|
}
|
|
1308
1374
|
/** Parameters for the `createConfigurationAction` operation. */
|
|
@@ -1318,13 +1384,13 @@ declare namespace SecretsManagerV2 {
|
|
|
1318
1384
|
namespace CreateConfigurationActionConstants {
|
|
1319
1385
|
/** The configuration type of this configuration - use this header to resolve 300 error responses. */
|
|
1320
1386
|
enum XSmAcceptConfigurationType {
|
|
1321
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1322
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1323
1387
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
1324
|
-
|
|
1388
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1389
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1325
1390
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
1326
1391
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
1327
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
1392
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
1393
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
1328
1394
|
}
|
|
1329
1395
|
}
|
|
1330
1396
|
/** Parameters for the `createNotificationsRegistration` operation. */
|
|
@@ -1352,7 +1418,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1352
1418
|
/*************************
|
|
1353
1419
|
* model interfaces
|
|
1354
1420
|
************************/
|
|
1355
|
-
/**
|
|
1421
|
+
/**
|
|
1422
|
+
* Issuance information that is associated with your certificate.
|
|
1423
|
+
*/
|
|
1356
1424
|
interface CertificateIssuanceInfo {
|
|
1357
1425
|
/** This parameter indicates whether the issued certificate is configured with an automatic rotation policy. */
|
|
1358
1426
|
auto_rotated?: boolean;
|
|
@@ -1393,14 +1461,18 @@ declare namespace SecretsManagerV2 {
|
|
|
1393
1461
|
}
|
|
1394
1462
|
}
|
|
1395
1463
|
}
|
|
1396
|
-
/**
|
|
1464
|
+
/**
|
|
1465
|
+
* The date and time that the certificate validity period begins and ends.
|
|
1466
|
+
*/
|
|
1397
1467
|
interface CertificateValidity {
|
|
1398
1468
|
/** The date-time format follows `RFC 3339`. */
|
|
1399
1469
|
not_before: string;
|
|
1400
1470
|
/** The date-time format follows `RFC 3339`. */
|
|
1401
1471
|
not_after: string;
|
|
1402
1472
|
}
|
|
1403
|
-
/**
|
|
1473
|
+
/**
|
|
1474
|
+
* Properties that describe a challenge.
|
|
1475
|
+
*/
|
|
1404
1476
|
interface ChallengeResource {
|
|
1405
1477
|
/** The challenge domain. */
|
|
1406
1478
|
domain?: string;
|
|
@@ -1413,19 +1485,29 @@ declare namespace SecretsManagerV2 {
|
|
|
1413
1485
|
/** The TXT record value. */
|
|
1414
1486
|
txt_record_value?: string;
|
|
1415
1487
|
}
|
|
1416
|
-
/**
|
|
1488
|
+
/**
|
|
1489
|
+
* Your configuration.
|
|
1490
|
+
*/
|
|
1417
1491
|
interface Configuration {
|
|
1418
1492
|
}
|
|
1419
|
-
/**
|
|
1493
|
+
/**
|
|
1494
|
+
* The response body to specify the properties of the action to create a configuration.
|
|
1495
|
+
*/
|
|
1420
1496
|
interface ConfigurationAction {
|
|
1421
1497
|
}
|
|
1422
|
-
/**
|
|
1498
|
+
/**
|
|
1499
|
+
* The request body to specify the properties of the action to create a configuration.
|
|
1500
|
+
*/
|
|
1423
1501
|
interface ConfigurationActionPrototype {
|
|
1424
1502
|
}
|
|
1425
|
-
/**
|
|
1503
|
+
/**
|
|
1504
|
+
* Your configuration metadata properties.
|
|
1505
|
+
*/
|
|
1426
1506
|
interface ConfigurationMetadata {
|
|
1427
1507
|
}
|
|
1428
|
-
/**
|
|
1508
|
+
/**
|
|
1509
|
+
* Properties that describe a paginated collection of secret locks.
|
|
1510
|
+
*/
|
|
1429
1511
|
interface ConfigurationMetadataPaginatedCollection {
|
|
1430
1512
|
/** The total number of resources in a collection. */
|
|
1431
1513
|
total_count: number;
|
|
@@ -1444,38 +1526,54 @@ declare namespace SecretsManagerV2 {
|
|
|
1444
1526
|
/** A collection of configuration metadata. */
|
|
1445
1527
|
configurations: ConfigurationMetadata[];
|
|
1446
1528
|
}
|
|
1447
|
-
/**
|
|
1529
|
+
/**
|
|
1530
|
+
* Your configuration update data.
|
|
1531
|
+
*/
|
|
1448
1532
|
interface ConfigurationPatch {
|
|
1449
1533
|
}
|
|
1450
|
-
/**
|
|
1534
|
+
/**
|
|
1535
|
+
* The details of your configuration.
|
|
1536
|
+
*/
|
|
1451
1537
|
interface ConfigurationPrototype {
|
|
1452
1538
|
}
|
|
1453
|
-
/**
|
|
1539
|
+
/**
|
|
1540
|
+
* The details of the Event Notifications registration.
|
|
1541
|
+
*/
|
|
1454
1542
|
interface NotificationsRegistration {
|
|
1455
1543
|
/** A CRN that uniquely identifies an IBM Cloud resource. */
|
|
1456
1544
|
event_notifications_instance_crn: string;
|
|
1457
1545
|
}
|
|
1458
|
-
/**
|
|
1546
|
+
/**
|
|
1547
|
+
* A URL that points to the first page in a collection.
|
|
1548
|
+
*/
|
|
1459
1549
|
interface PaginatedCollectionFirst {
|
|
1460
1550
|
/** A URL that points to a page in a collection. */
|
|
1461
1551
|
href: string;
|
|
1462
1552
|
}
|
|
1463
|
-
/**
|
|
1553
|
+
/**
|
|
1554
|
+
* A URL that points to the last page in a collection.
|
|
1555
|
+
*/
|
|
1464
1556
|
interface PaginatedCollectionLast {
|
|
1465
1557
|
/** A URL that points to a page in a collection. */
|
|
1466
1558
|
href: string;
|
|
1467
1559
|
}
|
|
1468
|
-
/**
|
|
1560
|
+
/**
|
|
1561
|
+
* A URL that points to the next page in a collection.
|
|
1562
|
+
*/
|
|
1469
1563
|
interface PaginatedCollectionNext {
|
|
1470
1564
|
/** A URL that points to a page in a collection. */
|
|
1471
1565
|
href: string;
|
|
1472
1566
|
}
|
|
1473
|
-
/**
|
|
1567
|
+
/**
|
|
1568
|
+
* A URL that points to the previous page in a collection.
|
|
1569
|
+
*/
|
|
1474
1570
|
interface PaginatedCollectionPrevious {
|
|
1475
1571
|
/** A URL that points to a page in a collection. */
|
|
1476
1572
|
href: string;
|
|
1477
1573
|
}
|
|
1478
|
-
/**
|
|
1574
|
+
/**
|
|
1575
|
+
* Policy for auto-generated passwords.
|
|
1576
|
+
*/
|
|
1479
1577
|
interface PasswordGenerationPolicy {
|
|
1480
1578
|
/** The length of auto-generated passwords. */
|
|
1481
1579
|
length?: number;
|
|
@@ -1486,7 +1584,10 @@ declare namespace SecretsManagerV2 {
|
|
|
1486
1584
|
/** Include uppercase letters in auto-generated passwords. */
|
|
1487
1585
|
include_uppercase?: boolean;
|
|
1488
1586
|
}
|
|
1489
|
-
/**
|
|
1587
|
+
/**
|
|
1588
|
+
* Policy patch for auto-generated passwords. Policy properties that are included in the patch are updated. Properties
|
|
1589
|
+
* that are not included in the patch remain unchanged.
|
|
1590
|
+
*/
|
|
1490
1591
|
interface PasswordGenerationPolicyPatch {
|
|
1491
1592
|
/** The length of auto-generated passwords. */
|
|
1492
1593
|
length?: number;
|
|
@@ -1497,7 +1598,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1497
1598
|
/** Include uppercase letters in auto-generated passwords. */
|
|
1498
1599
|
include_uppercase?: boolean;
|
|
1499
1600
|
}
|
|
1500
|
-
/**
|
|
1601
|
+
/**
|
|
1602
|
+
* Policy for auto-generated passwords.
|
|
1603
|
+
*/
|
|
1501
1604
|
interface PasswordGenerationPolicyRO {
|
|
1502
1605
|
/** The length of auto-generated passwords. */
|
|
1503
1606
|
length?: number;
|
|
@@ -1508,10 +1611,40 @@ declare namespace SecretsManagerV2 {
|
|
|
1508
1611
|
/** Include uppercase letters in auto-generated passwords. */
|
|
1509
1612
|
include_uppercase?: boolean;
|
|
1510
1613
|
}
|
|
1511
|
-
/**
|
|
1614
|
+
/**
|
|
1615
|
+
* The configuration data of your Private Certificate.
|
|
1616
|
+
*/
|
|
1512
1617
|
interface PrivateCertificateCAData {
|
|
1513
1618
|
}
|
|
1514
|
-
/**
|
|
1619
|
+
/**
|
|
1620
|
+
* The data that is associated with a cryptographic key.
|
|
1621
|
+
*/
|
|
1622
|
+
interface PrivateCertificateCryptoKey {
|
|
1623
|
+
/** The ID of a PKCS#11 key to use. If the key does not exist and generation is enabled, this ID is given to the
|
|
1624
|
+
* generated key. If the key exists, and generation is disabled, then this ID is used to look up the key. This
|
|
1625
|
+
* value or the crypto key label must be specified.
|
|
1626
|
+
*/
|
|
1627
|
+
id?: string;
|
|
1628
|
+
/** The label of the key to use. If the key does not exist and generation is enabled, this field is the label
|
|
1629
|
+
* that is given to the generated key. If the key exists, and generation is disabled, then this label is used to
|
|
1630
|
+
* look up the key. This value or the crypto key ID must be specified.
|
|
1631
|
+
*/
|
|
1632
|
+
label?: string;
|
|
1633
|
+
/** The indication of whether a new key is generated by the crypto provider if the given key name cannot be
|
|
1634
|
+
* found.
|
|
1635
|
+
*/
|
|
1636
|
+
allow_generate_key?: boolean;
|
|
1637
|
+
/** The data that is associated with a cryptographic provider. */
|
|
1638
|
+
provider: PrivateCertificateCryptoProvider;
|
|
1639
|
+
}
|
|
1640
|
+
/**
|
|
1641
|
+
* The data that is associated with a cryptographic provider.
|
|
1642
|
+
*/
|
|
1643
|
+
interface PrivateCertificateCryptoProvider {
|
|
1644
|
+
}
|
|
1645
|
+
/**
|
|
1646
|
+
* Defines the rotation object that is used to manually rotate public certificates.
|
|
1647
|
+
*/
|
|
1515
1648
|
interface PublicCertificateRotationObject {
|
|
1516
1649
|
/** This field indicates whether Secrets Manager rotates the private key for your public certificate
|
|
1517
1650
|
* automatically.
|
|
@@ -1521,19 +1654,30 @@ declare namespace SecretsManagerV2 {
|
|
|
1521
1654
|
*/
|
|
1522
1655
|
rotate_keys?: boolean;
|
|
1523
1656
|
}
|
|
1524
|
-
/**
|
|
1657
|
+
/**
|
|
1658
|
+
* This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
1659
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
1660
|
+
*/
|
|
1525
1661
|
interface RotationPolicy {
|
|
1526
1662
|
}
|
|
1527
|
-
/**
|
|
1663
|
+
/**
|
|
1664
|
+
* Your secret.
|
|
1665
|
+
*/
|
|
1528
1666
|
interface Secret {
|
|
1529
1667
|
}
|
|
1530
|
-
/**
|
|
1668
|
+
/**
|
|
1669
|
+
* The response body to specify the properties of the action to create a secret.
|
|
1670
|
+
*/
|
|
1531
1671
|
interface SecretAction {
|
|
1532
1672
|
}
|
|
1533
|
-
/**
|
|
1673
|
+
/**
|
|
1674
|
+
* The request body to specify the properties for your secret action.
|
|
1675
|
+
*/
|
|
1534
1676
|
interface SecretActionPrototype {
|
|
1535
1677
|
}
|
|
1536
|
-
/**
|
|
1678
|
+
/**
|
|
1679
|
+
* Properties that describe a secret group.
|
|
1680
|
+
*/
|
|
1537
1681
|
interface SecretGroup {
|
|
1538
1682
|
/** A v4 UUID identifier, or `default` secret group. */
|
|
1539
1683
|
id: string;
|
|
@@ -1552,14 +1696,18 @@ declare namespace SecretsManagerV2 {
|
|
|
1552
1696
|
/** The date when a resource was modified. The date format follows `RFC 3339`. */
|
|
1553
1697
|
updated_at: string;
|
|
1554
1698
|
}
|
|
1555
|
-
/**
|
|
1699
|
+
/**
|
|
1700
|
+
* Properties that describe a collection of secret groups.
|
|
1701
|
+
*/
|
|
1556
1702
|
interface SecretGroupCollection {
|
|
1557
1703
|
/** A collection of secret groups. */
|
|
1558
1704
|
secret_groups: SecretGroup[];
|
|
1559
1705
|
/** The total number of resources in a collection. */
|
|
1560
1706
|
total_count: number;
|
|
1561
1707
|
}
|
|
1562
|
-
/**
|
|
1708
|
+
/**
|
|
1709
|
+
* SecretLock.
|
|
1710
|
+
*/
|
|
1563
1711
|
interface SecretLock {
|
|
1564
1712
|
/** A human-readable name to assign to the lock. The lock name must be unique per secret version.
|
|
1565
1713
|
*
|
|
@@ -1601,7 +1749,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1601
1749
|
}
|
|
1602
1750
|
}
|
|
1603
1751
|
}
|
|
1604
|
-
/**
|
|
1752
|
+
/**
|
|
1753
|
+
* SecretLockPrototype.
|
|
1754
|
+
*/
|
|
1605
1755
|
interface SecretLockPrototype {
|
|
1606
1756
|
/** A human-readable name to assign to the lock. The lock name must be unique per secret version.
|
|
1607
1757
|
*
|
|
@@ -1618,7 +1768,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1618
1768
|
/** Optional information to associate with a lock, such as resources CRNs to be used by automation. */
|
|
1619
1769
|
attributes?: JsonObject;
|
|
1620
1770
|
}
|
|
1621
|
-
/**
|
|
1771
|
+
/**
|
|
1772
|
+
* Create locks response body containing a collection of locks that are attached to a secret.
|
|
1773
|
+
*/
|
|
1622
1774
|
interface SecretLocks {
|
|
1623
1775
|
/** A v4 UUID identifier. */
|
|
1624
1776
|
secret_id: string;
|
|
@@ -1648,7 +1800,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1648
1800
|
}
|
|
1649
1801
|
}
|
|
1650
1802
|
}
|
|
1651
|
-
/**
|
|
1803
|
+
/**
|
|
1804
|
+
* Properties that describe a paginated collection of your secret locks.
|
|
1805
|
+
*/
|
|
1652
1806
|
interface SecretLocksPaginatedCollection {
|
|
1653
1807
|
/** The total number of resources in a collection. */
|
|
1654
1808
|
total_count: number;
|
|
@@ -1667,10 +1821,14 @@ declare namespace SecretsManagerV2 {
|
|
|
1667
1821
|
/** A collection of secret locks. */
|
|
1668
1822
|
locks: SecretLock[];
|
|
1669
1823
|
}
|
|
1670
|
-
/**
|
|
1824
|
+
/**
|
|
1825
|
+
* Properties of your secret metadata.
|
|
1826
|
+
*/
|
|
1671
1827
|
interface SecretMetadata {
|
|
1672
1828
|
}
|
|
1673
|
-
/**
|
|
1829
|
+
/**
|
|
1830
|
+
* Properties that describe a paginated collection of your secret metadata.
|
|
1831
|
+
*/
|
|
1674
1832
|
interface SecretMetadataPaginatedCollection {
|
|
1675
1833
|
/** The total number of resources in a collection. */
|
|
1676
1834
|
total_count: number;
|
|
@@ -1689,19 +1847,29 @@ declare namespace SecretsManagerV2 {
|
|
|
1689
1847
|
/** A collection of secret metadata. */
|
|
1690
1848
|
secrets: SecretMetadata[];
|
|
1691
1849
|
}
|
|
1692
|
-
/**
|
|
1850
|
+
/**
|
|
1851
|
+
* Update your secret metadata.
|
|
1852
|
+
*/
|
|
1693
1853
|
interface SecretMetadataPatch {
|
|
1694
1854
|
}
|
|
1695
|
-
/**
|
|
1855
|
+
/**
|
|
1856
|
+
* Specify the properties for your secret.
|
|
1857
|
+
*/
|
|
1696
1858
|
interface SecretPrototype {
|
|
1697
1859
|
}
|
|
1698
|
-
/**
|
|
1860
|
+
/**
|
|
1861
|
+
* Your secret version.
|
|
1862
|
+
*/
|
|
1699
1863
|
interface SecretVersion {
|
|
1700
1864
|
}
|
|
1701
|
-
/**
|
|
1865
|
+
/**
|
|
1866
|
+
* The request body to specify the properties of the action to create a secret version.
|
|
1867
|
+
*/
|
|
1702
1868
|
interface SecretVersionActionPrototype {
|
|
1703
1869
|
}
|
|
1704
|
-
/**
|
|
1870
|
+
/**
|
|
1871
|
+
* SecretVersionLocks.
|
|
1872
|
+
*/
|
|
1705
1873
|
interface SecretVersionLocks {
|
|
1706
1874
|
/** A v4 UUID identifier. */
|
|
1707
1875
|
version_id: string;
|
|
@@ -1723,7 +1891,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1723
1891
|
}
|
|
1724
1892
|
}
|
|
1725
1893
|
}
|
|
1726
|
-
/**
|
|
1894
|
+
/**
|
|
1895
|
+
* Properties that describe a paginated collection of your secret version locks.
|
|
1896
|
+
*/
|
|
1727
1897
|
interface SecretVersionLocksPaginatedCollection {
|
|
1728
1898
|
/** The total number of resources in a collection. */
|
|
1729
1899
|
total_count: number;
|
|
@@ -1742,20 +1912,28 @@ declare namespace SecretsManagerV2 {
|
|
|
1742
1912
|
/** A collection of secret version locks. */
|
|
1743
1913
|
locks: SecretLock[];
|
|
1744
1914
|
}
|
|
1745
|
-
/**
|
|
1915
|
+
/**
|
|
1916
|
+
* Properties of the version metadata of your secret.
|
|
1917
|
+
*/
|
|
1746
1918
|
interface SecretVersionMetadata {
|
|
1747
1919
|
}
|
|
1748
|
-
/**
|
|
1920
|
+
/**
|
|
1921
|
+
* Properties that describe a collection of your secret version metadata.
|
|
1922
|
+
*/
|
|
1749
1923
|
interface SecretVersionMetadataCollection {
|
|
1750
1924
|
/** A collection of secret version metadata. */
|
|
1751
1925
|
versions: SecretVersionMetadata[];
|
|
1752
1926
|
/** The total number of resources in a collection. */
|
|
1753
1927
|
total_count: number;
|
|
1754
1928
|
}
|
|
1755
|
-
/**
|
|
1929
|
+
/**
|
|
1930
|
+
* Specify the properties for your new secret version.
|
|
1931
|
+
*/
|
|
1756
1932
|
interface SecretVersionPrototype {
|
|
1757
1933
|
}
|
|
1758
|
-
/**
|
|
1934
|
+
/**
|
|
1935
|
+
* Properties that describe a paginated collection of your secrets locks.
|
|
1936
|
+
*/
|
|
1759
1937
|
interface SecretsLocksPaginatedCollection {
|
|
1760
1938
|
/** The total number of resources in a collection. */
|
|
1761
1939
|
total_count: number;
|
|
@@ -1774,14 +1952,20 @@ declare namespace SecretsManagerV2 {
|
|
|
1774
1952
|
/** A collection of secrets and their locks. */
|
|
1775
1953
|
secrets_locks: SecretLocks[];
|
|
1776
1954
|
}
|
|
1777
|
-
/**
|
|
1955
|
+
/**
|
|
1956
|
+
* The source service resource key data of the generated service credentials.
|
|
1957
|
+
*/
|
|
1778
1958
|
interface ServiceCredentialsResourceKey {
|
|
1779
1959
|
/** The resource key CRN of the generated service credentials. */
|
|
1780
1960
|
crn?: string;
|
|
1781
1961
|
/** The resource key name of the generated service credentials. */
|
|
1782
1962
|
name?: string;
|
|
1783
1963
|
}
|
|
1784
|
-
/**
|
|
1964
|
+
/**
|
|
1965
|
+
* The properties of the service credentials secret payload.
|
|
1966
|
+
*
|
|
1967
|
+
* This type supports additional properties of type any.
|
|
1968
|
+
*/
|
|
1785
1969
|
interface ServiceCredentialsSecretCredentials {
|
|
1786
1970
|
/** The API key that is generated for this secret.
|
|
1787
1971
|
*
|
|
@@ -1799,10 +1983,14 @@ declare namespace SecretsManagerV2 {
|
|
|
1799
1983
|
iam_role_crn?: string;
|
|
1800
1984
|
/** The IAM Service ID CRN. */
|
|
1801
1985
|
iam_serviceid_crn?: string;
|
|
1802
|
-
/**
|
|
1986
|
+
/**
|
|
1987
|
+
* ServiceCredentialsSecretCredentials accepts additional properties of type any.
|
|
1988
|
+
*/
|
|
1803
1989
|
[propName: string]: any;
|
|
1804
1990
|
}
|
|
1805
|
-
/**
|
|
1991
|
+
/**
|
|
1992
|
+
* The properties that are required to create the service credentials for the specified source service instance.
|
|
1993
|
+
*/
|
|
1806
1994
|
interface ServiceCredentialsSecretSourceService {
|
|
1807
1995
|
/** The source service instance identifier. */
|
|
1808
1996
|
instance: ServiceCredentialsSourceServiceInstance;
|
|
@@ -1819,7 +2007,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1819
2007
|
*/
|
|
1820
2008
|
role?: ServiceCredentialsSourceServiceRole;
|
|
1821
2009
|
}
|
|
1822
|
-
/**
|
|
2010
|
+
/**
|
|
2011
|
+
* The properties of the resource key that was created for this source service instance.
|
|
2012
|
+
*/
|
|
1823
2013
|
interface ServiceCredentialsSecretSourceServiceRO {
|
|
1824
2014
|
/** The source service instance identifier. */
|
|
1825
2015
|
instance: ServiceCredentialsSourceServiceInstance;
|
|
@@ -1840,7 +2030,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1840
2030
|
/** The source service resource key data of the generated service credentials. */
|
|
1841
2031
|
resource_key?: ServiceCredentialsResourceKey;
|
|
1842
2032
|
}
|
|
1843
|
-
/**
|
|
2033
|
+
/**
|
|
2034
|
+
* The source service IAM data is returned in case IAM credentials where created for this secret.
|
|
2035
|
+
*/
|
|
1844
2036
|
interface ServiceCredentialsSourceServiceIam {
|
|
1845
2037
|
/** The IAM apikey metadata for the IAM credentials that were generated. */
|
|
1846
2038
|
apikey?: ServiceCredentialsSourceServiceIamApikey;
|
|
@@ -1849,7 +2041,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1849
2041
|
/** The IAM serviceid for the generated service credentials. */
|
|
1850
2042
|
serviceid?: ServiceCredentialsSourceServiceIamServiceid;
|
|
1851
2043
|
}
|
|
1852
|
-
/**
|
|
2044
|
+
/**
|
|
2045
|
+
* The IAM apikey metadata for the IAM credentials that were generated.
|
|
2046
|
+
*/
|
|
1853
2047
|
interface ServiceCredentialsSourceServiceIamApikey {
|
|
1854
2048
|
/** The IAM API key description for the generated service credentials. */
|
|
1855
2049
|
description?: string;
|
|
@@ -1858,37 +2052,60 @@ declare namespace SecretsManagerV2 {
|
|
|
1858
2052
|
/** The IAM API key name for the generated service credentials. */
|
|
1859
2053
|
name?: string;
|
|
1860
2054
|
}
|
|
1861
|
-
/**
|
|
2055
|
+
/**
|
|
2056
|
+
* The IAM role for the generate service credentials.
|
|
2057
|
+
*/
|
|
1862
2058
|
interface ServiceCredentialsSourceServiceIamRole {
|
|
1863
2059
|
/** The IAM role CRN assigned to the generated service credentials. */
|
|
1864
2060
|
crn?: string;
|
|
1865
2061
|
}
|
|
1866
|
-
/**
|
|
2062
|
+
/**
|
|
2063
|
+
* The IAM serviceid for the generated service credentials.
|
|
2064
|
+
*/
|
|
1867
2065
|
interface ServiceCredentialsSourceServiceIamServiceid {
|
|
1868
2066
|
/** The IAM Service ID CRN. */
|
|
1869
2067
|
crn?: string;
|
|
1870
2068
|
}
|
|
1871
|
-
/**
|
|
2069
|
+
/**
|
|
2070
|
+
* The source service instance identifier.
|
|
2071
|
+
*/
|
|
1872
2072
|
interface ServiceCredentialsSourceServiceInstance {
|
|
1873
2073
|
/** A CRN that uniquely identifies a service credentials source. */
|
|
1874
2074
|
crn?: string;
|
|
1875
2075
|
}
|
|
1876
|
-
/**
|
|
2076
|
+
/**
|
|
2077
|
+
* Configuration options represented as key-value pairs. Service-defined options are used in the generation of
|
|
2078
|
+
* credentials for some services. For example, Cloud Object Storage accepts the optional boolean parameter HMAC for
|
|
2079
|
+
* creating specific kind of credentials.
|
|
2080
|
+
*
|
|
2081
|
+
* This type supports additional properties of type any.
|
|
2082
|
+
*/
|
|
1877
2083
|
interface ServiceCredentialsSourceServiceParameters {
|
|
1878
2084
|
/** An optional platform defined option to reuse an existing IAM Service ID for the role assignment. */
|
|
1879
2085
|
serviceid_crn?: string;
|
|
1880
|
-
/**
|
|
2086
|
+
/**
|
|
2087
|
+
* ServiceCredentialsSourceServiceParameters accepts additional properties of type any.
|
|
2088
|
+
*/
|
|
1881
2089
|
[propName: string]: any;
|
|
1882
2090
|
}
|
|
1883
|
-
/**
|
|
2091
|
+
/**
|
|
2092
|
+
* The service-specific custom role. CRN is accepted. The role is assigned as part of an access policy to any
|
|
2093
|
+
* auto-generated IAM service ID. If you provide an existing service ID, it is added to the access policy for that
|
|
2094
|
+
* ID. If a role is not provided, any new service IDs that are autogenerated, will not have an assigned access policy
|
|
2095
|
+
* and provided service IDs are not changed in any way. Refer to the service documentation for supported roles.
|
|
2096
|
+
*/
|
|
1884
2097
|
interface ServiceCredentialsSourceServiceRole {
|
|
1885
2098
|
/** The service role CRN. */
|
|
1886
2099
|
crn: string;
|
|
1887
2100
|
}
|
|
1888
|
-
/**
|
|
2101
|
+
/**
|
|
2102
|
+
* The request body to specify the properties of the action to create a secret version.
|
|
2103
|
+
*/
|
|
1889
2104
|
interface VersionAction {
|
|
1890
2105
|
}
|
|
1891
|
-
/**
|
|
2106
|
+
/**
|
|
2107
|
+
* Your arbitrary secret.
|
|
2108
|
+
*/
|
|
1892
2109
|
interface ArbitrarySecret extends Secret {
|
|
1893
2110
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
1894
2111
|
created_by: string;
|
|
@@ -1912,7 +2129,7 @@ declare namespace SecretsManagerV2 {
|
|
|
1912
2129
|
id: string;
|
|
1913
2130
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
1914
2131
|
*
|
|
1915
|
-
* Label can be between 2-
|
|
2132
|
+
* Label can be between 2-64 characters, including spaces.
|
|
1916
2133
|
*
|
|
1917
2134
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
1918
2135
|
*/
|
|
@@ -1937,6 +2154,8 @@ declare namespace SecretsManagerV2 {
|
|
|
1937
2154
|
updated_at: string;
|
|
1938
2155
|
/** The number of versions of your secret. */
|
|
1939
2156
|
versions_total: number;
|
|
2157
|
+
/** The list of configurations that have a reference to the secret. */
|
|
2158
|
+
referenced_by?: string[];
|
|
1940
2159
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
1941
2160
|
* types: Arbitrary, username_password.
|
|
1942
2161
|
*/
|
|
@@ -1967,7 +2186,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1967
2186
|
}
|
|
1968
2187
|
}
|
|
1969
2188
|
}
|
|
1970
|
-
/**
|
|
2189
|
+
/**
|
|
2190
|
+
* Properties of the metadata of your arbitrary secret..
|
|
2191
|
+
*/
|
|
1971
2192
|
interface ArbitrarySecretMetadata extends SecretMetadata {
|
|
1972
2193
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
1973
2194
|
created_by: string;
|
|
@@ -1991,7 +2212,7 @@ declare namespace SecretsManagerV2 {
|
|
|
1991
2212
|
id: string;
|
|
1992
2213
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
1993
2214
|
*
|
|
1994
|
-
* Label can be between 2-
|
|
2215
|
+
* Label can be between 2-64 characters, including spaces.
|
|
1995
2216
|
*
|
|
1996
2217
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
1997
2218
|
*/
|
|
@@ -2016,6 +2237,8 @@ declare namespace SecretsManagerV2 {
|
|
|
2016
2237
|
updated_at: string;
|
|
2017
2238
|
/** The number of versions of your secret. */
|
|
2018
2239
|
versions_total: number;
|
|
2240
|
+
/** The list of configurations that have a reference to the secret. */
|
|
2241
|
+
referenced_by?: string[];
|
|
2019
2242
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
2020
2243
|
* types: Arbitrary, username_password.
|
|
2021
2244
|
*/
|
|
@@ -2044,7 +2267,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2044
2267
|
}
|
|
2045
2268
|
}
|
|
2046
2269
|
}
|
|
2047
|
-
/**
|
|
2270
|
+
/**
|
|
2271
|
+
* ArbitrarySecretMetadataPatch.
|
|
2272
|
+
*/
|
|
2048
2273
|
interface ArbitrarySecretMetadataPatch extends SecretMetadataPatch {
|
|
2049
2274
|
/** A human-readable name to assign to your secret.
|
|
2050
2275
|
*
|
|
@@ -2059,7 +2284,7 @@ declare namespace SecretsManagerV2 {
|
|
|
2059
2284
|
description?: string;
|
|
2060
2285
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
2061
2286
|
*
|
|
2062
|
-
* Label can be between 2-
|
|
2287
|
+
* Label can be between 2-64 characters, including spaces.
|
|
2063
2288
|
*
|
|
2064
2289
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
2065
2290
|
*/
|
|
@@ -2071,7 +2296,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2071
2296
|
*/
|
|
2072
2297
|
expiration_date?: string;
|
|
2073
2298
|
}
|
|
2074
|
-
/**
|
|
2299
|
+
/**
|
|
2300
|
+
* ArbitrarySecretPrototype.
|
|
2301
|
+
*/
|
|
2075
2302
|
interface ArbitrarySecretPrototype extends SecretPrototype {
|
|
2076
2303
|
/** The secret metadata that a user can customize. */
|
|
2077
2304
|
custom_metadata?: JsonObject;
|
|
@@ -2087,7 +2314,7 @@ declare namespace SecretsManagerV2 {
|
|
|
2087
2314
|
expiration_date?: string;
|
|
2088
2315
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
2089
2316
|
*
|
|
2090
|
-
* Label can be between 2-
|
|
2317
|
+
* Label can be between 2-64 characters, including spaces.
|
|
2091
2318
|
*
|
|
2092
2319
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
2093
2320
|
*/
|
|
@@ -2123,7 +2350,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2123
2350
|
}
|
|
2124
2351
|
}
|
|
2125
2352
|
}
|
|
2126
|
-
/**
|
|
2353
|
+
/**
|
|
2354
|
+
* Your arbitrary secret version.
|
|
2355
|
+
*/
|
|
2127
2356
|
interface ArbitrarySecretVersion extends SecretVersion {
|
|
2128
2357
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
2129
2358
|
auto_rotated?: boolean;
|
|
@@ -2182,7 +2411,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2182
2411
|
}
|
|
2183
2412
|
}
|
|
2184
2413
|
}
|
|
2185
|
-
/**
|
|
2414
|
+
/**
|
|
2415
|
+
* Properties of the version metadata of your arbitrary secret.
|
|
2416
|
+
*/
|
|
2186
2417
|
interface ArbitrarySecretVersionMetadata extends SecretVersionMetadata {
|
|
2187
2418
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
2188
2419
|
auto_rotated?: boolean;
|
|
@@ -2239,7 +2470,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2239
2470
|
}
|
|
2240
2471
|
}
|
|
2241
2472
|
}
|
|
2242
|
-
/**
|
|
2473
|
+
/**
|
|
2474
|
+
* ArbitrarySecretVersionPrototype.
|
|
2475
|
+
*/
|
|
2243
2476
|
interface ArbitrarySecretVersionPrototype extends SecretVersionPrototype {
|
|
2244
2477
|
/** The secret data that is assigned to an `arbitrary` secret. */
|
|
2245
2478
|
payload: string;
|
|
@@ -2248,7 +2481,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2248
2481
|
/** The secret version metadata that a user can customize. */
|
|
2249
2482
|
version_custom_metadata?: JsonObject;
|
|
2250
2483
|
}
|
|
2251
|
-
/**
|
|
2484
|
+
/**
|
|
2485
|
+
* This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
2486
|
+
*/
|
|
2252
2487
|
interface CommonRotationPolicy extends RotationPolicy {
|
|
2253
2488
|
/** This field indicates whether Secrets Manager rotates your secret automatically.
|
|
2254
2489
|
*
|
|
@@ -2270,7 +2505,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2270
2505
|
}
|
|
2271
2506
|
}
|
|
2272
2507
|
}
|
|
2273
|
-
/**
|
|
2508
|
+
/**
|
|
2509
|
+
* Properties that describe a Classic Infrastructure DNS configuration.
|
|
2510
|
+
*/
|
|
2274
2511
|
interface IAMCredentialsConfiguration extends Configuration {
|
|
2275
2512
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
2276
2513
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -2301,13 +2538,13 @@ declare namespace SecretsManagerV2 {
|
|
|
2301
2538
|
namespace Constants {
|
|
2302
2539
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
2303
2540
|
enum ConfigType {
|
|
2304
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
2305
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
2306
2541
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
2307
|
-
|
|
2542
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
2543
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
2308
2544
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
2309
2545
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
2310
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
2546
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
2547
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
2311
2548
|
}
|
|
2312
2549
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
2313
2550
|
enum SecretType {
|
|
@@ -2322,7 +2559,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2322
2559
|
}
|
|
2323
2560
|
}
|
|
2324
2561
|
}
|
|
2325
|
-
/**
|
|
2562
|
+
/**
|
|
2563
|
+
* Your IAMCredentials Configuration metadata properties.
|
|
2564
|
+
*/
|
|
2326
2565
|
interface IAMCredentialsConfigurationMetadata extends ConfigurationMetadata {
|
|
2327
2566
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
2328
2567
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -2347,13 +2586,13 @@ declare namespace SecretsManagerV2 {
|
|
|
2347
2586
|
namespace Constants {
|
|
2348
2587
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
2349
2588
|
enum ConfigType {
|
|
2350
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
2351
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
2352
2589
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
2353
|
-
|
|
2590
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
2591
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
2354
2592
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
2355
2593
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
2356
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
2594
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
2595
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
2357
2596
|
}
|
|
2358
2597
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
2359
2598
|
enum SecretType {
|
|
@@ -2368,7 +2607,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2368
2607
|
}
|
|
2369
2608
|
}
|
|
2370
2609
|
}
|
|
2371
|
-
/**
|
|
2610
|
+
/**
|
|
2611
|
+
* The configuration update of the IAM Credentials engine.
|
|
2612
|
+
*/
|
|
2372
2613
|
interface IAMCredentialsConfigurationPatch extends ConfigurationPatch {
|
|
2373
2614
|
/** An IBM Cloud API key that can create and manage service IDs. The API key must be assigned the Editor
|
|
2374
2615
|
* platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. For more
|
|
@@ -2377,7 +2618,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2377
2618
|
*/
|
|
2378
2619
|
api_key: string;
|
|
2379
2620
|
}
|
|
2380
|
-
/**
|
|
2621
|
+
/**
|
|
2622
|
+
* IAMCredentialsConfigurationPrototype.
|
|
2623
|
+
*/
|
|
2381
2624
|
interface IAMCredentialsConfigurationPrototype extends ConfigurationPrototype {
|
|
2382
2625
|
/** A human-readable unique name to assign to your configuration.
|
|
2383
2626
|
*
|
|
@@ -2397,17 +2640,19 @@ declare namespace SecretsManagerV2 {
|
|
|
2397
2640
|
namespace Constants {
|
|
2398
2641
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
2399
2642
|
enum ConfigType {
|
|
2400
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
2401
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
2402
2643
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
2403
|
-
|
|
2644
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
2645
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
2404
2646
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
2405
2647
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
2406
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
2648
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
2649
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
2407
2650
|
}
|
|
2408
2651
|
}
|
|
2409
2652
|
}
|
|
2410
|
-
/**
|
|
2653
|
+
/**
|
|
2654
|
+
* Your IAM credentials secret.
|
|
2655
|
+
*/
|
|
2411
2656
|
interface IAMCredentialsSecret extends Secret {
|
|
2412
2657
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
2413
2658
|
created_by: string;
|
|
@@ -2431,7 +2676,7 @@ declare namespace SecretsManagerV2 {
|
|
|
2431
2676
|
id: string;
|
|
2432
2677
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
2433
2678
|
*
|
|
2434
|
-
* Label can be between 2-
|
|
2679
|
+
* Label can be between 2-64 characters, including spaces.
|
|
2435
2680
|
*
|
|
2436
2681
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
2437
2682
|
*/
|
|
@@ -2456,12 +2701,15 @@ declare namespace SecretsManagerV2 {
|
|
|
2456
2701
|
updated_at: string;
|
|
2457
2702
|
/** The number of versions of your secret. */
|
|
2458
2703
|
versions_total: number;
|
|
2704
|
+
/** The list of configurations that have a reference to the secret. */
|
|
2705
|
+
referenced_by?: string[];
|
|
2459
2706
|
/** The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret
|
|
2460
2707
|
* types: iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The
|
|
2461
2708
|
* value can be either an integer that specifies the number of seconds, or the string representation of a
|
|
2462
2709
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
2463
2710
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
2464
2711
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
2712
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
2465
2713
|
*/
|
|
2466
2714
|
ttl: string;
|
|
2467
2715
|
/** Access Groups that you can use for an `iam_credentials` secret.
|
|
@@ -2504,6 +2752,10 @@ declare namespace SecretsManagerV2 {
|
|
|
2504
2752
|
* for secrets that can be auto-rotated and an existing rotation policy.
|
|
2505
2753
|
*/
|
|
2506
2754
|
next_rotation_date?: string;
|
|
2755
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
2756
|
+
* types: Arbitrary, username_password.
|
|
2757
|
+
*/
|
|
2758
|
+
expiration_date?: string;
|
|
2507
2759
|
/** The API key that is generated for this secret.
|
|
2508
2760
|
*
|
|
2509
2761
|
* After the secret reaches the end of its lease, the API key is deleted automatically. See the `time-to-live`
|
|
@@ -2535,7 +2787,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2535
2787
|
}
|
|
2536
2788
|
}
|
|
2537
2789
|
}
|
|
2538
|
-
/**
|
|
2790
|
+
/**
|
|
2791
|
+
* Properties of the metadata of your IAM credentials secret.
|
|
2792
|
+
*/
|
|
2539
2793
|
interface IAMCredentialsSecretMetadata extends SecretMetadata {
|
|
2540
2794
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
2541
2795
|
created_by: string;
|
|
@@ -2559,7 +2813,7 @@ declare namespace SecretsManagerV2 {
|
|
|
2559
2813
|
id: string;
|
|
2560
2814
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
2561
2815
|
*
|
|
2562
|
-
* Label can be between 2-
|
|
2816
|
+
* Label can be between 2-64 characters, including spaces.
|
|
2563
2817
|
*
|
|
2564
2818
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
2565
2819
|
*/
|
|
@@ -2584,12 +2838,15 @@ declare namespace SecretsManagerV2 {
|
|
|
2584
2838
|
updated_at: string;
|
|
2585
2839
|
/** The number of versions of your secret. */
|
|
2586
2840
|
versions_total: number;
|
|
2841
|
+
/** The list of configurations that have a reference to the secret. */
|
|
2842
|
+
referenced_by?: string[];
|
|
2587
2843
|
/** The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret
|
|
2588
2844
|
* types: iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The
|
|
2589
2845
|
* value can be either an integer that specifies the number of seconds, or the string representation of a
|
|
2590
2846
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
2591
2847
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
2592
2848
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
2849
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
2593
2850
|
*/
|
|
2594
2851
|
ttl: string;
|
|
2595
2852
|
/** Access Groups that you can use for an `iam_credentials` secret.
|
|
@@ -2632,6 +2889,10 @@ declare namespace SecretsManagerV2 {
|
|
|
2632
2889
|
* for secrets that can be auto-rotated and an existing rotation policy.
|
|
2633
2890
|
*/
|
|
2634
2891
|
next_rotation_date?: string;
|
|
2892
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
2893
|
+
* types: Arbitrary, username_password.
|
|
2894
|
+
*/
|
|
2895
|
+
expiration_date?: string;
|
|
2635
2896
|
}
|
|
2636
2897
|
namespace IAMCredentialsSecretMetadata {
|
|
2637
2898
|
namespace Constants {
|
|
@@ -2656,7 +2917,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2656
2917
|
}
|
|
2657
2918
|
}
|
|
2658
2919
|
}
|
|
2659
|
-
/**
|
|
2920
|
+
/**
|
|
2921
|
+
* IAMCredentialsSecretMetadataPatch.
|
|
2922
|
+
*/
|
|
2660
2923
|
interface IAMCredentialsSecretMetadataPatch extends SecretMetadataPatch {
|
|
2661
2924
|
/** A human-readable name to assign to your secret.
|
|
2662
2925
|
*
|
|
@@ -2671,7 +2934,7 @@ declare namespace SecretsManagerV2 {
|
|
|
2671
2934
|
description?: string;
|
|
2672
2935
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
2673
2936
|
*
|
|
2674
|
-
* Label can be between 2-
|
|
2937
|
+
* Label can be between 2-64 characters, including spaces.
|
|
2675
2938
|
*
|
|
2676
2939
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
2677
2940
|
*/
|
|
@@ -2684,6 +2947,7 @@ declare namespace SecretsManagerV2 {
|
|
|
2684
2947
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
2685
2948
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
2686
2949
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
2950
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
2687
2951
|
*/
|
|
2688
2952
|
ttl?: string;
|
|
2689
2953
|
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
@@ -2691,7 +2955,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2691
2955
|
*/
|
|
2692
2956
|
rotation?: RotationPolicy;
|
|
2693
2957
|
}
|
|
2694
|
-
/**
|
|
2958
|
+
/**
|
|
2959
|
+
* IAMCredentialsSecretPrototype.
|
|
2960
|
+
*/
|
|
2695
2961
|
interface IAMCredentialsSecretPrototype extends SecretPrototype {
|
|
2696
2962
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
2697
2963
|
* service_credentials, kv, and username_password.
|
|
@@ -2712,7 +2978,7 @@ declare namespace SecretsManagerV2 {
|
|
|
2712
2978
|
secret_group_id?: string;
|
|
2713
2979
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
2714
2980
|
*
|
|
2715
|
-
* Label can be between 2-
|
|
2981
|
+
* Label can be between 2-64 characters, including spaces.
|
|
2716
2982
|
*
|
|
2717
2983
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
2718
2984
|
*/
|
|
@@ -2723,6 +2989,7 @@ declare namespace SecretsManagerV2 {
|
|
|
2723
2989
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
2724
2990
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
2725
2991
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
2992
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
2726
2993
|
*/
|
|
2727
2994
|
ttl: string;
|
|
2728
2995
|
/** Access Groups that you can use for an `iam_credentials` secret.
|
|
@@ -2771,7 +3038,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2771
3038
|
}
|
|
2772
3039
|
}
|
|
2773
3040
|
}
|
|
2774
|
-
/**
|
|
3041
|
+
/**
|
|
3042
|
+
* IAMCredentialsSecretRestoreFromVersionPrototype.
|
|
3043
|
+
*/
|
|
2775
3044
|
interface IAMCredentialsSecretRestoreFromVersionPrototype extends SecretVersionPrototype {
|
|
2776
3045
|
/** A v4 UUID identifier, or `current` or `previous` secret version aliases. */
|
|
2777
3046
|
restore_from_version: string;
|
|
@@ -2780,7 +3049,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2780
3049
|
/** The secret version metadata that a user can customize. */
|
|
2781
3050
|
version_custom_metadata?: JsonObject;
|
|
2782
3051
|
}
|
|
2783
|
-
/**
|
|
3052
|
+
/**
|
|
3053
|
+
* Your IAM credentials version.
|
|
3054
|
+
*/
|
|
2784
3055
|
interface IAMCredentialsSecretVersion extends SecretVersion {
|
|
2785
3056
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
2786
3057
|
auto_rotated?: boolean;
|
|
@@ -2852,7 +3123,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2852
3123
|
}
|
|
2853
3124
|
}
|
|
2854
3125
|
}
|
|
2855
|
-
/**
|
|
3126
|
+
/**
|
|
3127
|
+
* Properties of the version metadata of your IAM credentials secret.
|
|
3128
|
+
*/
|
|
2856
3129
|
interface IAMCredentialsSecretVersionMetadata extends SecretVersionMetadata {
|
|
2857
3130
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
2858
3131
|
auto_rotated?: boolean;
|
|
@@ -2917,14 +3190,18 @@ declare namespace SecretsManagerV2 {
|
|
|
2917
3190
|
}
|
|
2918
3191
|
}
|
|
2919
3192
|
}
|
|
2920
|
-
/**
|
|
3193
|
+
/**
|
|
3194
|
+
* IAMCredentialsSecretVersionPrototype.
|
|
3195
|
+
*/
|
|
2921
3196
|
interface IAMCredentialsSecretVersionPrototype extends SecretVersionPrototype {
|
|
2922
3197
|
/** The secret metadata that a user can customize. */
|
|
2923
3198
|
custom_metadata?: JsonObject;
|
|
2924
3199
|
/** The secret version metadata that a user can customize. */
|
|
2925
3200
|
version_custom_metadata?: JsonObject;
|
|
2926
3201
|
}
|
|
2927
|
-
/**
|
|
3202
|
+
/**
|
|
3203
|
+
* Your imported certificate.
|
|
3204
|
+
*/
|
|
2928
3205
|
interface ImportedCertificate extends Secret {
|
|
2929
3206
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
2930
3207
|
created_by: string;
|
|
@@ -2948,7 +3225,7 @@ declare namespace SecretsManagerV2 {
|
|
|
2948
3225
|
id: string;
|
|
2949
3226
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
2950
3227
|
*
|
|
2951
|
-
* Label can be between 2-
|
|
3228
|
+
* Label can be between 2-64 characters, including spaces.
|
|
2952
3229
|
*
|
|
2953
3230
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
2954
3231
|
*/
|
|
@@ -2973,6 +3250,8 @@ declare namespace SecretsManagerV2 {
|
|
|
2973
3250
|
updated_at: string;
|
|
2974
3251
|
/** The number of versions of your secret. */
|
|
2975
3252
|
versions_total: number;
|
|
3253
|
+
/** The list of configurations that have a reference to the secret. */
|
|
3254
|
+
referenced_by?: string[];
|
|
2976
3255
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
2977
3256
|
* certificate.
|
|
2978
3257
|
*/
|
|
@@ -3035,7 +3314,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3035
3314
|
}
|
|
3036
3315
|
}
|
|
3037
3316
|
}
|
|
3038
|
-
/**
|
|
3317
|
+
/**
|
|
3318
|
+
* Properties of the secret metadata of your imported certificate.
|
|
3319
|
+
*/
|
|
3039
3320
|
interface ImportedCertificateMetadata extends SecretMetadata {
|
|
3040
3321
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
3041
3322
|
created_by: string;
|
|
@@ -3059,7 +3340,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3059
3340
|
id: string;
|
|
3060
3341
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
3061
3342
|
*
|
|
3062
|
-
* Label can be between 2-
|
|
3343
|
+
* Label can be between 2-64 characters, including spaces.
|
|
3063
3344
|
*
|
|
3064
3345
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
3065
3346
|
*/
|
|
@@ -3084,6 +3365,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3084
3365
|
updated_at: string;
|
|
3085
3366
|
/** The number of versions of your secret. */
|
|
3086
3367
|
versions_total: number;
|
|
3368
|
+
/** The list of configurations that have a reference to the secret. */
|
|
3369
|
+
referenced_by?: string[];
|
|
3087
3370
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
3088
3371
|
* certificate.
|
|
3089
3372
|
*/
|
|
@@ -3136,7 +3419,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3136
3419
|
}
|
|
3137
3420
|
}
|
|
3138
3421
|
}
|
|
3139
|
-
/**
|
|
3422
|
+
/**
|
|
3423
|
+
* ImportedCertificateMetadataPatch.
|
|
3424
|
+
*/
|
|
3140
3425
|
interface ImportedCertificateMetadataPatch extends SecretMetadataPatch {
|
|
3141
3426
|
/** A human-readable name to assign to your secret.
|
|
3142
3427
|
*
|
|
@@ -3151,7 +3436,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3151
3436
|
description?: string;
|
|
3152
3437
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
3153
3438
|
*
|
|
3154
|
-
* Label can be between 2-
|
|
3439
|
+
* Label can be between 2-64 characters, including spaces.
|
|
3155
3440
|
*
|
|
3156
3441
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
3157
3442
|
*/
|
|
@@ -3159,7 +3444,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3159
3444
|
/** The secret metadata that a user can customize. */
|
|
3160
3445
|
custom_metadata?: JsonObject;
|
|
3161
3446
|
}
|
|
3162
|
-
/**
|
|
3447
|
+
/**
|
|
3448
|
+
* ImportedCertificatePrototype.
|
|
3449
|
+
*/
|
|
3163
3450
|
interface ImportedCertificatePrototype extends SecretPrototype {
|
|
3164
3451
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
3165
3452
|
* service_credentials, kv, and username_password.
|
|
@@ -3180,7 +3467,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3180
3467
|
secret_group_id?: string;
|
|
3181
3468
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
3182
3469
|
*
|
|
3183
|
-
* Label can be between 2-
|
|
3470
|
+
* Label can be between 2-64 characters, including spaces.
|
|
3184
3471
|
*
|
|
3185
3472
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
3186
3473
|
*/
|
|
@@ -3215,7 +3502,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3215
3502
|
}
|
|
3216
3503
|
}
|
|
3217
3504
|
}
|
|
3218
|
-
/**
|
|
3505
|
+
/**
|
|
3506
|
+
* Versions of your imported certificate.
|
|
3507
|
+
*/
|
|
3219
3508
|
interface ImportedCertificateVersion extends SecretVersion {
|
|
3220
3509
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
3221
3510
|
auto_rotated?: boolean;
|
|
@@ -3286,7 +3575,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3286
3575
|
}
|
|
3287
3576
|
}
|
|
3288
3577
|
}
|
|
3289
|
-
/**
|
|
3578
|
+
/**
|
|
3579
|
+
* Properties of the version metadata of your imported certificate.
|
|
3580
|
+
*/
|
|
3290
3581
|
interface ImportedCertificateVersionMetadata extends SecretVersionMetadata {
|
|
3291
3582
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
3292
3583
|
auto_rotated?: boolean;
|
|
@@ -3347,7 +3638,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3347
3638
|
}
|
|
3348
3639
|
}
|
|
3349
3640
|
}
|
|
3350
|
-
/**
|
|
3641
|
+
/**
|
|
3642
|
+
* ImportedCertificateVersionPrototype.
|
|
3643
|
+
*/
|
|
3351
3644
|
interface ImportedCertificateVersionPrototype extends SecretVersionPrototype {
|
|
3352
3645
|
/** Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters. */
|
|
3353
3646
|
certificate: string;
|
|
@@ -3364,7 +3657,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3364
3657
|
/** The secret version metadata that a user can customize. */
|
|
3365
3658
|
version_custom_metadata?: JsonObject;
|
|
3366
3659
|
}
|
|
3367
|
-
/**
|
|
3660
|
+
/**
|
|
3661
|
+
* Your key-value secret.
|
|
3662
|
+
*/
|
|
3368
3663
|
interface KVSecret extends Secret {
|
|
3369
3664
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
3370
3665
|
created_by: string;
|
|
@@ -3388,7 +3683,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3388
3683
|
id: string;
|
|
3389
3684
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
3390
3685
|
*
|
|
3391
|
-
* Label can be between 2-
|
|
3686
|
+
* Label can be between 2-64 characters, including spaces.
|
|
3392
3687
|
*
|
|
3393
3688
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
3394
3689
|
*/
|
|
@@ -3413,6 +3708,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3413
3708
|
updated_at: string;
|
|
3414
3709
|
/** The number of versions of your secret. */
|
|
3415
3710
|
versions_total: number;
|
|
3711
|
+
/** The list of configurations that have a reference to the secret. */
|
|
3712
|
+
referenced_by?: string[];
|
|
3416
3713
|
/** The payload data of a key-value secret. */
|
|
3417
3714
|
data: JsonObject;
|
|
3418
3715
|
}
|
|
@@ -3439,7 +3736,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3439
3736
|
}
|
|
3440
3737
|
}
|
|
3441
3738
|
}
|
|
3442
|
-
/**
|
|
3739
|
+
/**
|
|
3740
|
+
* Properties of the metadata of your key-value secret metadata.
|
|
3741
|
+
*/
|
|
3443
3742
|
interface KVSecretMetadata extends SecretMetadata {
|
|
3444
3743
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
3445
3744
|
created_by: string;
|
|
@@ -3463,7 +3762,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3463
3762
|
id: string;
|
|
3464
3763
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
3465
3764
|
*
|
|
3466
|
-
* Label can be between 2-
|
|
3765
|
+
* Label can be between 2-64 characters, including spaces.
|
|
3467
3766
|
*
|
|
3468
3767
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
3469
3768
|
*/
|
|
@@ -3488,6 +3787,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3488
3787
|
updated_at: string;
|
|
3489
3788
|
/** The number of versions of your secret. */
|
|
3490
3789
|
versions_total: number;
|
|
3790
|
+
/** The list of configurations that have a reference to the secret. */
|
|
3791
|
+
referenced_by?: string[];
|
|
3491
3792
|
}
|
|
3492
3793
|
namespace KVSecretMetadata {
|
|
3493
3794
|
namespace Constants {
|
|
@@ -3512,7 +3813,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3512
3813
|
}
|
|
3513
3814
|
}
|
|
3514
3815
|
}
|
|
3515
|
-
/**
|
|
3816
|
+
/**
|
|
3817
|
+
* KVSecretMetadataPatch.
|
|
3818
|
+
*/
|
|
3516
3819
|
interface KVSecretMetadataPatch extends SecretMetadataPatch {
|
|
3517
3820
|
/** A human-readable name to assign to your secret.
|
|
3518
3821
|
*
|
|
@@ -3527,7 +3830,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3527
3830
|
description?: string;
|
|
3528
3831
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
3529
3832
|
*
|
|
3530
|
-
* Label can be between 2-
|
|
3833
|
+
* Label can be between 2-64 characters, including spaces.
|
|
3531
3834
|
*
|
|
3532
3835
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
3533
3836
|
*/
|
|
@@ -3535,7 +3838,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3535
3838
|
/** The secret metadata that a user can customize. */
|
|
3536
3839
|
custom_metadata?: JsonObject;
|
|
3537
3840
|
}
|
|
3538
|
-
/**
|
|
3841
|
+
/**
|
|
3842
|
+
* KVSecretPrototype.
|
|
3843
|
+
*/
|
|
3539
3844
|
interface KVSecretPrototype extends SecretPrototype {
|
|
3540
3845
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
3541
3846
|
* service_credentials, kv, and username_password.
|
|
@@ -3556,7 +3861,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3556
3861
|
secret_group_id?: string;
|
|
3557
3862
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
3558
3863
|
*
|
|
3559
|
-
* Label can be between 2-
|
|
3864
|
+
* Label can be between 2-64 characters, including spaces.
|
|
3560
3865
|
*
|
|
3561
3866
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
3562
3867
|
*/
|
|
@@ -3583,7 +3888,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3583
3888
|
}
|
|
3584
3889
|
}
|
|
3585
3890
|
}
|
|
3586
|
-
/**
|
|
3891
|
+
/**
|
|
3892
|
+
* Your key-value secret version.
|
|
3893
|
+
*/
|
|
3587
3894
|
interface KVSecretVersion extends SecretVersion {
|
|
3588
3895
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
3589
3896
|
auto_rotated?: boolean;
|
|
@@ -3638,7 +3945,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3638
3945
|
}
|
|
3639
3946
|
}
|
|
3640
3947
|
}
|
|
3641
|
-
/**
|
|
3948
|
+
/**
|
|
3949
|
+
* Properties of the version metadata of your key-value secret.
|
|
3950
|
+
*/
|
|
3642
3951
|
interface KVSecretVersionMetadata extends SecretVersionMetadata {
|
|
3643
3952
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
3644
3953
|
auto_rotated?: boolean;
|
|
@@ -3691,7 +4000,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3691
4000
|
}
|
|
3692
4001
|
}
|
|
3693
4002
|
}
|
|
3694
|
-
/**
|
|
4003
|
+
/**
|
|
4004
|
+
* KVSecretVersionPrototype.
|
|
4005
|
+
*/
|
|
3695
4006
|
interface KVSecretVersionPrototype extends SecretVersionPrototype {
|
|
3696
4007
|
/** The payload data of a key-value secret. */
|
|
3697
4008
|
data: JsonObject;
|
|
@@ -3700,7 +4011,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3700
4011
|
/** The secret version metadata that a user can customize. */
|
|
3701
4012
|
version_custom_metadata?: JsonObject;
|
|
3702
4013
|
}
|
|
3703
|
-
/**
|
|
4014
|
+
/**
|
|
4015
|
+
* Your private certificate.
|
|
4016
|
+
*/
|
|
3704
4017
|
interface PrivateCertificate extends Secret {
|
|
3705
4018
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
3706
4019
|
created_by: string;
|
|
@@ -3724,7 +4037,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3724
4037
|
id: string;
|
|
3725
4038
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
3726
4039
|
*
|
|
3727
|
-
* Label can be between 2-
|
|
4040
|
+
* Label can be between 2-64 characters, including spaces.
|
|
3728
4041
|
*
|
|
3729
4042
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
3730
4043
|
*/
|
|
@@ -3749,6 +4062,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3749
4062
|
updated_at: string;
|
|
3750
4063
|
/** The number of versions of your secret. */
|
|
3751
4064
|
versions_total: number;
|
|
4065
|
+
/** The list of configurations that have a reference to the secret. */
|
|
4066
|
+
referenced_by?: string[];
|
|
3752
4067
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
3753
4068
|
* certificate.
|
|
3754
4069
|
*/
|
|
@@ -3825,7 +4140,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3825
4140
|
}
|
|
3826
4141
|
}
|
|
3827
4142
|
}
|
|
3828
|
-
/**
|
|
4143
|
+
/**
|
|
4144
|
+
* The response body of the action to revoke the private certificate.
|
|
4145
|
+
*/
|
|
3829
4146
|
interface PrivateCertificateActionRevoke extends SecretAction {
|
|
3830
4147
|
/** The type of secret action. */
|
|
3831
4148
|
action_type: PrivateCertificateActionRevoke.Constants.ActionType | string;
|
|
@@ -3841,7 +4158,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3841
4158
|
}
|
|
3842
4159
|
}
|
|
3843
4160
|
}
|
|
3844
|
-
/**
|
|
4161
|
+
/**
|
|
4162
|
+
* The request body to specify the properties of the action to revoke the private certificate.
|
|
4163
|
+
*/
|
|
3845
4164
|
interface PrivateCertificateActionRevokePrototype extends SecretActionPrototype {
|
|
3846
4165
|
/** The type of secret action. */
|
|
3847
4166
|
action_type: PrivateCertificateActionRevokePrototype.Constants.ActionType | string;
|
|
@@ -3855,7 +4174,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3855
4174
|
}
|
|
3856
4175
|
}
|
|
3857
4176
|
}
|
|
3858
|
-
/**
|
|
4177
|
+
/**
|
|
4178
|
+
* The response body to specify the properties of the action to revoke the private certificate.
|
|
4179
|
+
*/
|
|
3859
4180
|
interface PrivateCertificateConfigurationActionRevoke extends ConfigurationAction {
|
|
3860
4181
|
/** The type of configuration action. */
|
|
3861
4182
|
action_type: PrivateCertificateConfigurationActionRevoke.Constants.ActionType | string;
|
|
@@ -3874,7 +4195,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3874
4195
|
}
|
|
3875
4196
|
}
|
|
3876
4197
|
}
|
|
3877
|
-
/**
|
|
4198
|
+
/**
|
|
4199
|
+
* The request body to specify the properties of the action to revoke the private certificate configuration.
|
|
4200
|
+
*/
|
|
3878
4201
|
interface PrivateCertificateConfigurationActionRevokePrototype extends ConfigurationActionPrototype {
|
|
3879
4202
|
/** The type of configuration action. */
|
|
3880
4203
|
action_type: PrivateCertificateConfigurationActionRevokePrototype.Constants.ActionType | string;
|
|
@@ -3891,7 +4214,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3891
4214
|
}
|
|
3892
4215
|
}
|
|
3893
4216
|
}
|
|
3894
|
-
/**
|
|
4217
|
+
/**
|
|
4218
|
+
* The response body of the action to rotate the CRL of an intermediate certificate authority for the private
|
|
4219
|
+
* certificate configuration.
|
|
4220
|
+
*/
|
|
3895
4221
|
interface PrivateCertificateConfigurationActionRotateCRL extends ConfigurationAction {
|
|
3896
4222
|
/** The type of configuration action. */
|
|
3897
4223
|
action_type: PrivateCertificateConfigurationActionRotateCRL.Constants.ActionType | string;
|
|
@@ -3912,7 +4238,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3912
4238
|
}
|
|
3913
4239
|
}
|
|
3914
4240
|
}
|
|
3915
|
-
/**
|
|
4241
|
+
/**
|
|
4242
|
+
* The request body of the action to rotate the CRL of an intermediate certificate authority for the private
|
|
4243
|
+
* certificate configuration.
|
|
4244
|
+
*/
|
|
3916
4245
|
interface PrivateCertificateConfigurationActionRotateCRLPrototype extends ConfigurationActionPrototype {
|
|
3917
4246
|
/** The type of configuration action. */
|
|
3918
4247
|
action_type: PrivateCertificateConfigurationActionRotateCRLPrototype.Constants.ActionType | string;
|
|
@@ -3929,7 +4258,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3929
4258
|
}
|
|
3930
4259
|
}
|
|
3931
4260
|
}
|
|
3932
|
-
/**
|
|
4261
|
+
/**
|
|
4262
|
+
* The response body of the action to set a signed intermediate certificate authority for the private certificate
|
|
4263
|
+
* configuration.
|
|
4264
|
+
*/
|
|
3933
4265
|
interface PrivateCertificateConfigurationActionSetSigned extends ConfigurationAction {
|
|
3934
4266
|
/** The type of configuration action. */
|
|
3935
4267
|
action_type: PrivateCertificateConfigurationActionSetSigned.Constants.ActionType | string;
|
|
@@ -3948,7 +4280,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3948
4280
|
}
|
|
3949
4281
|
}
|
|
3950
4282
|
}
|
|
3951
|
-
/**
|
|
4283
|
+
/**
|
|
4284
|
+
* The request body of the action to set a signed intermediate certificate authority for the private certificate
|
|
4285
|
+
* consideration.
|
|
4286
|
+
*/
|
|
3952
4287
|
interface PrivateCertificateConfigurationActionSetSignedPrototype extends ConfigurationActionPrototype {
|
|
3953
4288
|
/** The type of configuration action. */
|
|
3954
4289
|
action_type: PrivateCertificateConfigurationActionSetSignedPrototype.Constants.ActionType | string;
|
|
@@ -3967,7 +4302,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3967
4302
|
}
|
|
3968
4303
|
}
|
|
3969
4304
|
}
|
|
3970
|
-
/**
|
|
4305
|
+
/**
|
|
4306
|
+
* The response body of the action to sign the CSR for the private certificate configuration.
|
|
4307
|
+
*/
|
|
3971
4308
|
interface PrivateCertificateConfigurationActionSignCSR extends ConfigurationAction {
|
|
3972
4309
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
3973
4310
|
common_name?: string;
|
|
@@ -4068,7 +4405,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4068
4405
|
}
|
|
4069
4406
|
}
|
|
4070
4407
|
}
|
|
4071
|
-
/**
|
|
4408
|
+
/**
|
|
4409
|
+
* The request body to specify the properties of the action to sign a CSR for the private certificate configuration.
|
|
4410
|
+
*/
|
|
4072
4411
|
interface PrivateCertificateConfigurationActionSignCSRPrototype extends ConfigurationActionPrototype {
|
|
4073
4412
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
4074
4413
|
common_name?: string;
|
|
@@ -4167,7 +4506,10 @@ declare namespace SecretsManagerV2 {
|
|
|
4167
4506
|
}
|
|
4168
4507
|
}
|
|
4169
4508
|
}
|
|
4170
|
-
/**
|
|
4509
|
+
/**
|
|
4510
|
+
* The response body of the action to sign the intermediate certificate authority for the private certificate
|
|
4511
|
+
* configuration.
|
|
4512
|
+
*/
|
|
4171
4513
|
interface PrivateCertificateConfigurationActionSignIntermediate extends ConfigurationAction {
|
|
4172
4514
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
4173
4515
|
common_name?: string;
|
|
@@ -4266,7 +4608,10 @@ declare namespace SecretsManagerV2 {
|
|
|
4266
4608
|
}
|
|
4267
4609
|
}
|
|
4268
4610
|
}
|
|
4269
|
-
/**
|
|
4611
|
+
/**
|
|
4612
|
+
* The request body to specify the properties of the action to sign an intermediate certificate authority for the
|
|
4613
|
+
* private certificate configuration.
|
|
4614
|
+
*/
|
|
4270
4615
|
interface PrivateCertificateConfigurationActionSignIntermediatePrototype extends ConfigurationActionPrototype {
|
|
4271
4616
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
4272
4617
|
common_name?: string;
|
|
@@ -4365,7 +4710,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4365
4710
|
}
|
|
4366
4711
|
}
|
|
4367
4712
|
}
|
|
4368
|
-
/**
|
|
4713
|
+
/**
|
|
4714
|
+
* The data that is associated with the root certificate authority.
|
|
4715
|
+
*/
|
|
4369
4716
|
interface PrivateCertificateConfigurationCACertificate extends PrivateCertificateCAData {
|
|
4370
4717
|
/** Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters. */
|
|
4371
4718
|
certificate: string;
|
|
@@ -4376,7 +4723,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4376
4723
|
/** The certificate expiration time. */
|
|
4377
4724
|
expiration?: number;
|
|
4378
4725
|
}
|
|
4379
|
-
/**
|
|
4726
|
+
/**
|
|
4727
|
+
* The configuration of the root certificate authority.
|
|
4728
|
+
*/
|
|
4380
4729
|
interface PrivateCertificateConfigurationIntermediateCA extends Configuration {
|
|
4381
4730
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
4382
4731
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -4427,6 +4776,8 @@ declare namespace SecretsManagerV2 {
|
|
|
4427
4776
|
* `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
|
|
4428
4777
|
*/
|
|
4429
4778
|
status?: PrivateCertificateConfigurationIntermediateCA.Constants.Status | string;
|
|
4779
|
+
/** The data that is associated with a cryptographic key. */
|
|
4780
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
4430
4781
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA in seconds. */
|
|
4431
4782
|
max_ttl_seconds?: number;
|
|
4432
4783
|
/** The time until the certificate revocation list (CRL) expires, in seconds. */
|
|
@@ -4490,13 +4841,13 @@ declare namespace SecretsManagerV2 {
|
|
|
4490
4841
|
namespace Constants {
|
|
4491
4842
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
4492
4843
|
enum ConfigType {
|
|
4493
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4494
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
4495
4844
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
4496
|
-
|
|
4845
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
4846
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4497
4847
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
4498
4848
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
4499
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
4849
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
4850
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
4500
4851
|
}
|
|
4501
4852
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
4502
4853
|
enum SecretType {
|
|
@@ -4540,7 +4891,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4540
4891
|
}
|
|
4541
4892
|
}
|
|
4542
4893
|
}
|
|
4543
|
-
/**
|
|
4894
|
+
/**
|
|
4895
|
+
* The data that is associated with the intermediate certificate authority.
|
|
4896
|
+
*/
|
|
4544
4897
|
interface PrivateCertificateConfigurationIntermediateCACSR extends PrivateCertificateCAData {
|
|
4545
4898
|
/** The certificate signing request. */
|
|
4546
4899
|
csr?: string;
|
|
@@ -4562,7 +4915,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4562
4915
|
}
|
|
4563
4916
|
}
|
|
4564
4917
|
}
|
|
4565
|
-
/**
|
|
4918
|
+
/**
|
|
4919
|
+
* The configuration of the metadata properties of the intermediate certificate authority.
|
|
4920
|
+
*/
|
|
4566
4921
|
interface PrivateCertificateConfigurationIntermediateCAMetadata extends ConfigurationMetadata {
|
|
4567
4922
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
4568
4923
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -4613,18 +4968,20 @@ declare namespace SecretsManagerV2 {
|
|
|
4613
4968
|
* `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
|
|
4614
4969
|
*/
|
|
4615
4970
|
status?: PrivateCertificateConfigurationIntermediateCAMetadata.Constants.Status | string;
|
|
4971
|
+
/** The data that is associated with a cryptographic key. */
|
|
4972
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
4616
4973
|
}
|
|
4617
4974
|
namespace PrivateCertificateConfigurationIntermediateCAMetadata {
|
|
4618
4975
|
namespace Constants {
|
|
4619
4976
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
4620
4977
|
enum ConfigType {
|
|
4621
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4622
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
4623
4978
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
4624
|
-
|
|
4979
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
4980
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4625
4981
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
4626
4982
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
4627
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
4983
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
4984
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
4628
4985
|
}
|
|
4629
4986
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
4630
4987
|
enum SecretType {
|
|
@@ -4658,7 +5015,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4658
5015
|
}
|
|
4659
5016
|
}
|
|
4660
5017
|
}
|
|
4661
|
-
/**
|
|
5018
|
+
/**
|
|
5019
|
+
* The configuration patch of the intermediate certificate authority.
|
|
5020
|
+
*/
|
|
4662
5021
|
interface PrivateCertificateConfigurationIntermediateCAPatch extends ConfigurationPatch {
|
|
4663
5022
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA.
|
|
4664
5023
|
*
|
|
@@ -4691,7 +5050,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4691
5050
|
*/
|
|
4692
5051
|
issuing_certificates_urls_encoded?: boolean;
|
|
4693
5052
|
}
|
|
4694
|
-
/**
|
|
5053
|
+
/**
|
|
5054
|
+
* The configuration of the intermediate certificate authority.
|
|
5055
|
+
*/
|
|
4695
5056
|
interface PrivateCertificateConfigurationIntermediateCAPrototype extends ConfigurationPrototype {
|
|
4696
5057
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
4697
5058
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -4704,6 +5065,8 @@ declare namespace SecretsManagerV2 {
|
|
|
4704
5065
|
* To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
|
|
4705
5066
|
*/
|
|
4706
5067
|
name: string;
|
|
5068
|
+
/** The data that is associated with a cryptographic key. */
|
|
5069
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
4707
5070
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA.
|
|
4708
5071
|
*
|
|
4709
5072
|
* The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API
|
|
@@ -4804,13 +5167,13 @@ declare namespace SecretsManagerV2 {
|
|
|
4804
5167
|
namespace Constants {
|
|
4805
5168
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
4806
5169
|
enum ConfigType {
|
|
4807
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4808
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
4809
5170
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
4810
|
-
|
|
5171
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5172
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4811
5173
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
4812
5174
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
4813
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5175
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5176
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
4814
5177
|
}
|
|
4815
5178
|
/** The signing method to use with this certificate authority to generate private certificates. You can choose between internal or externally signed options. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-intermediate-certificate-authorities). */
|
|
4816
5179
|
enum SigningMethod {
|
|
@@ -4834,7 +5197,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4834
5197
|
}
|
|
4835
5198
|
}
|
|
4836
5199
|
}
|
|
4837
|
-
/**
|
|
5200
|
+
/**
|
|
5201
|
+
* The root certificate authority .
|
|
5202
|
+
*/
|
|
4838
5203
|
interface PrivateCertificateConfigurationRootCA extends Configuration {
|
|
4839
5204
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
4840
5205
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -4877,6 +5242,8 @@ declare namespace SecretsManagerV2 {
|
|
|
4877
5242
|
* `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
|
|
4878
5243
|
*/
|
|
4879
5244
|
status?: PrivateCertificateConfigurationRootCA.Constants.Status | string;
|
|
5245
|
+
/** The data that is associated with a cryptographic key. */
|
|
5246
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
4880
5247
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA in seconds. */
|
|
4881
5248
|
max_ttl_seconds?: number;
|
|
4882
5249
|
/** The time until the certificate revocation list (CRL) expires, in seconds. */
|
|
@@ -4952,13 +5319,13 @@ declare namespace SecretsManagerV2 {
|
|
|
4952
5319
|
namespace Constants {
|
|
4953
5320
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
4954
5321
|
enum ConfigType {
|
|
4955
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4956
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
4957
5322
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
4958
|
-
|
|
5323
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5324
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4959
5325
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
4960
5326
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
4961
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5327
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5328
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
4962
5329
|
}
|
|
4963
5330
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
4964
5331
|
enum SecretType {
|
|
@@ -4997,7 +5364,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4997
5364
|
}
|
|
4998
5365
|
}
|
|
4999
5366
|
}
|
|
5000
|
-
/**
|
|
5367
|
+
/**
|
|
5368
|
+
* The configuration of the metadata properties of the root certificate authority.
|
|
5369
|
+
*/
|
|
5001
5370
|
interface PrivateCertificateConfigurationRootCAMetadata extends ConfigurationMetadata {
|
|
5002
5371
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5003
5372
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5040,18 +5409,20 @@ declare namespace SecretsManagerV2 {
|
|
|
5040
5409
|
* `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
|
|
5041
5410
|
*/
|
|
5042
5411
|
status?: PrivateCertificateConfigurationRootCAMetadata.Constants.Status | string;
|
|
5412
|
+
/** The data that is associated with a cryptographic key. */
|
|
5413
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
5043
5414
|
}
|
|
5044
5415
|
namespace PrivateCertificateConfigurationRootCAMetadata {
|
|
5045
5416
|
namespace Constants {
|
|
5046
5417
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
5047
5418
|
enum ConfigType {
|
|
5048
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5049
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5050
5419
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5051
|
-
|
|
5420
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5421
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5052
5422
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5053
5423
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5054
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5424
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5425
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5055
5426
|
}
|
|
5056
5427
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
5057
5428
|
enum SecretType {
|
|
@@ -5080,7 +5451,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5080
5451
|
}
|
|
5081
5452
|
}
|
|
5082
5453
|
}
|
|
5083
|
-
/**
|
|
5454
|
+
/**
|
|
5455
|
+
* The configuration of the metadata patch for the root certificate authority.
|
|
5456
|
+
*/
|
|
5084
5457
|
interface PrivateCertificateConfigurationRootCAPatch extends ConfigurationPatch {
|
|
5085
5458
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA.
|
|
5086
5459
|
*
|
|
@@ -5113,7 +5486,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5113
5486
|
*/
|
|
5114
5487
|
issuing_certificates_urls_encoded?: boolean;
|
|
5115
5488
|
}
|
|
5116
|
-
/**
|
|
5489
|
+
/**
|
|
5490
|
+
* The configuration of the root certificate authority.
|
|
5491
|
+
*/
|
|
5117
5492
|
interface PrivateCertificateConfigurationRootCAPrototype extends ConfigurationPrototype {
|
|
5118
5493
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5119
5494
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5126,6 +5501,8 @@ declare namespace SecretsManagerV2 {
|
|
|
5126
5501
|
* To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
|
|
5127
5502
|
*/
|
|
5128
5503
|
name: string;
|
|
5504
|
+
/** The data that is associated with a cryptographic key. */
|
|
5505
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
5129
5506
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA.
|
|
5130
5507
|
*
|
|
5131
5508
|
* The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API
|
|
@@ -5235,13 +5612,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5235
5612
|
namespace Constants {
|
|
5236
5613
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
5237
5614
|
enum ConfigType {
|
|
5238
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5239
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5240
5615
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5241
|
-
|
|
5616
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5617
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5242
5618
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5243
5619
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5244
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5620
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5621
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5245
5622
|
}
|
|
5246
5623
|
/** The format of the returned data. */
|
|
5247
5624
|
enum Format {
|
|
@@ -5260,7 +5637,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5260
5637
|
}
|
|
5261
5638
|
}
|
|
5262
5639
|
}
|
|
5263
|
-
/**
|
|
5640
|
+
/**
|
|
5641
|
+
* The configuration of the private certificate template.
|
|
5642
|
+
*/
|
|
5264
5643
|
interface PrivateCertificateConfigurationTemplate extends Configuration {
|
|
5265
5644
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5266
5645
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5433,13 +5812,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5433
5812
|
namespace Constants {
|
|
5434
5813
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
5435
5814
|
enum ConfigType {
|
|
5436
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5437
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5438
5815
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5439
|
-
|
|
5816
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5817
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5440
5818
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5441
5819
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5442
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5820
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5821
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5443
5822
|
}
|
|
5444
5823
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
5445
5824
|
enum SecretType {
|
|
@@ -5459,7 +5838,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5459
5838
|
}
|
|
5460
5839
|
}
|
|
5461
5840
|
}
|
|
5462
|
-
/**
|
|
5841
|
+
/**
|
|
5842
|
+
* The metadata properties of the configuration of the private certificate template.
|
|
5843
|
+
*/
|
|
5463
5844
|
interface PrivateCertificateConfigurationTemplateMetadata extends ConfigurationMetadata {
|
|
5464
5845
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5465
5846
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5486,13 +5867,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5486
5867
|
namespace Constants {
|
|
5487
5868
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
5488
5869
|
enum ConfigType {
|
|
5489
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5490
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5491
5870
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5492
|
-
|
|
5871
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5872
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5493
5873
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5494
5874
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5495
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5875
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5876
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5496
5877
|
}
|
|
5497
5878
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
5498
5879
|
enum SecretType {
|
|
@@ -5507,7 +5888,11 @@ declare namespace SecretsManagerV2 {
|
|
|
5507
5888
|
}
|
|
5508
5889
|
}
|
|
5509
5890
|
}
|
|
5510
|
-
/**
|
|
5891
|
+
/**
|
|
5892
|
+
* Properties that describe a certificate template. You can use a certificate template to control the parameters that
|
|
5893
|
+
* are applied to your issued private certificates. For more information, see the
|
|
5894
|
+
* [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-certificate-templates).
|
|
5895
|
+
*/
|
|
5511
5896
|
interface PrivateCertificateConfigurationTemplatePatch extends ConfigurationPatch {
|
|
5512
5897
|
/** This field scopes the creation of private certificates to only the secret groups that you specify.
|
|
5513
5898
|
*
|
|
@@ -5680,7 +6065,11 @@ declare namespace SecretsManagerV2 {
|
|
|
5680
6065
|
}
|
|
5681
6066
|
}
|
|
5682
6067
|
}
|
|
5683
|
-
/**
|
|
6068
|
+
/**
|
|
6069
|
+
* Properties that describe a certificate template. You can use a certificate template to control the parameters that
|
|
6070
|
+
* are applied to your issued private certificates. For more information, see the
|
|
6071
|
+
* [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-certificate-templates).
|
|
6072
|
+
*/
|
|
5684
6073
|
interface PrivateCertificateConfigurationTemplatePrototype extends ConfigurationPrototype {
|
|
5685
6074
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5686
6075
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5867,13 +6256,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5867
6256
|
namespace Constants {
|
|
5868
6257
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
5869
6258
|
enum ConfigType {
|
|
5870
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5871
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5872
6259
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5873
|
-
|
|
6260
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6261
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5874
6262
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5875
6263
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5876
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
6264
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
6265
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5877
6266
|
}
|
|
5878
6267
|
/** The type of private key to generate. */
|
|
5879
6268
|
enum KeyType {
|
|
@@ -5882,7 +6271,30 @@ declare namespace SecretsManagerV2 {
|
|
|
5882
6271
|
}
|
|
5883
6272
|
}
|
|
5884
6273
|
}
|
|
5885
|
-
/**
|
|
6274
|
+
/**
|
|
6275
|
+
* The data that is associated with Hyper Protect Crypto Services as the cryptographic provider.
|
|
6276
|
+
*/
|
|
6277
|
+
interface PrivateCertificateCryptoProviderHPCS extends PrivateCertificateCryptoProvider {
|
|
6278
|
+
/** The type of cryptographic provider. */
|
|
6279
|
+
type: PrivateCertificateCryptoProviderHPCS.Constants.Type | string;
|
|
6280
|
+
/** The HPCS instance CRN. */
|
|
6281
|
+
instance_crn: string;
|
|
6282
|
+
/** The secret Id of iam credentials with api key to access HPCS instance. */
|
|
6283
|
+
pin_iam_credentials_secret_id: string;
|
|
6284
|
+
/** The HPCS private key store space id. */
|
|
6285
|
+
private_keystore_id: string;
|
|
6286
|
+
}
|
|
6287
|
+
namespace PrivateCertificateCryptoProviderHPCS {
|
|
6288
|
+
namespace Constants {
|
|
6289
|
+
/** The type of cryptographic provider. */
|
|
6290
|
+
enum Type {
|
|
6291
|
+
HYPER_PROTECT_CRYPTO_SERVICES = "hyper_protect_crypto_services"
|
|
6292
|
+
}
|
|
6293
|
+
}
|
|
6294
|
+
}
|
|
6295
|
+
/**
|
|
6296
|
+
* Properties of the metadata of your private certificate.
|
|
6297
|
+
*/
|
|
5886
6298
|
interface PrivateCertificateMetadata extends SecretMetadata {
|
|
5887
6299
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
5888
6300
|
created_by: string;
|
|
@@ -5906,7 +6318,7 @@ declare namespace SecretsManagerV2 {
|
|
|
5906
6318
|
id: string;
|
|
5907
6319
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
5908
6320
|
*
|
|
5909
|
-
* Label can be between 2-
|
|
6321
|
+
* Label can be between 2-64 characters, including spaces.
|
|
5910
6322
|
*
|
|
5911
6323
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
5912
6324
|
*/
|
|
@@ -5931,6 +6343,8 @@ declare namespace SecretsManagerV2 {
|
|
|
5931
6343
|
updated_at: string;
|
|
5932
6344
|
/** The number of versions of your secret. */
|
|
5933
6345
|
versions_total: number;
|
|
6346
|
+
/** The list of configurations that have a reference to the secret. */
|
|
6347
|
+
referenced_by?: string[];
|
|
5934
6348
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
5935
6349
|
* certificate.
|
|
5936
6350
|
*/
|
|
@@ -5997,7 +6411,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5997
6411
|
}
|
|
5998
6412
|
}
|
|
5999
6413
|
}
|
|
6000
|
-
/**
|
|
6414
|
+
/**
|
|
6415
|
+
* PrivateCertificateMetadataPatch.
|
|
6416
|
+
*/
|
|
6001
6417
|
interface PrivateCertificateMetadataPatch extends SecretMetadataPatch {
|
|
6002
6418
|
/** A human-readable name to assign to your secret.
|
|
6003
6419
|
*
|
|
@@ -6012,7 +6428,7 @@ declare namespace SecretsManagerV2 {
|
|
|
6012
6428
|
description?: string;
|
|
6013
6429
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
6014
6430
|
*
|
|
6015
|
-
* Label can be between 2-
|
|
6431
|
+
* Label can be between 2-64 characters, including spaces.
|
|
6016
6432
|
*
|
|
6017
6433
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
6018
6434
|
*/
|
|
@@ -6024,7 +6440,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6024
6440
|
*/
|
|
6025
6441
|
rotation?: RotationPolicy;
|
|
6026
6442
|
}
|
|
6027
|
-
/**
|
|
6443
|
+
/**
|
|
6444
|
+
* PrivateCertificatePrototype.
|
|
6445
|
+
*/
|
|
6028
6446
|
interface PrivateCertificatePrototype extends SecretPrototype {
|
|
6029
6447
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
6030
6448
|
* service_credentials, kv, and username_password.
|
|
@@ -6045,7 +6463,7 @@ declare namespace SecretsManagerV2 {
|
|
|
6045
6463
|
secret_group_id?: string;
|
|
6046
6464
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
6047
6465
|
*
|
|
6048
|
-
* Label can be between 2-
|
|
6466
|
+
* Label can be between 2-64 characters, including spaces.
|
|
6049
6467
|
*
|
|
6050
6468
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
6051
6469
|
*/
|
|
@@ -6122,7 +6540,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6122
6540
|
}
|
|
6123
6541
|
}
|
|
6124
6542
|
}
|
|
6125
|
-
/**
|
|
6543
|
+
/**
|
|
6544
|
+
* Your private certificate version.
|
|
6545
|
+
*/
|
|
6126
6546
|
interface PrivateCertificateVersion extends SecretVersion {
|
|
6127
6547
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
6128
6548
|
auto_rotated?: boolean;
|
|
@@ -6193,7 +6613,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6193
6613
|
}
|
|
6194
6614
|
}
|
|
6195
6615
|
}
|
|
6196
|
-
/**
|
|
6616
|
+
/**
|
|
6617
|
+
* The response body to specify the properties of the action to revoke the private certificate.
|
|
6618
|
+
*/
|
|
6197
6619
|
interface PrivateCertificateVersionActionRevoke extends VersionAction {
|
|
6198
6620
|
/** The type of secret version action. */
|
|
6199
6621
|
action_type: PrivateCertificateVersionActionRevoke.Constants.ActionType | string;
|
|
@@ -6208,7 +6630,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6208
6630
|
}
|
|
6209
6631
|
}
|
|
6210
6632
|
}
|
|
6211
|
-
/**
|
|
6633
|
+
/**
|
|
6634
|
+
* The request body to specify the properties of the action to revoke the private certificate.
|
|
6635
|
+
*/
|
|
6212
6636
|
interface PrivateCertificateVersionActionRevokePrototype extends SecretVersionActionPrototype {
|
|
6213
6637
|
/** The type of secret version action. */
|
|
6214
6638
|
action_type: PrivateCertificateVersionActionRevokePrototype.Constants.ActionType | string;
|
|
@@ -6221,7 +6645,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6221
6645
|
}
|
|
6222
6646
|
}
|
|
6223
6647
|
}
|
|
6224
|
-
/**
|
|
6648
|
+
/**
|
|
6649
|
+
* Properties of the version metadata of your private certificate.
|
|
6650
|
+
*/
|
|
6225
6651
|
interface PrivateCertificateVersionMetadata extends SecretVersionMetadata {
|
|
6226
6652
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
6227
6653
|
auto_rotated?: boolean;
|
|
@@ -6282,7 +6708,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6282
6708
|
}
|
|
6283
6709
|
}
|
|
6284
6710
|
}
|
|
6285
|
-
/**
|
|
6711
|
+
/**
|
|
6712
|
+
* PrivateCertificateVersionPrototype.
|
|
6713
|
+
*/
|
|
6286
6714
|
interface PrivateCertificateVersionPrototype extends SecretVersionPrototype {
|
|
6287
6715
|
/** The secret metadata that a user can customize. */
|
|
6288
6716
|
custom_metadata?: JsonObject;
|
|
@@ -6291,7 +6719,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6291
6719
|
/** The certificate signing request. */
|
|
6292
6720
|
csr?: string;
|
|
6293
6721
|
}
|
|
6294
|
-
/**
|
|
6722
|
+
/**
|
|
6723
|
+
* Your public certificate.
|
|
6724
|
+
*/
|
|
6295
6725
|
interface PublicCertificate extends Secret {
|
|
6296
6726
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
6297
6727
|
created_by: string;
|
|
@@ -6315,7 +6745,7 @@ declare namespace SecretsManagerV2 {
|
|
|
6315
6745
|
id: string;
|
|
6316
6746
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
6317
6747
|
*
|
|
6318
|
-
* Label can be between 2-
|
|
6748
|
+
* Label can be between 2-64 characters, including spaces.
|
|
6319
6749
|
*
|
|
6320
6750
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
6321
6751
|
*/
|
|
@@ -6340,6 +6770,8 @@ declare namespace SecretsManagerV2 {
|
|
|
6340
6770
|
updated_at: string;
|
|
6341
6771
|
/** The number of versions of your secret. */
|
|
6342
6772
|
versions_total: number;
|
|
6773
|
+
/** The list of configurations that have a reference to the secret. */
|
|
6774
|
+
referenced_by?: string[];
|
|
6343
6775
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
6344
6776
|
* certificate.
|
|
6345
6777
|
*/
|
|
@@ -6414,7 +6846,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6414
6846
|
}
|
|
6415
6847
|
}
|
|
6416
6848
|
}
|
|
6417
|
-
/**
|
|
6849
|
+
/**
|
|
6850
|
+
* The response body of the action to validate manual DNS challenges for the public certificate.
|
|
6851
|
+
*/
|
|
6418
6852
|
interface PublicCertificateActionValidateManualDNS extends SecretAction {
|
|
6419
6853
|
/** The type of secret action. */
|
|
6420
6854
|
action_type: PublicCertificateActionValidateManualDNS.Constants.ActionType | string;
|
|
@@ -6428,7 +6862,10 @@ declare namespace SecretsManagerV2 {
|
|
|
6428
6862
|
}
|
|
6429
6863
|
}
|
|
6430
6864
|
}
|
|
6431
|
-
/**
|
|
6865
|
+
/**
|
|
6866
|
+
* The request body to specify the properties of the action to validate manual DNS challenges for the public
|
|
6867
|
+
* certificate.
|
|
6868
|
+
*/
|
|
6432
6869
|
interface PublicCertificateActionValidateManualDNSPrototype extends SecretActionPrototype {
|
|
6433
6870
|
/** The type of secret action. */
|
|
6434
6871
|
action_type: PublicCertificateActionValidateManualDNSPrototype.Constants.ActionType | string;
|
|
@@ -6442,7 +6879,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6442
6879
|
}
|
|
6443
6880
|
}
|
|
6444
6881
|
}
|
|
6445
|
-
/**
|
|
6882
|
+
/**
|
|
6883
|
+
* Properties that describe a Let's Encrypt CA configuration.
|
|
6884
|
+
*/
|
|
6446
6885
|
interface PublicCertificateConfigurationCALetsEncrypt extends Configuration {
|
|
6447
6886
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6448
6887
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6477,13 +6916,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6477
6916
|
namespace Constants {
|
|
6478
6917
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
6479
6918
|
enum ConfigType {
|
|
6480
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6481
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6482
6919
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6483
|
-
|
|
6920
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6921
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6484
6922
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6485
6923
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6486
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
6924
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
6925
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6487
6926
|
}
|
|
6488
6927
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6489
6928
|
enum SecretType {
|
|
@@ -6503,7 +6942,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6503
6942
|
}
|
|
6504
6943
|
}
|
|
6505
6944
|
}
|
|
6506
|
-
/**
|
|
6945
|
+
/**
|
|
6946
|
+
* Your Let's Encrypt CA metadata properties.
|
|
6947
|
+
*/
|
|
6507
6948
|
interface PublicCertificateConfigurationCALetsEncryptMetadata extends ConfigurationMetadata {
|
|
6508
6949
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6509
6950
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6534,13 +6975,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6534
6975
|
namespace Constants {
|
|
6535
6976
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
6536
6977
|
enum ConfigType {
|
|
6537
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6538
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6539
6978
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6540
|
-
|
|
6979
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6980
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6541
6981
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6542
6982
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6543
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
6983
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
6984
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6544
6985
|
}
|
|
6545
6986
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6546
6987
|
enum SecretType {
|
|
@@ -6560,7 +7001,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6560
7001
|
}
|
|
6561
7002
|
}
|
|
6562
7003
|
}
|
|
6563
|
-
/**
|
|
7004
|
+
/**
|
|
7005
|
+
* The configuration update of the Let's Encrypt Certificate Authority.
|
|
7006
|
+
*/
|
|
6564
7007
|
interface PublicCertificateConfigurationCALetsEncryptPatch extends ConfigurationPatch {
|
|
6565
7008
|
/** The configuration of the Let's Encrypt CA environment. */
|
|
6566
7009
|
lets_encrypt_environment: PublicCertificateConfigurationCALetsEncryptPatch.Constants.LetsEncryptEnvironment | string;
|
|
@@ -6582,7 +7025,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6582
7025
|
}
|
|
6583
7026
|
}
|
|
6584
7027
|
}
|
|
6585
|
-
/**
|
|
7028
|
+
/**
|
|
7029
|
+
* The properties of the Let's Encrypt CA configuration.
|
|
7030
|
+
*/
|
|
6586
7031
|
interface PublicCertificateConfigurationCALetsEncryptPrototype extends ConfigurationPrototype {
|
|
6587
7032
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6588
7033
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6610,13 +7055,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6610
7055
|
namespace Constants {
|
|
6611
7056
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
6612
7057
|
enum ConfigType {
|
|
6613
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6614
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6615
7058
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6616
|
-
|
|
7059
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7060
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6617
7061
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6618
7062
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6619
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7063
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7064
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6620
7065
|
}
|
|
6621
7066
|
/** The configuration of the Let's Encrypt CA environment. */
|
|
6622
7067
|
enum LetsEncryptEnvironment {
|
|
@@ -6625,7 +7070,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6625
7070
|
}
|
|
6626
7071
|
}
|
|
6627
7072
|
}
|
|
6628
|
-
/**
|
|
7073
|
+
/**
|
|
7074
|
+
* Properties that describe a Classic Infrastructure DNS configuration.
|
|
7075
|
+
*/
|
|
6629
7076
|
interface PublicCertificateConfigurationDNSClassicInfrastructure extends Configuration {
|
|
6630
7077
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6631
7078
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6662,13 +7109,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6662
7109
|
namespace Constants {
|
|
6663
7110
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
6664
7111
|
enum ConfigType {
|
|
6665
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6666
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6667
7112
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6668
|
-
|
|
7113
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7114
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6669
7115
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6670
7116
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6671
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7117
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7118
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6672
7119
|
}
|
|
6673
7120
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6674
7121
|
enum SecretType {
|
|
@@ -6683,7 +7130,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6683
7130
|
}
|
|
6684
7131
|
}
|
|
6685
7132
|
}
|
|
6686
|
-
/**
|
|
7133
|
+
/**
|
|
7134
|
+
* Your Classic Infrastructure DNS metadata properties.
|
|
7135
|
+
*/
|
|
6687
7136
|
interface PublicCertificateConfigurationDNSClassicInfrastructureMetadata extends ConfigurationMetadata {
|
|
6688
7137
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6689
7138
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6708,13 +7157,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6708
7157
|
namespace Constants {
|
|
6709
7158
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
6710
7159
|
enum ConfigType {
|
|
6711
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6712
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6713
7160
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6714
|
-
|
|
7161
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7162
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6715
7163
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6716
7164
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6717
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7165
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7166
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6718
7167
|
}
|
|
6719
7168
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6720
7169
|
enum SecretType {
|
|
@@ -6729,7 +7178,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6729
7178
|
}
|
|
6730
7179
|
}
|
|
6731
7180
|
}
|
|
6732
|
-
/**
|
|
7181
|
+
/**
|
|
7182
|
+
* Properties that describe the configuration update of an IBM Cloud classic infrastructure (SoftLayer).
|
|
7183
|
+
*/
|
|
6733
7184
|
interface PublicCertificateConfigurationDNSClassicInfrastructurePatch extends ConfigurationPatch {
|
|
6734
7185
|
/** The username that is associated with your classic infrastructure account.
|
|
6735
7186
|
*
|
|
@@ -6744,7 +7195,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6744
7195
|
*/
|
|
6745
7196
|
classic_infrastructure_password?: string;
|
|
6746
7197
|
}
|
|
6747
|
-
/**
|
|
7198
|
+
/**
|
|
7199
|
+
* PublicCertificateConfigurationDNSClassicInfrastructurePrototype.
|
|
7200
|
+
*/
|
|
6748
7201
|
interface PublicCertificateConfigurationDNSClassicInfrastructurePrototype extends ConfigurationPrototype {
|
|
6749
7202
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6750
7203
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6774,17 +7227,19 @@ declare namespace SecretsManagerV2 {
|
|
|
6774
7227
|
namespace Constants {
|
|
6775
7228
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
6776
7229
|
enum ConfigType {
|
|
6777
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6778
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6779
7230
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6780
|
-
|
|
7231
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7232
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6781
7233
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6782
7234
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6783
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7235
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7236
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6784
7237
|
}
|
|
6785
7238
|
}
|
|
6786
7239
|
}
|
|
6787
|
-
/**
|
|
7240
|
+
/**
|
|
7241
|
+
* Properties that describe a Cloud Internet Services DNS configuration.
|
|
7242
|
+
*/
|
|
6788
7243
|
interface PublicCertificateConfigurationDNSCloudInternetServices extends Configuration {
|
|
6789
7244
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6790
7245
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6829,13 +7284,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6829
7284
|
namespace Constants {
|
|
6830
7285
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
6831
7286
|
enum ConfigType {
|
|
6832
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6833
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6834
7287
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6835
|
-
|
|
7288
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7289
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6836
7290
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6837
7291
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6838
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7292
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7293
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6839
7294
|
}
|
|
6840
7295
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6841
7296
|
enum SecretType {
|
|
@@ -6850,7 +7305,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6850
7305
|
}
|
|
6851
7306
|
}
|
|
6852
7307
|
}
|
|
6853
|
-
/**
|
|
7308
|
+
/**
|
|
7309
|
+
* Your Cloud Internet Services DNS metadata properties.
|
|
7310
|
+
*/
|
|
6854
7311
|
interface PublicCertificateConfigurationDNSCloudInternetServicesMetadata extends ConfigurationMetadata {
|
|
6855
7312
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6856
7313
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6875,13 +7332,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6875
7332
|
namespace Constants {
|
|
6876
7333
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
6877
7334
|
enum ConfigType {
|
|
6878
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6879
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6880
7335
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6881
|
-
|
|
7336
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7337
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6882
7338
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6883
7339
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6884
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7340
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7341
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6885
7342
|
}
|
|
6886
7343
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6887
7344
|
enum SecretType {
|
|
@@ -6896,7 +7353,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6896
7353
|
}
|
|
6897
7354
|
}
|
|
6898
7355
|
}
|
|
6899
|
-
/**
|
|
7356
|
+
/**
|
|
7357
|
+
* The configuration update of the Cloud Internet Services DNS.
|
|
7358
|
+
*/
|
|
6900
7359
|
interface PublicCertificateConfigurationDNSCloudInternetServicesPatch extends ConfigurationPatch {
|
|
6901
7360
|
/** An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.
|
|
6902
7361
|
*
|
|
@@ -6919,7 +7378,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6919
7378
|
/** A CRN that uniquely identifies an IBM Cloud resource. */
|
|
6920
7379
|
cloud_internet_services_crn?: string;
|
|
6921
7380
|
}
|
|
6922
|
-
/**
|
|
7381
|
+
/**
|
|
7382
|
+
* Specify the properties for Cloud Internet Services DNS configuration.
|
|
7383
|
+
*/
|
|
6923
7384
|
interface PublicCertificateConfigurationDNSCloudInternetServicesPrototype extends ConfigurationPrototype {
|
|
6924
7385
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6925
7386
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6957,17 +7418,19 @@ declare namespace SecretsManagerV2 {
|
|
|
6957
7418
|
namespace Constants {
|
|
6958
7419
|
/** The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template. */
|
|
6959
7420
|
enum ConfigType {
|
|
6960
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6961
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6962
7421
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6963
|
-
|
|
7422
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7423
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6964
7424
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6965
7425
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6966
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7426
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7427
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6967
7428
|
}
|
|
6968
7429
|
}
|
|
6969
7430
|
}
|
|
6970
|
-
/**
|
|
7431
|
+
/**
|
|
7432
|
+
* Properties of the metadata of your public certificate.
|
|
7433
|
+
*/
|
|
6971
7434
|
interface PublicCertificateMetadata extends SecretMetadata {
|
|
6972
7435
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
6973
7436
|
created_by: string;
|
|
@@ -6991,7 +7454,7 @@ declare namespace SecretsManagerV2 {
|
|
|
6991
7454
|
id: string;
|
|
6992
7455
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
6993
7456
|
*
|
|
6994
|
-
* Label can be between 2-
|
|
7457
|
+
* Label can be between 2-64 characters, including spaces.
|
|
6995
7458
|
*
|
|
6996
7459
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
6997
7460
|
*/
|
|
@@ -7016,6 +7479,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7016
7479
|
updated_at: string;
|
|
7017
7480
|
/** The number of versions of your secret. */
|
|
7018
7481
|
versions_total: number;
|
|
7482
|
+
/** The list of configurations that have a reference to the secret. */
|
|
7483
|
+
referenced_by?: string[];
|
|
7019
7484
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
7020
7485
|
* certificate.
|
|
7021
7486
|
*/
|
|
@@ -7080,7 +7545,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7080
7545
|
}
|
|
7081
7546
|
}
|
|
7082
7547
|
}
|
|
7083
|
-
/**
|
|
7548
|
+
/**
|
|
7549
|
+
* PublicCertificateMetadataPatch.
|
|
7550
|
+
*/
|
|
7084
7551
|
interface PublicCertificateMetadataPatch extends SecretMetadataPatch {
|
|
7085
7552
|
/** A human-readable name to assign to your secret.
|
|
7086
7553
|
*
|
|
@@ -7095,7 +7562,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7095
7562
|
description?: string;
|
|
7096
7563
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
7097
7564
|
*
|
|
7098
|
-
* Label can be between 2-
|
|
7565
|
+
* Label can be between 2-64 characters, including spaces.
|
|
7099
7566
|
*
|
|
7100
7567
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
7101
7568
|
*/
|
|
@@ -7107,7 +7574,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7107
7574
|
*/
|
|
7108
7575
|
rotation?: RotationPolicy;
|
|
7109
7576
|
}
|
|
7110
|
-
/**
|
|
7577
|
+
/**
|
|
7578
|
+
* PublicCertificatePrototype.
|
|
7579
|
+
*/
|
|
7111
7580
|
interface PublicCertificatePrototype extends SecretPrototype {
|
|
7112
7581
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
7113
7582
|
* service_credentials, kv, and username_password.
|
|
@@ -7128,7 +7597,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7128
7597
|
secret_group_id?: string;
|
|
7129
7598
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
7130
7599
|
*
|
|
7131
|
-
* Label can be between 2-
|
|
7600
|
+
* Label can be between 2-64 characters, including spaces.
|
|
7132
7601
|
*
|
|
7133
7602
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
7134
7603
|
*/
|
|
@@ -7179,7 +7648,12 @@ declare namespace SecretsManagerV2 {
|
|
|
7179
7648
|
}
|
|
7180
7649
|
}
|
|
7181
7650
|
}
|
|
7182
|
-
/**
|
|
7651
|
+
/**
|
|
7652
|
+
* This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
7653
|
+
*
|
|
7654
|
+
* For public certificates, if `auto_rotate` is set to `true`, the service reorders your certificate for 31 days,
|
|
7655
|
+
* before it expires.
|
|
7656
|
+
*/
|
|
7183
7657
|
interface PublicCertificateRotationPolicy extends RotationPolicy {
|
|
7184
7658
|
/** This field indicates whether Secrets Manager rotates your secret automatically.
|
|
7185
7659
|
*
|
|
@@ -7195,7 +7669,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7195
7669
|
*/
|
|
7196
7670
|
rotate_keys: boolean;
|
|
7197
7671
|
}
|
|
7198
|
-
/**
|
|
7672
|
+
/**
|
|
7673
|
+
* Versions of your public certificate.
|
|
7674
|
+
*/
|
|
7199
7675
|
interface PublicCertificateVersion extends SecretVersion {
|
|
7200
7676
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
7201
7677
|
auto_rotated?: boolean;
|
|
@@ -7266,7 +7742,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7266
7742
|
}
|
|
7267
7743
|
}
|
|
7268
7744
|
}
|
|
7269
|
-
/**
|
|
7745
|
+
/**
|
|
7746
|
+
* Properties of the version metadata of your public certificate.
|
|
7747
|
+
*/
|
|
7270
7748
|
interface PublicCertificateVersionMetadata extends SecretVersionMetadata {
|
|
7271
7749
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
7272
7750
|
auto_rotated?: boolean;
|
|
@@ -7327,7 +7805,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7327
7805
|
}
|
|
7328
7806
|
}
|
|
7329
7807
|
}
|
|
7330
|
-
/**
|
|
7808
|
+
/**
|
|
7809
|
+
* PublicCertificateVersionPrototype.
|
|
7810
|
+
*/
|
|
7331
7811
|
interface PublicCertificateVersionPrototype extends SecretVersionPrototype {
|
|
7332
7812
|
/** Defines the rotation object that is used to manually rotate public certificates. */
|
|
7333
7813
|
rotation: PublicCertificateRotationObject;
|
|
@@ -7336,7 +7816,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7336
7816
|
/** The secret version metadata that a user can customize. */
|
|
7337
7817
|
version_custom_metadata?: JsonObject;
|
|
7338
7818
|
}
|
|
7339
|
-
/**
|
|
7819
|
+
/**
|
|
7820
|
+
* Your service credentials secret.
|
|
7821
|
+
*/
|
|
7340
7822
|
interface ServiceCredentialsSecret extends Secret {
|
|
7341
7823
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7342
7824
|
created_by: string;
|
|
@@ -7360,7 +7842,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7360
7842
|
id: string;
|
|
7361
7843
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
7362
7844
|
*
|
|
7363
|
-
* Label can be between 2-
|
|
7845
|
+
* Label can be between 2-64 characters, including spaces.
|
|
7364
7846
|
*
|
|
7365
7847
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
7366
7848
|
*/
|
|
@@ -7385,6 +7867,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7385
7867
|
updated_at: string;
|
|
7386
7868
|
/** The number of versions of your secret. */
|
|
7387
7869
|
versions_total: number;
|
|
7870
|
+
/** The list of configurations that have a reference to the secret. */
|
|
7871
|
+
referenced_by?: string[];
|
|
7388
7872
|
/** The date that the secret is scheduled for automatic rotation.
|
|
7389
7873
|
*
|
|
7390
7874
|
* The service automatically creates a new version of the secret on its next rotation date. This field exists only
|
|
@@ -7401,8 +7885,13 @@ declare namespace SecretsManagerV2 {
|
|
|
7401
7885
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
7402
7886
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
7403
7887
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
7888
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
7404
7889
|
*/
|
|
7405
7890
|
ttl?: string;
|
|
7891
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
7892
|
+
* types: Arbitrary, username_password.
|
|
7893
|
+
*/
|
|
7894
|
+
expiration_date?: string;
|
|
7406
7895
|
/** The properties of the resource key that was created for this source service instance. */
|
|
7407
7896
|
source_service: ServiceCredentialsSecretSourceServiceRO;
|
|
7408
7897
|
/** The properties of the service credentials secret payload. */
|
|
@@ -7431,7 +7920,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7431
7920
|
}
|
|
7432
7921
|
}
|
|
7433
7922
|
}
|
|
7434
|
-
/**
|
|
7923
|
+
/**
|
|
7924
|
+
* The metadata properties for your service credentials secret.
|
|
7925
|
+
*/
|
|
7435
7926
|
interface ServiceCredentialsSecretMetadata extends SecretMetadata {
|
|
7436
7927
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7437
7928
|
created_by: string;
|
|
@@ -7455,7 +7946,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7455
7946
|
id: string;
|
|
7456
7947
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
7457
7948
|
*
|
|
7458
|
-
* Label can be between 2-
|
|
7949
|
+
* Label can be between 2-64 characters, including spaces.
|
|
7459
7950
|
*
|
|
7460
7951
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
7461
7952
|
*/
|
|
@@ -7480,6 +7971,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7480
7971
|
updated_at: string;
|
|
7481
7972
|
/** The number of versions of your secret. */
|
|
7482
7973
|
versions_total: number;
|
|
7974
|
+
/** The list of configurations that have a reference to the secret. */
|
|
7975
|
+
referenced_by?: string[];
|
|
7483
7976
|
/** The date that the secret is scheduled for automatic rotation.
|
|
7484
7977
|
*
|
|
7485
7978
|
* The service automatically creates a new version of the secret on its next rotation date. This field exists only
|
|
@@ -7496,8 +7989,13 @@ declare namespace SecretsManagerV2 {
|
|
|
7496
7989
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
7497
7990
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
7498
7991
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
7992
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
7499
7993
|
*/
|
|
7500
7994
|
ttl?: string;
|
|
7995
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
7996
|
+
* types: Arbitrary, username_password.
|
|
7997
|
+
*/
|
|
7998
|
+
expiration_date?: string;
|
|
7501
7999
|
/** The properties of the resource key that was created for this source service instance. */
|
|
7502
8000
|
source_service: ServiceCredentialsSecretSourceServiceRO;
|
|
7503
8001
|
}
|
|
@@ -7524,7 +8022,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7524
8022
|
}
|
|
7525
8023
|
}
|
|
7526
8024
|
}
|
|
7527
|
-
/**
|
|
8025
|
+
/**
|
|
8026
|
+
* ServiceCredentialsSecretMetadataPatch.
|
|
8027
|
+
*/
|
|
7528
8028
|
interface ServiceCredentialsSecretMetadataPatch extends SecretMetadataPatch {
|
|
7529
8029
|
/** The secret metadata that a user can customize. */
|
|
7530
8030
|
custom_metadata?: JsonObject;
|
|
@@ -7536,7 +8036,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7536
8036
|
description?: string;
|
|
7537
8037
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
7538
8038
|
*
|
|
7539
|
-
* Label can be between 2-
|
|
8039
|
+
* Label can be between 2-64 characters, including spaces.
|
|
7540
8040
|
*
|
|
7541
8041
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
7542
8042
|
*/
|
|
@@ -7556,10 +8056,13 @@ declare namespace SecretsManagerV2 {
|
|
|
7556
8056
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
7557
8057
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
7558
8058
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
8059
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
7559
8060
|
*/
|
|
7560
8061
|
ttl?: string;
|
|
7561
8062
|
}
|
|
7562
|
-
/**
|
|
8063
|
+
/**
|
|
8064
|
+
* ServiceCredentialsSecretPrototype.
|
|
8065
|
+
*/
|
|
7563
8066
|
interface ServiceCredentialsSecretPrototype extends SecretPrototype {
|
|
7564
8067
|
/** The secret metadata that a user can customize. */
|
|
7565
8068
|
custom_metadata?: JsonObject;
|
|
@@ -7571,7 +8074,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7571
8074
|
description?: string;
|
|
7572
8075
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
7573
8076
|
*
|
|
7574
|
-
* Label can be between 2-
|
|
8077
|
+
* Label can be between 2-64 characters, including spaces.
|
|
7575
8078
|
*
|
|
7576
8079
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
7577
8080
|
*/
|
|
@@ -7601,6 +8104,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7601
8104
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
7602
8105
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
7603
8106
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
8107
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
7604
8108
|
*/
|
|
7605
8109
|
ttl?: string;
|
|
7606
8110
|
/** The secret version metadata that a user can customize. */
|
|
@@ -7621,7 +8125,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7621
8125
|
}
|
|
7622
8126
|
}
|
|
7623
8127
|
}
|
|
7624
|
-
/**
|
|
8128
|
+
/**
|
|
8129
|
+
* Your service credentials secret version.
|
|
8130
|
+
*/
|
|
7625
8131
|
interface ServiceCredentialsSecretVersion extends SecretVersion {
|
|
7626
8132
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
7627
8133
|
auto_rotated?: boolean;
|
|
@@ -7682,7 +8188,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7682
8188
|
}
|
|
7683
8189
|
}
|
|
7684
8190
|
}
|
|
7685
|
-
/**
|
|
8191
|
+
/**
|
|
8192
|
+
* The version metadata properties for your service credentials secret.
|
|
8193
|
+
*/
|
|
7686
8194
|
interface ServiceCredentialsSecretVersionMetadata extends SecretVersionMetadata {
|
|
7687
8195
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
7688
8196
|
auto_rotated?: boolean;
|
|
@@ -7741,14 +8249,18 @@ declare namespace SecretsManagerV2 {
|
|
|
7741
8249
|
}
|
|
7742
8250
|
}
|
|
7743
8251
|
}
|
|
7744
|
-
/**
|
|
8252
|
+
/**
|
|
8253
|
+
* ServiceCredentialsSecretVersionPrototype.
|
|
8254
|
+
*/
|
|
7745
8255
|
interface ServiceCredentialsSecretVersionPrototype extends SecretVersionPrototype {
|
|
7746
8256
|
/** The secret metadata that a user can customize. */
|
|
7747
8257
|
custom_metadata?: JsonObject;
|
|
7748
8258
|
/** The secret version metadata that a user can customize. */
|
|
7749
8259
|
version_custom_metadata?: JsonObject;
|
|
7750
8260
|
}
|
|
7751
|
-
/**
|
|
8261
|
+
/**
|
|
8262
|
+
* Your user credentials secret.
|
|
8263
|
+
*/
|
|
7752
8264
|
interface UsernamePasswordSecret extends Secret {
|
|
7753
8265
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7754
8266
|
created_by: string;
|
|
@@ -7772,7 +8284,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7772
8284
|
id: string;
|
|
7773
8285
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
7774
8286
|
*
|
|
7775
|
-
* Label can be between 2-
|
|
8287
|
+
* Label can be between 2-64 characters, including spaces.
|
|
7776
8288
|
*
|
|
7777
8289
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
7778
8290
|
*/
|
|
@@ -7797,6 +8309,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7797
8309
|
updated_at: string;
|
|
7798
8310
|
/** The number of versions of your secret. */
|
|
7799
8311
|
versions_total: number;
|
|
8312
|
+
/** The list of configurations that have a reference to the secret. */
|
|
8313
|
+
referenced_by?: string[];
|
|
7800
8314
|
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
7801
8315
|
* username_password, private_cert, public_cert, iam_credentials.
|
|
7802
8316
|
*/
|
|
@@ -7841,7 +8355,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7841
8355
|
}
|
|
7842
8356
|
}
|
|
7843
8357
|
}
|
|
7844
|
-
/**
|
|
8358
|
+
/**
|
|
8359
|
+
* Properties of the metadata of your user credentials secret.
|
|
8360
|
+
*/
|
|
7845
8361
|
interface UsernamePasswordSecretMetadata extends SecretMetadata {
|
|
7846
8362
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7847
8363
|
created_by: string;
|
|
@@ -7865,7 +8381,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7865
8381
|
id: string;
|
|
7866
8382
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
7867
8383
|
*
|
|
7868
|
-
* Label can be between 2-
|
|
8384
|
+
* Label can be between 2-64 characters, including spaces.
|
|
7869
8385
|
*
|
|
7870
8386
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
7871
8387
|
*/
|
|
@@ -7890,6 +8406,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7890
8406
|
updated_at: string;
|
|
7891
8407
|
/** The number of versions of your secret. */
|
|
7892
8408
|
versions_total: number;
|
|
8409
|
+
/** The list of configurations that have a reference to the secret. */
|
|
8410
|
+
referenced_by?: string[];
|
|
7893
8411
|
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
7894
8412
|
* username_password, private_cert, public_cert, iam_credentials.
|
|
7895
8413
|
*/
|
|
@@ -7930,7 +8448,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7930
8448
|
}
|
|
7931
8449
|
}
|
|
7932
8450
|
}
|
|
7933
|
-
/**
|
|
8451
|
+
/**
|
|
8452
|
+
* UsernamePasswordSecretMetadataPatch.
|
|
8453
|
+
*/
|
|
7934
8454
|
interface UsernamePasswordSecretMetadataPatch extends SecretMetadataPatch {
|
|
7935
8455
|
/** A human-readable name to assign to your secret.
|
|
7936
8456
|
*
|
|
@@ -7945,7 +8465,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7945
8465
|
description?: string;
|
|
7946
8466
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
7947
8467
|
*
|
|
7948
|
-
* Label can be between 2-
|
|
8468
|
+
* Label can be between 2-64 characters, including spaces.
|
|
7949
8469
|
*
|
|
7950
8470
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
7951
8471
|
*/
|
|
@@ -7965,7 +8485,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7965
8485
|
*/
|
|
7966
8486
|
password_generation_policy?: PasswordGenerationPolicyPatch;
|
|
7967
8487
|
}
|
|
7968
|
-
/**
|
|
8488
|
+
/**
|
|
8489
|
+
* UsernamePasswordSecretPrototype.
|
|
8490
|
+
*/
|
|
7969
8491
|
interface UsernamePasswordSecretPrototype extends SecretPrototype {
|
|
7970
8492
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
7971
8493
|
* service_credentials, kv, and username_password.
|
|
@@ -7986,7 +8508,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7986
8508
|
secret_group_id?: string;
|
|
7987
8509
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
7988
8510
|
*
|
|
7989
|
-
* Label can be between 2-
|
|
8511
|
+
* Label can be between 2-64 characters, including spaces.
|
|
7990
8512
|
*
|
|
7991
8513
|
* To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
|
|
7992
8514
|
*/
|
|
@@ -8027,7 +8549,9 @@ declare namespace SecretsManagerV2 {
|
|
|
8027
8549
|
}
|
|
8028
8550
|
}
|
|
8029
8551
|
}
|
|
8030
|
-
/**
|
|
8552
|
+
/**
|
|
8553
|
+
* Your user credentials secret version.
|
|
8554
|
+
*/
|
|
8031
8555
|
interface UsernamePasswordSecretVersion extends SecretVersion {
|
|
8032
8556
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
8033
8557
|
auto_rotated?: boolean;
|
|
@@ -8084,7 +8608,9 @@ declare namespace SecretsManagerV2 {
|
|
|
8084
8608
|
}
|
|
8085
8609
|
}
|
|
8086
8610
|
}
|
|
8087
|
-
/**
|
|
8611
|
+
/**
|
|
8612
|
+
* Properties of the version metadata of your user credentials secret.
|
|
8613
|
+
*/
|
|
8088
8614
|
interface UsernamePasswordSecretVersionMetadata extends SecretVersionMetadata {
|
|
8089
8615
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
8090
8616
|
auto_rotated?: boolean;
|
|
@@ -8137,7 +8663,9 @@ declare namespace SecretsManagerV2 {
|
|
|
8137
8663
|
}
|
|
8138
8664
|
}
|
|
8139
8665
|
}
|
|
8140
|
-
/**
|
|
8666
|
+
/**
|
|
8667
|
+
* UsernamePasswordSecretVersionPrototype.
|
|
8668
|
+
*/
|
|
8141
8669
|
interface UsernamePasswordSecretVersionPrototype extends SecretVersionPrototype {
|
|
8142
8670
|
/** The password that is assigned to an `username_password` secret. If you omit this parameter, Secrets Manager
|
|
8143
8671
|
* generates a new random password for your secret.
|