@ibm-cloud/secrets-manager 2.0.4 → 2.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/README.md +1 -3
- package/examples/secrets-manager.v2.test.js +13 -26
- package/package.json +2 -2
- package/secrets-manager/v2.d.ts +762 -270
- package/secrets-manager/v2.js +110 -82
- package/secrets-manager/v2.js.map +1 -1
package/secrets-manager/v2.d.ts
CHANGED
|
@@ -133,7 +133,7 @@ declare class SecretsManagerV2 extends BaseService {
|
|
|
133
133
|
* Delete a secret group by specifying the ID of the secret group.
|
|
134
134
|
*
|
|
135
135
|
* **Note:** To delete a secret group, it must be empty. If you need to remove a secret group that contains secrets,
|
|
136
|
-
* you must first
|
|
136
|
+
* you must first delete the secrets that are associated with the group.
|
|
137
137
|
*
|
|
138
138
|
* @param {Object} params - The parameters to send to the service.
|
|
139
139
|
* @param {string} params.id - The v4 UUID that uniquely identifies your secret group.
|
|
@@ -223,8 +223,7 @@ declare class SecretsManagerV2 extends BaseService {
|
|
|
223
223
|
* Get a secret and its details by specifying the ID of the secret.
|
|
224
224
|
*
|
|
225
225
|
* A successful request returns the secret data that is associated with your secret, along with other metadata. To
|
|
226
|
-
* view only the details of a specified secret without retrieving its value, use the
|
|
227
|
-
* metadata](#get-secret-metadata) operation.
|
|
226
|
+
* view only the details of a specified secret without retrieving its value, use the Get secret metadata operation.
|
|
228
227
|
*
|
|
229
228
|
* @param {Object} params - The parameters to send to the service.
|
|
230
229
|
* @param {string} params.id - The v4 UUID that uniquely identifies your secret.
|
|
@@ -284,8 +283,7 @@ declare class SecretsManagerV2 extends BaseService {
|
|
|
284
283
|
* Get a secret and its details by specifying the Name and Type of the secret.
|
|
285
284
|
*
|
|
286
285
|
* A successful request returns the secret data that is associated with your secret, along with other metadata. To
|
|
287
|
-
* view only the details of a specified secret without retrieving its value, use the
|
|
288
|
-
* metadata](#get-secret-metadata) operation.
|
|
286
|
+
* view only the details of a specified secret without retrieving its value, use the Get secret metadata operation.
|
|
289
287
|
*
|
|
290
288
|
* @param {Object} params - The parameters to send to the service.
|
|
291
289
|
* @param {string} params.secretType - The secret type. Supported types are arbitrary, imported_cert, public_cert,
|
|
@@ -662,6 +660,13 @@ declare class SecretsManagerV2 extends BaseService {
|
|
|
662
660
|
*
|
|
663
661
|
* **Usage:** If you want to list only the configurations that contain the string `text`, use
|
|
664
662
|
* `../configurations?search=text`.
|
|
663
|
+
* @param {string[]} [params.secretTypes] - Filter configurations by secret types, iam_credentials, public_cert or
|
|
664
|
+
* private_cert.
|
|
665
|
+
*
|
|
666
|
+
* You can apply multiple filters by using a comma-separated list of secret types.
|
|
667
|
+
*
|
|
668
|
+
* **Usage:** To retrieve a list of configurations that are associated with all secret types, use
|
|
669
|
+
* `..?secret_types=iam_credentials,public_cert,private_cert`.
|
|
665
670
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
666
671
|
* @returns {Promise<SecretsManagerV2.Response<SecretsManagerV2.ConfigurationMetadataPaginatedCollection>>}
|
|
667
672
|
*/
|
|
@@ -1281,8 +1286,25 @@ declare namespace SecretsManagerV2 {
|
|
|
1281
1286
|
* `../configurations?search=text`.
|
|
1282
1287
|
*/
|
|
1283
1288
|
search?: string;
|
|
1289
|
+
/** Filter configurations by secret types, iam_credentials, public_cert or private_cert.
|
|
1290
|
+
*
|
|
1291
|
+
* You can apply multiple filters by using a comma-separated list of secret types.
|
|
1292
|
+
*
|
|
1293
|
+
* **Usage:** To retrieve a list of configurations that are associated with all secret types, use
|
|
1294
|
+
* `..?secret_types=iam_credentials,public_cert,private_cert`.
|
|
1295
|
+
*/
|
|
1296
|
+
secretTypes?: ListConfigurationsConstants.SecretTypes[] | string[];
|
|
1284
1297
|
headers?: OutgoingHttpHeaders;
|
|
1285
1298
|
}
|
|
1299
|
+
/** Constants for the `listConfigurations` operation. */
|
|
1300
|
+
namespace ListConfigurationsConstants {
|
|
1301
|
+
/** 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`. */
|
|
1302
|
+
enum SecretTypes {
|
|
1303
|
+
IAM_CREDENTIALS = "iam_credentials",
|
|
1304
|
+
PRIVATE_CERT = "private_cert",
|
|
1305
|
+
PUBLIC_CERT = "public_cert"
|
|
1306
|
+
}
|
|
1307
|
+
}
|
|
1286
1308
|
/** Parameters for the `getConfiguration` operation. */
|
|
1287
1309
|
interface GetConfigurationParams {
|
|
1288
1310
|
/** The name that uniquely identifies a configuration. */
|
|
@@ -1295,13 +1317,13 @@ declare namespace SecretsManagerV2 {
|
|
|
1295
1317
|
namespace GetConfigurationConstants {
|
|
1296
1318
|
/** The configuration type of this configuration - use this header to resolve 300 error responses. */
|
|
1297
1319
|
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
1320
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
1301
|
-
|
|
1321
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1322
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1302
1323
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
1303
1324
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
1304
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
1325
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
1326
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
1305
1327
|
}
|
|
1306
1328
|
}
|
|
1307
1329
|
/** Parameters for the `updateConfiguration` operation. */
|
|
@@ -1317,13 +1339,13 @@ declare namespace SecretsManagerV2 {
|
|
|
1317
1339
|
namespace UpdateConfigurationConstants {
|
|
1318
1340
|
/** The configuration type of this configuration - use this header to resolve 300 error responses. */
|
|
1319
1341
|
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
1342
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
1323
|
-
|
|
1343
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1344
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1324
1345
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
1325
1346
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
1326
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
1347
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
1348
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
1327
1349
|
}
|
|
1328
1350
|
}
|
|
1329
1351
|
/** Parameters for the `deleteConfiguration` operation. */
|
|
@@ -1338,13 +1360,13 @@ declare namespace SecretsManagerV2 {
|
|
|
1338
1360
|
namespace DeleteConfigurationConstants {
|
|
1339
1361
|
/** The configuration type of this configuration - use this header to resolve 300 error responses. */
|
|
1340
1362
|
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
1363
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
1344
|
-
|
|
1364
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1365
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1345
1366
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
1346
1367
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
1347
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
1368
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
1369
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
1348
1370
|
}
|
|
1349
1371
|
}
|
|
1350
1372
|
/** Parameters for the `createConfigurationAction` operation. */
|
|
@@ -1360,13 +1382,13 @@ declare namespace SecretsManagerV2 {
|
|
|
1360
1382
|
namespace CreateConfigurationActionConstants {
|
|
1361
1383
|
/** The configuration type of this configuration - use this header to resolve 300 error responses. */
|
|
1362
1384
|
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
1385
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
1366
|
-
|
|
1386
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
1387
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
1367
1388
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
1368
1389
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
1369
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
1390
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
1391
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
1370
1392
|
}
|
|
1371
1393
|
}
|
|
1372
1394
|
/** Parameters for the `createNotificationsRegistration` operation. */
|
|
@@ -1394,7 +1416,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1394
1416
|
/*************************
|
|
1395
1417
|
* model interfaces
|
|
1396
1418
|
************************/
|
|
1397
|
-
/**
|
|
1419
|
+
/**
|
|
1420
|
+
* Issuance information that is associated with your certificate.
|
|
1421
|
+
*/
|
|
1398
1422
|
interface CertificateIssuanceInfo {
|
|
1399
1423
|
/** This parameter indicates whether the issued certificate is configured with an automatic rotation policy. */
|
|
1400
1424
|
auto_rotated?: boolean;
|
|
@@ -1435,14 +1459,18 @@ declare namespace SecretsManagerV2 {
|
|
|
1435
1459
|
}
|
|
1436
1460
|
}
|
|
1437
1461
|
}
|
|
1438
|
-
/**
|
|
1462
|
+
/**
|
|
1463
|
+
* The date and time that the certificate validity period begins and ends.
|
|
1464
|
+
*/
|
|
1439
1465
|
interface CertificateValidity {
|
|
1440
1466
|
/** The date-time format follows `RFC 3339`. */
|
|
1441
1467
|
not_before: string;
|
|
1442
1468
|
/** The date-time format follows `RFC 3339`. */
|
|
1443
1469
|
not_after: string;
|
|
1444
1470
|
}
|
|
1445
|
-
/**
|
|
1471
|
+
/**
|
|
1472
|
+
* Properties that describe a challenge.
|
|
1473
|
+
*/
|
|
1446
1474
|
interface ChallengeResource {
|
|
1447
1475
|
/** The challenge domain. */
|
|
1448
1476
|
domain?: string;
|
|
@@ -1455,19 +1483,29 @@ declare namespace SecretsManagerV2 {
|
|
|
1455
1483
|
/** The TXT record value. */
|
|
1456
1484
|
txt_record_value?: string;
|
|
1457
1485
|
}
|
|
1458
|
-
/**
|
|
1486
|
+
/**
|
|
1487
|
+
* Your configuration.
|
|
1488
|
+
*/
|
|
1459
1489
|
interface Configuration {
|
|
1460
1490
|
}
|
|
1461
|
-
/**
|
|
1491
|
+
/**
|
|
1492
|
+
* The response body to specify the properties of the action to create a configuration.
|
|
1493
|
+
*/
|
|
1462
1494
|
interface ConfigurationAction {
|
|
1463
1495
|
}
|
|
1464
|
-
/**
|
|
1496
|
+
/**
|
|
1497
|
+
* The request body to specify the properties of the action to create a configuration.
|
|
1498
|
+
*/
|
|
1465
1499
|
interface ConfigurationActionPrototype {
|
|
1466
1500
|
}
|
|
1467
|
-
/**
|
|
1501
|
+
/**
|
|
1502
|
+
* Your configuration metadata properties.
|
|
1503
|
+
*/
|
|
1468
1504
|
interface ConfigurationMetadata {
|
|
1469
1505
|
}
|
|
1470
|
-
/**
|
|
1506
|
+
/**
|
|
1507
|
+
* Properties that describe a paginated collection of secret locks.
|
|
1508
|
+
*/
|
|
1471
1509
|
interface ConfigurationMetadataPaginatedCollection {
|
|
1472
1510
|
/** The total number of resources in a collection. */
|
|
1473
1511
|
total_count: number;
|
|
@@ -1486,38 +1524,54 @@ declare namespace SecretsManagerV2 {
|
|
|
1486
1524
|
/** A collection of configuration metadata. */
|
|
1487
1525
|
configurations: ConfigurationMetadata[];
|
|
1488
1526
|
}
|
|
1489
|
-
/**
|
|
1527
|
+
/**
|
|
1528
|
+
* Your configuration update data.
|
|
1529
|
+
*/
|
|
1490
1530
|
interface ConfigurationPatch {
|
|
1491
1531
|
}
|
|
1492
|
-
/**
|
|
1532
|
+
/**
|
|
1533
|
+
* The details of your configuration.
|
|
1534
|
+
*/
|
|
1493
1535
|
interface ConfigurationPrototype {
|
|
1494
1536
|
}
|
|
1495
|
-
/**
|
|
1537
|
+
/**
|
|
1538
|
+
* The details of the Event Notifications registration.
|
|
1539
|
+
*/
|
|
1496
1540
|
interface NotificationsRegistration {
|
|
1497
1541
|
/** A CRN that uniquely identifies an IBM Cloud resource. */
|
|
1498
1542
|
event_notifications_instance_crn: string;
|
|
1499
1543
|
}
|
|
1500
|
-
/**
|
|
1544
|
+
/**
|
|
1545
|
+
* A URL that points to the first page in a collection.
|
|
1546
|
+
*/
|
|
1501
1547
|
interface PaginatedCollectionFirst {
|
|
1502
1548
|
/** A URL that points to a page in a collection. */
|
|
1503
1549
|
href: string;
|
|
1504
1550
|
}
|
|
1505
|
-
/**
|
|
1551
|
+
/**
|
|
1552
|
+
* A URL that points to the last page in a collection.
|
|
1553
|
+
*/
|
|
1506
1554
|
interface PaginatedCollectionLast {
|
|
1507
1555
|
/** A URL that points to a page in a collection. */
|
|
1508
1556
|
href: string;
|
|
1509
1557
|
}
|
|
1510
|
-
/**
|
|
1558
|
+
/**
|
|
1559
|
+
* A URL that points to the next page in a collection.
|
|
1560
|
+
*/
|
|
1511
1561
|
interface PaginatedCollectionNext {
|
|
1512
1562
|
/** A URL that points to a page in a collection. */
|
|
1513
1563
|
href: string;
|
|
1514
1564
|
}
|
|
1515
|
-
/**
|
|
1565
|
+
/**
|
|
1566
|
+
* A URL that points to the previous page in a collection.
|
|
1567
|
+
*/
|
|
1516
1568
|
interface PaginatedCollectionPrevious {
|
|
1517
1569
|
/** A URL that points to a page in a collection. */
|
|
1518
1570
|
href: string;
|
|
1519
1571
|
}
|
|
1520
|
-
/**
|
|
1572
|
+
/**
|
|
1573
|
+
* Policy for auto-generated passwords.
|
|
1574
|
+
*/
|
|
1521
1575
|
interface PasswordGenerationPolicy {
|
|
1522
1576
|
/** The length of auto-generated passwords. */
|
|
1523
1577
|
length?: number;
|
|
@@ -1528,7 +1582,10 @@ declare namespace SecretsManagerV2 {
|
|
|
1528
1582
|
/** Include uppercase letters in auto-generated passwords. */
|
|
1529
1583
|
include_uppercase?: boolean;
|
|
1530
1584
|
}
|
|
1531
|
-
/**
|
|
1585
|
+
/**
|
|
1586
|
+
* Policy patch for auto-generated passwords. Policy properties that are included in the patch are updated. Properties
|
|
1587
|
+
* that are not included in the patch remain unchanged.
|
|
1588
|
+
*/
|
|
1532
1589
|
interface PasswordGenerationPolicyPatch {
|
|
1533
1590
|
/** The length of auto-generated passwords. */
|
|
1534
1591
|
length?: number;
|
|
@@ -1539,7 +1596,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1539
1596
|
/** Include uppercase letters in auto-generated passwords. */
|
|
1540
1597
|
include_uppercase?: boolean;
|
|
1541
1598
|
}
|
|
1542
|
-
/**
|
|
1599
|
+
/**
|
|
1600
|
+
* Policy for auto-generated passwords.
|
|
1601
|
+
*/
|
|
1543
1602
|
interface PasswordGenerationPolicyRO {
|
|
1544
1603
|
/** The length of auto-generated passwords. */
|
|
1545
1604
|
length?: number;
|
|
@@ -1550,10 +1609,40 @@ declare namespace SecretsManagerV2 {
|
|
|
1550
1609
|
/** Include uppercase letters in auto-generated passwords. */
|
|
1551
1610
|
include_uppercase?: boolean;
|
|
1552
1611
|
}
|
|
1553
|
-
/**
|
|
1612
|
+
/**
|
|
1613
|
+
* The configuration data of your Private Certificate.
|
|
1614
|
+
*/
|
|
1554
1615
|
interface PrivateCertificateCAData {
|
|
1555
1616
|
}
|
|
1556
|
-
/**
|
|
1617
|
+
/**
|
|
1618
|
+
* The data that is associated with a cryptographic key.
|
|
1619
|
+
*/
|
|
1620
|
+
interface PrivateCertificateCryptoKey {
|
|
1621
|
+
/** 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
|
|
1622
|
+
* generated key. If the key exists, and generation is disabled, then this ID is used to look up the key. This
|
|
1623
|
+
* value or the crypto key label must be specified.
|
|
1624
|
+
*/
|
|
1625
|
+
id?: string;
|
|
1626
|
+
/** The label of the key to use. If the key does not exist and generation is enabled, this field is the label
|
|
1627
|
+
* that is given to the generated key. If the key exists, and generation is disabled, then this label is used to
|
|
1628
|
+
* look up the key. This value or the crypto key ID must be specified.
|
|
1629
|
+
*/
|
|
1630
|
+
label?: string;
|
|
1631
|
+
/** The indication of whether a new key is generated by the crypto provider if the given key name cannot be
|
|
1632
|
+
* found.
|
|
1633
|
+
*/
|
|
1634
|
+
allow_generate_key?: boolean;
|
|
1635
|
+
/** The data that is associated with a cryptographic provider. */
|
|
1636
|
+
provider: PrivateCertificateCryptoProvider;
|
|
1637
|
+
}
|
|
1638
|
+
/**
|
|
1639
|
+
* The data that is associated with a cryptographic provider.
|
|
1640
|
+
*/
|
|
1641
|
+
interface PrivateCertificateCryptoProvider {
|
|
1642
|
+
}
|
|
1643
|
+
/**
|
|
1644
|
+
* Defines the rotation object that is used to manually rotate public certificates.
|
|
1645
|
+
*/
|
|
1557
1646
|
interface PublicCertificateRotationObject {
|
|
1558
1647
|
/** This field indicates whether Secrets Manager rotates the private key for your public certificate
|
|
1559
1648
|
* automatically.
|
|
@@ -1563,19 +1652,30 @@ declare namespace SecretsManagerV2 {
|
|
|
1563
1652
|
*/
|
|
1564
1653
|
rotate_keys?: boolean;
|
|
1565
1654
|
}
|
|
1566
|
-
/**
|
|
1655
|
+
/**
|
|
1656
|
+
* This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
1657
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
1658
|
+
*/
|
|
1567
1659
|
interface RotationPolicy {
|
|
1568
1660
|
}
|
|
1569
|
-
/**
|
|
1661
|
+
/**
|
|
1662
|
+
* Your secret.
|
|
1663
|
+
*/
|
|
1570
1664
|
interface Secret {
|
|
1571
1665
|
}
|
|
1572
|
-
/**
|
|
1666
|
+
/**
|
|
1667
|
+
* The response body to specify the properties of the action to create a secret.
|
|
1668
|
+
*/
|
|
1573
1669
|
interface SecretAction {
|
|
1574
1670
|
}
|
|
1575
|
-
/**
|
|
1671
|
+
/**
|
|
1672
|
+
* The request body to specify the properties for your secret action.
|
|
1673
|
+
*/
|
|
1576
1674
|
interface SecretActionPrototype {
|
|
1577
1675
|
}
|
|
1578
|
-
/**
|
|
1676
|
+
/**
|
|
1677
|
+
* Properties that describe a secret group.
|
|
1678
|
+
*/
|
|
1579
1679
|
interface SecretGroup {
|
|
1580
1680
|
/** A v4 UUID identifier, or `default` secret group. */
|
|
1581
1681
|
id: string;
|
|
@@ -1594,14 +1694,18 @@ declare namespace SecretsManagerV2 {
|
|
|
1594
1694
|
/** The date when a resource was modified. The date format follows `RFC 3339`. */
|
|
1595
1695
|
updated_at: string;
|
|
1596
1696
|
}
|
|
1597
|
-
/**
|
|
1697
|
+
/**
|
|
1698
|
+
* Properties that describe a collection of secret groups.
|
|
1699
|
+
*/
|
|
1598
1700
|
interface SecretGroupCollection {
|
|
1599
1701
|
/** A collection of secret groups. */
|
|
1600
1702
|
secret_groups: SecretGroup[];
|
|
1601
1703
|
/** The total number of resources in a collection. */
|
|
1602
1704
|
total_count: number;
|
|
1603
1705
|
}
|
|
1604
|
-
/**
|
|
1706
|
+
/**
|
|
1707
|
+
* SecretLock.
|
|
1708
|
+
*/
|
|
1605
1709
|
interface SecretLock {
|
|
1606
1710
|
/** A human-readable name to assign to the lock. The lock name must be unique per secret version.
|
|
1607
1711
|
*
|
|
@@ -1643,7 +1747,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1643
1747
|
}
|
|
1644
1748
|
}
|
|
1645
1749
|
}
|
|
1646
|
-
/**
|
|
1750
|
+
/**
|
|
1751
|
+
* SecretLockPrototype.
|
|
1752
|
+
*/
|
|
1647
1753
|
interface SecretLockPrototype {
|
|
1648
1754
|
/** A human-readable name to assign to the lock. The lock name must be unique per secret version.
|
|
1649
1755
|
*
|
|
@@ -1660,7 +1766,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1660
1766
|
/** Optional information to associate with a lock, such as resources CRNs to be used by automation. */
|
|
1661
1767
|
attributes?: JsonObject;
|
|
1662
1768
|
}
|
|
1663
|
-
/**
|
|
1769
|
+
/**
|
|
1770
|
+
* Create locks response body containing a collection of locks that are attached to a secret.
|
|
1771
|
+
*/
|
|
1664
1772
|
interface SecretLocks {
|
|
1665
1773
|
/** A v4 UUID identifier. */
|
|
1666
1774
|
secret_id: string;
|
|
@@ -1690,7 +1798,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1690
1798
|
}
|
|
1691
1799
|
}
|
|
1692
1800
|
}
|
|
1693
|
-
/**
|
|
1801
|
+
/**
|
|
1802
|
+
* Properties that describe a paginated collection of your secret locks.
|
|
1803
|
+
*/
|
|
1694
1804
|
interface SecretLocksPaginatedCollection {
|
|
1695
1805
|
/** The total number of resources in a collection. */
|
|
1696
1806
|
total_count: number;
|
|
@@ -1709,10 +1819,14 @@ declare namespace SecretsManagerV2 {
|
|
|
1709
1819
|
/** A collection of secret locks. */
|
|
1710
1820
|
locks: SecretLock[];
|
|
1711
1821
|
}
|
|
1712
|
-
/**
|
|
1822
|
+
/**
|
|
1823
|
+
* Properties of your secret metadata.
|
|
1824
|
+
*/
|
|
1713
1825
|
interface SecretMetadata {
|
|
1714
1826
|
}
|
|
1715
|
-
/**
|
|
1827
|
+
/**
|
|
1828
|
+
* Properties that describe a paginated collection of your secret metadata.
|
|
1829
|
+
*/
|
|
1716
1830
|
interface SecretMetadataPaginatedCollection {
|
|
1717
1831
|
/** The total number of resources in a collection. */
|
|
1718
1832
|
total_count: number;
|
|
@@ -1731,19 +1845,29 @@ declare namespace SecretsManagerV2 {
|
|
|
1731
1845
|
/** A collection of secret metadata. */
|
|
1732
1846
|
secrets: SecretMetadata[];
|
|
1733
1847
|
}
|
|
1734
|
-
/**
|
|
1848
|
+
/**
|
|
1849
|
+
* Update your secret metadata.
|
|
1850
|
+
*/
|
|
1735
1851
|
interface SecretMetadataPatch {
|
|
1736
1852
|
}
|
|
1737
|
-
/**
|
|
1853
|
+
/**
|
|
1854
|
+
* Specify the properties for your secret.
|
|
1855
|
+
*/
|
|
1738
1856
|
interface SecretPrototype {
|
|
1739
1857
|
}
|
|
1740
|
-
/**
|
|
1858
|
+
/**
|
|
1859
|
+
* Your secret version.
|
|
1860
|
+
*/
|
|
1741
1861
|
interface SecretVersion {
|
|
1742
1862
|
}
|
|
1743
|
-
/**
|
|
1863
|
+
/**
|
|
1864
|
+
* The request body to specify the properties of the action to create a secret version.
|
|
1865
|
+
*/
|
|
1744
1866
|
interface SecretVersionActionPrototype {
|
|
1745
1867
|
}
|
|
1746
|
-
/**
|
|
1868
|
+
/**
|
|
1869
|
+
* SecretVersionLocks.
|
|
1870
|
+
*/
|
|
1747
1871
|
interface SecretVersionLocks {
|
|
1748
1872
|
/** A v4 UUID identifier. */
|
|
1749
1873
|
version_id: string;
|
|
@@ -1765,7 +1889,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1765
1889
|
}
|
|
1766
1890
|
}
|
|
1767
1891
|
}
|
|
1768
|
-
/**
|
|
1892
|
+
/**
|
|
1893
|
+
* Properties that describe a paginated collection of your secret version locks.
|
|
1894
|
+
*/
|
|
1769
1895
|
interface SecretVersionLocksPaginatedCollection {
|
|
1770
1896
|
/** The total number of resources in a collection. */
|
|
1771
1897
|
total_count: number;
|
|
@@ -1784,20 +1910,28 @@ declare namespace SecretsManagerV2 {
|
|
|
1784
1910
|
/** A collection of secret version locks. */
|
|
1785
1911
|
locks: SecretLock[];
|
|
1786
1912
|
}
|
|
1787
|
-
/**
|
|
1913
|
+
/**
|
|
1914
|
+
* Properties of the version metadata of your secret.
|
|
1915
|
+
*/
|
|
1788
1916
|
interface SecretVersionMetadata {
|
|
1789
1917
|
}
|
|
1790
|
-
/**
|
|
1918
|
+
/**
|
|
1919
|
+
* Properties that describe a collection of your secret version metadata.
|
|
1920
|
+
*/
|
|
1791
1921
|
interface SecretVersionMetadataCollection {
|
|
1792
1922
|
/** A collection of secret version metadata. */
|
|
1793
1923
|
versions: SecretVersionMetadata[];
|
|
1794
1924
|
/** The total number of resources in a collection. */
|
|
1795
1925
|
total_count: number;
|
|
1796
1926
|
}
|
|
1797
|
-
/**
|
|
1927
|
+
/**
|
|
1928
|
+
* Specify the properties for your new secret version.
|
|
1929
|
+
*/
|
|
1798
1930
|
interface SecretVersionPrototype {
|
|
1799
1931
|
}
|
|
1800
|
-
/**
|
|
1932
|
+
/**
|
|
1933
|
+
* Properties that describe a paginated collection of your secrets locks.
|
|
1934
|
+
*/
|
|
1801
1935
|
interface SecretsLocksPaginatedCollection {
|
|
1802
1936
|
/** The total number of resources in a collection. */
|
|
1803
1937
|
total_count: number;
|
|
@@ -1816,14 +1950,20 @@ declare namespace SecretsManagerV2 {
|
|
|
1816
1950
|
/** A collection of secrets and their locks. */
|
|
1817
1951
|
secrets_locks: SecretLocks[];
|
|
1818
1952
|
}
|
|
1819
|
-
/**
|
|
1953
|
+
/**
|
|
1954
|
+
* The source service resource key data of the generated service credentials.
|
|
1955
|
+
*/
|
|
1820
1956
|
interface ServiceCredentialsResourceKey {
|
|
1821
1957
|
/** The resource key CRN of the generated service credentials. */
|
|
1822
1958
|
crn?: string;
|
|
1823
1959
|
/** The resource key name of the generated service credentials. */
|
|
1824
1960
|
name?: string;
|
|
1825
1961
|
}
|
|
1826
|
-
/**
|
|
1962
|
+
/**
|
|
1963
|
+
* The properties of the service credentials secret payload.
|
|
1964
|
+
*
|
|
1965
|
+
* This type supports additional properties of type any.
|
|
1966
|
+
*/
|
|
1827
1967
|
interface ServiceCredentialsSecretCredentials {
|
|
1828
1968
|
/** The API key that is generated for this secret.
|
|
1829
1969
|
*
|
|
@@ -1841,10 +1981,14 @@ declare namespace SecretsManagerV2 {
|
|
|
1841
1981
|
iam_role_crn?: string;
|
|
1842
1982
|
/** The IAM Service ID CRN. */
|
|
1843
1983
|
iam_serviceid_crn?: string;
|
|
1844
|
-
/**
|
|
1984
|
+
/**
|
|
1985
|
+
* ServiceCredentialsSecretCredentials accepts additional properties of type any.
|
|
1986
|
+
*/
|
|
1845
1987
|
[propName: string]: any;
|
|
1846
1988
|
}
|
|
1847
|
-
/**
|
|
1989
|
+
/**
|
|
1990
|
+
* The properties that are required to create the service credentials for the specified source service instance.
|
|
1991
|
+
*/
|
|
1848
1992
|
interface ServiceCredentialsSecretSourceService {
|
|
1849
1993
|
/** The source service instance identifier. */
|
|
1850
1994
|
instance: ServiceCredentialsSourceServiceInstance;
|
|
@@ -1861,7 +2005,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1861
2005
|
*/
|
|
1862
2006
|
role?: ServiceCredentialsSourceServiceRole;
|
|
1863
2007
|
}
|
|
1864
|
-
/**
|
|
2008
|
+
/**
|
|
2009
|
+
* The properties of the resource key that was created for this source service instance.
|
|
2010
|
+
*/
|
|
1865
2011
|
interface ServiceCredentialsSecretSourceServiceRO {
|
|
1866
2012
|
/** The source service instance identifier. */
|
|
1867
2013
|
instance: ServiceCredentialsSourceServiceInstance;
|
|
@@ -1882,7 +2028,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1882
2028
|
/** The source service resource key data of the generated service credentials. */
|
|
1883
2029
|
resource_key?: ServiceCredentialsResourceKey;
|
|
1884
2030
|
}
|
|
1885
|
-
/**
|
|
2031
|
+
/**
|
|
2032
|
+
* The source service IAM data is returned in case IAM credentials where created for this secret.
|
|
2033
|
+
*/
|
|
1886
2034
|
interface ServiceCredentialsSourceServiceIam {
|
|
1887
2035
|
/** The IAM apikey metadata for the IAM credentials that were generated. */
|
|
1888
2036
|
apikey?: ServiceCredentialsSourceServiceIamApikey;
|
|
@@ -1891,7 +2039,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1891
2039
|
/** The IAM serviceid for the generated service credentials. */
|
|
1892
2040
|
serviceid?: ServiceCredentialsSourceServiceIamServiceid;
|
|
1893
2041
|
}
|
|
1894
|
-
/**
|
|
2042
|
+
/**
|
|
2043
|
+
* The IAM apikey metadata for the IAM credentials that were generated.
|
|
2044
|
+
*/
|
|
1895
2045
|
interface ServiceCredentialsSourceServiceIamApikey {
|
|
1896
2046
|
/** The IAM API key description for the generated service credentials. */
|
|
1897
2047
|
description?: string;
|
|
@@ -1900,37 +2050,60 @@ declare namespace SecretsManagerV2 {
|
|
|
1900
2050
|
/** The IAM API key name for the generated service credentials. */
|
|
1901
2051
|
name?: string;
|
|
1902
2052
|
}
|
|
1903
|
-
/**
|
|
2053
|
+
/**
|
|
2054
|
+
* The IAM role for the generate service credentials.
|
|
2055
|
+
*/
|
|
1904
2056
|
interface ServiceCredentialsSourceServiceIamRole {
|
|
1905
2057
|
/** The IAM role CRN assigned to the generated service credentials. */
|
|
1906
2058
|
crn?: string;
|
|
1907
2059
|
}
|
|
1908
|
-
/**
|
|
2060
|
+
/**
|
|
2061
|
+
* The IAM serviceid for the generated service credentials.
|
|
2062
|
+
*/
|
|
1909
2063
|
interface ServiceCredentialsSourceServiceIamServiceid {
|
|
1910
2064
|
/** The IAM Service ID CRN. */
|
|
1911
2065
|
crn?: string;
|
|
1912
2066
|
}
|
|
1913
|
-
/**
|
|
2067
|
+
/**
|
|
2068
|
+
* The source service instance identifier.
|
|
2069
|
+
*/
|
|
1914
2070
|
interface ServiceCredentialsSourceServiceInstance {
|
|
1915
2071
|
/** A CRN that uniquely identifies a service credentials source. */
|
|
1916
2072
|
crn?: string;
|
|
1917
2073
|
}
|
|
1918
|
-
/**
|
|
2074
|
+
/**
|
|
2075
|
+
* Configuration options represented as key-value pairs. Service-defined options are used in the generation of
|
|
2076
|
+
* credentials for some services. For example, Cloud Object Storage accepts the optional boolean parameter HMAC for
|
|
2077
|
+
* creating specific kind of credentials.
|
|
2078
|
+
*
|
|
2079
|
+
* This type supports additional properties of type any.
|
|
2080
|
+
*/
|
|
1919
2081
|
interface ServiceCredentialsSourceServiceParameters {
|
|
1920
2082
|
/** An optional platform defined option to reuse an existing IAM Service ID for the role assignment. */
|
|
1921
2083
|
serviceid_crn?: string;
|
|
1922
|
-
/**
|
|
2084
|
+
/**
|
|
2085
|
+
* ServiceCredentialsSourceServiceParameters accepts additional properties of type any.
|
|
2086
|
+
*/
|
|
1923
2087
|
[propName: string]: any;
|
|
1924
2088
|
}
|
|
1925
|
-
/**
|
|
2089
|
+
/**
|
|
2090
|
+
* The service-specific custom role. CRN is accepted. The role is assigned as part of an access policy to any
|
|
2091
|
+
* auto-generated IAM service ID. If you provide an existing service ID, it is added to the access policy for that
|
|
2092
|
+
* ID. If a role is not provided, any new service IDs that are autogenerated, will not have an assigned access policy
|
|
2093
|
+
* and provided service IDs are not changed in any way. Refer to the service documentation for supported roles.
|
|
2094
|
+
*/
|
|
1926
2095
|
interface ServiceCredentialsSourceServiceRole {
|
|
1927
2096
|
/** The service role CRN. */
|
|
1928
2097
|
crn: string;
|
|
1929
2098
|
}
|
|
1930
|
-
/**
|
|
2099
|
+
/**
|
|
2100
|
+
* The request body to specify the properties of the action to create a secret version.
|
|
2101
|
+
*/
|
|
1931
2102
|
interface VersionAction {
|
|
1932
2103
|
}
|
|
1933
|
-
/**
|
|
2104
|
+
/**
|
|
2105
|
+
* Your arbitrary secret.
|
|
2106
|
+
*/
|
|
1934
2107
|
interface ArbitrarySecret extends Secret {
|
|
1935
2108
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
1936
2109
|
created_by: string;
|
|
@@ -1979,6 +2152,8 @@ declare namespace SecretsManagerV2 {
|
|
|
1979
2152
|
updated_at: string;
|
|
1980
2153
|
/** The number of versions of your secret. */
|
|
1981
2154
|
versions_total: number;
|
|
2155
|
+
/** The list of configurations that have a reference to the secret. */
|
|
2156
|
+
referenced_by?: string[];
|
|
1982
2157
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
1983
2158
|
* types: Arbitrary, username_password.
|
|
1984
2159
|
*/
|
|
@@ -2009,7 +2184,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2009
2184
|
}
|
|
2010
2185
|
}
|
|
2011
2186
|
}
|
|
2012
|
-
/**
|
|
2187
|
+
/**
|
|
2188
|
+
* Properties of the metadata of your arbitrary secret..
|
|
2189
|
+
*/
|
|
2013
2190
|
interface ArbitrarySecretMetadata extends SecretMetadata {
|
|
2014
2191
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
2015
2192
|
created_by: string;
|
|
@@ -2058,6 +2235,8 @@ declare namespace SecretsManagerV2 {
|
|
|
2058
2235
|
updated_at: string;
|
|
2059
2236
|
/** The number of versions of your secret. */
|
|
2060
2237
|
versions_total: number;
|
|
2238
|
+
/** The list of configurations that have a reference to the secret. */
|
|
2239
|
+
referenced_by?: string[];
|
|
2061
2240
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
2062
2241
|
* types: Arbitrary, username_password.
|
|
2063
2242
|
*/
|
|
@@ -2086,7 +2265,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2086
2265
|
}
|
|
2087
2266
|
}
|
|
2088
2267
|
}
|
|
2089
|
-
/**
|
|
2268
|
+
/**
|
|
2269
|
+
* ArbitrarySecretMetadataPatch.
|
|
2270
|
+
*/
|
|
2090
2271
|
interface ArbitrarySecretMetadataPatch extends SecretMetadataPatch {
|
|
2091
2272
|
/** A human-readable name to assign to your secret.
|
|
2092
2273
|
*
|
|
@@ -2113,7 +2294,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2113
2294
|
*/
|
|
2114
2295
|
expiration_date?: string;
|
|
2115
2296
|
}
|
|
2116
|
-
/**
|
|
2297
|
+
/**
|
|
2298
|
+
* ArbitrarySecretPrototype.
|
|
2299
|
+
*/
|
|
2117
2300
|
interface ArbitrarySecretPrototype extends SecretPrototype {
|
|
2118
2301
|
/** The secret metadata that a user can customize. */
|
|
2119
2302
|
custom_metadata?: JsonObject;
|
|
@@ -2165,7 +2348,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2165
2348
|
}
|
|
2166
2349
|
}
|
|
2167
2350
|
}
|
|
2168
|
-
/**
|
|
2351
|
+
/**
|
|
2352
|
+
* Your arbitrary secret version.
|
|
2353
|
+
*/
|
|
2169
2354
|
interface ArbitrarySecretVersion extends SecretVersion {
|
|
2170
2355
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
2171
2356
|
auto_rotated?: boolean;
|
|
@@ -2224,7 +2409,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2224
2409
|
}
|
|
2225
2410
|
}
|
|
2226
2411
|
}
|
|
2227
|
-
/**
|
|
2412
|
+
/**
|
|
2413
|
+
* Properties of the version metadata of your arbitrary secret.
|
|
2414
|
+
*/
|
|
2228
2415
|
interface ArbitrarySecretVersionMetadata extends SecretVersionMetadata {
|
|
2229
2416
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
2230
2417
|
auto_rotated?: boolean;
|
|
@@ -2281,7 +2468,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2281
2468
|
}
|
|
2282
2469
|
}
|
|
2283
2470
|
}
|
|
2284
|
-
/**
|
|
2471
|
+
/**
|
|
2472
|
+
* ArbitrarySecretVersionPrototype.
|
|
2473
|
+
*/
|
|
2285
2474
|
interface ArbitrarySecretVersionPrototype extends SecretVersionPrototype {
|
|
2286
2475
|
/** The secret data that is assigned to an `arbitrary` secret. */
|
|
2287
2476
|
payload: string;
|
|
@@ -2290,7 +2479,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2290
2479
|
/** The secret version metadata that a user can customize. */
|
|
2291
2480
|
version_custom_metadata?: JsonObject;
|
|
2292
2481
|
}
|
|
2293
|
-
/**
|
|
2482
|
+
/**
|
|
2483
|
+
* This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
2484
|
+
*/
|
|
2294
2485
|
interface CommonRotationPolicy extends RotationPolicy {
|
|
2295
2486
|
/** This field indicates whether Secrets Manager rotates your secret automatically.
|
|
2296
2487
|
*
|
|
@@ -2312,7 +2503,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2312
2503
|
}
|
|
2313
2504
|
}
|
|
2314
2505
|
}
|
|
2315
|
-
/**
|
|
2506
|
+
/**
|
|
2507
|
+
* Properties that describe a Classic Infrastructure DNS configuration.
|
|
2508
|
+
*/
|
|
2316
2509
|
interface IAMCredentialsConfiguration extends Configuration {
|
|
2317
2510
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
2318
2511
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -2343,13 +2536,13 @@ declare namespace SecretsManagerV2 {
|
|
|
2343
2536
|
namespace Constants {
|
|
2344
2537
|
/** 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
2538
|
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
2539
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
2349
|
-
|
|
2540
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
2541
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
2350
2542
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
2351
2543
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
2352
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
2544
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
2545
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
2353
2546
|
}
|
|
2354
2547
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
2355
2548
|
enum SecretType {
|
|
@@ -2364,7 +2557,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2364
2557
|
}
|
|
2365
2558
|
}
|
|
2366
2559
|
}
|
|
2367
|
-
/**
|
|
2560
|
+
/**
|
|
2561
|
+
* Your IAMCredentials Configuration metadata properties.
|
|
2562
|
+
*/
|
|
2368
2563
|
interface IAMCredentialsConfigurationMetadata extends ConfigurationMetadata {
|
|
2369
2564
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
2370
2565
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -2389,13 +2584,13 @@ declare namespace SecretsManagerV2 {
|
|
|
2389
2584
|
namespace Constants {
|
|
2390
2585
|
/** 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
2586
|
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
2587
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
2395
|
-
|
|
2588
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
2589
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
2396
2590
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
2397
2591
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
2398
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
2592
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
2593
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
2399
2594
|
}
|
|
2400
2595
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
2401
2596
|
enum SecretType {
|
|
@@ -2410,7 +2605,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2410
2605
|
}
|
|
2411
2606
|
}
|
|
2412
2607
|
}
|
|
2413
|
-
/**
|
|
2608
|
+
/**
|
|
2609
|
+
* The configuration update of the IAM Credentials engine.
|
|
2610
|
+
*/
|
|
2414
2611
|
interface IAMCredentialsConfigurationPatch extends ConfigurationPatch {
|
|
2415
2612
|
/** An IBM Cloud API key that can create and manage service IDs. The API key must be assigned the Editor
|
|
2416
2613
|
* platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. For more
|
|
@@ -2419,7 +2616,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2419
2616
|
*/
|
|
2420
2617
|
api_key: string;
|
|
2421
2618
|
}
|
|
2422
|
-
/**
|
|
2619
|
+
/**
|
|
2620
|
+
* IAMCredentialsConfigurationPrototype.
|
|
2621
|
+
*/
|
|
2423
2622
|
interface IAMCredentialsConfigurationPrototype extends ConfigurationPrototype {
|
|
2424
2623
|
/** A human-readable unique name to assign to your configuration.
|
|
2425
2624
|
*
|
|
@@ -2439,17 +2638,19 @@ declare namespace SecretsManagerV2 {
|
|
|
2439
2638
|
namespace Constants {
|
|
2440
2639
|
/** 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
2640
|
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
2641
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
2445
|
-
|
|
2642
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
2643
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
2446
2644
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
2447
2645
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
2448
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
2646
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
2647
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
2449
2648
|
}
|
|
2450
2649
|
}
|
|
2451
2650
|
}
|
|
2452
|
-
/**
|
|
2651
|
+
/**
|
|
2652
|
+
* Your IAM credentials secret.
|
|
2653
|
+
*/
|
|
2453
2654
|
interface IAMCredentialsSecret extends Secret {
|
|
2454
2655
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
2455
2656
|
created_by: string;
|
|
@@ -2498,12 +2699,15 @@ declare namespace SecretsManagerV2 {
|
|
|
2498
2699
|
updated_at: string;
|
|
2499
2700
|
/** The number of versions of your secret. */
|
|
2500
2701
|
versions_total: number;
|
|
2702
|
+
/** The list of configurations that have a reference to the secret. */
|
|
2703
|
+
referenced_by?: string[];
|
|
2501
2704
|
/** The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret
|
|
2502
2705
|
* types: iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The
|
|
2503
2706
|
* value can be either an integer that specifies the number of seconds, or the string representation of a
|
|
2504
2707
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
2505
2708
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
2506
2709
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
2710
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
2507
2711
|
*/
|
|
2508
2712
|
ttl: string;
|
|
2509
2713
|
/** Access Groups that you can use for an `iam_credentials` secret.
|
|
@@ -2581,7 +2785,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2581
2785
|
}
|
|
2582
2786
|
}
|
|
2583
2787
|
}
|
|
2584
|
-
/**
|
|
2788
|
+
/**
|
|
2789
|
+
* Properties of the metadata of your IAM credentials secret.
|
|
2790
|
+
*/
|
|
2585
2791
|
interface IAMCredentialsSecretMetadata extends SecretMetadata {
|
|
2586
2792
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
2587
2793
|
created_by: string;
|
|
@@ -2630,12 +2836,15 @@ declare namespace SecretsManagerV2 {
|
|
|
2630
2836
|
updated_at: string;
|
|
2631
2837
|
/** The number of versions of your secret. */
|
|
2632
2838
|
versions_total: number;
|
|
2839
|
+
/** The list of configurations that have a reference to the secret. */
|
|
2840
|
+
referenced_by?: string[];
|
|
2633
2841
|
/** The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret
|
|
2634
2842
|
* types: iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The
|
|
2635
2843
|
* value can be either an integer that specifies the number of seconds, or the string representation of a
|
|
2636
2844
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
2637
2845
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
2638
2846
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
2847
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
2639
2848
|
*/
|
|
2640
2849
|
ttl: string;
|
|
2641
2850
|
/** Access Groups that you can use for an `iam_credentials` secret.
|
|
@@ -2706,7 +2915,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2706
2915
|
}
|
|
2707
2916
|
}
|
|
2708
2917
|
}
|
|
2709
|
-
/**
|
|
2918
|
+
/**
|
|
2919
|
+
* IAMCredentialsSecretMetadataPatch.
|
|
2920
|
+
*/
|
|
2710
2921
|
interface IAMCredentialsSecretMetadataPatch extends SecretMetadataPatch {
|
|
2711
2922
|
/** A human-readable name to assign to your secret.
|
|
2712
2923
|
*
|
|
@@ -2734,6 +2945,7 @@ declare namespace SecretsManagerV2 {
|
|
|
2734
2945
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
2735
2946
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
2736
2947
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
2948
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
2737
2949
|
*/
|
|
2738
2950
|
ttl?: string;
|
|
2739
2951
|
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
@@ -2741,7 +2953,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2741
2953
|
*/
|
|
2742
2954
|
rotation?: RotationPolicy;
|
|
2743
2955
|
}
|
|
2744
|
-
/**
|
|
2956
|
+
/**
|
|
2957
|
+
* IAMCredentialsSecretPrototype.
|
|
2958
|
+
*/
|
|
2745
2959
|
interface IAMCredentialsSecretPrototype extends SecretPrototype {
|
|
2746
2960
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
2747
2961
|
* service_credentials, kv, and username_password.
|
|
@@ -2773,6 +2987,7 @@ declare namespace SecretsManagerV2 {
|
|
|
2773
2987
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
2774
2988
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
2775
2989
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
2990
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
2776
2991
|
*/
|
|
2777
2992
|
ttl: string;
|
|
2778
2993
|
/** Access Groups that you can use for an `iam_credentials` secret.
|
|
@@ -2821,7 +3036,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2821
3036
|
}
|
|
2822
3037
|
}
|
|
2823
3038
|
}
|
|
2824
|
-
/**
|
|
3039
|
+
/**
|
|
3040
|
+
* IAMCredentialsSecretRestoreFromVersionPrototype.
|
|
3041
|
+
*/
|
|
2825
3042
|
interface IAMCredentialsSecretRestoreFromVersionPrototype extends SecretVersionPrototype {
|
|
2826
3043
|
/** A v4 UUID identifier, or `current` or `previous` secret version aliases. */
|
|
2827
3044
|
restore_from_version: string;
|
|
@@ -2830,7 +3047,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2830
3047
|
/** The secret version metadata that a user can customize. */
|
|
2831
3048
|
version_custom_metadata?: JsonObject;
|
|
2832
3049
|
}
|
|
2833
|
-
/**
|
|
3050
|
+
/**
|
|
3051
|
+
* Your IAM credentials version.
|
|
3052
|
+
*/
|
|
2834
3053
|
interface IAMCredentialsSecretVersion extends SecretVersion {
|
|
2835
3054
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
2836
3055
|
auto_rotated?: boolean;
|
|
@@ -2862,6 +3081,10 @@ declare namespace SecretsManagerV2 {
|
|
|
2862
3081
|
version_custom_metadata?: JsonObject;
|
|
2863
3082
|
/** A v4 UUID identifier. */
|
|
2864
3083
|
secret_id: string;
|
|
3084
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
3085
|
+
* types: Arbitrary, username_password.
|
|
3086
|
+
*/
|
|
3087
|
+
expiration_date?: string;
|
|
2865
3088
|
/** The ID of the API key that is generated for this secret. */
|
|
2866
3089
|
api_key_id?: string;
|
|
2867
3090
|
/** The service ID under which the API key (see the `api_key` field) is created.
|
|
@@ -2902,7 +3125,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2902
3125
|
}
|
|
2903
3126
|
}
|
|
2904
3127
|
}
|
|
2905
|
-
/**
|
|
3128
|
+
/**
|
|
3129
|
+
* Properties of the version metadata of your IAM credentials secret.
|
|
3130
|
+
*/
|
|
2906
3131
|
interface IAMCredentialsSecretVersionMetadata extends SecretVersionMetadata {
|
|
2907
3132
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
2908
3133
|
auto_rotated?: boolean;
|
|
@@ -2934,6 +3159,10 @@ declare namespace SecretsManagerV2 {
|
|
|
2934
3159
|
version_custom_metadata?: JsonObject;
|
|
2935
3160
|
/** A v4 UUID identifier. */
|
|
2936
3161
|
secret_id: string;
|
|
3162
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
3163
|
+
* types: Arbitrary, username_password.
|
|
3164
|
+
*/
|
|
3165
|
+
expiration_date?: string;
|
|
2937
3166
|
/** The ID of the API key that is generated for this secret. */
|
|
2938
3167
|
api_key_id?: string;
|
|
2939
3168
|
/** The service ID under which the API key (see the `api_key` field) is created.
|
|
@@ -2967,14 +3196,18 @@ declare namespace SecretsManagerV2 {
|
|
|
2967
3196
|
}
|
|
2968
3197
|
}
|
|
2969
3198
|
}
|
|
2970
|
-
/**
|
|
3199
|
+
/**
|
|
3200
|
+
* IAMCredentialsSecretVersionPrototype.
|
|
3201
|
+
*/
|
|
2971
3202
|
interface IAMCredentialsSecretVersionPrototype extends SecretVersionPrototype {
|
|
2972
3203
|
/** The secret metadata that a user can customize. */
|
|
2973
3204
|
custom_metadata?: JsonObject;
|
|
2974
3205
|
/** The secret version metadata that a user can customize. */
|
|
2975
3206
|
version_custom_metadata?: JsonObject;
|
|
2976
3207
|
}
|
|
2977
|
-
/**
|
|
3208
|
+
/**
|
|
3209
|
+
* Your imported certificate.
|
|
3210
|
+
*/
|
|
2978
3211
|
interface ImportedCertificate extends Secret {
|
|
2979
3212
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
2980
3213
|
created_by: string;
|
|
@@ -3023,6 +3256,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3023
3256
|
updated_at: string;
|
|
3024
3257
|
/** The number of versions of your secret. */
|
|
3025
3258
|
versions_total: number;
|
|
3259
|
+
/** The list of configurations that have a reference to the secret. */
|
|
3260
|
+
referenced_by?: string[];
|
|
3026
3261
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
3027
3262
|
* certificate.
|
|
3028
3263
|
*/
|
|
@@ -3085,7 +3320,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3085
3320
|
}
|
|
3086
3321
|
}
|
|
3087
3322
|
}
|
|
3088
|
-
/**
|
|
3323
|
+
/**
|
|
3324
|
+
* Properties of the secret metadata of your imported certificate.
|
|
3325
|
+
*/
|
|
3089
3326
|
interface ImportedCertificateMetadata extends SecretMetadata {
|
|
3090
3327
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
3091
3328
|
created_by: string;
|
|
@@ -3134,6 +3371,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3134
3371
|
updated_at: string;
|
|
3135
3372
|
/** The number of versions of your secret. */
|
|
3136
3373
|
versions_total: number;
|
|
3374
|
+
/** The list of configurations that have a reference to the secret. */
|
|
3375
|
+
referenced_by?: string[];
|
|
3137
3376
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
3138
3377
|
* certificate.
|
|
3139
3378
|
*/
|
|
@@ -3186,7 +3425,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3186
3425
|
}
|
|
3187
3426
|
}
|
|
3188
3427
|
}
|
|
3189
|
-
/**
|
|
3428
|
+
/**
|
|
3429
|
+
* ImportedCertificateMetadataPatch.
|
|
3430
|
+
*/
|
|
3190
3431
|
interface ImportedCertificateMetadataPatch extends SecretMetadataPatch {
|
|
3191
3432
|
/** A human-readable name to assign to your secret.
|
|
3192
3433
|
*
|
|
@@ -3209,7 +3450,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3209
3450
|
/** The secret metadata that a user can customize. */
|
|
3210
3451
|
custom_metadata?: JsonObject;
|
|
3211
3452
|
}
|
|
3212
|
-
/**
|
|
3453
|
+
/**
|
|
3454
|
+
* ImportedCertificatePrototype.
|
|
3455
|
+
*/
|
|
3213
3456
|
interface ImportedCertificatePrototype extends SecretPrototype {
|
|
3214
3457
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
3215
3458
|
* service_credentials, kv, and username_password.
|
|
@@ -3265,7 +3508,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3265
3508
|
}
|
|
3266
3509
|
}
|
|
3267
3510
|
}
|
|
3268
|
-
/**
|
|
3511
|
+
/**
|
|
3512
|
+
* Versions of your imported certificate.
|
|
3513
|
+
*/
|
|
3269
3514
|
interface ImportedCertificateVersion extends SecretVersion {
|
|
3270
3515
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
3271
3516
|
auto_rotated?: boolean;
|
|
@@ -3300,7 +3545,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3300
3545
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
3301
3546
|
* types: Arbitrary, username_password.
|
|
3302
3547
|
*/
|
|
3303
|
-
expiration_date
|
|
3548
|
+
expiration_date?: string;
|
|
3304
3549
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
3305
3550
|
serial_number: string;
|
|
3306
3551
|
/** The date and time that the certificate validity period begins and ends. */
|
|
@@ -3336,7 +3581,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3336
3581
|
}
|
|
3337
3582
|
}
|
|
3338
3583
|
}
|
|
3339
|
-
/**
|
|
3584
|
+
/**
|
|
3585
|
+
* Properties of the version metadata of your imported certificate.
|
|
3586
|
+
*/
|
|
3340
3587
|
interface ImportedCertificateVersionMetadata extends SecretVersionMetadata {
|
|
3341
3588
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
3342
3589
|
auto_rotated?: boolean;
|
|
@@ -3371,7 +3618,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3371
3618
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
3372
3619
|
* types: Arbitrary, username_password.
|
|
3373
3620
|
*/
|
|
3374
|
-
expiration_date
|
|
3621
|
+
expiration_date?: string;
|
|
3375
3622
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
3376
3623
|
serial_number: string;
|
|
3377
3624
|
/** The date and time that the certificate validity period begins and ends. */
|
|
@@ -3397,7 +3644,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3397
3644
|
}
|
|
3398
3645
|
}
|
|
3399
3646
|
}
|
|
3400
|
-
/**
|
|
3647
|
+
/**
|
|
3648
|
+
* ImportedCertificateVersionPrototype.
|
|
3649
|
+
*/
|
|
3401
3650
|
interface ImportedCertificateVersionPrototype extends SecretVersionPrototype {
|
|
3402
3651
|
/** Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters. */
|
|
3403
3652
|
certificate: string;
|
|
@@ -3414,7 +3663,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3414
3663
|
/** The secret version metadata that a user can customize. */
|
|
3415
3664
|
version_custom_metadata?: JsonObject;
|
|
3416
3665
|
}
|
|
3417
|
-
/**
|
|
3666
|
+
/**
|
|
3667
|
+
* Your key-value secret.
|
|
3668
|
+
*/
|
|
3418
3669
|
interface KVSecret extends Secret {
|
|
3419
3670
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
3420
3671
|
created_by: string;
|
|
@@ -3463,6 +3714,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3463
3714
|
updated_at: string;
|
|
3464
3715
|
/** The number of versions of your secret. */
|
|
3465
3716
|
versions_total: number;
|
|
3717
|
+
/** The list of configurations that have a reference to the secret. */
|
|
3718
|
+
referenced_by?: string[];
|
|
3466
3719
|
/** The payload data of a key-value secret. */
|
|
3467
3720
|
data: JsonObject;
|
|
3468
3721
|
}
|
|
@@ -3489,7 +3742,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3489
3742
|
}
|
|
3490
3743
|
}
|
|
3491
3744
|
}
|
|
3492
|
-
/**
|
|
3745
|
+
/**
|
|
3746
|
+
* Properties of the metadata of your key-value secret metadata.
|
|
3747
|
+
*/
|
|
3493
3748
|
interface KVSecretMetadata extends SecretMetadata {
|
|
3494
3749
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
3495
3750
|
created_by: string;
|
|
@@ -3538,6 +3793,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3538
3793
|
updated_at: string;
|
|
3539
3794
|
/** The number of versions of your secret. */
|
|
3540
3795
|
versions_total: number;
|
|
3796
|
+
/** The list of configurations that have a reference to the secret. */
|
|
3797
|
+
referenced_by?: string[];
|
|
3541
3798
|
}
|
|
3542
3799
|
namespace KVSecretMetadata {
|
|
3543
3800
|
namespace Constants {
|
|
@@ -3562,7 +3819,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3562
3819
|
}
|
|
3563
3820
|
}
|
|
3564
3821
|
}
|
|
3565
|
-
/**
|
|
3822
|
+
/**
|
|
3823
|
+
* KVSecretMetadataPatch.
|
|
3824
|
+
*/
|
|
3566
3825
|
interface KVSecretMetadataPatch extends SecretMetadataPatch {
|
|
3567
3826
|
/** A human-readable name to assign to your secret.
|
|
3568
3827
|
*
|
|
@@ -3585,7 +3844,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3585
3844
|
/** The secret metadata that a user can customize. */
|
|
3586
3845
|
custom_metadata?: JsonObject;
|
|
3587
3846
|
}
|
|
3588
|
-
/**
|
|
3847
|
+
/**
|
|
3848
|
+
* KVSecretPrototype.
|
|
3849
|
+
*/
|
|
3589
3850
|
interface KVSecretPrototype extends SecretPrototype {
|
|
3590
3851
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
3591
3852
|
* service_credentials, kv, and username_password.
|
|
@@ -3633,7 +3894,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3633
3894
|
}
|
|
3634
3895
|
}
|
|
3635
3896
|
}
|
|
3636
|
-
/**
|
|
3897
|
+
/**
|
|
3898
|
+
* Your key-value secret version.
|
|
3899
|
+
*/
|
|
3637
3900
|
interface KVSecretVersion extends SecretVersion {
|
|
3638
3901
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
3639
3902
|
auto_rotated?: boolean;
|
|
@@ -3665,6 +3928,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3665
3928
|
version_custom_metadata?: JsonObject;
|
|
3666
3929
|
/** A v4 UUID identifier. */
|
|
3667
3930
|
secret_id: string;
|
|
3931
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
3932
|
+
* types: Arbitrary, username_password.
|
|
3933
|
+
*/
|
|
3934
|
+
expiration_date?: string;
|
|
3668
3935
|
/** The payload data of a key-value secret. */
|
|
3669
3936
|
data: JsonObject;
|
|
3670
3937
|
}
|
|
@@ -3688,7 +3955,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3688
3955
|
}
|
|
3689
3956
|
}
|
|
3690
3957
|
}
|
|
3691
|
-
/**
|
|
3958
|
+
/**
|
|
3959
|
+
* Properties of the version metadata of your key-value secret.
|
|
3960
|
+
*/
|
|
3692
3961
|
interface KVSecretVersionMetadata extends SecretVersionMetadata {
|
|
3693
3962
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
3694
3963
|
auto_rotated?: boolean;
|
|
@@ -3720,6 +3989,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3720
3989
|
version_custom_metadata?: JsonObject;
|
|
3721
3990
|
/** A v4 UUID identifier. */
|
|
3722
3991
|
secret_id: string;
|
|
3992
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
3993
|
+
* types: Arbitrary, username_password.
|
|
3994
|
+
*/
|
|
3995
|
+
expiration_date?: string;
|
|
3723
3996
|
}
|
|
3724
3997
|
namespace KVSecretVersionMetadata {
|
|
3725
3998
|
namespace Constants {
|
|
@@ -3741,7 +4014,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3741
4014
|
}
|
|
3742
4015
|
}
|
|
3743
4016
|
}
|
|
3744
|
-
/**
|
|
4017
|
+
/**
|
|
4018
|
+
* KVSecretVersionPrototype.
|
|
4019
|
+
*/
|
|
3745
4020
|
interface KVSecretVersionPrototype extends SecretVersionPrototype {
|
|
3746
4021
|
/** The payload data of a key-value secret. */
|
|
3747
4022
|
data: JsonObject;
|
|
@@ -3750,7 +4025,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3750
4025
|
/** The secret version metadata that a user can customize. */
|
|
3751
4026
|
version_custom_metadata?: JsonObject;
|
|
3752
4027
|
}
|
|
3753
|
-
/**
|
|
4028
|
+
/**
|
|
4029
|
+
* Your private certificate.
|
|
4030
|
+
*/
|
|
3754
4031
|
interface PrivateCertificate extends Secret {
|
|
3755
4032
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
3756
4033
|
created_by: string;
|
|
@@ -3799,6 +4076,8 @@ declare namespace SecretsManagerV2 {
|
|
|
3799
4076
|
updated_at: string;
|
|
3800
4077
|
/** The number of versions of your secret. */
|
|
3801
4078
|
versions_total: number;
|
|
4079
|
+
/** The list of configurations that have a reference to the secret. */
|
|
4080
|
+
referenced_by?: string[];
|
|
3802
4081
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
3803
4082
|
* certificate.
|
|
3804
4083
|
*/
|
|
@@ -3875,7 +4154,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3875
4154
|
}
|
|
3876
4155
|
}
|
|
3877
4156
|
}
|
|
3878
|
-
/**
|
|
4157
|
+
/**
|
|
4158
|
+
* The response body of the action to revoke the private certificate.
|
|
4159
|
+
*/
|
|
3879
4160
|
interface PrivateCertificateActionRevoke extends SecretAction {
|
|
3880
4161
|
/** The type of secret action. */
|
|
3881
4162
|
action_type: PrivateCertificateActionRevoke.Constants.ActionType | string;
|
|
@@ -3891,7 +4172,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3891
4172
|
}
|
|
3892
4173
|
}
|
|
3893
4174
|
}
|
|
3894
|
-
/**
|
|
4175
|
+
/**
|
|
4176
|
+
* The request body to specify the properties of the action to revoke the private certificate.
|
|
4177
|
+
*/
|
|
3895
4178
|
interface PrivateCertificateActionRevokePrototype extends SecretActionPrototype {
|
|
3896
4179
|
/** The type of secret action. */
|
|
3897
4180
|
action_type: PrivateCertificateActionRevokePrototype.Constants.ActionType | string;
|
|
@@ -3905,7 +4188,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3905
4188
|
}
|
|
3906
4189
|
}
|
|
3907
4190
|
}
|
|
3908
|
-
/**
|
|
4191
|
+
/**
|
|
4192
|
+
* The response body to specify the properties of the action to revoke the private certificate.
|
|
4193
|
+
*/
|
|
3909
4194
|
interface PrivateCertificateConfigurationActionRevoke extends ConfigurationAction {
|
|
3910
4195
|
/** The type of configuration action. */
|
|
3911
4196
|
action_type: PrivateCertificateConfigurationActionRevoke.Constants.ActionType | string;
|
|
@@ -3924,7 +4209,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3924
4209
|
}
|
|
3925
4210
|
}
|
|
3926
4211
|
}
|
|
3927
|
-
/**
|
|
4212
|
+
/**
|
|
4213
|
+
* The request body to specify the properties of the action to revoke the private certificate configuration.
|
|
4214
|
+
*/
|
|
3928
4215
|
interface PrivateCertificateConfigurationActionRevokePrototype extends ConfigurationActionPrototype {
|
|
3929
4216
|
/** The type of configuration action. */
|
|
3930
4217
|
action_type: PrivateCertificateConfigurationActionRevokePrototype.Constants.ActionType | string;
|
|
@@ -3941,7 +4228,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3941
4228
|
}
|
|
3942
4229
|
}
|
|
3943
4230
|
}
|
|
3944
|
-
/**
|
|
4231
|
+
/**
|
|
4232
|
+
* The response body of the action to rotate the CRL of an intermediate certificate authority for the private
|
|
4233
|
+
* certificate configuration.
|
|
4234
|
+
*/
|
|
3945
4235
|
interface PrivateCertificateConfigurationActionRotateCRL extends ConfigurationAction {
|
|
3946
4236
|
/** The type of configuration action. */
|
|
3947
4237
|
action_type: PrivateCertificateConfigurationActionRotateCRL.Constants.ActionType | string;
|
|
@@ -3962,7 +4252,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3962
4252
|
}
|
|
3963
4253
|
}
|
|
3964
4254
|
}
|
|
3965
|
-
/**
|
|
4255
|
+
/**
|
|
4256
|
+
* The request body of the action to rotate the CRL of an intermediate certificate authority for the private
|
|
4257
|
+
* certificate configuration.
|
|
4258
|
+
*/
|
|
3966
4259
|
interface PrivateCertificateConfigurationActionRotateCRLPrototype extends ConfigurationActionPrototype {
|
|
3967
4260
|
/** The type of configuration action. */
|
|
3968
4261
|
action_type: PrivateCertificateConfigurationActionRotateCRLPrototype.Constants.ActionType | string;
|
|
@@ -3979,7 +4272,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3979
4272
|
}
|
|
3980
4273
|
}
|
|
3981
4274
|
}
|
|
3982
|
-
/**
|
|
4275
|
+
/**
|
|
4276
|
+
* The response body of the action to set a signed intermediate certificate authority for the private certificate
|
|
4277
|
+
* configuration.
|
|
4278
|
+
*/
|
|
3983
4279
|
interface PrivateCertificateConfigurationActionSetSigned extends ConfigurationAction {
|
|
3984
4280
|
/** The type of configuration action. */
|
|
3985
4281
|
action_type: PrivateCertificateConfigurationActionSetSigned.Constants.ActionType | string;
|
|
@@ -3998,7 +4294,10 @@ declare namespace SecretsManagerV2 {
|
|
|
3998
4294
|
}
|
|
3999
4295
|
}
|
|
4000
4296
|
}
|
|
4001
|
-
/**
|
|
4297
|
+
/**
|
|
4298
|
+
* The request body of the action to set a signed intermediate certificate authority for the private certificate
|
|
4299
|
+
* consideration.
|
|
4300
|
+
*/
|
|
4002
4301
|
interface PrivateCertificateConfigurationActionSetSignedPrototype extends ConfigurationActionPrototype {
|
|
4003
4302
|
/** The type of configuration action. */
|
|
4004
4303
|
action_type: PrivateCertificateConfigurationActionSetSignedPrototype.Constants.ActionType | string;
|
|
@@ -4017,7 +4316,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4017
4316
|
}
|
|
4018
4317
|
}
|
|
4019
4318
|
}
|
|
4020
|
-
/**
|
|
4319
|
+
/**
|
|
4320
|
+
* The response body of the action to sign the CSR for the private certificate configuration.
|
|
4321
|
+
*/
|
|
4021
4322
|
interface PrivateCertificateConfigurationActionSignCSR extends ConfigurationAction {
|
|
4022
4323
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
4023
4324
|
common_name?: string;
|
|
@@ -4118,7 +4419,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4118
4419
|
}
|
|
4119
4420
|
}
|
|
4120
4421
|
}
|
|
4121
|
-
/**
|
|
4422
|
+
/**
|
|
4423
|
+
* The request body to specify the properties of the action to sign a CSR for the private certificate configuration.
|
|
4424
|
+
*/
|
|
4122
4425
|
interface PrivateCertificateConfigurationActionSignCSRPrototype extends ConfigurationActionPrototype {
|
|
4123
4426
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
4124
4427
|
common_name?: string;
|
|
@@ -4217,7 +4520,10 @@ declare namespace SecretsManagerV2 {
|
|
|
4217
4520
|
}
|
|
4218
4521
|
}
|
|
4219
4522
|
}
|
|
4220
|
-
/**
|
|
4523
|
+
/**
|
|
4524
|
+
* The response body of the action to sign the intermediate certificate authority for the private certificate
|
|
4525
|
+
* configuration.
|
|
4526
|
+
*/
|
|
4221
4527
|
interface PrivateCertificateConfigurationActionSignIntermediate extends ConfigurationAction {
|
|
4222
4528
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
4223
4529
|
common_name?: string;
|
|
@@ -4316,7 +4622,10 @@ declare namespace SecretsManagerV2 {
|
|
|
4316
4622
|
}
|
|
4317
4623
|
}
|
|
4318
4624
|
}
|
|
4319
|
-
/**
|
|
4625
|
+
/**
|
|
4626
|
+
* The request body to specify the properties of the action to sign an intermediate certificate authority for the
|
|
4627
|
+
* private certificate configuration.
|
|
4628
|
+
*/
|
|
4320
4629
|
interface PrivateCertificateConfigurationActionSignIntermediatePrototype extends ConfigurationActionPrototype {
|
|
4321
4630
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
4322
4631
|
common_name?: string;
|
|
@@ -4415,7 +4724,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4415
4724
|
}
|
|
4416
4725
|
}
|
|
4417
4726
|
}
|
|
4418
|
-
/**
|
|
4727
|
+
/**
|
|
4728
|
+
* The data that is associated with the root certificate authority.
|
|
4729
|
+
*/
|
|
4419
4730
|
interface PrivateCertificateConfigurationCACertificate extends PrivateCertificateCAData {
|
|
4420
4731
|
/** Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters. */
|
|
4421
4732
|
certificate: string;
|
|
@@ -4426,7 +4737,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4426
4737
|
/** The certificate expiration time. */
|
|
4427
4738
|
expiration?: number;
|
|
4428
4739
|
}
|
|
4429
|
-
/**
|
|
4740
|
+
/**
|
|
4741
|
+
* The configuration of the root certificate authority.
|
|
4742
|
+
*/
|
|
4430
4743
|
interface PrivateCertificateConfigurationIntermediateCA extends Configuration {
|
|
4431
4744
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
4432
4745
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -4477,6 +4790,8 @@ declare namespace SecretsManagerV2 {
|
|
|
4477
4790
|
* `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
|
|
4478
4791
|
*/
|
|
4479
4792
|
status?: PrivateCertificateConfigurationIntermediateCA.Constants.Status | string;
|
|
4793
|
+
/** The data that is associated with a cryptographic key. */
|
|
4794
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
4480
4795
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA in seconds. */
|
|
4481
4796
|
max_ttl_seconds?: number;
|
|
4482
4797
|
/** The time until the certificate revocation list (CRL) expires, in seconds. */
|
|
@@ -4540,13 +4855,13 @@ declare namespace SecretsManagerV2 {
|
|
|
4540
4855
|
namespace Constants {
|
|
4541
4856
|
/** 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
4857
|
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
4858
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
4546
|
-
|
|
4859
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
4860
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4547
4861
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
4548
4862
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
4549
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
4863
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
4864
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
4550
4865
|
}
|
|
4551
4866
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
4552
4867
|
enum SecretType {
|
|
@@ -4590,7 +4905,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4590
4905
|
}
|
|
4591
4906
|
}
|
|
4592
4907
|
}
|
|
4593
|
-
/**
|
|
4908
|
+
/**
|
|
4909
|
+
* The data that is associated with the intermediate certificate authority.
|
|
4910
|
+
*/
|
|
4594
4911
|
interface PrivateCertificateConfigurationIntermediateCACSR extends PrivateCertificateCAData {
|
|
4595
4912
|
/** The certificate signing request. */
|
|
4596
4913
|
csr?: string;
|
|
@@ -4612,7 +4929,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4612
4929
|
}
|
|
4613
4930
|
}
|
|
4614
4931
|
}
|
|
4615
|
-
/**
|
|
4932
|
+
/**
|
|
4933
|
+
* The configuration of the metadata properties of the intermediate certificate authority.
|
|
4934
|
+
*/
|
|
4616
4935
|
interface PrivateCertificateConfigurationIntermediateCAMetadata extends ConfigurationMetadata {
|
|
4617
4936
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
4618
4937
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -4663,18 +4982,20 @@ declare namespace SecretsManagerV2 {
|
|
|
4663
4982
|
* `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
|
|
4664
4983
|
*/
|
|
4665
4984
|
status?: PrivateCertificateConfigurationIntermediateCAMetadata.Constants.Status | string;
|
|
4985
|
+
/** The data that is associated with a cryptographic key. */
|
|
4986
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
4666
4987
|
}
|
|
4667
4988
|
namespace PrivateCertificateConfigurationIntermediateCAMetadata {
|
|
4668
4989
|
namespace Constants {
|
|
4669
4990
|
/** 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
4991
|
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
4992
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
4674
|
-
|
|
4993
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
4994
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4675
4995
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
4676
4996
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
4677
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
4997
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
4998
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
4678
4999
|
}
|
|
4679
5000
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
4680
5001
|
enum SecretType {
|
|
@@ -4708,7 +5029,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4708
5029
|
}
|
|
4709
5030
|
}
|
|
4710
5031
|
}
|
|
4711
|
-
/**
|
|
5032
|
+
/**
|
|
5033
|
+
* The configuration patch of the intermediate certificate authority.
|
|
5034
|
+
*/
|
|
4712
5035
|
interface PrivateCertificateConfigurationIntermediateCAPatch extends ConfigurationPatch {
|
|
4713
5036
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA.
|
|
4714
5037
|
*
|
|
@@ -4741,7 +5064,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4741
5064
|
*/
|
|
4742
5065
|
issuing_certificates_urls_encoded?: boolean;
|
|
4743
5066
|
}
|
|
4744
|
-
/**
|
|
5067
|
+
/**
|
|
5068
|
+
* The configuration of the intermediate certificate authority.
|
|
5069
|
+
*/
|
|
4745
5070
|
interface PrivateCertificateConfigurationIntermediateCAPrototype extends ConfigurationPrototype {
|
|
4746
5071
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
4747
5072
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -4754,6 +5079,8 @@ declare namespace SecretsManagerV2 {
|
|
|
4754
5079
|
* To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
|
|
4755
5080
|
*/
|
|
4756
5081
|
name: string;
|
|
5082
|
+
/** The data that is associated with a cryptographic key. */
|
|
5083
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
4757
5084
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA.
|
|
4758
5085
|
*
|
|
4759
5086
|
* The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API
|
|
@@ -4854,13 +5181,13 @@ declare namespace SecretsManagerV2 {
|
|
|
4854
5181
|
namespace Constants {
|
|
4855
5182
|
/** 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
5183
|
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
5184
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
4860
|
-
|
|
5185
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5186
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
4861
5187
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
4862
5188
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
4863
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5189
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5190
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
4864
5191
|
}
|
|
4865
5192
|
/** 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
5193
|
enum SigningMethod {
|
|
@@ -4884,7 +5211,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4884
5211
|
}
|
|
4885
5212
|
}
|
|
4886
5213
|
}
|
|
4887
|
-
/**
|
|
5214
|
+
/**
|
|
5215
|
+
* The root certificate authority .
|
|
5216
|
+
*/
|
|
4888
5217
|
interface PrivateCertificateConfigurationRootCA extends Configuration {
|
|
4889
5218
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
4890
5219
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -4927,6 +5256,8 @@ declare namespace SecretsManagerV2 {
|
|
|
4927
5256
|
* `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
|
|
4928
5257
|
*/
|
|
4929
5258
|
status?: PrivateCertificateConfigurationRootCA.Constants.Status | string;
|
|
5259
|
+
/** The data that is associated with a cryptographic key. */
|
|
5260
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
4930
5261
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA in seconds. */
|
|
4931
5262
|
max_ttl_seconds?: number;
|
|
4932
5263
|
/** The time until the certificate revocation list (CRL) expires, in seconds. */
|
|
@@ -5002,13 +5333,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5002
5333
|
namespace Constants {
|
|
5003
5334
|
/** 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
5335
|
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
5336
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5008
|
-
|
|
5337
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5338
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5009
5339
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5010
5340
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5011
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5341
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5342
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5012
5343
|
}
|
|
5013
5344
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
5014
5345
|
enum SecretType {
|
|
@@ -5047,7 +5378,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5047
5378
|
}
|
|
5048
5379
|
}
|
|
5049
5380
|
}
|
|
5050
|
-
/**
|
|
5381
|
+
/**
|
|
5382
|
+
* The configuration of the metadata properties of the root certificate authority.
|
|
5383
|
+
*/
|
|
5051
5384
|
interface PrivateCertificateConfigurationRootCAMetadata extends ConfigurationMetadata {
|
|
5052
5385
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5053
5386
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5090,18 +5423,20 @@ declare namespace SecretsManagerV2 {
|
|
|
5090
5423
|
* `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
|
|
5091
5424
|
*/
|
|
5092
5425
|
status?: PrivateCertificateConfigurationRootCAMetadata.Constants.Status | string;
|
|
5426
|
+
/** The data that is associated with a cryptographic key. */
|
|
5427
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
5093
5428
|
}
|
|
5094
5429
|
namespace PrivateCertificateConfigurationRootCAMetadata {
|
|
5095
5430
|
namespace Constants {
|
|
5096
5431
|
/** 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
5432
|
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
5433
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5101
|
-
|
|
5434
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5435
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5102
5436
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5103
5437
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5104
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5438
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5439
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5105
5440
|
}
|
|
5106
5441
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
5107
5442
|
enum SecretType {
|
|
@@ -5130,7 +5465,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5130
5465
|
}
|
|
5131
5466
|
}
|
|
5132
5467
|
}
|
|
5133
|
-
/**
|
|
5468
|
+
/**
|
|
5469
|
+
* The configuration of the metadata patch for the root certificate authority.
|
|
5470
|
+
*/
|
|
5134
5471
|
interface PrivateCertificateConfigurationRootCAPatch extends ConfigurationPatch {
|
|
5135
5472
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA.
|
|
5136
5473
|
*
|
|
@@ -5163,7 +5500,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5163
5500
|
*/
|
|
5164
5501
|
issuing_certificates_urls_encoded?: boolean;
|
|
5165
5502
|
}
|
|
5166
|
-
/**
|
|
5503
|
+
/**
|
|
5504
|
+
* The configuration of the root certificate authority.
|
|
5505
|
+
*/
|
|
5167
5506
|
interface PrivateCertificateConfigurationRootCAPrototype extends ConfigurationPrototype {
|
|
5168
5507
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5169
5508
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5176,6 +5515,8 @@ declare namespace SecretsManagerV2 {
|
|
|
5176
5515
|
* To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
|
|
5177
5516
|
*/
|
|
5178
5517
|
name: string;
|
|
5518
|
+
/** The data that is associated with a cryptographic key. */
|
|
5519
|
+
crypto_key?: PrivateCertificateCryptoKey;
|
|
5179
5520
|
/** The maximum time-to-live (TTL) for certificates that are created by this CA.
|
|
5180
5521
|
*
|
|
5181
5522
|
* The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API
|
|
@@ -5285,13 +5626,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5285
5626
|
namespace Constants {
|
|
5286
5627
|
/** 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
5628
|
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
5629
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5291
|
-
|
|
5630
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5631
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5292
5632
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5293
5633
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5294
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5634
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5635
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5295
5636
|
}
|
|
5296
5637
|
/** The format of the returned data. */
|
|
5297
5638
|
enum Format {
|
|
@@ -5310,7 +5651,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5310
5651
|
}
|
|
5311
5652
|
}
|
|
5312
5653
|
}
|
|
5313
|
-
/**
|
|
5654
|
+
/**
|
|
5655
|
+
* The configuration of the private certificate template.
|
|
5656
|
+
*/
|
|
5314
5657
|
interface PrivateCertificateConfigurationTemplate extends Configuration {
|
|
5315
5658
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5316
5659
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5483,13 +5826,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5483
5826
|
namespace Constants {
|
|
5484
5827
|
/** 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
5828
|
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
5829
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5489
|
-
|
|
5830
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5831
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5490
5832
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5491
5833
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5492
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5834
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5835
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5493
5836
|
}
|
|
5494
5837
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
5495
5838
|
enum SecretType {
|
|
@@ -5509,7 +5852,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5509
5852
|
}
|
|
5510
5853
|
}
|
|
5511
5854
|
}
|
|
5512
|
-
/**
|
|
5855
|
+
/**
|
|
5856
|
+
* The metadata properties of the configuration of the private certificate template.
|
|
5857
|
+
*/
|
|
5513
5858
|
interface PrivateCertificateConfigurationTemplateMetadata extends ConfigurationMetadata {
|
|
5514
5859
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5515
5860
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5536,13 +5881,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5536
5881
|
namespace Constants {
|
|
5537
5882
|
/** 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
5883
|
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
5884
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5542
|
-
|
|
5885
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
5886
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5543
5887
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5544
5888
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5545
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
5889
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
5890
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5546
5891
|
}
|
|
5547
5892
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
5548
5893
|
enum SecretType {
|
|
@@ -5557,7 +5902,11 @@ declare namespace SecretsManagerV2 {
|
|
|
5557
5902
|
}
|
|
5558
5903
|
}
|
|
5559
5904
|
}
|
|
5560
|
-
/**
|
|
5905
|
+
/**
|
|
5906
|
+
* Properties that describe a certificate template. You can use a certificate template to control the parameters that
|
|
5907
|
+
* are applied to your issued private certificates. For more information, see the
|
|
5908
|
+
* [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-certificate-templates).
|
|
5909
|
+
*/
|
|
5561
5910
|
interface PrivateCertificateConfigurationTemplatePatch extends ConfigurationPatch {
|
|
5562
5911
|
/** This field scopes the creation of private certificates to only the secret groups that you specify.
|
|
5563
5912
|
*
|
|
@@ -5730,7 +6079,11 @@ declare namespace SecretsManagerV2 {
|
|
|
5730
6079
|
}
|
|
5731
6080
|
}
|
|
5732
6081
|
}
|
|
5733
|
-
/**
|
|
6082
|
+
/**
|
|
6083
|
+
* Properties that describe a certificate template. You can use a certificate template to control the parameters that
|
|
6084
|
+
* are applied to your issued private certificates. For more information, see the
|
|
6085
|
+
* [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-certificate-templates).
|
|
6086
|
+
*/
|
|
5734
6087
|
interface PrivateCertificateConfigurationTemplatePrototype extends ConfigurationPrototype {
|
|
5735
6088
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
5736
6089
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -5917,13 +6270,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5917
6270
|
namespace Constants {
|
|
5918
6271
|
/** 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
6272
|
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
6273
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
5923
|
-
|
|
6274
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6275
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
5924
6276
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
5925
6277
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
5926
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
6278
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
6279
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
5927
6280
|
}
|
|
5928
6281
|
/** The type of private key to generate. */
|
|
5929
6282
|
enum KeyType {
|
|
@@ -5932,7 +6285,30 @@ declare namespace SecretsManagerV2 {
|
|
|
5932
6285
|
}
|
|
5933
6286
|
}
|
|
5934
6287
|
}
|
|
5935
|
-
/**
|
|
6288
|
+
/**
|
|
6289
|
+
* The data that is associated with Hyper Protect Crypto Services as the cryptographic provider.
|
|
6290
|
+
*/
|
|
6291
|
+
interface PrivateCertificateCryptoProviderHPCS extends PrivateCertificateCryptoProvider {
|
|
6292
|
+
/** The type of cryptographic provider. */
|
|
6293
|
+
type: PrivateCertificateCryptoProviderHPCS.Constants.Type | string;
|
|
6294
|
+
/** The HPCS instance CRN. */
|
|
6295
|
+
instance_crn: string;
|
|
6296
|
+
/** The secret Id of iam credentials with api key to access HPCS instance. */
|
|
6297
|
+
pin_iam_credentials_secret_id: string;
|
|
6298
|
+
/** The HPCS private key store space id. */
|
|
6299
|
+
private_keystore_id: string;
|
|
6300
|
+
}
|
|
6301
|
+
namespace PrivateCertificateCryptoProviderHPCS {
|
|
6302
|
+
namespace Constants {
|
|
6303
|
+
/** The type of cryptographic provider. */
|
|
6304
|
+
enum Type {
|
|
6305
|
+
HYPER_PROTECT_CRYPTO_SERVICES = "hyper_protect_crypto_services"
|
|
6306
|
+
}
|
|
6307
|
+
}
|
|
6308
|
+
}
|
|
6309
|
+
/**
|
|
6310
|
+
* Properties of the metadata of your private certificate.
|
|
6311
|
+
*/
|
|
5936
6312
|
interface PrivateCertificateMetadata extends SecretMetadata {
|
|
5937
6313
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
5938
6314
|
created_by: string;
|
|
@@ -5981,6 +6357,8 @@ declare namespace SecretsManagerV2 {
|
|
|
5981
6357
|
updated_at: string;
|
|
5982
6358
|
/** The number of versions of your secret. */
|
|
5983
6359
|
versions_total: number;
|
|
6360
|
+
/** The list of configurations that have a reference to the secret. */
|
|
6361
|
+
referenced_by?: string[];
|
|
5984
6362
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
5985
6363
|
* certificate.
|
|
5986
6364
|
*/
|
|
@@ -6047,7 +6425,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6047
6425
|
}
|
|
6048
6426
|
}
|
|
6049
6427
|
}
|
|
6050
|
-
/**
|
|
6428
|
+
/**
|
|
6429
|
+
* PrivateCertificateMetadataPatch.
|
|
6430
|
+
*/
|
|
6051
6431
|
interface PrivateCertificateMetadataPatch extends SecretMetadataPatch {
|
|
6052
6432
|
/** A human-readable name to assign to your secret.
|
|
6053
6433
|
*
|
|
@@ -6074,7 +6454,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6074
6454
|
*/
|
|
6075
6455
|
rotation?: RotationPolicy;
|
|
6076
6456
|
}
|
|
6077
|
-
/**
|
|
6457
|
+
/**
|
|
6458
|
+
* PrivateCertificatePrototype.
|
|
6459
|
+
*/
|
|
6078
6460
|
interface PrivateCertificatePrototype extends SecretPrototype {
|
|
6079
6461
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
6080
6462
|
* service_credentials, kv, and username_password.
|
|
@@ -6172,7 +6554,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6172
6554
|
}
|
|
6173
6555
|
}
|
|
6174
6556
|
}
|
|
6175
|
-
/**
|
|
6557
|
+
/**
|
|
6558
|
+
* Your private certificate version.
|
|
6559
|
+
*/
|
|
6176
6560
|
interface PrivateCertificateVersion extends SecretVersion {
|
|
6177
6561
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
6178
6562
|
auto_rotated?: boolean;
|
|
@@ -6207,7 +6591,7 @@ declare namespace SecretsManagerV2 {
|
|
|
6207
6591
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
6208
6592
|
* types: Arbitrary, username_password.
|
|
6209
6593
|
*/
|
|
6210
|
-
expiration_date
|
|
6594
|
+
expiration_date?: string;
|
|
6211
6595
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
6212
6596
|
serial_number: string;
|
|
6213
6597
|
/** The date and time that the certificate validity period begins and ends. */
|
|
@@ -6243,7 +6627,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6243
6627
|
}
|
|
6244
6628
|
}
|
|
6245
6629
|
}
|
|
6246
|
-
/**
|
|
6630
|
+
/**
|
|
6631
|
+
* The response body to specify the properties of the action to revoke the private certificate.
|
|
6632
|
+
*/
|
|
6247
6633
|
interface PrivateCertificateVersionActionRevoke extends VersionAction {
|
|
6248
6634
|
/** The type of secret version action. */
|
|
6249
6635
|
action_type: PrivateCertificateVersionActionRevoke.Constants.ActionType | string;
|
|
@@ -6258,7 +6644,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6258
6644
|
}
|
|
6259
6645
|
}
|
|
6260
6646
|
}
|
|
6261
|
-
/**
|
|
6647
|
+
/**
|
|
6648
|
+
* The request body to specify the properties of the action to revoke the private certificate.
|
|
6649
|
+
*/
|
|
6262
6650
|
interface PrivateCertificateVersionActionRevokePrototype extends SecretVersionActionPrototype {
|
|
6263
6651
|
/** The type of secret version action. */
|
|
6264
6652
|
action_type: PrivateCertificateVersionActionRevokePrototype.Constants.ActionType | string;
|
|
@@ -6271,7 +6659,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6271
6659
|
}
|
|
6272
6660
|
}
|
|
6273
6661
|
}
|
|
6274
|
-
/**
|
|
6662
|
+
/**
|
|
6663
|
+
* Properties of the version metadata of your private certificate.
|
|
6664
|
+
*/
|
|
6275
6665
|
interface PrivateCertificateVersionMetadata extends SecretVersionMetadata {
|
|
6276
6666
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
6277
6667
|
auto_rotated?: boolean;
|
|
@@ -6306,7 +6696,7 @@ declare namespace SecretsManagerV2 {
|
|
|
6306
6696
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
6307
6697
|
* types: Arbitrary, username_password.
|
|
6308
6698
|
*/
|
|
6309
|
-
expiration_date
|
|
6699
|
+
expiration_date?: string;
|
|
6310
6700
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
6311
6701
|
serial_number: string;
|
|
6312
6702
|
/** The date and time that the certificate validity period begins and ends. */
|
|
@@ -6332,7 +6722,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6332
6722
|
}
|
|
6333
6723
|
}
|
|
6334
6724
|
}
|
|
6335
|
-
/**
|
|
6725
|
+
/**
|
|
6726
|
+
* PrivateCertificateVersionPrototype.
|
|
6727
|
+
*/
|
|
6336
6728
|
interface PrivateCertificateVersionPrototype extends SecretVersionPrototype {
|
|
6337
6729
|
/** The secret metadata that a user can customize. */
|
|
6338
6730
|
custom_metadata?: JsonObject;
|
|
@@ -6341,7 +6733,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6341
6733
|
/** The certificate signing request. */
|
|
6342
6734
|
csr?: string;
|
|
6343
6735
|
}
|
|
6344
|
-
/**
|
|
6736
|
+
/**
|
|
6737
|
+
* Your public certificate.
|
|
6738
|
+
*/
|
|
6345
6739
|
interface PublicCertificate extends Secret {
|
|
6346
6740
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
6347
6741
|
created_by: string;
|
|
@@ -6390,6 +6784,8 @@ declare namespace SecretsManagerV2 {
|
|
|
6390
6784
|
updated_at: string;
|
|
6391
6785
|
/** The number of versions of your secret. */
|
|
6392
6786
|
versions_total: number;
|
|
6787
|
+
/** The list of configurations that have a reference to the secret. */
|
|
6788
|
+
referenced_by?: string[];
|
|
6393
6789
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
6394
6790
|
* certificate.
|
|
6395
6791
|
*/
|
|
@@ -6464,7 +6860,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6464
6860
|
}
|
|
6465
6861
|
}
|
|
6466
6862
|
}
|
|
6467
|
-
/**
|
|
6863
|
+
/**
|
|
6864
|
+
* The response body of the action to validate manual DNS challenges for the public certificate.
|
|
6865
|
+
*/
|
|
6468
6866
|
interface PublicCertificateActionValidateManualDNS extends SecretAction {
|
|
6469
6867
|
/** The type of secret action. */
|
|
6470
6868
|
action_type: PublicCertificateActionValidateManualDNS.Constants.ActionType | string;
|
|
@@ -6478,7 +6876,10 @@ declare namespace SecretsManagerV2 {
|
|
|
6478
6876
|
}
|
|
6479
6877
|
}
|
|
6480
6878
|
}
|
|
6481
|
-
/**
|
|
6879
|
+
/**
|
|
6880
|
+
* The request body to specify the properties of the action to validate manual DNS challenges for the public
|
|
6881
|
+
* certificate.
|
|
6882
|
+
*/
|
|
6482
6883
|
interface PublicCertificateActionValidateManualDNSPrototype extends SecretActionPrototype {
|
|
6483
6884
|
/** The type of secret action. */
|
|
6484
6885
|
action_type: PublicCertificateActionValidateManualDNSPrototype.Constants.ActionType | string;
|
|
@@ -6492,7 +6893,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6492
6893
|
}
|
|
6493
6894
|
}
|
|
6494
6895
|
}
|
|
6495
|
-
/**
|
|
6896
|
+
/**
|
|
6897
|
+
* Properties that describe a Let's Encrypt CA configuration.
|
|
6898
|
+
*/
|
|
6496
6899
|
interface PublicCertificateConfigurationCALetsEncrypt extends Configuration {
|
|
6497
6900
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6498
6901
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6527,13 +6930,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6527
6930
|
namespace Constants {
|
|
6528
6931
|
/** 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
6932
|
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
6933
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6533
|
-
|
|
6934
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6935
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6534
6936
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6535
6937
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6536
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
6938
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
6939
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6537
6940
|
}
|
|
6538
6941
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6539
6942
|
enum SecretType {
|
|
@@ -6553,7 +6956,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6553
6956
|
}
|
|
6554
6957
|
}
|
|
6555
6958
|
}
|
|
6556
|
-
/**
|
|
6959
|
+
/**
|
|
6960
|
+
* Your Let's Encrypt CA metadata properties.
|
|
6961
|
+
*/
|
|
6557
6962
|
interface PublicCertificateConfigurationCALetsEncryptMetadata extends ConfigurationMetadata {
|
|
6558
6963
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6559
6964
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6584,13 +6989,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6584
6989
|
namespace Constants {
|
|
6585
6990
|
/** 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
6991
|
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
6992
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6590
|
-
|
|
6993
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
6994
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6591
6995
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6592
6996
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6593
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
6997
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
6998
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6594
6999
|
}
|
|
6595
7000
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6596
7001
|
enum SecretType {
|
|
@@ -6610,7 +7015,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6610
7015
|
}
|
|
6611
7016
|
}
|
|
6612
7017
|
}
|
|
6613
|
-
/**
|
|
7018
|
+
/**
|
|
7019
|
+
* The configuration update of the Let's Encrypt Certificate Authority.
|
|
7020
|
+
*/
|
|
6614
7021
|
interface PublicCertificateConfigurationCALetsEncryptPatch extends ConfigurationPatch {
|
|
6615
7022
|
/** The configuration of the Let's Encrypt CA environment. */
|
|
6616
7023
|
lets_encrypt_environment: PublicCertificateConfigurationCALetsEncryptPatch.Constants.LetsEncryptEnvironment | string;
|
|
@@ -6632,7 +7039,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6632
7039
|
}
|
|
6633
7040
|
}
|
|
6634
7041
|
}
|
|
6635
|
-
/**
|
|
7042
|
+
/**
|
|
7043
|
+
* The properties of the Let's Encrypt CA configuration.
|
|
7044
|
+
*/
|
|
6636
7045
|
interface PublicCertificateConfigurationCALetsEncryptPrototype extends ConfigurationPrototype {
|
|
6637
7046
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6638
7047
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6660,13 +7069,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6660
7069
|
namespace Constants {
|
|
6661
7070
|
/** 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
7071
|
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
7072
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6666
|
-
|
|
7073
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7074
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6667
7075
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6668
7076
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6669
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7077
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7078
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6670
7079
|
}
|
|
6671
7080
|
/** The configuration of the Let's Encrypt CA environment. */
|
|
6672
7081
|
enum LetsEncryptEnvironment {
|
|
@@ -6675,7 +7084,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6675
7084
|
}
|
|
6676
7085
|
}
|
|
6677
7086
|
}
|
|
6678
|
-
/**
|
|
7087
|
+
/**
|
|
7088
|
+
* Properties that describe a Classic Infrastructure DNS configuration.
|
|
7089
|
+
*/
|
|
6679
7090
|
interface PublicCertificateConfigurationDNSClassicInfrastructure extends Configuration {
|
|
6680
7091
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6681
7092
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6712,13 +7123,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6712
7123
|
namespace Constants {
|
|
6713
7124
|
/** 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
7125
|
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
7126
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6718
|
-
|
|
7127
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7128
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6719
7129
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6720
7130
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6721
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7131
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7132
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6722
7133
|
}
|
|
6723
7134
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6724
7135
|
enum SecretType {
|
|
@@ -6733,7 +7144,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6733
7144
|
}
|
|
6734
7145
|
}
|
|
6735
7146
|
}
|
|
6736
|
-
/**
|
|
7147
|
+
/**
|
|
7148
|
+
* Your Classic Infrastructure DNS metadata properties.
|
|
7149
|
+
*/
|
|
6737
7150
|
interface PublicCertificateConfigurationDNSClassicInfrastructureMetadata extends ConfigurationMetadata {
|
|
6738
7151
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6739
7152
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6758,13 +7171,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6758
7171
|
namespace Constants {
|
|
6759
7172
|
/** 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
7173
|
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
7174
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6764
|
-
|
|
7175
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7176
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6765
7177
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6766
7178
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6767
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7179
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7180
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6768
7181
|
}
|
|
6769
7182
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6770
7183
|
enum SecretType {
|
|
@@ -6779,7 +7192,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6779
7192
|
}
|
|
6780
7193
|
}
|
|
6781
7194
|
}
|
|
6782
|
-
/**
|
|
7195
|
+
/**
|
|
7196
|
+
* Properties that describe the configuration update of an IBM Cloud classic infrastructure (SoftLayer).
|
|
7197
|
+
*/
|
|
6783
7198
|
interface PublicCertificateConfigurationDNSClassicInfrastructurePatch extends ConfigurationPatch {
|
|
6784
7199
|
/** The username that is associated with your classic infrastructure account.
|
|
6785
7200
|
*
|
|
@@ -6794,7 +7209,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6794
7209
|
*/
|
|
6795
7210
|
classic_infrastructure_password?: string;
|
|
6796
7211
|
}
|
|
6797
|
-
/**
|
|
7212
|
+
/**
|
|
7213
|
+
* PublicCertificateConfigurationDNSClassicInfrastructurePrototype.
|
|
7214
|
+
*/
|
|
6798
7215
|
interface PublicCertificateConfigurationDNSClassicInfrastructurePrototype extends ConfigurationPrototype {
|
|
6799
7216
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6800
7217
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6824,17 +7241,19 @@ declare namespace SecretsManagerV2 {
|
|
|
6824
7241
|
namespace Constants {
|
|
6825
7242
|
/** 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
7243
|
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
7244
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6830
|
-
|
|
7245
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7246
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6831
7247
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6832
7248
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6833
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7249
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7250
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6834
7251
|
}
|
|
6835
7252
|
}
|
|
6836
7253
|
}
|
|
6837
|
-
/**
|
|
7254
|
+
/**
|
|
7255
|
+
* Properties that describe a Cloud Internet Services DNS configuration.
|
|
7256
|
+
*/
|
|
6838
7257
|
interface PublicCertificateConfigurationDNSCloudInternetServices extends Configuration {
|
|
6839
7258
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6840
7259
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6879,13 +7298,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6879
7298
|
namespace Constants {
|
|
6880
7299
|
/** 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
7300
|
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
7301
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6885
|
-
|
|
7302
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7303
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6886
7304
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6887
7305
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6888
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7306
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7307
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6889
7308
|
}
|
|
6890
7309
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6891
7310
|
enum SecretType {
|
|
@@ -6900,7 +7319,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6900
7319
|
}
|
|
6901
7320
|
}
|
|
6902
7321
|
}
|
|
6903
|
-
/**
|
|
7322
|
+
/**
|
|
7323
|
+
* Your Cloud Internet Services DNS metadata properties.
|
|
7324
|
+
*/
|
|
6904
7325
|
interface PublicCertificateConfigurationDNSCloudInternetServicesMetadata extends ConfigurationMetadata {
|
|
6905
7326
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6906
7327
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -6925,13 +7346,13 @@ declare namespace SecretsManagerV2 {
|
|
|
6925
7346
|
namespace Constants {
|
|
6926
7347
|
/** 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
7348
|
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
7349
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
6931
|
-
|
|
7350
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7351
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
6932
7352
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
6933
7353
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
6934
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7354
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7355
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
6935
7356
|
}
|
|
6936
7357
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password. */
|
|
6937
7358
|
enum SecretType {
|
|
@@ -6946,7 +7367,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6946
7367
|
}
|
|
6947
7368
|
}
|
|
6948
7369
|
}
|
|
6949
|
-
/**
|
|
7370
|
+
/**
|
|
7371
|
+
* The configuration update of the Cloud Internet Services DNS.
|
|
7372
|
+
*/
|
|
6950
7373
|
interface PublicCertificateConfigurationDNSCloudInternetServicesPatch extends ConfigurationPatch {
|
|
6951
7374
|
/** An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.
|
|
6952
7375
|
*
|
|
@@ -6969,7 +7392,9 @@ declare namespace SecretsManagerV2 {
|
|
|
6969
7392
|
/** A CRN that uniquely identifies an IBM Cloud resource. */
|
|
6970
7393
|
cloud_internet_services_crn?: string;
|
|
6971
7394
|
}
|
|
6972
|
-
/**
|
|
7395
|
+
/**
|
|
7396
|
+
* Specify the properties for Cloud Internet Services DNS configuration.
|
|
7397
|
+
*/
|
|
6973
7398
|
interface PublicCertificateConfigurationDNSCloudInternetServicesPrototype extends ConfigurationPrototype {
|
|
6974
7399
|
/** The configuration type. Can be one of: iam_credentials_configuration,
|
|
6975
7400
|
* public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure,
|
|
@@ -7007,17 +7432,19 @@ declare namespace SecretsManagerV2 {
|
|
|
7007
7432
|
namespace Constants {
|
|
7008
7433
|
/** 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
7434
|
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
7435
|
PUBLIC_CERT_CONFIGURATION_DNS_CLOUD_INTERNET_SERVICES = "public_cert_configuration_dns_cloud_internet_services",
|
|
7013
|
-
|
|
7436
|
+
PUBLIC_CERT_CONFIGURATION_DNS_CLASSIC_INFRASTRUCTURE = "public_cert_configuration_dns_classic_infrastructure",
|
|
7437
|
+
PUBLIC_CERT_CONFIGURATION_CA_LETS_ENCRYPT = "public_cert_configuration_ca_lets_encrypt",
|
|
7014
7438
|
PRIVATE_CERT_CONFIGURATION_ROOT_CA = "private_cert_configuration_root_ca",
|
|
7015
7439
|
PRIVATE_CERT_CONFIGURATION_INTERMEDIATE_CA = "private_cert_configuration_intermediate_ca",
|
|
7016
|
-
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template"
|
|
7440
|
+
PRIVATE_CERT_CONFIGURATION_TEMPLATE = "private_cert_configuration_template",
|
|
7441
|
+
IAM_CREDENTIALS_CONFIGURATION = "iam_credentials_configuration"
|
|
7017
7442
|
}
|
|
7018
7443
|
}
|
|
7019
7444
|
}
|
|
7020
|
-
/**
|
|
7445
|
+
/**
|
|
7446
|
+
* Properties of the metadata of your public certificate.
|
|
7447
|
+
*/
|
|
7021
7448
|
interface PublicCertificateMetadata extends SecretMetadata {
|
|
7022
7449
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7023
7450
|
created_by: string;
|
|
@@ -7066,6 +7493,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7066
7493
|
updated_at: string;
|
|
7067
7494
|
/** The number of versions of your secret. */
|
|
7068
7495
|
versions_total: number;
|
|
7496
|
+
/** The list of configurations that have a reference to the secret. */
|
|
7497
|
+
referenced_by?: string[];
|
|
7069
7498
|
/** The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
|
|
7070
7499
|
* certificate.
|
|
7071
7500
|
*/
|
|
@@ -7130,7 +7559,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7130
7559
|
}
|
|
7131
7560
|
}
|
|
7132
7561
|
}
|
|
7133
|
-
/**
|
|
7562
|
+
/**
|
|
7563
|
+
* PublicCertificateMetadataPatch.
|
|
7564
|
+
*/
|
|
7134
7565
|
interface PublicCertificateMetadataPatch extends SecretMetadataPatch {
|
|
7135
7566
|
/** A human-readable name to assign to your secret.
|
|
7136
7567
|
*
|
|
@@ -7157,7 +7588,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7157
7588
|
*/
|
|
7158
7589
|
rotation?: RotationPolicy;
|
|
7159
7590
|
}
|
|
7160
|
-
/**
|
|
7591
|
+
/**
|
|
7592
|
+
* PublicCertificatePrototype.
|
|
7593
|
+
*/
|
|
7161
7594
|
interface PublicCertificatePrototype extends SecretPrototype {
|
|
7162
7595
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
7163
7596
|
* service_credentials, kv, and username_password.
|
|
@@ -7229,7 +7662,12 @@ declare namespace SecretsManagerV2 {
|
|
|
7229
7662
|
}
|
|
7230
7663
|
}
|
|
7231
7664
|
}
|
|
7232
|
-
/**
|
|
7665
|
+
/**
|
|
7666
|
+
* This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
7667
|
+
*
|
|
7668
|
+
* For public certificates, if `auto_rotate` is set to `true`, the service reorders your certificate for 31 days,
|
|
7669
|
+
* before it expires.
|
|
7670
|
+
*/
|
|
7233
7671
|
interface PublicCertificateRotationPolicy extends RotationPolicy {
|
|
7234
7672
|
/** This field indicates whether Secrets Manager rotates your secret automatically.
|
|
7235
7673
|
*
|
|
@@ -7245,7 +7683,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7245
7683
|
*/
|
|
7246
7684
|
rotate_keys: boolean;
|
|
7247
7685
|
}
|
|
7248
|
-
/**
|
|
7686
|
+
/**
|
|
7687
|
+
* Versions of your public certificate.
|
|
7688
|
+
*/
|
|
7249
7689
|
interface PublicCertificateVersion extends SecretVersion {
|
|
7250
7690
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
7251
7691
|
auto_rotated?: boolean;
|
|
@@ -7316,7 +7756,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7316
7756
|
}
|
|
7317
7757
|
}
|
|
7318
7758
|
}
|
|
7319
|
-
/**
|
|
7759
|
+
/**
|
|
7760
|
+
* Properties of the version metadata of your public certificate.
|
|
7761
|
+
*/
|
|
7320
7762
|
interface PublicCertificateVersionMetadata extends SecretVersionMetadata {
|
|
7321
7763
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
7322
7764
|
auto_rotated?: boolean;
|
|
@@ -7377,7 +7819,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7377
7819
|
}
|
|
7378
7820
|
}
|
|
7379
7821
|
}
|
|
7380
|
-
/**
|
|
7822
|
+
/**
|
|
7823
|
+
* PublicCertificateVersionPrototype.
|
|
7824
|
+
*/
|
|
7381
7825
|
interface PublicCertificateVersionPrototype extends SecretVersionPrototype {
|
|
7382
7826
|
/** Defines the rotation object that is used to manually rotate public certificates. */
|
|
7383
7827
|
rotation: PublicCertificateRotationObject;
|
|
@@ -7386,7 +7830,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7386
7830
|
/** The secret version metadata that a user can customize. */
|
|
7387
7831
|
version_custom_metadata?: JsonObject;
|
|
7388
7832
|
}
|
|
7389
|
-
/**
|
|
7833
|
+
/**
|
|
7834
|
+
* Your service credentials secret.
|
|
7835
|
+
*/
|
|
7390
7836
|
interface ServiceCredentialsSecret extends Secret {
|
|
7391
7837
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7392
7838
|
created_by: string;
|
|
@@ -7435,6 +7881,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7435
7881
|
updated_at: string;
|
|
7436
7882
|
/** The number of versions of your secret. */
|
|
7437
7883
|
versions_total: number;
|
|
7884
|
+
/** The list of configurations that have a reference to the secret. */
|
|
7885
|
+
referenced_by?: string[];
|
|
7438
7886
|
/** The date that the secret is scheduled for automatic rotation.
|
|
7439
7887
|
*
|
|
7440
7888
|
* The service automatically creates a new version of the secret on its next rotation date. This field exists only
|
|
@@ -7451,6 +7899,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7451
7899
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
7452
7900
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
7453
7901
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
7902
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
7454
7903
|
*/
|
|
7455
7904
|
ttl?: string;
|
|
7456
7905
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
@@ -7485,7 +7934,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7485
7934
|
}
|
|
7486
7935
|
}
|
|
7487
7936
|
}
|
|
7488
|
-
/**
|
|
7937
|
+
/**
|
|
7938
|
+
* The metadata properties for your service credentials secret.
|
|
7939
|
+
*/
|
|
7489
7940
|
interface ServiceCredentialsSecretMetadata extends SecretMetadata {
|
|
7490
7941
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7491
7942
|
created_by: string;
|
|
@@ -7534,6 +7985,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7534
7985
|
updated_at: string;
|
|
7535
7986
|
/** The number of versions of your secret. */
|
|
7536
7987
|
versions_total: number;
|
|
7988
|
+
/** The list of configurations that have a reference to the secret. */
|
|
7989
|
+
referenced_by?: string[];
|
|
7537
7990
|
/** The date that the secret is scheduled for automatic rotation.
|
|
7538
7991
|
*
|
|
7539
7992
|
* The service automatically creates a new version of the secret on its next rotation date. This field exists only
|
|
@@ -7550,6 +8003,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7550
8003
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
7551
8004
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
7552
8005
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
8006
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
7553
8007
|
*/
|
|
7554
8008
|
ttl?: string;
|
|
7555
8009
|
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
@@ -7582,7 +8036,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7582
8036
|
}
|
|
7583
8037
|
}
|
|
7584
8038
|
}
|
|
7585
|
-
/**
|
|
8039
|
+
/**
|
|
8040
|
+
* ServiceCredentialsSecretMetadataPatch.
|
|
8041
|
+
*/
|
|
7586
8042
|
interface ServiceCredentialsSecretMetadataPatch extends SecretMetadataPatch {
|
|
7587
8043
|
/** The secret metadata that a user can customize. */
|
|
7588
8044
|
custom_metadata?: JsonObject;
|
|
@@ -7614,10 +8070,13 @@ declare namespace SecretsManagerV2 {
|
|
|
7614
8070
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
7615
8071
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
7616
8072
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
8073
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
7617
8074
|
*/
|
|
7618
8075
|
ttl?: string;
|
|
7619
8076
|
}
|
|
7620
|
-
/**
|
|
8077
|
+
/**
|
|
8078
|
+
* ServiceCredentialsSecretPrototype.
|
|
8079
|
+
*/
|
|
7621
8080
|
interface ServiceCredentialsSecretPrototype extends SecretPrototype {
|
|
7622
8081
|
/** The secret metadata that a user can customize. */
|
|
7623
8082
|
custom_metadata?: JsonObject;
|
|
@@ -7659,6 +8118,7 @@ declare namespace SecretsManagerV2 {
|
|
|
7659
8118
|
* duration, such as `1440m` or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum
|
|
7660
8119
|
* duration is 1 minute. The maximum is 90 days. For the service_credentials secret type, the TTL field is
|
|
7661
8120
|
* optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
|
|
8121
|
+
* After the TTL is modified, it will be applied only on the next secret rotation.
|
|
7662
8122
|
*/
|
|
7663
8123
|
ttl?: string;
|
|
7664
8124
|
/** The secret version metadata that a user can customize. */
|
|
@@ -7679,7 +8139,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7679
8139
|
}
|
|
7680
8140
|
}
|
|
7681
8141
|
}
|
|
7682
|
-
/**
|
|
8142
|
+
/**
|
|
8143
|
+
* Your service credentials secret version.
|
|
8144
|
+
*/
|
|
7683
8145
|
interface ServiceCredentialsSecretVersion extends SecretVersion {
|
|
7684
8146
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
7685
8147
|
auto_rotated?: boolean;
|
|
@@ -7740,7 +8202,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7740
8202
|
}
|
|
7741
8203
|
}
|
|
7742
8204
|
}
|
|
7743
|
-
/**
|
|
8205
|
+
/**
|
|
8206
|
+
* The version metadata properties for your service credentials secret.
|
|
8207
|
+
*/
|
|
7744
8208
|
interface ServiceCredentialsSecretVersionMetadata extends SecretVersionMetadata {
|
|
7745
8209
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
7746
8210
|
auto_rotated?: boolean;
|
|
@@ -7799,14 +8263,18 @@ declare namespace SecretsManagerV2 {
|
|
|
7799
8263
|
}
|
|
7800
8264
|
}
|
|
7801
8265
|
}
|
|
7802
|
-
/**
|
|
8266
|
+
/**
|
|
8267
|
+
* ServiceCredentialsSecretVersionPrototype.
|
|
8268
|
+
*/
|
|
7803
8269
|
interface ServiceCredentialsSecretVersionPrototype extends SecretVersionPrototype {
|
|
7804
8270
|
/** The secret metadata that a user can customize. */
|
|
7805
8271
|
custom_metadata?: JsonObject;
|
|
7806
8272
|
/** The secret version metadata that a user can customize. */
|
|
7807
8273
|
version_custom_metadata?: JsonObject;
|
|
7808
8274
|
}
|
|
7809
|
-
/**
|
|
8275
|
+
/**
|
|
8276
|
+
* Your user credentials secret.
|
|
8277
|
+
*/
|
|
7810
8278
|
interface UsernamePasswordSecret extends Secret {
|
|
7811
8279
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7812
8280
|
created_by: string;
|
|
@@ -7855,6 +8323,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7855
8323
|
updated_at: string;
|
|
7856
8324
|
/** The number of versions of your secret. */
|
|
7857
8325
|
versions_total: number;
|
|
8326
|
+
/** The list of configurations that have a reference to the secret. */
|
|
8327
|
+
referenced_by?: string[];
|
|
7858
8328
|
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
7859
8329
|
* username_password, private_cert, public_cert, iam_credentials.
|
|
7860
8330
|
*/
|
|
@@ -7899,7 +8369,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7899
8369
|
}
|
|
7900
8370
|
}
|
|
7901
8371
|
}
|
|
7902
|
-
/**
|
|
8372
|
+
/**
|
|
8373
|
+
* Properties of the metadata of your user credentials secret.
|
|
8374
|
+
*/
|
|
7903
8375
|
interface UsernamePasswordSecretMetadata extends SecretMetadata {
|
|
7904
8376
|
/** The unique identifier that is associated with the entity that created the secret. */
|
|
7905
8377
|
created_by: string;
|
|
@@ -7948,6 +8420,8 @@ declare namespace SecretsManagerV2 {
|
|
|
7948
8420
|
updated_at: string;
|
|
7949
8421
|
/** The number of versions of your secret. */
|
|
7950
8422
|
versions_total: number;
|
|
8423
|
+
/** The list of configurations that have a reference to the secret. */
|
|
8424
|
+
referenced_by?: string[];
|
|
7951
8425
|
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
7952
8426
|
* username_password, private_cert, public_cert, iam_credentials.
|
|
7953
8427
|
*/
|
|
@@ -7988,7 +8462,9 @@ declare namespace SecretsManagerV2 {
|
|
|
7988
8462
|
}
|
|
7989
8463
|
}
|
|
7990
8464
|
}
|
|
7991
|
-
/**
|
|
8465
|
+
/**
|
|
8466
|
+
* UsernamePasswordSecretMetadataPatch.
|
|
8467
|
+
*/
|
|
7992
8468
|
interface UsernamePasswordSecretMetadataPatch extends SecretMetadataPatch {
|
|
7993
8469
|
/** A human-readable name to assign to your secret.
|
|
7994
8470
|
*
|
|
@@ -8023,7 +8499,9 @@ declare namespace SecretsManagerV2 {
|
|
|
8023
8499
|
*/
|
|
8024
8500
|
password_generation_policy?: PasswordGenerationPolicyPatch;
|
|
8025
8501
|
}
|
|
8026
|
-
/**
|
|
8502
|
+
/**
|
|
8503
|
+
* UsernamePasswordSecretPrototype.
|
|
8504
|
+
*/
|
|
8027
8505
|
interface UsernamePasswordSecretPrototype extends SecretPrototype {
|
|
8028
8506
|
/** The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
|
|
8029
8507
|
* service_credentials, kv, and username_password.
|
|
@@ -8085,7 +8563,9 @@ declare namespace SecretsManagerV2 {
|
|
|
8085
8563
|
}
|
|
8086
8564
|
}
|
|
8087
8565
|
}
|
|
8088
|
-
/**
|
|
8566
|
+
/**
|
|
8567
|
+
* Your user credentials secret version.
|
|
8568
|
+
*/
|
|
8089
8569
|
interface UsernamePasswordSecretVersion extends SecretVersion {
|
|
8090
8570
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
8091
8571
|
auto_rotated?: boolean;
|
|
@@ -8117,6 +8597,10 @@ declare namespace SecretsManagerV2 {
|
|
|
8117
8597
|
version_custom_metadata?: JsonObject;
|
|
8118
8598
|
/** A v4 UUID identifier. */
|
|
8119
8599
|
secret_id: string;
|
|
8600
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
8601
|
+
* types: Arbitrary, username_password.
|
|
8602
|
+
*/
|
|
8603
|
+
expiration_date?: string;
|
|
8120
8604
|
/** The username that is assigned to an `username_password` secret. */
|
|
8121
8605
|
username: string;
|
|
8122
8606
|
/** The password that is assigned to an `username_password` secret. */
|
|
@@ -8142,7 +8626,9 @@ declare namespace SecretsManagerV2 {
|
|
|
8142
8626
|
}
|
|
8143
8627
|
}
|
|
8144
8628
|
}
|
|
8145
|
-
/**
|
|
8629
|
+
/**
|
|
8630
|
+
* Properties of the version metadata of your user credentials secret.
|
|
8631
|
+
*/
|
|
8146
8632
|
interface UsernamePasswordSecretVersionMetadata extends SecretVersionMetadata {
|
|
8147
8633
|
/** Indicates whether the version of the secret was created by automatic rotation. */
|
|
8148
8634
|
auto_rotated?: boolean;
|
|
@@ -8174,6 +8660,10 @@ declare namespace SecretsManagerV2 {
|
|
|
8174
8660
|
version_custom_metadata?: JsonObject;
|
|
8175
8661
|
/** A v4 UUID identifier. */
|
|
8176
8662
|
secret_id: string;
|
|
8663
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
8664
|
+
* types: Arbitrary, username_password.
|
|
8665
|
+
*/
|
|
8666
|
+
expiration_date?: string;
|
|
8177
8667
|
}
|
|
8178
8668
|
namespace UsernamePasswordSecretVersionMetadata {
|
|
8179
8669
|
namespace Constants {
|
|
@@ -8195,7 +8685,9 @@ declare namespace SecretsManagerV2 {
|
|
|
8195
8685
|
}
|
|
8196
8686
|
}
|
|
8197
8687
|
}
|
|
8198
|
-
/**
|
|
8688
|
+
/**
|
|
8689
|
+
* UsernamePasswordSecretVersionPrototype.
|
|
8690
|
+
*/
|
|
8199
8691
|
interface UsernamePasswordSecretVersionPrototype extends SecretVersionPrototype {
|
|
8200
8692
|
/** The password that is assigned to an `username_password` secret. If you omit this parameter, Secrets Manager
|
|
8201
8693
|
* generates a new random password for your secret.
|