@ibm-cloud/secrets-manager 2.0.4 → 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 +2 -0
- package/README.md +1 -2
- package/examples/secrets-manager.v2.test.js +13 -26
- package/package.json +2 -2
- package/secrets-manager/v2.d.ts +731 -261
- package/secrets-manager/v2.js +107 -77
- package/secrets-manager/v2.js.map +1 -1
package/secrets-manager/v2.d.ts
CHANGED
|
@@ -662,6 +662,13 @@ declare class SecretsManagerV2 extends BaseService {
|
|
|
662
662
|
*
|
|
663
663
|
* **Usage:** If you want to list only the configurations that contain the string `text`, use
|
|
664
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`.
|
|
665
672
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
666
673
|
* @returns {Promise<SecretsManagerV2.Response<SecretsManagerV2.ConfigurationMetadataPaginatedCollection>>}
|
|
667
674
|
*/
|
|
@@ -1281,8 +1288,25 @@ declare namespace SecretsManagerV2 {
|
|
|
1281
1288
|
* `../configurations?search=text`.
|
|
1282
1289
|
*/
|
|
1283
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[];
|
|
1284
1299
|
headers?: OutgoingHttpHeaders;
|
|
1285
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
|
+
}
|
|
1286
1310
|
/** Parameters for the `getConfiguration` operation. */
|
|
1287
1311
|
interface GetConfigurationParams {
|
|
1288
1312
|
/** The name that uniquely identifies a configuration. */
|
|
@@ -1295,13 +1319,13 @@ declare namespace SecretsManagerV2 {
|
|
|
1295
1319
|
namespace GetConfigurationConstants {
|
|
1296
1320
|
/** The configuration type of this configuration - use this header to resolve 300 error responses. */
|
|
1297
1321
|
enum XSmAcceptConfigurationType {
|
|
1298
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1299
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1300
1322
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
1301
|
-
|
|
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",
|
|
1302
1325
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
1303
1326
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
1304
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
1327
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
1328
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
1305
1329
|
}
|
|
1306
1330
|
}
|
|
1307
1331
|
/** Parameters for the `updateConfiguration` operation. */
|
|
@@ -1317,13 +1341,13 @@ declare namespace SecretsManagerV2 {
|
|
|
1317
1341
|
namespace UpdateConfigurationConstants {
|
|
1318
1342
|
/** The configuration type of this configuration - use this header to resolve 300 error responses. */
|
|
1319
1343
|
enum XSmAcceptConfigurationType {
|
|
1320
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1321
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1322
1344
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
1323
|
-
|
|
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",
|
|
1324
1347
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
1325
1348
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
1326
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
1349
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
1350
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
1327
1351
|
}
|
|
1328
1352
|
}
|
|
1329
1353
|
/** Parameters for the `deleteConfiguration` operation. */
|
|
@@ -1338,13 +1362,13 @@ declare namespace SecretsManagerV2 {
|
|
|
1338
1362
|
namespace DeleteConfigurationConstants {
|
|
1339
1363
|
/** The configuration type of this configuration - use this header to resolve 300 error responses. */
|
|
1340
1364
|
enum XSmAcceptConfigurationType {
|
|
1341
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1342
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1343
1365
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
1344
|
-
|
|
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",
|
|
1345
1368
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
1346
1369
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
1347
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
1370
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
1371
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
1348
1372
|
}
|
|
1349
1373
|
}
|
|
1350
1374
|
/** Parameters for the `createConfigurationAction` operation. */
|
|
@@ -1360,13 +1384,13 @@ declare namespace SecretsManagerV2 {
|
|
|
1360
1384
|
namespace CreateConfigurationActionConstants {
|
|
1361
1385
|
/** The configuration type of this configuration - use this header to resolve 300 error responses. */
|
|
1362
1386
|
enum XSmAcceptConfigurationType {
|
|
1363
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1364
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1365
1387
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
1366
|
-
|
|
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",
|
|
1367
1390
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
1368
1391
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
1369
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
1392
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
1393
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
1370
1394
|
}
|
|
1371
1395
|
}
|
|
1372
1396
|
/** Parameters for the `createNotificationsRegistration` operation. */
|
|
@@ -1394,7 +1418,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1394
1418
|
/*************************
|
|
1395
1419
|
* model interfaces
|
|
1396
1420
|
************************/
|
|
1397
|
-
/**
|
|
1421
|
+
/**
|
|
1422
|
+
* Issuance information that is associated with your certificate.
|
|
1423
|
+
*/
|
|
1398
1424
|
interface CertificateIssuanceInfo {
|
|
1399
1425
|
/** This parameter indicates whether the issued certificate is configured with an automatic rotation policy. */
|
|
1400
1426
|
auto_rotated?: boolean;
|
|
@@ -1435,14 +1461,18 @@ declare namespace SecretsManagerV2 {
|
|
|
1435
1461
|
}
|
|
1436
1462
|
}
|
|
1437
1463
|
}
|
|
1438
|
-
/**
|
|
1464
|
+
/**
|
|
1465
|
+
* The date and time that the certificate validity period begins and ends.
|
|
1466
|
+
*/
|
|
1439
1467
|
interface CertificateValidity {
|
|
1440
1468
|
/** The date-time format follows `RFC 3339`. */
|
|
1441
1469
|
not_before: string;
|
|
1442
1470
|
/** The date-time format follows `RFC 3339`. */
|
|
1443
1471
|
not_after: string;
|
|
1444
1472
|
}
|
|
1445
|
-
/**
|
|
1473
|
+
/**
|
|
1474
|
+
* Properties that describe a challenge.
|
|
1475
|
+
*/
|
|
1446
1476
|
interface ChallengeResource {
|
|
1447
1477
|
/** The challenge domain. */
|
|
1448
1478
|
domain?: string;
|
|
@@ -1455,19 +1485,29 @@ declare namespace SecretsManagerV2 {
|
|
|
1455
1485
|
/** The TXT record value. */
|
|
1456
1486
|
txt_record_value?: string;
|
|
1457
1487
|
}
|
|
1458
|
-
/**
|
|
1488
|
+
/**
|
|
1489
|
+
* Your configuration.
|
|
1490
|
+
*/
|
|
1459
1491
|
interface Configuration {
|
|
1460
1492
|
}
|
|
1461
|
-
/**
|
|
1493
|
+
/**
|
|
1494
|
+
* The response body to specify the properties of the action to create a configuration.
|
|
1495
|
+
*/
|
|
1462
1496
|
interface ConfigurationAction {
|
|
1463
1497
|
}
|
|
1464
|
-
/**
|
|
1498
|
+
/**
|
|
1499
|
+
* The request body to specify the properties of the action to create a configuration.
|
|
1500
|
+
*/
|
|
1465
1501
|
interface ConfigurationActionPrototype {
|
|
1466
1502
|
}
|
|
1467
|
-
/**
|
|
1503
|
+
/**
|
|
1504
|
+
* Your configuration metadata properties.
|
|
1505
|
+
*/
|
|
1468
1506
|
interface ConfigurationMetadata {
|
|
1469
1507
|
}
|
|
1470
|
-
/**
|
|
1508
|
+
/**
|
|
1509
|
+
* Properties that describe a paginated collection of secret locks.
|
|
1510
|
+
*/
|
|
1471
1511
|
interface ConfigurationMetadataPaginatedCollection {
|
|
1472
1512
|
/** The total number of resources in a collection. */
|
|
1473
1513
|
total_count: number;
|
|
@@ -1486,38 +1526,54 @@ declare namespace SecretsManagerV2 {
|
|
|
1486
1526
|
/** A collection of configuration metadata. */
|
|
1487
1527
|
configurations: ConfigurationMetadata[];
|
|
1488
1528
|
}
|
|
1489
|
-
/**
|
|
1529
|
+
/**
|
|
1530
|
+
* Your configuration update data.
|
|
1531
|
+
*/
|
|
1490
1532
|
interface ConfigurationPatch {
|
|
1491
1533
|
}
|
|
1492
|
-
/**
|
|
1534
|
+
/**
|
|
1535
|
+
* The details of your configuration.
|
|
1536
|
+
*/
|
|
1493
1537
|
interface ConfigurationPrototype {
|
|
1494
1538
|
}
|
|
1495
|
-
/**
|
|
1539
|
+
/**
|
|
1540
|
+
* The details of the Event Notifications registration.
|
|
1541
|
+
*/
|
|
1496
1542
|
interface NotificationsRegistration {
|
|
1497
1543
|
/** A CRN that uniquely identifies an IBM Cloud resource. */
|
|
1498
1544
|
event_notifications_instance_crn: string;
|
|
1499
1545
|
}
|
|
1500
|
-
/**
|
|
1546
|
+
/**
|
|
1547
|
+
* A URL that points to the first page in a collection.
|
|
1548
|
+
*/
|
|
1501
1549
|
interface PaginatedCollectionFirst {
|
|
1502
1550
|
/** A URL that points to a page in a collection. */
|
|
1503
1551
|
href: string;
|
|
1504
1552
|
}
|
|
1505
|
-
/**
|
|
1553
|
+
/**
|
|
1554
|
+
* A URL that points to the last page in a collection.
|
|
1555
|
+
*/
|
|
1506
1556
|
interface PaginatedCollectionLast {
|
|
1507
1557
|
/** A URL that points to a page in a collection. */
|
|
1508
1558
|
href: string;
|
|
1509
1559
|
}
|
|
1510
|
-
/**
|
|
1560
|
+
/**
|
|
1561
|
+
* A URL that points to the next page in a collection.
|
|
1562
|
+
*/
|
|
1511
1563
|
interface PaginatedCollectionNext {
|
|
1512
1564
|
/** A URL that points to a page in a collection. */
|
|
1513
1565
|
href: string;
|
|
1514
1566
|
}
|
|
1515
|
-
/**
|
|
1567
|
+
/**
|
|
1568
|
+
* A URL that points to the previous page in a collection.
|
|
1569
|
+
*/
|
|
1516
1570
|
interface PaginatedCollectionPrevious {
|
|
1517
1571
|
/** A URL that points to a page in a collection. */
|
|
1518
1572
|
href: string;
|
|
1519
1573
|
}
|
|
1520
|
-
/**
|
|
1574
|
+
/**
|
|
1575
|
+
* Policy for auto-generated passwords.
|
|
1576
|
+
*/
|
|
1521
1577
|
interface PasswordGenerationPolicy {
|
|
1522
1578
|
/** The length of auto-generated passwords. */
|
|
1523
1579
|
length?: number;
|
|
@@ -1528,7 +1584,10 @@ declare namespace SecretsManagerV2 {
|
|
|
1528
1584
|
/** Include uppercase letters in auto-generated passwords. */
|
|
1529
1585
|
include_uppercase?: boolean;
|
|
1530
1586
|
}
|
|
1531
|
-
/**
|
|
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
|
+
*/
|
|
1532
1591
|
interface PasswordGenerationPolicyPatch {
|
|
1533
1592
|
/** The length of auto-generated passwords. */
|
|
1534
1593
|
length?: number;
|
|
@@ -1539,7 +1598,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1539
1598
|
/** Include uppercase letters in auto-generated passwords. */
|
|
1540
1599
|
include_uppercase?: boolean;
|
|
1541
1600
|
}
|
|
1542
|
-
/**
|
|
1601
|
+
/**
|
|
1602
|
+
* Policy for auto-generated passwords.
|
|
1603
|
+
*/
|
|
1543
1604
|
interface PasswordGenerationPolicyRO {
|
|
1544
1605
|
/** The length of auto-generated passwords. */
|
|
1545
1606
|
length?: number;
|
|
@@ -1550,10 +1611,40 @@ declare namespace SecretsManagerV2 {
|
|
|
1550
1611
|
/** Include uppercase letters in auto-generated passwords. */
|
|
1551
1612
|
include_uppercase?: boolean;
|
|
1552
1613
|
}
|
|
1553
|
-
/**
|
|
1614
|
+
/**
|
|
1615
|
+
* The configuration data of your Private Certificate.
|
|
1616
|
+
*/
|
|
1554
1617
|
interface PrivateCertificateCAData {
|
|
1555
1618
|
}
|
|
1556
|
-
/**
|
|
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
|
+
*/
|
|
1557
1648
|
interface PublicCertificateRotationObject {
|
|
1558
1649
|
/** This field indicates whether Secrets Manager rotates the private key for your public certificate
|
|
1559
1650
|
* automatically.
|
|
@@ -1563,19 +1654,30 @@ declare namespace SecretsManagerV2 {
|
|
|
1563
1654
|
*/
|
|
1564
1655
|
rotate_keys?: boolean;
|
|
1565
1656
|
}
|
|
1566
|
-
/**
|
|
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
|
+
*/
|
|
1567
1661
|
interface RotationPolicy {
|
|
1568
1662
|
}
|
|
1569
|
-
/**
|
|
1663
|
+
/**
|
|
1664
|
+
* Your secret.
|
|
1665
|
+
*/
|
|
1570
1666
|
interface Secret {
|
|
1571
1667
|
}
|
|
1572
|
-
/**
|
|
1668
|
+
/**
|
|
1669
|
+
* The response body to specify the properties of the action to create a secret.
|
|
1670
|
+
*/
|
|
1573
1671
|
interface SecretAction {
|
|
1574
1672
|
}
|
|
1575
|
-
/**
|
|
1673
|
+
/**
|
|
1674
|
+
* The request body to specify the properties for your secret action.
|
|
1675
|
+
*/
|
|
1576
1676
|
interface SecretActionPrototype {
|
|
1577
1677
|
}
|
|
1578
|
-
/**
|
|
1678
|
+
/**
|
|
1679
|
+
* Properties that describe a secret group.
|
|
1680
|
+
*/
|
|
1579
1681
|
interface SecretGroup {
|
|
1580
1682
|
/** A v4 UUID identifier, or `default` secret group. */
|
|
1581
1683
|
id: string;
|
|
@@ -1594,14 +1696,18 @@ declare namespace SecretsManagerV2 {
|
|
|
1594
1696
|
/** The date when a resource was modified. The date format follows `RFC 3339`. */
|
|
1595
1697
|
updated_at: string;
|
|
1596
1698
|
}
|
|
1597
|
-
/**
|
|
1699
|
+
/**
|
|
1700
|
+
* Properties that describe a collection of secret groups.
|
|
1701
|
+
*/
|
|
1598
1702
|
interface SecretGroupCollection {
|
|
1599
1703
|
/** A collection of secret groups. */
|
|
1600
1704
|
secret_groups: SecretGroup[];
|
|
1601
1705
|
/** The total number of resources in a collection. */
|
|
1602
1706
|
total_count: number;
|
|
1603
1707
|
}
|
|
1604
|
-
/**
|
|
1708
|
+
/**
|
|
1709
|
+
* SecretLock.
|
|
1710
|
+
*/
|
|
1605
1711
|
interface SecretLock {
|
|
1606
1712
|
/** A human-readable name to assign to the lock. The lock name must be unique per secret version.
|
|
1607
1713
|
*
|
|
@@ -1643,7 +1749,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1643
1749
|
}
|
|
1644
1750
|
}
|
|
1645
1751
|
}
|
|
1646
|
-
/**
|
|
1752
|
+
/**
|
|
1753
|
+
* SecretLockPrototype.
|
|
1754
|
+
*/
|
|
1647
1755
|
interface SecretLockPrototype {
|
|
1648
1756
|
/** A human-readable name to assign to the lock. The lock name must be unique per secret version.
|
|
1649
1757
|
*
|
|
@@ -1660,7 +1768,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1660
1768
|
/** Optional information to associate with a lock, such as resources CRNs to be used by automation. */
|
|
1661
1769
|
attributes?: JsonObject;
|
|
1662
1770
|
}
|
|
1663
|
-
/**
|
|
1771
|
+
/**
|
|
1772
|
+
* Create locks response body containing a collection of locks that are attached to a secret.
|
|
1773
|
+
*/
|
|
1664
1774
|
interface SecretLocks {
|
|
1665
1775
|
/** A v4 UUID identifier. */
|
|
1666
1776
|
secret_id: string;
|
|
@@ -1690,7 +1800,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1690
1800
|
}
|
|
1691
1801
|
}
|
|
1692
1802
|
}
|
|
1693
|
-
/**
|
|
1803
|
+
/**
|
|
1804
|
+
* Properties that describe a paginated collection of your secret locks.
|
|
1805
|
+
*/
|
|
1694
1806
|
interface SecretLocksPaginatedCollection {
|
|
1695
1807
|
/** The total number of resources in a collection. */
|
|
1696
1808
|
total_count: number;
|
|
@@ -1709,10 +1821,14 @@ declare namespace SecretsManagerV2 {
|
|
|
1709
1821
|
/** A collection of secret locks. */
|
|
1710
1822
|
locks: SecretLock[];
|
|
1711
1823
|
}
|
|
1712
|
-
/**
|
|
1824
|
+
/**
|
|
1825
|
+
* Properties of your secret metadata.
|
|
1826
|
+
*/
|
|
1713
1827
|
interface SecretMetadata {
|
|
1714
1828
|
}
|
|
1715
|
-
/**
|
|
1829
|
+
/**
|
|
1830
|
+
* Properties that describe a paginated collection of your secret metadata.
|
|
1831
|
+
*/
|
|
1716
1832
|
interface SecretMetadataPaginatedCollection {
|
|
1717
1833
|
/** The total number of resources in a collection. */
|
|
1718
1834
|
total_count: number;
|
|
@@ -1731,19 +1847,29 @@ declare namespace SecretsManagerV2 {
|
|
|
1731
1847
|
/** A collection of secret metadata. */
|
|
1732
1848
|
secrets: SecretMetadata[];
|
|
1733
1849
|
}
|
|
1734
|
-
/**
|
|
1850
|
+
/**
|
|
1851
|
+
* Update your secret metadata.
|
|
1852
|
+
*/
|
|
1735
1853
|
interface SecretMetadataPatch {
|
|
1736
1854
|
}
|
|
1737
|
-
/**
|
|
1855
|
+
/**
|
|
1856
|
+
* Specify the properties for your secret.
|
|
1857
|
+
*/
|
|
1738
1858
|
interface SecretPrototype {
|
|
1739
1859
|
}
|
|
1740
|
-
/**
|
|
1860
|
+
/**
|
|
1861
|
+
* Your secret version.
|
|
1862
|
+
*/
|
|
1741
1863
|
interface SecretVersion {
|
|
1742
1864
|
}
|
|
1743
|
-
/**
|
|
1865
|
+
/**
|
|
1866
|
+
* The request body to specify the properties of the action to create a secret version.
|
|
1867
|
+
*/
|
|
1744
1868
|
interface SecretVersionActionPrototype {
|
|
1745
1869
|
}
|
|
1746
|
-
/**
|
|
1870
|
+
/**
|
|
1871
|
+
* SecretVersionLocks.
|
|
1872
|
+
*/
|
|
1747
1873
|
interface SecretVersionLocks {
|
|
1748
1874
|
/** A v4 UUID identifier. */
|
|
1749
1875
|
version_id: string;
|
|
@@ -1765,7 +1891,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1765
1891
|
}
|
|
1766
1892
|
}
|
|
1767
1893
|
}
|
|
1768
|
-
/**
|
|
1894
|
+
/**
|
|
1895
|
+
* Properties that describe a paginated collection of your secret version locks.
|
|
1896
|
+
*/
|
|
1769
1897
|
interface SecretVersionLocksPaginatedCollection {
|
|
1770
1898
|
/** The total number of resources in a collection. */
|
|
1771
1899
|
total_count: number;
|
|
@@ -1784,20 +1912,28 @@ declare namespace SecretsManagerV2 {
|
|
|
1784
1912
|
/** A collection of secret version locks. */
|
|
1785
1913
|
locks: SecretLock[];
|
|
1786
1914
|
}
|
|
1787
|
-
/**
|
|
1915
|
+
/**
|
|
1916
|
+
* Properties of the version metadata of your secret.
|
|
1917
|
+
*/
|
|
1788
1918
|
interface SecretVersionMetadata {
|
|
1789
1919
|
}
|
|
1790
|
-
/**
|
|
1920
|
+
/**
|
|
1921
|
+
* Properties that describe a collection of your secret version metadata.
|
|
1922
|
+
*/
|
|
1791
1923
|
interface SecretVersionMetadataCollection {
|
|
1792
1924
|
/** A collection of secret version metadata. */
|
|
1793
1925
|
versions: SecretVersionMetadata[];
|
|
1794
1926
|
/** The total number of resources in a collection. */
|
|
1795
1927
|
total_count: number;
|
|
1796
1928
|
}
|
|
1797
|
-
/**
|
|
1929
|
+
/**
|
|
1930
|
+
* Specify the properties for your new secret version.
|
|
1931
|
+
*/
|
|
1798
1932
|
interface SecretVersionPrototype {
|
|
1799
1933
|
}
|
|
1800
|
-
/**
|
|
1934
|
+
/**
|
|
1935
|
+
* Properties that describe a paginated collection of your secrets locks.
|
|
1936
|
+
*/
|
|
1801
1937
|
interface SecretsLocksPaginatedCollection {
|
|
1802
1938
|
/** The total number of resources in a collection. */
|
|
1803
1939
|
total_count: number;
|
|
@@ -1816,14 +1952,20 @@ declare namespace SecretsManagerV2 {
|
|
|
1816
1952
|
/** A collection of secrets and their locks. */
|
|
1817
1953
|
secrets_locks: SecretLocks[];
|
|
1818
1954
|
}
|
|
1819
|
-
/**
|
|
1955
|
+
/**
|
|
1956
|
+
* The source service resource key data of the generated service credentials.
|
|
1957
|
+
*/
|
|
1820
1958
|
interface ServiceCredentialsResourceKey {
|
|
1821
1959
|
/** The resource key CRN of the generated service credentials. */
|
|
1822
1960
|
crn?: string;
|
|
1823
1961
|
/** The resource key name of the generated service credentials. */
|
|
1824
1962
|
name?: string;
|
|
1825
1963
|
}
|
|
1826
|
-
/**
|
|
1964
|
+
/**
|
|
1965
|
+
* The properties of the service credentials secret payload.
|
|
1966
|
+
*
|
|
1967
|
+
* This type supports additional properties of type any.
|
|
1968
|
+
*/
|
|
1827
1969
|
interface ServiceCredentialsSecretCredentials {
|
|
1828
1970
|
/** The API key that is generated for this secret.
|
|
1829
1971
|
*
|
|
@@ -1841,10 +1983,14 @@ declare namespace SecretsManagerV2 {
|
|
|
1841
1983
|
iam_role_crn?: string;
|
|
1842
1984
|
/** The IAM Service ID CRN. */
|
|
1843
1985
|
iam_serviceid_crn?: string;
|
|
1844
|
-
/**
|
|
1986
|
+
/**
|
|
1987
|
+
* ServiceCredentialsSecretCredentials accepts additional properties of type any.
|
|
1988
|
+
*/
|
|
1845
1989
|
[propName: string]: any;
|
|
1846
1990
|
}
|
|
1847
|
-
/**
|
|
1991
|
+
/**
|
|
1992
|
+
* The properties that are required to create the service credentials for the specified source service instance.
|
|
1993
|
+
*/
|
|
1848
1994
|
interface ServiceCredentialsSecretSourceService {
|
|
1849
1995
|
/** The source service instance identifier. */
|
|
1850
1996
|
instance: ServiceCredentialsSourceServiceInstance;
|
|
@@ -1861,7 +2007,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1861
2007
|
*/
|
|
1862
2008
|
role?: ServiceCredentialsSourceServiceRole;
|
|
1863
2009
|
}
|
|
1864
|
-
/**
|
|
2010
|
+
/**
|
|
2011
|
+
* The properties of the resource key that was created for this source service instance.
|
|
2012
|
+
*/
|
|
1865
2013
|
interface ServiceCredentialsSecretSourceServiceRO {
|
|
1866
2014
|
/** The source service instance identifier. */
|
|
1867
2015
|
instance: ServiceCredentialsSourceServiceInstance;
|
|
@@ -1882,7 +2030,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1882
2030
|
/** The source service resource key data of the generated service credentials. */
|
|
1883
2031
|
resource_key?: ServiceCredentialsResourceKey;
|
|
1884
2032
|
}
|
|
1885
|
-
/**
|
|
2033
|
+
/**
|
|
2034
|
+
* The source service IAM data is returned in case IAM credentials where created for this secret.
|
|
2035
|
+
*/
|
|
1886
2036
|
interface ServiceCredentialsSourceServiceIam {
|
|
1887
2037
|
/** The IAM apikey metadata for the IAM credentials that were generated. */
|
|
1888
2038
|
apikey?: ServiceCredentialsSourceServiceIamApikey;
|
|
@@ -1891,7 +2041,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1891
2041
|
/** The IAM serviceid for the generated service credentials. */
|
|
1892
2042
|
serviceid?: ServiceCredentialsSourceServiceIamServiceid;
|
|
1893
2043
|
}
|
|
1894
|
-
/**
|
|
2044
|
+
/**
|
|
2045
|
+
* The IAM apikey metadata for the IAM credentials that were generated.
|
|
2046
|
+
*/
|
|
1895
2047
|
interface ServiceCredentialsSourceServiceIamApikey {
|
|
1896
2048
|
/** The IAM API key description for the generated service credentials. */
|
|
1897
2049
|
description?: string;
|
|
@@ -1900,37 +2052,60 @@ declare namespace SecretsManagerV2 {
|
|
|
1900
2052
|
/** The IAM API key name for the generated service credentials. */
|
|
1901
2053
|
name?: string;
|
|
1902
2054
|
}
|
|
1903
|
-
/**
|
|
2055
|
+
/**
|
|
2056
|
+
* The IAM role for the generate service credentials.
|
|
2057
|
+
*/
|
|
1904
2058
|
interface ServiceCredentialsSourceServiceIamRole {
|
|
1905
2059
|
/** The IAM role CRN assigned to the generated service credentials. */
|
|
1906
2060
|
crn?: string;
|
|
1907
2061
|
}
|
|
1908
|
-
/**
|
|
2062
|
+
/**
|
|
2063
|
+
* The IAM serviceid for the generated service credentials.
|
|
2064
|
+
*/
|
|
1909
2065
|
interface ServiceCredentialsSourceServiceIamServiceid {
|
|
1910
2066
|
/** The IAM Service ID CRN. */
|
|
1911
2067
|
crn?: string;
|
|
1912
2068
|
}
|
|
1913
|
-
/**
|
|
2069
|
+
/**
|
|
2070
|
+
* The source service instance identifier.
|
|
2071
|
+
*/
|
|
1914
2072
|
interface ServiceCredentialsSourceServiceInstance {
|
|
1915
2073
|
/** A CRN that uniquely identifies a service credentials source. */
|
|
1916
2074
|
crn?: string;
|
|
1917
2075
|
}
|
|
1918
|
-
/**
|
|
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
|
+
*/
|
|
1919
2083
|
interface ServiceCredentialsSourceServiceParameters {
|
|
1920
2084
|
/** An optional platform defined option to reuse an existing IAM Service ID for the role assignment. */
|
|
1921
2085
|
serviceid_crn?: string;
|
|
1922
|
-
/**
|
|
2086
|
+
/**
|
|
2087
|
+
* ServiceCredentialsSourceServiceParameters accepts additional properties of type any.
|
|
2088
|
+
*/
|
|
1923
2089
|
[propName: string]: any;
|
|
1924
2090
|
}
|
|
1925
|
-
/**
|
|
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
|
+
*/
|
|
1926
2097
|
interface ServiceCredentialsSourceServiceRole {
|
|
1927
2098
|
/** The service role CRN. */
|
|
1928
2099
|
crn: string;
|
|
1929
2100
|
}
|
|
1930
|
-
/**
|
|
2101
|
+
/**
|
|
2102
|
+
* The request body to specify the properties of the action to create a secret version.
|
|
2103
|
+
*/
|
|
1931
2104
|
interface VersionAction {
|
|
1932
2105
|
}
|
|
1933
|
-
/**
|
|
2106
|
+
/**
|
|
2107
|
+
* Your arbitrary secret.
|
|
2108
|
+
*/
|
|
1934
2109
|
interface ArbitrarySecret extends Secret {
|
|
1935
2110
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
1936
2111
|
created_by: string;
|
|
@@ -1979,6 +2154,8 @@ declare namespace SecretsManagerV2 {
|
|
|
1979
2154
|
updated_at: string;
|
|
1980
2155
|
/** The number of versions of your secret. */
|
|
1981
2156
|
versions_total: number;
|
|
2157
|
+
/** The list of configurations that have a reference to the secret. */
|
|
2158
|
+
referenced_by?: string[];
|
|
1982
2159
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
1983
2160
|
* types: Arbitrary, username_password.
|
|
1984
2161
|
*/
|
|
@@ -2009,7 +2186,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2009
2186
|
}
|
|
2010
2187
|
}
|
|
2011
2188
|
}
|
|
2012
|
-
/**
|
|
2189
|
+
/**
|
|
2190
|
+
* Properties of the metadata of your arbitrary secret..
|
|
2191
|
+
*/
|
|
2013
2192
|
interface ArbitrarySecretMetadata extends SecretMetadata {
|
|
2014
2193
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
2015
2194
|
created_by: string;
|
|
@@ -2058,6 +2237,8 @@ declare namespace SecretsManagerV2 {
|
|
|
2058
2237
|
updated_at: string;
|
|
2059
2238
|
/** The number of versions of your secret. */
|
|
2060
2239
|
versions_total: number;
|
|
2240
|
+
/** The list of configurations that have a reference to the secret. */
|
|
2241
|
+
referenced_by?: string[];
|
|
2061
2242
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
2062
2243
|
* types: Arbitrary, username_password.
|
|
2063
2244
|
*/
|
|
@@ -2086,7 +2267,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2086
2267
|
}
|
|
2087
2268
|
}
|
|
2088
2269
|
}
|
|
2089
|
-
/**
|
|
2270
|
+
/**
|
|
2271
|
+
* ArbitrarySecretMetadataPatch.
|
|
2272
|
+
*/
|
|
2090
2273
|
interface ArbitrarySecretMetadataPatch extends SecretMetadataPatch {
|
|
2091
2274
|
/** A human-readable name to assign to your secret.
|
|
2092
2275
|
*
|
|
@@ -2113,7 +2296,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2113
2296
|
*/
|
|
2114
2297
|
expiration_date?: string;
|
|
2115
2298
|
}
|
|
2116
|
-
/**
|
|
2299
|
+
/**
|
|
2300
|
+
* ArbitrarySecretPrototype.
|
|
2301
|
+
*/
|
|
2117
2302
|
interface ArbitrarySecretPrototype extends SecretPrototype {
|
|
2118
2303
|
/** The secret metadata that a user can customize. */
|
|
2119
2304
|
custom_metadata?: JsonObject;
|
|
@@ -2165,7 +2350,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2165
2350
|
}
|
|
2166
2351
|
}
|
|
2167
2352
|
}
|
|
2168
|
-
/**
|
|
2353
|
+
/**
|
|
2354
|
+
* Your arbitrary secret version.
|
|
2355
|
+
*/
|
|
2169
2356
|
interface ArbitrarySecretVersion extends SecretVersion {
|
|
2170
2357
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
2171
2358
|
auto_rotated?: boolean;
|
|
@@ -2224,7 +2411,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2224
2411
|
}
|
|
2225
2412
|
}
|
|
2226
2413
|
}
|
|
2227
|
-
/**
|
|
2414
|
+
/**
|
|
2415
|
+
* Properties of the version metadata of your arbitrary secret.
|
|
2416
|
+
*/
|
|
2228
2417
|
interface ArbitrarySecretVersionMetadata extends SecretVersionMetadata {
|
|
2229
2418
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
2230
2419
|
auto_rotated?: boolean;
|
|
@@ -2281,7 +2470,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2281
2470
|
}
|
|
2282
2471
|
}
|
|
2283
2472
|
}
|
|
2284
|
-
/**
|
|
2473
|
+
/**
|
|
2474
|
+
* ArbitrarySecretVersionPrototype.
|
|
2475
|
+
*/
|
|
2285
2476
|
interface ArbitrarySecretVersionPrototype extends SecretVersionPrototype {
|
|
2286
2477
|
/** The secret data that is assigned to an `arbitrary` secret. */
|
|
2287
2478
|
payload: string;
|
|
@@ -2290,7 +2481,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2290
2481
|
/** The secret version metadata that a user can customize. */
|
|
2291
2482
|
version_custom_metadata?: JsonObject;
|
|
2292
2483
|
}
|
|
2293
|
-
/**
|
|
2484
|
+
/**
|
|
2485
|
+
* This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
2486
|
+
*/
|
|
2294
2487
|
interface CommonRotationPolicy extends RotationPolicy {
|
|
2295
2488
|
/** This field indicates whether Secrets Manager rotates your secret automatically.
|
|
2296
2489
|
*
|
|
@@ -2312,7 +2505,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2312
2505
|
}
|
|
2313
2506
|
}
|
|
2314
2507
|
}
|
|
2315
|
-
/**
|
|
2508
|
+
/**
|
|
2509
|
+
* Properties that describe a Classic Infrastructure DNS configuration.
|
|
2510
|
+
*/
|
|
2316
2511
|
interface IAMCredentialsConfiguration extends Configuration {
|
|
2317
2512
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
2318
2513
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -2343,13 +2538,13 @@ declare namespace SecretsManagerV2 {
|
|
|
2343
2538
|
namespace Constants {
|
|
2344
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. */
|
|
2345
2540
|
enum ConfigType {
|
|
2346
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
2347
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
2348
2541
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
2349
|
-
|
|
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",
|
|
2350
2544
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
2351
2545
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
2352
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
2546
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
2547
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
2353
2548
|
}
|
|
2354
2549
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
2355
2550
|
enum SecretType {
|
|
@@ -2364,7 +2559,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2364
2559
|
}
|
|
2365
2560
|
}
|
|
2366
2561
|
}
|
|
2367
|
-
/**
|
|
2562
|
+
/**
|
|
2563
|
+
* Your IAMCredentials Configuration metadata properties.
|
|
2564
|
+
*/
|
|
2368
2565
|
interface IAMCredentialsConfigurationMetadata extends ConfigurationMetadata {
|
|
2369
2566
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
2370
2567
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -2389,13 +2586,13 @@ declare namespace SecretsManagerV2 {
|
|
|
2389
2586
|
namespace Constants {
|
|
2390
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. */
|
|
2391
2588
|
enum ConfigType {
|
|
2392
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
2393
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
2394
2589
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
2395
|
-
|
|
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",
|
|
2396
2592
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
2397
2593
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
2398
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
2594
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
2595
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
2399
2596
|
}
|
|
2400
2597
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
2401
2598
|
enum SecretType {
|
|
@@ -2410,7 +2607,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2410
2607
|
}
|
|
2411
2608
|
}
|
|
2412
2609
|
}
|
|
2413
|
-
/**
|
|
2610
|
+
/**
|
|
2611
|
+
* The configuration update of the IAM Credentials engine.
|
|
2612
|
+
*/
|
|
2414
2613
|
interface IAMCredentialsConfigurationPatch extends ConfigurationPatch {
|
|
2415
2614
|
/** An IBM Cloud API key that can create and manage service IDs. The API key must be assigned the Editor
|
|
2416
2615
|
* platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. For more
|
|
@@ -2419,7 +2618,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2419
2618
|
*/
|
|
2420
2619
|
api_key: string;
|
|
2421
2620
|
}
|
|
2422
|
-
/**
|
|
2621
|
+
/**
|
|
2622
|
+
* IAMCredentialsConfigurationPrototype.
|
|
2623
|
+
*/
|
|
2423
2624
|
interface IAMCredentialsConfigurationPrototype extends ConfigurationPrototype {
|
|
2424
2625
|
/** A human-readable unique name to assign to your configuration.
|
|
2425
2626
|
*
|
|
@@ -2439,17 +2640,19 @@ declare namespace SecretsManagerV2 {
|
|
|
2439
2640
|
namespace Constants {
|
|
2440
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. */
|
|
2441
2642
|
enum ConfigType {
|
|
2442
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
2443
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
2444
2643
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
2445
|
-
|
|
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",
|
|
2446
2646
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
2447
2647
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
2448
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
2648
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
2649
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
2449
2650
|
}
|
|
2450
2651
|
}
|
|
2451
2652
|
}
|
|
2452
|
-
/**
|
|
2653
|
+
/**
|
|
2654
|
+
* Your IAM credentials secret.
|
|
2655
|
+
*/
|
|
2453
2656
|
interface IAMCredentialsSecret extends Secret {
|
|
2454
2657
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
2455
2658
|
created_by: string;
|
|
@@ -2498,12 +2701,15 @@ declare namespace SecretsManagerV2 {
|
|
|
2498
2701
|
updated_at: string;
|
|
2499
2702
|
/** The number of versions of your secret. */
|
|
2500
2703
|
versions_total: number;
|
|
2704
|
+
/** The list of configurations that have a reference to the secret. */
|
|
2705
|
+
referenced_by?: string[];
|
|
2501
2706
|
/** The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret
|
|
2502
2707
|
* types: iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The
|
|
2503
2708
|
* value can be either an integer that specifies the number of seconds, or the string representation of a
|
|
2504
2709
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
2505
2710
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
2506
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.
|
|
2507
2713
|
*/
|
|
2508
2714
|
ttl: string;
|
|
2509
2715
|
/** Access Groups that you can use for an `iam_credentials` secret.
|
|
@@ -2581,7 +2787,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2581
2787
|
}
|
|
2582
2788
|
}
|
|
2583
2789
|
}
|
|
2584
|
-
/**
|
|
2790
|
+
/**
|
|
2791
|
+
* Properties of the metadata of your IAM credentials secret.
|
|
2792
|
+
*/
|
|
2585
2793
|
interface IAMCredentialsSecretMetadata extends SecretMetadata {
|
|
2586
2794
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
2587
2795
|
created_by: string;
|
|
@@ -2630,12 +2838,15 @@ declare namespace SecretsManagerV2 {
|
|
|
2630
2838
|
updated_at: string;
|
|
2631
2839
|
/** The number of versions of your secret. */
|
|
2632
2840
|
versions_total: number;
|
|
2841
|
+
/** The list of configurations that have a reference to the secret. */
|
|
2842
|
+
referenced_by?: string[];
|
|
2633
2843
|
/** The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret
|
|
2634
2844
|
* types: iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The
|
|
2635
2845
|
* value can be either an integer that specifies the number of seconds, or the string representation of a
|
|
2636
2846
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
2637
2847
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
2638
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.
|
|
2639
2850
|
*/
|
|
2640
2851
|
ttl: string;
|
|
2641
2852
|
/** Access Groups that you can use for an `iam_credentials` secret.
|
|
@@ -2706,7 +2917,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2706
2917
|
}
|
|
2707
2918
|
}
|
|
2708
2919
|
}
|
|
2709
|
-
/**
|
|
2920
|
+
/**
|
|
2921
|
+
* IAMCredentialsSecretMetadataPatch.
|
|
2922
|
+
*/
|
|
2710
2923
|
interface IAMCredentialsSecretMetadataPatch extends SecretMetadataPatch {
|
|
2711
2924
|
/** A human-readable name to assign to your secret.
|
|
2712
2925
|
*
|
|
@@ -2734,6 +2947,7 @@ declare namespace SecretsManagerV2 {
|
|
|
2734
2947
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
2735
2948
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
2736
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.
|
|
2737
2951
|
*/
|
|
2738
2952
|
ttl?: string;
|
|
2739
2953
|
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
@@ -2741,7 +2955,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2741
2955
|
*/
|
|
2742
2956
|
rotation?: RotationPolicy;
|
|
2743
2957
|
}
|
|
2744
|
-
/**
|
|
2958
|
+
/**
|
|
2959
|
+
* IAMCredentialsSecretPrototype.
|
|
2960
|
+
*/
|
|
2745
2961
|
interface IAMCredentialsSecretPrototype extends SecretPrototype {
|
|
2746
2962
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
2747
2963
|
* service_credentials, kv, and username_password.
|
|
@@ -2773,6 +2989,7 @@ declare namespace SecretsManagerV2 {
|
|
|
2773
2989
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
2774
2990
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
2775
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.
|
|
2776
2993
|
*/
|
|
2777
2994
|
ttl: string;
|
|
2778
2995
|
/** Access Groups that you can use for an `iam_credentials` secret.
|
|
@@ -2821,7 +3038,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2821
3038
|
}
|
|
2822
3039
|
}
|
|
2823
3040
|
}
|
|
2824
|
-
/**
|
|
3041
|
+
/**
|
|
3042
|
+
* IAMCredentialsSecretRestoreFromVersionPrototype.
|
|
3043
|
+
*/
|
|
2825
3044
|
interface IAMCredentialsSecretRestoreFromVersionPrototype extends SecretVersionPrototype {
|
|
2826
3045
|
/** A v4 UUID identifier, or `current` or `previous` secret version aliases. */
|
|
2827
3046
|
restore_from_version: string;
|
|
@@ -2830,7 +3049,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2830
3049
|
/** The secret version metadata that a user can customize. */
|
|
2831
3050
|
version_custom_metadata?: JsonObject;
|
|
2832
3051
|
}
|
|
2833
|
-
/**
|
|
3052
|
+
/**
|
|
3053
|
+
* Your IAM credentials version.
|
|
3054
|
+
*/
|
|
2834
3055
|
interface IAMCredentialsSecretVersion extends SecretVersion {
|
|
2835
3056
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
2836
3057
|
auto_rotated?: boolean;
|
|
@@ -2902,7 +3123,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2902
3123
|
}
|
|
2903
3124
|
}
|
|
2904
3125
|
}
|
|
2905
|
-
/**
|
|
3126
|
+
/**
|
|
3127
|
+
* Properties of the version metadata of your IAM credentials secret.
|
|
3128
|
+
*/
|
|
2906
3129
|
interface IAMCredentialsSecretVersionMetadata extends SecretVersionMetadata {
|
|
2907
3130
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
2908
3131
|
auto_rotated?: boolean;
|
|
@@ -2967,14 +3190,18 @@ declare namespace SecretsManagerV2 {
|
|
|
2967
3190
|
}
|
|
2968
3191
|
}
|
|
2969
3192
|
}
|
|
2970
|
-
/**
|
|
3193
|
+
/**
|
|
3194
|
+
* IAMCredentialsSecretVersionPrototype.
|
|
3195
|
+
*/
|
|
2971
3196
|
interface IAMCredentialsSecretVersionPrototype extends SecretVersionPrototype {
|
|
2972
3197
|
/** The secret metadata that a user can customize. */
|
|
2973
3198
|
custom_metadata?: JsonObject;
|
|
2974
3199
|
/** The secret version metadata that a user can customize. */
|
|
2975
3200
|
version_custom_metadata?: JsonObject;
|
|
2976
3201
|
}
|
|
2977
|
-
/**
|
|
3202
|
+
/**
|
|
3203
|
+
* Your imported certificate.
|
|
3204
|
+
*/
|
|
2978
3205
|
interface ImportedCertificate extends Secret {
|
|
2979
3206
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
2980
3207
|
created_by: string;
|
|
@@ -3023,6 +3250,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3023
3250
|
updated_at: string;
|
|
3024
3251
|
/** The number of versions of your secret. */
|
|
3025
3252
|
versions_total: number;
|
|
3253
|
+
/** The list of configurations that have a reference to the secret. */
|
|
3254
|
+
referenced_by?: string[];
|
|
3026
3255
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
3027
3256
|
* certificate.
|
|
3028
3257
|
*/
|
|
@@ -3085,7 +3314,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3085
3314
|
}
|
|
3086
3315
|
}
|
|
3087
3316
|
}
|
|
3088
|
-
/**
|
|
3317
|
+
/**
|
|
3318
|
+
* Properties of the secret metadata of your imported certificate.
|
|
3319
|
+
*/
|
|
3089
3320
|
interface ImportedCertificateMetadata extends SecretMetadata {
|
|
3090
3321
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
3091
3322
|
created_by: string;
|
|
@@ -3134,6 +3365,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3134
3365
|
updated_at: string;
|
|
3135
3366
|
/** The number of versions of your secret. */
|
|
3136
3367
|
versions_total: number;
|
|
3368
|
+
/** The list of configurations that have a reference to the secret. */
|
|
3369
|
+
referenced_by?: string[];
|
|
3137
3370
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
3138
3371
|
* certificate.
|
|
3139
3372
|
*/
|
|
@@ -3186,7 +3419,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3186
3419
|
}
|
|
3187
3420
|
}
|
|
3188
3421
|
}
|
|
3189
|
-
/**
|
|
3422
|
+
/**
|
|
3423
|
+
* ImportedCertificateMetadataPatch.
|
|
3424
|
+
*/
|
|
3190
3425
|
interface ImportedCertificateMetadataPatch extends SecretMetadataPatch {
|
|
3191
3426
|
/** A human-readable name to assign to your secret.
|
|
3192
3427
|
*
|
|
@@ -3209,7 +3444,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3209
3444
|
/** The secret metadata that a user can customize. */
|
|
3210
3445
|
custom_metadata?: JsonObject;
|
|
3211
3446
|
}
|
|
3212
|
-
/**
|
|
3447
|
+
/**
|
|
3448
|
+
* ImportedCertificatePrototype.
|
|
3449
|
+
*/
|
|
3213
3450
|
interface ImportedCertificatePrototype extends SecretPrototype {
|
|
3214
3451
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
3215
3452
|
* service_credentials, kv, and username_password.
|
|
@@ -3265,7 +3502,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3265
3502
|
}
|
|
3266
3503
|
}
|
|
3267
3504
|
}
|
|
3268
|
-
/**
|
|
3505
|
+
/**
|
|
3506
|
+
* Versions of your imported certificate.
|
|
3507
|
+
*/
|
|
3269
3508
|
interface ImportedCertificateVersion extends SecretVersion {
|
|
3270
3509
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
3271
3510
|
auto_rotated?: boolean;
|
|
@@ -3336,7 +3575,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3336
3575
|
}
|
|
3337
3576
|
}
|
|
3338
3577
|
}
|
|
3339
|
-
/**
|
|
3578
|
+
/**
|
|
3579
|
+
* Properties of the version metadata of your imported certificate.
|
|
3580
|
+
*/
|
|
3340
3581
|
interface ImportedCertificateVersionMetadata extends SecretVersionMetadata {
|
|
3341
3582
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
3342
3583
|
auto_rotated?: boolean;
|
|
@@ -3397,7 +3638,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3397
3638
|
}
|
|
3398
3639
|
}
|
|
3399
3640
|
}
|
|
3400
|
-
/**
|
|
3641
|
+
/**
|
|
3642
|
+
* ImportedCertificateVersionPrototype.
|
|
3643
|
+
*/
|
|
3401
3644
|
interface ImportedCertificateVersionPrototype extends SecretVersionPrototype {
|
|
3402
3645
|
/** Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters. */
|
|
3403
3646
|
certificate: string;
|
|
@@ -3414,7 +3657,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3414
3657
|
/** The secret version metadata that a user can customize. */
|
|
3415
3658
|
version_custom_metadata?: JsonObject;
|
|
3416
3659
|
}
|
|
3417
|
-
/**
|
|
3660
|
+
/**
|
|
3661
|
+
* Your key-value secret.
|
|
3662
|
+
*/
|
|
3418
3663
|
interface KVSecret extends Secret {
|
|
3419
3664
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
3420
3665
|
created_by: string;
|
|
@@ -3463,6 +3708,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3463
3708
|
updated_at: string;
|
|
3464
3709
|
/** The number of versions of your secret. */
|
|
3465
3710
|
versions_total: number;
|
|
3711
|
+
/** The list of configurations that have a reference to the secret. */
|
|
3712
|
+
referenced_by?: string[];
|
|
3466
3713
|
/** The payload data of a key-value secret. */
|
|
3467
3714
|
data: JsonObject;
|
|
3468
3715
|
}
|
|
@@ -3489,7 +3736,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3489
3736
|
}
|
|
3490
3737
|
}
|
|
3491
3738
|
}
|
|
3492
|
-
/**
|
|
3739
|
+
/**
|
|
3740
|
+
* Properties of the metadata of your key-value secret metadata.
|
|
3741
|
+
*/
|
|
3493
3742
|
interface KVSecretMetadata extends SecretMetadata {
|
|
3494
3743
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
3495
3744
|
created_by: string;
|
|
@@ -3538,6 +3787,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3538
3787
|
updated_at: string;
|
|
3539
3788
|
/** The number of versions of your secret. */
|
|
3540
3789
|
versions_total: number;
|
|
3790
|
+
/** The list of configurations that have a reference to the secret. */
|
|
3791
|
+
referenced_by?: string[];
|
|
3541
3792
|
}
|
|
3542
3793
|
namespace KVSecretMetadata {
|
|
3543
3794
|
namespace Constants {
|
|
@@ -3562,7 +3813,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3562
3813
|
}
|
|
3563
3814
|
}
|
|
3564
3815
|
}
|
|
3565
|
-
/**
|
|
3816
|
+
/**
|
|
3817
|
+
* KVSecretMetadataPatch.
|
|
3818
|
+
*/
|
|
3566
3819
|
interface KVSecretMetadataPatch extends SecretMetadataPatch {
|
|
3567
3820
|
/** A human-readable name to assign to your secret.
|
|
3568
3821
|
*
|
|
@@ -3585,7 +3838,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3585
3838
|
/** The secret metadata that a user can customize. */
|
|
3586
3839
|
custom_metadata?: JsonObject;
|
|
3587
3840
|
}
|
|
3588
|
-
/**
|
|
3841
|
+
/**
|
|
3842
|
+
* KVSecretPrototype.
|
|
3843
|
+
*/
|
|
3589
3844
|
interface KVSecretPrototype extends SecretPrototype {
|
|
3590
3845
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
3591
3846
|
* service_credentials, kv, and username_password.
|
|
@@ -3633,7 +3888,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3633
3888
|
}
|
|
3634
3889
|
}
|
|
3635
3890
|
}
|
|
3636
|
-
/**
|
|
3891
|
+
/**
|
|
3892
|
+
* Your key-value secret version.
|
|
3893
|
+
*/
|
|
3637
3894
|
interface KVSecretVersion extends SecretVersion {
|
|
3638
3895
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
3639
3896
|
auto_rotated?: boolean;
|
|
@@ -3688,7 +3945,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3688
3945
|
}
|
|
3689
3946
|
}
|
|
3690
3947
|
}
|
|
3691
|
-
/**
|
|
3948
|
+
/**
|
|
3949
|
+
* Properties of the version metadata of your key-value secret.
|
|
3950
|
+
*/
|
|
3692
3951
|
interface KVSecretVersionMetadata extends SecretVersionMetadata {
|
|
3693
3952
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
3694
3953
|
auto_rotated?: boolean;
|
|
@@ -3741,7 +4000,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3741
4000
|
}
|
|
3742
4001
|
}
|
|
3743
4002
|
}
|
|
3744
|
-
/**
|
|
4003
|
+
/**
|
|
4004
|
+
* KVSecretVersionPrototype.
|
|
4005
|
+
*/
|
|
3745
4006
|
interface KVSecretVersionPrototype extends SecretVersionPrototype {
|
|
3746
4007
|
/** The payload data of a key-value secret. */
|
|
3747
4008
|
data: JsonObject;
|
|
@@ -3750,7 +4011,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3750
4011
|
/** The secret version metadata that a user can customize. */
|
|
3751
4012
|
version_custom_metadata?: JsonObject;
|
|
3752
4013
|
}
|
|
3753
|
-
/**
|
|
4014
|
+
/**
|
|
4015
|
+
* Your private certificate.
|
|
4016
|
+
*/
|
|
3754
4017
|
interface PrivateCertificate extends Secret {
|
|
3755
4018
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
3756
4019
|
created_by: string;
|
|
@@ -3799,6 +4062,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3799
4062
|
updated_at: string;
|
|
3800
4063
|
/** The number of versions of your secret. */
|
|
3801
4064
|
versions_total: number;
|
|
4065
|
+
/** The list of configurations that have a reference to the secret. */
|
|
4066
|
+
referenced_by?: string[];
|
|
3802
4067
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
3803
4068
|
* certificate.
|
|
3804
4069
|
*/
|
|
@@ -3875,7 +4140,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3875
4140
|
}
|
|
3876
4141
|
}
|
|
3877
4142
|
}
|
|
3878
|
-
/**
|
|
4143
|
+
/**
|
|
4144
|
+
* The response body of the action to revoke the private certificate.
|
|
4145
|
+
*/
|
|
3879
4146
|
interface PrivateCertificateActionRevoke extends SecretAction {
|
|
3880
4147
|
/** The type of secret action. */
|
|
3881
4148
|
action_type: PrivateCertificateActionRevoke.Constants.ActionType | string;
|
|
@@ -3891,7 +4158,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3891
4158
|
}
|
|
3892
4159
|
}
|
|
3893
4160
|
}
|
|
3894
|
-
/**
|
|
4161
|
+
/**
|
|
4162
|
+
* The request body to specify the properties of the action to revoke the private certificate.
|
|
4163
|
+
*/
|
|
3895
4164
|
interface PrivateCertificateActionRevokePrototype extends SecretActionPrototype {
|
|
3896
4165
|
/** The type of secret action. */
|
|
3897
4166
|
action_type: PrivateCertificateActionRevokePrototype.Constants.ActionType | string;
|
|
@@ -3905,7 +4174,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3905
4174
|
}
|
|
3906
4175
|
}
|
|
3907
4176
|
}
|
|
3908
|
-
/**
|
|
4177
|
+
/**
|
|
4178
|
+
* The response body to specify the properties of the action to revoke the private certificate.
|
|
4179
|
+
*/
|
|
3909
4180
|
interface PrivateCertificateConfigurationActionRevoke extends ConfigurationAction {
|
|
3910
4181
|
/** The type of configuration action. */
|
|
3911
4182
|
action_type: PrivateCertificateConfigurationActionRevoke.Constants.ActionType | string;
|
|
@@ -3924,7 +4195,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3924
4195
|
}
|
|
3925
4196
|
}
|
|
3926
4197
|
}
|
|
3927
|
-
/**
|
|
4198
|
+
/**
|
|
4199
|
+
* The request body to specify the properties of the action to revoke the private certificate configuration.
|
|
4200
|
+
*/
|
|
3928
4201
|
interface PrivateCertificateConfigurationActionRevokePrototype extends ConfigurationActionPrototype {
|
|
3929
4202
|
/** The type of configuration action. */
|
|
3930
4203
|
action_type: PrivateCertificateConfigurationActionRevokePrototype.Constants.ActionType | string;
|
|
@@ -3941,7 +4214,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3941
4214
|
}
|
|
3942
4215
|
}
|
|
3943
4216
|
}
|
|
3944
|
-
/**
|
|
4217
|
+
/**
|
|
4218
|
+
* The response body of the action to rotate the CRL of an intermediate certificate authority for the private
|
|
4219
|
+
* certificate configuration.
|
|
4220
|
+
*/
|
|
3945
4221
|
interface PrivateCertificateConfigurationActionRotateCRL extends ConfigurationAction {
|
|
3946
4222
|
/** The type of configuration action. */
|
|
3947
4223
|
action_type: PrivateCertificateConfigurationActionRotateCRL.Constants.ActionType | string;
|
|
@@ -3962,7 +4238,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3962
4238
|
}
|
|
3963
4239
|
}
|
|
3964
4240
|
}
|
|
3965
|
-
/**
|
|
4241
|
+
/**
|
|
4242
|
+
* The request body of the action to rotate the CRL of an intermediate certificate authority for the private
|
|
4243
|
+
* certificate configuration.
|
|
4244
|
+
*/
|
|
3966
4245
|
interface PrivateCertificateConfigurationActionRotateCRLPrototype extends ConfigurationActionPrototype {
|
|
3967
4246
|
/** The type of configuration action. */
|
|
3968
4247
|
action_type: PrivateCertificateConfigurationActionRotateCRLPrototype.Constants.ActionType | string;
|
|
@@ -3979,7 +4258,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3979
4258
|
}
|
|
3980
4259
|
}
|
|
3981
4260
|
}
|
|
3982
|
-
/**
|
|
4261
|
+
/**
|
|
4262
|
+
* The response body of the action to set a signed intermediate certificate authority for the private certificate
|
|
4263
|
+
* configuration.
|
|
4264
|
+
*/
|
|
3983
4265
|
interface PrivateCertificateConfigurationActionSetSigned extends ConfigurationAction {
|
|
3984
4266
|
/** The type of configuration action. */
|
|
3985
4267
|
action_type: PrivateCertificateConfigurationActionSetSigned.Constants.ActionType | string;
|
|
@@ -3998,7 +4280,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3998
4280
|
}
|
|
3999
4281
|
}
|
|
4000
4282
|
}
|
|
4001
|
-
/**
|
|
4283
|
+
/**
|
|
4284
|
+
* The request body of the action to set a signed intermediate certificate authority for the private certificate
|
|
4285
|
+
* consideration.
|
|
4286
|
+
*/
|
|
4002
4287
|
interface PrivateCertificateConfigurationActionSetSignedPrototype extends ConfigurationActionPrototype {
|
|
4003
4288
|
/** The type of configuration action. */
|
|
4004
4289
|
action_type: PrivateCertificateConfigurationActionSetSignedPrototype.Constants.ActionType | string;
|
|
@@ -4017,7 +4302,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4017
4302
|
}
|
|
4018
4303
|
}
|
|
4019
4304
|
}
|
|
4020
|
-
/**
|
|
4305
|
+
/**
|
|
4306
|
+
* The response body of the action to sign the CSR for the private certificate configuration.
|
|
4307
|
+
*/
|
|
4021
4308
|
interface PrivateCertificateConfigurationActionSignCSR extends ConfigurationAction {
|
|
4022
4309
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
4023
4310
|
common_name?: string;
|
|
@@ -4118,7 +4405,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4118
4405
|
}
|
|
4119
4406
|
}
|
|
4120
4407
|
}
|
|
4121
|
-
/**
|
|
4408
|
+
/**
|
|
4409
|
+
* The request body to specify the properties of the action to sign a CSR for the private certificate configuration.
|
|
4410
|
+
*/
|
|
4122
4411
|
interface PrivateCertificateConfigurationActionSignCSRPrototype extends ConfigurationActionPrototype {
|
|
4123
4412
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
4124
4413
|
common_name?: string;
|
|
@@ -4217,7 +4506,10 @@ declare namespace SecretsManagerV2 {
|
|
|
4217
4506
|
}
|
|
4218
4507
|
}
|
|
4219
4508
|
}
|
|
4220
|
-
/**
|
|
4509
|
+
/**
|
|
4510
|
+
* The response body of the action to sign the intermediate certificate authority for the private certificate
|
|
4511
|
+
* configuration.
|
|
4512
|
+
*/
|
|
4221
4513
|
interface PrivateCertificateConfigurationActionSignIntermediate extends ConfigurationAction {
|
|
4222
4514
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
4223
4515
|
common_name?: string;
|
|
@@ -4316,7 +4608,10 @@ declare namespace SecretsManagerV2 {
|
|
|
4316
4608
|
}
|
|
4317
4609
|
}
|
|
4318
4610
|
}
|
|
4319
|
-
/**
|
|
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
|
+
*/
|
|
4320
4615
|
interface PrivateCertificateConfigurationActionSignIntermediatePrototype extends ConfigurationActionPrototype {
|
|
4321
4616
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
4322
4617
|
common_name?: string;
|
|
@@ -4415,7 +4710,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4415
4710
|
}
|
|
4416
4711
|
}
|
|
4417
4712
|
}
|
|
4418
|
-
/**
|
|
4713
|
+
/**
|
|
4714
|
+
* The data that is associated with the root certificate authority.
|
|
4715
|
+
*/
|
|
4419
4716
|
interface PrivateCertificateConfigurationCACertificate extends PrivateCertificateCAData {
|
|
4420
4717
|
/** Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters. */
|
|
4421
4718
|
certificate: string;
|
|
@@ -4426,7 +4723,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4426
4723
|
/** The certificate expiration time. */
|
|
4427
4724
|
expiration?: number;
|
|
4428
4725
|
}
|
|
4429
|
-
/**
|
|
4726
|
+
/**
|
|
4727
|
+
* The configuration of the root certificate authority.
|
|
4728
|
+
*/
|
|
4430
4729
|
interface PrivateCertificateConfigurationIntermediateCA extends Configuration {
|
|
4431
4730
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
4432
4731
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -4477,6 +4776,8 @@ declare namespace SecretsManagerV2 {
|
|
|
4477
4776
|
* `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
|
|
4478
4777
|
*/
|
|
4479
4778
|
status?: PrivateCertificateConfigurationIntermediateCA.Constants.Status | string;
|
|
4779
|
+
/** The data that is associated with a cryptographic key. */
|
|
4780
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
4480
4781
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA in seconds. */
|
|
4481
4782
|
max_ttl_seconds?: number;
|
|
4482
4783
|
/** The time until the certificate revocation list (CRL) expires, in seconds. */
|
|
@@ -4540,13 +4841,13 @@ declare namespace SecretsManagerV2 {
|
|
|
4540
4841
|
namespace Constants {
|
|
4541
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. */
|
|
4542
4843
|
enum ConfigType {
|
|
4543
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4544
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
4545
4844
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
4546
|
-
|
|
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",
|
|
4547
4847
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
4548
4848
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
4549
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
4849
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
4850
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
4550
4851
|
}
|
|
4551
4852
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
4552
4853
|
enum SecretType {
|
|
@@ -4590,7 +4891,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4590
4891
|
}
|
|
4591
4892
|
}
|
|
4592
4893
|
}
|
|
4593
|
-
/**
|
|
4894
|
+
/**
|
|
4895
|
+
* The data that is associated with the intermediate certificate authority.
|
|
4896
|
+
*/
|
|
4594
4897
|
interface PrivateCertificateConfigurationIntermediateCACSR extends PrivateCertificateCAData {
|
|
4595
4898
|
/** The certificate signing request. */
|
|
4596
4899
|
csr?: string;
|
|
@@ -4612,7 +4915,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4612
4915
|
}
|
|
4613
4916
|
}
|
|
4614
4917
|
}
|
|
4615
|
-
/**
|
|
4918
|
+
/**
|
|
4919
|
+
* The configuration of the metadata properties of the intermediate certificate authority.
|
|
4920
|
+
*/
|
|
4616
4921
|
interface PrivateCertificateConfigurationIntermediateCAMetadata extends ConfigurationMetadata {
|
|
4617
4922
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
4618
4923
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -4663,18 +4968,20 @@ declare namespace SecretsManagerV2 {
|
|
|
4663
4968
|
* `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
|
|
4664
4969
|
*/
|
|
4665
4970
|
status?: PrivateCertificateConfigurationIntermediateCAMetadata.Constants.Status | string;
|
|
4971
|
+
/** The data that is associated with a cryptographic key. */
|
|
4972
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
4666
4973
|
}
|
|
4667
4974
|
namespace PrivateCertificateConfigurationIntermediateCAMetadata {
|
|
4668
4975
|
namespace Constants {
|
|
4669
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. */
|
|
4670
4977
|
enum ConfigType {
|
|
4671
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4672
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
4673
4978
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
4674
|
-
|
|
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",
|
|
4675
4981
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
4676
4982
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
4677
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
4983
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
4984
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
4678
4985
|
}
|
|
4679
4986
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
4680
4987
|
enum SecretType {
|
|
@@ -4708,7 +5015,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4708
5015
|
}
|
|
4709
5016
|
}
|
|
4710
5017
|
}
|
|
4711
|
-
/**
|
|
5018
|
+
/**
|
|
5019
|
+
* The configuration patch of the intermediate certificate authority.
|
|
5020
|
+
*/
|
|
4712
5021
|
interface PrivateCertificateConfigurationIntermediateCAPatch extends ConfigurationPatch {
|
|
4713
5022
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA.
|
|
4714
5023
|
*
|
|
@@ -4741,7 +5050,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4741
5050
|
*/
|
|
4742
5051
|
issuing_certificates_urls_encoded?: boolean;
|
|
4743
5052
|
}
|
|
4744
|
-
/**
|
|
5053
|
+
/**
|
|
5054
|
+
* The configuration of the intermediate certificate authority.
|
|
5055
|
+
*/
|
|
4745
5056
|
interface PrivateCertificateConfigurationIntermediateCAPrototype extends ConfigurationPrototype {
|
|
4746
5057
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
4747
5058
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -4754,6 +5065,8 @@ declare namespace SecretsManagerV2 {
|
|
|
4754
5065
|
* To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
|
|
4755
5066
|
*/
|
|
4756
5067
|
name: string;
|
|
5068
|
+
/** The data that is associated with a cryptographic key. */
|
|
5069
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
4757
5070
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA.
|
|
4758
5071
|
*
|
|
4759
5072
|
* The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API
|
|
@@ -4854,13 +5167,13 @@ declare namespace SecretsManagerV2 {
|
|
|
4854
5167
|
namespace Constants {
|
|
4855
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. */
|
|
4856
5169
|
enum ConfigType {
|
|
4857
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4858
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
4859
5170
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
4860
|
-
|
|
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",
|
|
4861
5173
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
4862
5174
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
4863
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5175
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5176
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
4864
5177
|
}
|
|
4865
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). */
|
|
4866
5179
|
enum SigningMethod {
|
|
@@ -4884,7 +5197,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4884
5197
|
}
|
|
4885
5198
|
}
|
|
4886
5199
|
}
|
|
4887
|
-
/**
|
|
5200
|
+
/**
|
|
5201
|
+
* The root certificate authority .
|
|
5202
|
+
*/
|
|
4888
5203
|
interface PrivateCertificateConfigurationRootCA extends Configuration {
|
|
4889
5204
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
4890
5205
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -4927,6 +5242,8 @@ declare namespace SecretsManagerV2 {
|
|
|
4927
5242
|
* `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
|
|
4928
5243
|
*/
|
|
4929
5244
|
status?: PrivateCertificateConfigurationRootCA.Constants.Status | string;
|
|
5245
|
+
/** The data that is associated with a cryptographic key. */
|
|
5246
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
4930
5247
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA in seconds. */
|
|
4931
5248
|
max_ttl_seconds?: number;
|
|
4932
5249
|
/** The time until the certificate revocation list (CRL) expires, in seconds. */
|
|
@@ -5002,13 +5319,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5002
5319
|
namespace Constants {
|
|
5003
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. */
|
|
5004
5321
|
enum ConfigType {
|
|
5005
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5006
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5007
5322
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5008
|
-
|
|
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",
|
|
5009
5325
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5010
5326
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5011
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5327
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5328
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5012
5329
|
}
|
|
5013
5330
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
5014
5331
|
enum SecretType {
|
|
@@ -5047,7 +5364,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5047
5364
|
}
|
|
5048
5365
|
}
|
|
5049
5366
|
}
|
|
5050
|
-
/**
|
|
5367
|
+
/**
|
|
5368
|
+
* The configuration of the metadata properties of the root certificate authority.
|
|
5369
|
+
*/
|
|
5051
5370
|
interface PrivateCertificateConfigurationRootCAMetadata extends ConfigurationMetadata {
|
|
5052
5371
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5053
5372
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5090,18 +5409,20 @@ declare namespace SecretsManagerV2 {
|
|
|
5090
5409
|
* `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
|
|
5091
5410
|
*/
|
|
5092
5411
|
status?: PrivateCertificateConfigurationRootCAMetadata.Constants.Status | string;
|
|
5412
|
+
/** The data that is associated with a cryptographic key. */
|
|
5413
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
5093
5414
|
}
|
|
5094
5415
|
namespace PrivateCertificateConfigurationRootCAMetadata {
|
|
5095
5416
|
namespace Constants {
|
|
5096
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. */
|
|
5097
5418
|
enum ConfigType {
|
|
5098
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5099
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5100
5419
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5101
|
-
|
|
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",
|
|
5102
5422
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5103
5423
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5104
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5424
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5425
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5105
5426
|
}
|
|
5106
5427
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
5107
5428
|
enum SecretType {
|
|
@@ -5130,7 +5451,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5130
5451
|
}
|
|
5131
5452
|
}
|
|
5132
5453
|
}
|
|
5133
|
-
/**
|
|
5454
|
+
/**
|
|
5455
|
+
* The configuration of the metadata patch for the root certificate authority.
|
|
5456
|
+
*/
|
|
5134
5457
|
interface PrivateCertificateConfigurationRootCAPatch extends ConfigurationPatch {
|
|
5135
5458
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA.
|
|
5136
5459
|
*
|
|
@@ -5163,7 +5486,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5163
5486
|
*/
|
|
5164
5487
|
issuing_certificates_urls_encoded?: boolean;
|
|
5165
5488
|
}
|
|
5166
|
-
/**
|
|
5489
|
+
/**
|
|
5490
|
+
* The configuration of the root certificate authority.
|
|
5491
|
+
*/
|
|
5167
5492
|
interface PrivateCertificateConfigurationRootCAPrototype extends ConfigurationPrototype {
|
|
5168
5493
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5169
5494
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5176,6 +5501,8 @@ declare namespace SecretsManagerV2 {
|
|
|
5176
5501
|
* To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
|
|
5177
5502
|
*/
|
|
5178
5503
|
name: string;
|
|
5504
|
+
/** The data that is associated with a cryptographic key. */
|
|
5505
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
5179
5506
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA.
|
|
5180
5507
|
*
|
|
5181
5508
|
* The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API
|
|
@@ -5285,13 +5612,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5285
5612
|
namespace Constants {
|
|
5286
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. */
|
|
5287
5614
|
enum ConfigType {
|
|
5288
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5289
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5290
5615
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5291
|
-
|
|
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",
|
|
5292
5618
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5293
5619
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5294
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5620
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5621
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5295
5622
|
}
|
|
5296
5623
|
/** The format of the returned data. */
|
|
5297
5624
|
enum Format {
|
|
@@ -5310,7 +5637,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5310
5637
|
}
|
|
5311
5638
|
}
|
|
5312
5639
|
}
|
|
5313
|
-
/**
|
|
5640
|
+
/**
|
|
5641
|
+
* The configuration of the private certificate template.
|
|
5642
|
+
*/
|
|
5314
5643
|
interface PrivateCertificateConfigurationTemplate extends Configuration {
|
|
5315
5644
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5316
5645
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5483,13 +5812,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5483
5812
|
namespace Constants {
|
|
5484
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. */
|
|
5485
5814
|
enum ConfigType {
|
|
5486
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5487
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5488
5815
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5489
|
-
|
|
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",
|
|
5490
5818
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5491
5819
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5492
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5820
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5821
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5493
5822
|
}
|
|
5494
5823
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
5495
5824
|
enum SecretType {
|
|
@@ -5509,7 +5838,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5509
5838
|
}
|
|
5510
5839
|
}
|
|
5511
5840
|
}
|
|
5512
|
-
/**
|
|
5841
|
+
/**
|
|
5842
|
+
* The metadata properties of the configuration of the private certificate template.
|
|
5843
|
+
*/
|
|
5513
5844
|
interface PrivateCertificateConfigurationTemplateMetadata extends ConfigurationMetadata {
|
|
5514
5845
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5515
5846
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5536,13 +5867,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5536
5867
|
namespace Constants {
|
|
5537
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. */
|
|
5538
5869
|
enum ConfigType {
|
|
5539
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5540
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5541
5870
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5542
|
-
|
|
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",
|
|
5543
5873
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5544
5874
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5545
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5875
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5876
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5546
5877
|
}
|
|
5547
5878
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
5548
5879
|
enum SecretType {
|
|
@@ -5557,7 +5888,11 @@ declare namespace SecretsManagerV2 {
|
|
|
5557
5888
|
}
|
|
5558
5889
|
}
|
|
5559
5890
|
}
|
|
5560
|
-
/**
|
|
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
|
+
*/
|
|
5561
5896
|
interface PrivateCertificateConfigurationTemplatePatch extends ConfigurationPatch {
|
|
5562
5897
|
/** This field scopes the creation of private certificates to only the secret groups that you specify.
|
|
5563
5898
|
*
|
|
@@ -5730,7 +6065,11 @@ declare namespace SecretsManagerV2 {
|
|
|
5730
6065
|
}
|
|
5731
6066
|
}
|
|
5732
6067
|
}
|
|
5733
|
-
/**
|
|
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
|
+
*/
|
|
5734
6073
|
interface PrivateCertificateConfigurationTemplatePrototype extends ConfigurationPrototype {
|
|
5735
6074
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5736
6075
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5917,13 +6256,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5917
6256
|
namespace Constants {
|
|
5918
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. */
|
|
5919
6258
|
enum ConfigType {
|
|
5920
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5921
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5922
6259
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5923
|
-
|
|
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",
|
|
5924
6262
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5925
6263
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5926
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
6264
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
6265
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5927
6266
|
}
|
|
5928
6267
|
/** The type of private key to generate. */
|
|
5929
6268
|
enum KeyType {
|
|
@@ -5932,7 +6271,30 @@ declare namespace SecretsManagerV2 {
|
|
|
5932
6271
|
}
|
|
5933
6272
|
}
|
|
5934
6273
|
}
|
|
5935
|
-
/**
|
|
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
|
+
*/
|
|
5936
6298
|
interface PrivateCertificateMetadata extends SecretMetadata {
|
|
5937
6299
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
5938
6300
|
created_by: string;
|
|
@@ -5981,6 +6343,8 @@ declare namespace SecretsManagerV2 {
|
|
|
5981
6343
|
updated_at: string;
|
|
5982
6344
|
/** The number of versions of your secret. */
|
|
5983
6345
|
versions_total: number;
|
|
6346
|
+
/** The list of configurations that have a reference to the secret. */
|
|
6347
|
+
referenced_by?: string[];
|
|
5984
6348
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
5985
6349
|
* certificate.
|
|
5986
6350
|
*/
|
|
@@ -6047,7 +6411,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6047
6411
|
}
|
|
6048
6412
|
}
|
|
6049
6413
|
}
|
|
6050
|
-
/**
|
|
6414
|
+
/**
|
|
6415
|
+
* PrivateCertificateMetadataPatch.
|
|
6416
|
+
*/
|
|
6051
6417
|
interface PrivateCertificateMetadataPatch extends SecretMetadataPatch {
|
|
6052
6418
|
/** A human-readable name to assign to your secret.
|
|
6053
6419
|
*
|
|
@@ -6074,7 +6440,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6074
6440
|
*/
|
|
6075
6441
|
rotation?: RotationPolicy;
|
|
6076
6442
|
}
|
|
6077
|
-
/**
|
|
6443
|
+
/**
|
|
6444
|
+
* PrivateCertificatePrototype.
|
|
6445
|
+
*/
|
|
6078
6446
|
interface PrivateCertificatePrototype extends SecretPrototype {
|
|
6079
6447
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
6080
6448
|
* service_credentials, kv, and username_password.
|
|
@@ -6172,7 +6540,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6172
6540
|
}
|
|
6173
6541
|
}
|
|
6174
6542
|
}
|
|
6175
|
-
/**
|
|
6543
|
+
/**
|
|
6544
|
+
* Your private certificate version.
|
|
6545
|
+
*/
|
|
6176
6546
|
interface PrivateCertificateVersion extends SecretVersion {
|
|
6177
6547
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
6178
6548
|
auto_rotated?: boolean;
|
|
@@ -6243,7 +6613,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6243
6613
|
}
|
|
6244
6614
|
}
|
|
6245
6615
|
}
|
|
6246
|
-
/**
|
|
6616
|
+
/**
|
|
6617
|
+
* The response body to specify the properties of the action to revoke the private certificate.
|
|
6618
|
+
*/
|
|
6247
6619
|
interface PrivateCertificateVersionActionRevoke extends VersionAction {
|
|
6248
6620
|
/** The type of secret version action. */
|
|
6249
6621
|
action_type: PrivateCertificateVersionActionRevoke.Constants.ActionType | string;
|
|
@@ -6258,7 +6630,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6258
6630
|
}
|
|
6259
6631
|
}
|
|
6260
6632
|
}
|
|
6261
|
-
/**
|
|
6633
|
+
/**
|
|
6634
|
+
* The request body to specify the properties of the action to revoke the private certificate.
|
|
6635
|
+
*/
|
|
6262
6636
|
interface PrivateCertificateVersionActionRevokePrototype extends SecretVersionActionPrototype {
|
|
6263
6637
|
/** The type of secret version action. */
|
|
6264
6638
|
action_type: PrivateCertificateVersionActionRevokePrototype.Constants.ActionType | string;
|
|
@@ -6271,7 +6645,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6271
6645
|
}
|
|
6272
6646
|
}
|
|
6273
6647
|
}
|
|
6274
|
-
/**
|
|
6648
|
+
/**
|
|
6649
|
+
* Properties of the version metadata of your private certificate.
|
|
6650
|
+
*/
|
|
6275
6651
|
interface PrivateCertificateVersionMetadata extends SecretVersionMetadata {
|
|
6276
6652
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
6277
6653
|
auto_rotated?: boolean;
|
|
@@ -6332,7 +6708,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6332
6708
|
}
|
|
6333
6709
|
}
|
|
6334
6710
|
}
|
|
6335
|
-
/**
|
|
6711
|
+
/**
|
|
6712
|
+
* PrivateCertificateVersionPrototype.
|
|
6713
|
+
*/
|
|
6336
6714
|
interface PrivateCertificateVersionPrototype extends SecretVersionPrototype {
|
|
6337
6715
|
/** The secret metadata that a user can customize. */
|
|
6338
6716
|
custom_metadata?: JsonObject;
|
|
@@ -6341,7 +6719,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6341
6719
|
/** The certificate signing request. */
|
|
6342
6720
|
csr?: string;
|
|
6343
6721
|
}
|
|
6344
|
-
/**
|
|
6722
|
+
/**
|
|
6723
|
+
* Your public certificate.
|
|
6724
|
+
*/
|
|
6345
6725
|
interface PublicCertificate extends Secret {
|
|
6346
6726
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
6347
6727
|
created_by: string;
|
|
@@ -6390,6 +6770,8 @@ declare namespace SecretsManagerV2 {
|
|
|
6390
6770
|
updated_at: string;
|
|
6391
6771
|
/** The number of versions of your secret. */
|
|
6392
6772
|
versions_total: number;
|
|
6773
|
+
/** The list of configurations that have a reference to the secret. */
|
|
6774
|
+
referenced_by?: string[];
|
|
6393
6775
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
6394
6776
|
* certificate.
|
|
6395
6777
|
*/
|
|
@@ -6464,7 +6846,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6464
6846
|
}
|
|
6465
6847
|
}
|
|
6466
6848
|
}
|
|
6467
|
-
/**
|
|
6849
|
+
/**
|
|
6850
|
+
* The response body of the action to validate manual DNS challenges for the public certificate.
|
|
6851
|
+
*/
|
|
6468
6852
|
interface PublicCertificateActionValidateManualDNS extends SecretAction {
|
|
6469
6853
|
/** The type of secret action. */
|
|
6470
6854
|
action_type: PublicCertificateActionValidateManualDNS.Constants.ActionType | string;
|
|
@@ -6478,7 +6862,10 @@ declare namespace SecretsManagerV2 {
|
|
|
6478
6862
|
}
|
|
6479
6863
|
}
|
|
6480
6864
|
}
|
|
6481
|
-
/**
|
|
6865
|
+
/**
|
|
6866
|
+
* The request body to specify the properties of the action to validate manual DNS challenges for the public
|
|
6867
|
+
* certificate.
|
|
6868
|
+
*/
|
|
6482
6869
|
interface PublicCertificateActionValidateManualDNSPrototype extends SecretActionPrototype {
|
|
6483
6870
|
/** The type of secret action. */
|
|
6484
6871
|
action_type: PublicCertificateActionValidateManualDNSPrototype.Constants.ActionType | string;
|
|
@@ -6492,7 +6879,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6492
6879
|
}
|
|
6493
6880
|
}
|
|
6494
6881
|
}
|
|
6495
|
-
/**
|
|
6882
|
+
/**
|
|
6883
|
+
* Properties that describe a Let's Encrypt CA configuration.
|
|
6884
|
+
*/
|
|
6496
6885
|
interface PublicCertificateConfigurationCALetsEncrypt extends Configuration {
|
|
6497
6886
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6498
6887
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6527,13 +6916,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6527
6916
|
namespace Constants {
|
|
6528
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. */
|
|
6529
6918
|
enum ConfigType {
|
|
6530
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6531
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6532
6919
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6533
|
-
|
|
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",
|
|
6534
6922
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6535
6923
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6536
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
6924
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
6925
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6537
6926
|
}
|
|
6538
6927
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6539
6928
|
enum SecretType {
|
|
@@ -6553,7 +6942,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6553
6942
|
}
|
|
6554
6943
|
}
|
|
6555
6944
|
}
|
|
6556
|
-
/**
|
|
6945
|
+
/**
|
|
6946
|
+
* Your Let's Encrypt CA metadata properties.
|
|
6947
|
+
*/
|
|
6557
6948
|
interface PublicCertificateConfigurationCALetsEncryptMetadata extends ConfigurationMetadata {
|
|
6558
6949
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6559
6950
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6584,13 +6975,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6584
6975
|
namespace Constants {
|
|
6585
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. */
|
|
6586
6977
|
enum ConfigType {
|
|
6587
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6588
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6589
6978
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6590
|
-
|
|
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",
|
|
6591
6981
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6592
6982
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6593
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
6983
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
6984
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6594
6985
|
}
|
|
6595
6986
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6596
6987
|
enum SecretType {
|
|
@@ -6610,7 +7001,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6610
7001
|
}
|
|
6611
7002
|
}
|
|
6612
7003
|
}
|
|
6613
|
-
/**
|
|
7004
|
+
/**
|
|
7005
|
+
* The configuration update of the Let's Encrypt Certificate Authority.
|
|
7006
|
+
*/
|
|
6614
7007
|
interface PublicCertificateConfigurationCALetsEncryptPatch extends ConfigurationPatch {
|
|
6615
7008
|
/** The configuration of the Let's Encrypt CA environment. */
|
|
6616
7009
|
lets_encrypt_environment: PublicCertificateConfigurationCALetsEncryptPatch.Constants.LetsEncryptEnvironment | string;
|
|
@@ -6632,7 +7025,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6632
7025
|
}
|
|
6633
7026
|
}
|
|
6634
7027
|
}
|
|
6635
|
-
/**
|
|
7028
|
+
/**
|
|
7029
|
+
* The properties of the Let's Encrypt CA configuration.
|
|
7030
|
+
*/
|
|
6636
7031
|
interface PublicCertificateConfigurationCALetsEncryptPrototype extends ConfigurationPrototype {
|
|
6637
7032
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6638
7033
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6660,13 +7055,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6660
7055
|
namespace Constants {
|
|
6661
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. */
|
|
6662
7057
|
enum ConfigType {
|
|
6663
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6664
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6665
7058
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6666
|
-
|
|
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",
|
|
6667
7061
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6668
7062
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6669
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7063
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7064
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6670
7065
|
}
|
|
6671
7066
|
/** The configuration of the Let's Encrypt CA environment. */
|
|
6672
7067
|
enum LetsEncryptEnvironment {
|
|
@@ -6675,7 +7070,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6675
7070
|
}
|
|
6676
7071
|
}
|
|
6677
7072
|
}
|
|
6678
|
-
/**
|
|
7073
|
+
/**
|
|
7074
|
+
* Properties that describe a Classic Infrastructure DNS configuration.
|
|
7075
|
+
*/
|
|
6679
7076
|
interface PublicCertificateConfigurationDNSClassicInfrastructure extends Configuration {
|
|
6680
7077
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6681
7078
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6712,13 +7109,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6712
7109
|
namespace Constants {
|
|
6713
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. */
|
|
6714
7111
|
enum ConfigType {
|
|
6715
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6716
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6717
7112
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6718
|
-
|
|
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",
|
|
6719
7115
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6720
7116
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6721
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7117
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7118
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6722
7119
|
}
|
|
6723
7120
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6724
7121
|
enum SecretType {
|
|
@@ -6733,7 +7130,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6733
7130
|
}
|
|
6734
7131
|
}
|
|
6735
7132
|
}
|
|
6736
|
-
/**
|
|
7133
|
+
/**
|
|
7134
|
+
* Your Classic Infrastructure DNS metadata properties.
|
|
7135
|
+
*/
|
|
6737
7136
|
interface PublicCertificateConfigurationDNSClassicInfrastructureMetadata extends ConfigurationMetadata {
|
|
6738
7137
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6739
7138
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6758,13 +7157,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6758
7157
|
namespace Constants {
|
|
6759
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. */
|
|
6760
7159
|
enum ConfigType {
|
|
6761
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6762
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6763
7160
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6764
|
-
|
|
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",
|
|
6765
7163
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6766
7164
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6767
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7165
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7166
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6768
7167
|
}
|
|
6769
7168
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6770
7169
|
enum SecretType {
|
|
@@ -6779,7 +7178,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6779
7178
|
}
|
|
6780
7179
|
}
|
|
6781
7180
|
}
|
|
6782
|
-
/**
|
|
7181
|
+
/**
|
|
7182
|
+
* Properties that describe the configuration update of an IBM Cloud classic infrastructure (SoftLayer).
|
|
7183
|
+
*/
|
|
6783
7184
|
interface PublicCertificateConfigurationDNSClassicInfrastructurePatch extends ConfigurationPatch {
|
|
6784
7185
|
/** The username that is associated with your classic infrastructure account.
|
|
6785
7186
|
*
|
|
@@ -6794,7 +7195,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6794
7195
|
*/
|
|
6795
7196
|
classic_infrastructure_password?: string;
|
|
6796
7197
|
}
|
|
6797
|
-
/**
|
|
7198
|
+
/**
|
|
7199
|
+
* PublicCertificateConfigurationDNSClassicInfrastructurePrototype.
|
|
7200
|
+
*/
|
|
6798
7201
|
interface PublicCertificateConfigurationDNSClassicInfrastructurePrototype extends ConfigurationPrototype {
|
|
6799
7202
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6800
7203
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6824,17 +7227,19 @@ declare namespace SecretsManagerV2 {
|
|
|
6824
7227
|
namespace Constants {
|
|
6825
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. */
|
|
6826
7229
|
enum ConfigType {
|
|
6827
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6828
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6829
7230
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6830
|
-
|
|
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",
|
|
6831
7233
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6832
7234
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6833
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7235
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7236
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6834
7237
|
}
|
|
6835
7238
|
}
|
|
6836
7239
|
}
|
|
6837
|
-
/**
|
|
7240
|
+
/**
|
|
7241
|
+
* Properties that describe a Cloud Internet Services DNS configuration.
|
|
7242
|
+
*/
|
|
6838
7243
|
interface PublicCertificateConfigurationDNSCloudInternetServices extends Configuration {
|
|
6839
7244
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6840
7245
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6879,13 +7284,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6879
7284
|
namespace Constants {
|
|
6880
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. */
|
|
6881
7286
|
enum ConfigType {
|
|
6882
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6883
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6884
7287
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6885
|
-
|
|
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",
|
|
6886
7290
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6887
7291
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6888
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7292
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7293
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6889
7294
|
}
|
|
6890
7295
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6891
7296
|
enum SecretType {
|
|
@@ -6900,7 +7305,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6900
7305
|
}
|
|
6901
7306
|
}
|
|
6902
7307
|
}
|
|
6903
|
-
/**
|
|
7308
|
+
/**
|
|
7309
|
+
* Your Cloud Internet Services DNS metadata properties.
|
|
7310
|
+
*/
|
|
6904
7311
|
interface PublicCertificateConfigurationDNSCloudInternetServicesMetadata extends ConfigurationMetadata {
|
|
6905
7312
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6906
7313
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6925,13 +7332,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6925
7332
|
namespace Constants {
|
|
6926
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. */
|
|
6927
7334
|
enum ConfigType {
|
|
6928
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6929
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6930
7335
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6931
|
-
|
|
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",
|
|
6932
7338
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6933
7339
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6934
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7340
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7341
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6935
7342
|
}
|
|
6936
7343
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6937
7344
|
enum SecretType {
|
|
@@ -6946,7 +7353,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6946
7353
|
}
|
|
6947
7354
|
}
|
|
6948
7355
|
}
|
|
6949
|
-
/**
|
|
7356
|
+
/**
|
|
7357
|
+
* The configuration update of the Cloud Internet Services DNS.
|
|
7358
|
+
*/
|
|
6950
7359
|
interface PublicCertificateConfigurationDNSCloudInternetServicesPatch extends ConfigurationPatch {
|
|
6951
7360
|
/** An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.
|
|
6952
7361
|
*
|
|
@@ -6969,7 +7378,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6969
7378
|
/** A CRN that uniquely identifies an IBM Cloud resource. */
|
|
6970
7379
|
cloud_internet_services_crn?: string;
|
|
6971
7380
|
}
|
|
6972
|
-
/**
|
|
7381
|
+
/**
|
|
7382
|
+
* Specify the properties for Cloud Internet Services DNS configuration.
|
|
7383
|
+
*/
|
|
6973
7384
|
interface PublicCertificateConfigurationDNSCloudInternetServicesPrototype extends ConfigurationPrototype {
|
|
6974
7385
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6975
7386
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -7007,17 +7418,19 @@ declare namespace SecretsManagerV2 {
|
|
|
7007
7418
|
namespace Constants {
|
|
7008
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. */
|
|
7009
7420
|
enum ConfigType {
|
|
7010
|
-
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
7011
|
-
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7012
7421
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
7013
|
-
|
|
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",
|
|
7014
7424
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
7015
7425
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
7016
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7426
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7427
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
7017
7428
|
}
|
|
7018
7429
|
}
|
|
7019
7430
|
}
|
|
7020
|
-
/**
|
|
7431
|
+
/**
|
|
7432
|
+
* Properties of the metadata of your public certificate.
|
|
7433
|
+
*/
|
|
7021
7434
|
interface PublicCertificateMetadata extends SecretMetadata {
|
|
7022
7435
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7023
7436
|
created_by: string;
|
|
@@ -7066,6 +7479,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7066
7479
|
updated_at: string;
|
|
7067
7480
|
/** The number of versions of your secret. */
|
|
7068
7481
|
versions_total: number;
|
|
7482
|
+
/** The list of configurations that have a reference to the secret. */
|
|
7483
|
+
referenced_by?: string[];
|
|
7069
7484
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
7070
7485
|
* certificate.
|
|
7071
7486
|
*/
|
|
@@ -7130,7 +7545,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7130
7545
|
}
|
|
7131
7546
|
}
|
|
7132
7547
|
}
|
|
7133
|
-
/**
|
|
7548
|
+
/**
|
|
7549
|
+
* PublicCertificateMetadataPatch.
|
|
7550
|
+
*/
|
|
7134
7551
|
interface PublicCertificateMetadataPatch extends SecretMetadataPatch {
|
|
7135
7552
|
/** A human-readable name to assign to your secret.
|
|
7136
7553
|
*
|
|
@@ -7157,7 +7574,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7157
7574
|
*/
|
|
7158
7575
|
rotation?: RotationPolicy;
|
|
7159
7576
|
}
|
|
7160
|
-
/**
|
|
7577
|
+
/**
|
|
7578
|
+
* PublicCertificatePrototype.
|
|
7579
|
+
*/
|
|
7161
7580
|
interface PublicCertificatePrototype extends SecretPrototype {
|
|
7162
7581
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
7163
7582
|
* service_credentials, kv, and username_password.
|
|
@@ -7229,7 +7648,12 @@ declare namespace SecretsManagerV2 {
|
|
|
7229
7648
|
}
|
|
7230
7649
|
}
|
|
7231
7650
|
}
|
|
7232
|
-
/**
|
|
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
|
+
*/
|
|
7233
7657
|
interface PublicCertificateRotationPolicy extends RotationPolicy {
|
|
7234
7658
|
/** This field indicates whether Secrets Manager rotates your secret automatically.
|
|
7235
7659
|
*
|
|
@@ -7245,7 +7669,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7245
7669
|
*/
|
|
7246
7670
|
rotate_keys: boolean;
|
|
7247
7671
|
}
|
|
7248
|
-
/**
|
|
7672
|
+
/**
|
|
7673
|
+
* Versions of your public certificate.
|
|
7674
|
+
*/
|
|
7249
7675
|
interface PublicCertificateVersion extends SecretVersion {
|
|
7250
7676
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
7251
7677
|
auto_rotated?: boolean;
|
|
@@ -7316,7 +7742,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7316
7742
|
}
|
|
7317
7743
|
}
|
|
7318
7744
|
}
|
|
7319
|
-
/**
|
|
7745
|
+
/**
|
|
7746
|
+
* Properties of the version metadata of your public certificate.
|
|
7747
|
+
*/
|
|
7320
7748
|
interface PublicCertificateVersionMetadata extends SecretVersionMetadata {
|
|
7321
7749
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
7322
7750
|
auto_rotated?: boolean;
|
|
@@ -7377,7 +7805,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7377
7805
|
}
|
|
7378
7806
|
}
|
|
7379
7807
|
}
|
|
7380
|
-
/**
|
|
7808
|
+
/**
|
|
7809
|
+
* PublicCertificateVersionPrototype.
|
|
7810
|
+
*/
|
|
7381
7811
|
interface PublicCertificateVersionPrototype extends SecretVersionPrototype {
|
|
7382
7812
|
/** Defines the rotation object that is used to manually rotate public certificates. */
|
|
7383
7813
|
rotation: PublicCertificateRotationObject;
|
|
@@ -7386,7 +7816,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7386
7816
|
/** The secret version metadata that a user can customize. */
|
|
7387
7817
|
version_custom_metadata?: JsonObject;
|
|
7388
7818
|
}
|
|
7389
|
-
/**
|
|
7819
|
+
/**
|
|
7820
|
+
* Your service credentials secret.
|
|
7821
|
+
*/
|
|
7390
7822
|
interface ServiceCredentialsSecret extends Secret {
|
|
7391
7823
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7392
7824
|
created_by: string;
|
|
@@ -7435,6 +7867,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7435
7867
|
updated_at: string;
|
|
7436
7868
|
/** The number of versions of your secret. */
|
|
7437
7869
|
versions_total: number;
|
|
7870
|
+
/** The list of configurations that have a reference to the secret. */
|
|
7871
|
+
referenced_by?: string[];
|
|
7438
7872
|
/** The date that the secret is scheduled for automatic rotation.
|
|
7439
7873
|
*
|
|
7440
7874
|
* The service automatically creates a new version of the secret on its next rotation date. This field exists only
|
|
@@ -7451,6 +7885,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7451
7885
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
7452
7886
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
7453
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.
|
|
7454
7889
|
*/
|
|
7455
7890
|
ttl?: string;
|
|
7456
7891
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
@@ -7485,7 +7920,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7485
7920
|
}
|
|
7486
7921
|
}
|
|
7487
7922
|
}
|
|
7488
|
-
/**
|
|
7923
|
+
/**
|
|
7924
|
+
* The metadata properties for your service credentials secret.
|
|
7925
|
+
*/
|
|
7489
7926
|
interface ServiceCredentialsSecretMetadata extends SecretMetadata {
|
|
7490
7927
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7491
7928
|
created_by: string;
|
|
@@ -7534,6 +7971,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7534
7971
|
updated_at: string;
|
|
7535
7972
|
/** The number of versions of your secret. */
|
|
7536
7973
|
versions_total: number;
|
|
7974
|
+
/** The list of configurations that have a reference to the secret. */
|
|
7975
|
+
referenced_by?: string[];
|
|
7537
7976
|
/** The date that the secret is scheduled for automatic rotation.
|
|
7538
7977
|
*
|
|
7539
7978
|
* The service automatically creates a new version of the secret on its next rotation date. This field exists only
|
|
@@ -7550,6 +7989,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7550
7989
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
7551
7990
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
7552
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.
|
|
7553
7993
|
*/
|
|
7554
7994
|
ttl?: string;
|
|
7555
7995
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
@@ -7582,7 +8022,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7582
8022
|
}
|
|
7583
8023
|
}
|
|
7584
8024
|
}
|
|
7585
|
-
/**
|
|
8025
|
+
/**
|
|
8026
|
+
* ServiceCredentialsSecretMetadataPatch.
|
|
8027
|
+
*/
|
|
7586
8028
|
interface ServiceCredentialsSecretMetadataPatch extends SecretMetadataPatch {
|
|
7587
8029
|
/** The secret metadata that a user can customize. */
|
|
7588
8030
|
custom_metadata?: JsonObject;
|
|
@@ -7614,10 +8056,13 @@ declare namespace SecretsManagerV2 {
|
|
|
7614
8056
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
7615
8057
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
7616
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.
|
|
7617
8060
|
*/
|
|
7618
8061
|
ttl?: string;
|
|
7619
8062
|
}
|
|
7620
|
-
/**
|
|
8063
|
+
/**
|
|
8064
|
+
* ServiceCredentialsSecretPrototype.
|
|
8065
|
+
*/
|
|
7621
8066
|
interface ServiceCredentialsSecretPrototype extends SecretPrototype {
|
|
7622
8067
|
/** The secret metadata that a user can customize. */
|
|
7623
8068
|
custom_metadata?: JsonObject;
|
|
@@ -7659,6 +8104,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7659
8104
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
7660
8105
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
7661
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.
|
|
7662
8108
|
*/
|
|
7663
8109
|
ttl?: string;
|
|
7664
8110
|
/** The secret version metadata that a user can customize. */
|
|
@@ -7679,7 +8125,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7679
8125
|
}
|
|
7680
8126
|
}
|
|
7681
8127
|
}
|
|
7682
|
-
/**
|
|
8128
|
+
/**
|
|
8129
|
+
* Your service credentials secret version.
|
|
8130
|
+
*/
|
|
7683
8131
|
interface ServiceCredentialsSecretVersion extends SecretVersion {
|
|
7684
8132
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
7685
8133
|
auto_rotated?: boolean;
|
|
@@ -7740,7 +8188,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7740
8188
|
}
|
|
7741
8189
|
}
|
|
7742
8190
|
}
|
|
7743
|
-
/**
|
|
8191
|
+
/**
|
|
8192
|
+
* The version metadata properties for your service credentials secret.
|
|
8193
|
+
*/
|
|
7744
8194
|
interface ServiceCredentialsSecretVersionMetadata extends SecretVersionMetadata {
|
|
7745
8195
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
7746
8196
|
auto_rotated?: boolean;
|
|
@@ -7799,14 +8249,18 @@ declare namespace SecretsManagerV2 {
|
|
|
7799
8249
|
}
|
|
7800
8250
|
}
|
|
7801
8251
|
}
|
|
7802
|
-
/**
|
|
8252
|
+
/**
|
|
8253
|
+
* ServiceCredentialsSecretVersionPrototype.
|
|
8254
|
+
*/
|
|
7803
8255
|
interface ServiceCredentialsSecretVersionPrototype extends SecretVersionPrototype {
|
|
7804
8256
|
/** The secret metadata that a user can customize. */
|
|
7805
8257
|
custom_metadata?: JsonObject;
|
|
7806
8258
|
/** The secret version metadata that a user can customize. */
|
|
7807
8259
|
version_custom_metadata?: JsonObject;
|
|
7808
8260
|
}
|
|
7809
|
-
/**
|
|
8261
|
+
/**
|
|
8262
|
+
* Your user credentials secret.
|
|
8263
|
+
*/
|
|
7810
8264
|
interface UsernamePasswordSecret extends Secret {
|
|
7811
8265
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7812
8266
|
created_by: string;
|
|
@@ -7855,6 +8309,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7855
8309
|
updated_at: string;
|
|
7856
8310
|
/** The number of versions of your secret. */
|
|
7857
8311
|
versions_total: number;
|
|
8312
|
+
/** The list of configurations that have a reference to the secret. */
|
|
8313
|
+
referenced_by?: string[];
|
|
7858
8314
|
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
7859
8315
|
* username_password, private_cert, public_cert, iam_credentials.
|
|
7860
8316
|
*/
|
|
@@ -7899,7 +8355,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7899
8355
|
}
|
|
7900
8356
|
}
|
|
7901
8357
|
}
|
|
7902
|
-
/**
|
|
8358
|
+
/**
|
|
8359
|
+
* Properties of the metadata of your user credentials secret.
|
|
8360
|
+
*/
|
|
7903
8361
|
interface UsernamePasswordSecretMetadata extends SecretMetadata {
|
|
7904
8362
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7905
8363
|
created_by: string;
|
|
@@ -7948,6 +8406,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7948
8406
|
updated_at: string;
|
|
7949
8407
|
/** The number of versions of your secret. */
|
|
7950
8408
|
versions_total: number;
|
|
8409
|
+
/** The list of configurations that have a reference to the secret. */
|
|
8410
|
+
referenced_by?: string[];
|
|
7951
8411
|
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
7952
8412
|
* username_password, private_cert, public_cert, iam_credentials.
|
|
7953
8413
|
*/
|
|
@@ -7988,7 +8448,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7988
8448
|
}
|
|
7989
8449
|
}
|
|
7990
8450
|
}
|
|
7991
|
-
/**
|
|
8451
|
+
/**
|
|
8452
|
+
* UsernamePasswordSecretMetadataPatch.
|
|
8453
|
+
*/
|
|
7992
8454
|
interface UsernamePasswordSecretMetadataPatch extends SecretMetadataPatch {
|
|
7993
8455
|
/** A human-readable name to assign to your secret.
|
|
7994
8456
|
*
|
|
@@ -8023,7 +8485,9 @@ declare namespace SecretsManagerV2 {
|
|
|
8023
8485
|
*/
|
|
8024
8486
|
password_generation_policy?: PasswordGenerationPolicyPatch;
|
|
8025
8487
|
}
|
|
8026
|
-
/**
|
|
8488
|
+
/**
|
|
8489
|
+
* UsernamePasswordSecretPrototype.
|
|
8490
|
+
*/
|
|
8027
8491
|
interface UsernamePasswordSecretPrototype extends SecretPrototype {
|
|
8028
8492
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
8029
8493
|
* service_credentials, kv, and username_password.
|
|
@@ -8085,7 +8549,9 @@ declare namespace SecretsManagerV2 {
|
|
|
8085
8549
|
}
|
|
8086
8550
|
}
|
|
8087
8551
|
}
|
|
8088
|
-
/**
|
|
8552
|
+
/**
|
|
8553
|
+
* Your user credentials secret version.
|
|
8554
|
+
*/
|
|
8089
8555
|
interface UsernamePasswordSecretVersion extends SecretVersion {
|
|
8090
8556
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
8091
8557
|
auto_rotated?: boolean;
|
|
@@ -8142,7 +8608,9 @@ declare namespace SecretsManagerV2 {
|
|
|
8142
8608
|
}
|
|
8143
8609
|
}
|
|
8144
8610
|
}
|
|
8145
|
-
/**
|
|
8611
|
+
/**
|
|
8612
|
+
* Properties of the version metadata of your user credentials secret.
|
|
8613
|
+
*/
|
|
8146
8614
|
interface UsernamePasswordSecretVersionMetadata extends SecretVersionMetadata {
|
|
8147
8615
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
8148
8616
|
auto_rotated?: boolean;
|
|
@@ -8195,7 +8663,9 @@ declare namespace SecretsManagerV2 {
|
|
|
8195
8663
|
}
|
|
8196
8664
|
}
|
|
8197
8665
|
}
|
|
8198
|
-
/**
|
|
8666
|
+
/**
|
|
8667
|
+
* UsernamePasswordSecretVersionPrototype.
|
|
8668
|
+
*/
|
|
8199
8669
|
interface UsernamePasswordSecretVersionPrototype extends SecretVersionPrototype {
|
|
8200
8670
|
/** The password that is assigned to an `username_password` secret. If you omit this parameter, Secrets Manager
|
|
8201
8671
|
* generates a new random password for your secret.
|