@ibm-cloud/secrets-manager 2.0.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -0
- package/README.md +40 -60
- package/examples/secrets-manager.v2.test.js +73 -40
- package/package.json +1 -1
- package/secrets-manager/v2.d.ts +229 -101
- package/secrets-manager/v2.js +69 -15
- package/secrets-manager/v2.js.map +1 -1
package/secrets-manager/v2.d.ts
CHANGED
|
@@ -266,6 +266,25 @@ declare class SecretsManagerV2 extends BaseService {
|
|
|
266
266
|
* @returns {Promise<SecretsManagerV2.Response<SecretsManagerV2.SecretAction>>}
|
|
267
267
|
*/
|
|
268
268
|
createSecretAction(params: SecretsManagerV2.CreateSecretActionParams): Promise<SecretsManagerV2.Response<SecretsManagerV2.SecretAction>>;
|
|
269
|
+
/**
|
|
270
|
+
* Get a secret by name.
|
|
271
|
+
*
|
|
272
|
+
* Get a secret and its details by specifying the Name and Type of the secret.
|
|
273
|
+
*
|
|
274
|
+
* A successful request returns the secret data that is associated with your secret, along with other metadata. To
|
|
275
|
+
* view only the details of a specified secret without retrieving its value, use the [Get secret
|
|
276
|
+
* metadata](#get-secret-metadata) operation.
|
|
277
|
+
*
|
|
278
|
+
* @param {Object} params - The parameters to send to the service.
|
|
279
|
+
* @param {string} params.secretType - The secret type. Supported types are arbitrary, certificates (imported, public,
|
|
280
|
+
* and private), IAM credentials, key-value, and user credentials.
|
|
281
|
+
* @param {string} params.name - A human-readable name to assign to your secret. To protect your privacy, do not use
|
|
282
|
+
* personal data, such as your name or location, as a name for your secret.
|
|
283
|
+
* @param {string} params.secretGroupName - The name of your secret group.
|
|
284
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
285
|
+
* @returns {Promise<SecretsManagerV2.Response<SecretsManagerV2.Secret>>}
|
|
286
|
+
*/
|
|
287
|
+
getSecretByNameType(params: SecretsManagerV2.GetSecretByNameTypeParams): Promise<SecretsManagerV2.Response<SecretsManagerV2.Secret>>;
|
|
269
288
|
/*************************
|
|
270
289
|
* secretVersions
|
|
271
290
|
************************/
|
|
@@ -630,7 +649,7 @@ declare class SecretsManagerV2 extends BaseService {
|
|
|
630
649
|
* more of the fields: `name`, `config_type`, `secret_type`.
|
|
631
650
|
*
|
|
632
651
|
* **Usage:** If you want to list only the configurations that contain the string `text`, use
|
|
633
|
-
* `../
|
|
652
|
+
* `../configurations?search=text`.
|
|
634
653
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
635
654
|
* @returns {Promise<SecretsManagerV2.Response<SecretsManagerV2.ConfigurationMetadataPaginatedCollection>>}
|
|
636
655
|
*/
|
|
@@ -908,6 +927,33 @@ declare namespace SecretsManagerV2 {
|
|
|
908
927
|
secretActionPrototype: SecretActionPrototype;
|
|
909
928
|
headers?: OutgoingHttpHeaders;
|
|
910
929
|
}
|
|
930
|
+
/** Parameters for the `getSecretByNameType` operation. */
|
|
931
|
+
interface GetSecretByNameTypeParams {
|
|
932
|
+
/** The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM
|
|
933
|
+
* credentials, key-value, and user credentials.
|
|
934
|
+
*/
|
|
935
|
+
secretType: GetSecretByNameTypeConstants.SecretType | string;
|
|
936
|
+
/** A human-readable name to assign to your secret. To protect your privacy, do not use personal data, such as
|
|
937
|
+
* your name or location, as a name for your secret.
|
|
938
|
+
*/
|
|
939
|
+
name: string;
|
|
940
|
+
/** The name of your secret group. */
|
|
941
|
+
secretGroupName: string;
|
|
942
|
+
headers?: OutgoingHttpHeaders;
|
|
943
|
+
}
|
|
944
|
+
/** Constants for the `getSecretByNameType` operation. */
|
|
945
|
+
namespace GetSecretByNameTypeConstants {
|
|
946
|
+
/** The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials. */
|
|
947
|
+
enum SecretType {
|
|
948
|
+
ARBITRARY = "arbitrary",
|
|
949
|
+
IMPORTED_CERT = "imported_cert",
|
|
950
|
+
PUBLIC_CERT = "public_cert",
|
|
951
|
+
IAM_CREDENTIALS = "iam_credentials",
|
|
952
|
+
KV = "kv",
|
|
953
|
+
USERNAME_PASSWORD = "username_password",
|
|
954
|
+
PRIVATE_CERT = "private_cert"
|
|
955
|
+
}
|
|
956
|
+
}
|
|
911
957
|
/** Parameters for the `createSecretVersion` operation. */
|
|
912
958
|
interface CreateSecretVersionParams {
|
|
913
959
|
/** The v4 UUID that uniquely identifies your secret. */
|
|
@@ -1189,7 +1235,7 @@ declare namespace SecretsManagerV2 {
|
|
|
1189
1235
|
* `name`, `config_type`, `secret_type`.
|
|
1190
1236
|
*
|
|
1191
1237
|
* **Usage:** If you want to list only the configurations that contain the string `text`, use
|
|
1192
|
-
* `../
|
|
1238
|
+
* `../configurations?search=text`.
|
|
1193
1239
|
*/
|
|
1194
1240
|
search?: string;
|
|
1195
1241
|
headers?: OutgoingHttpHeaders;
|
|
@@ -1429,7 +1475,7 @@ declare namespace SecretsManagerV2 {
|
|
|
1429
1475
|
*/
|
|
1430
1476
|
rotate_keys?: boolean;
|
|
1431
1477
|
}
|
|
1432
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically. */
|
|
1478
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types: username_password, private_cert, public_cert, iam_credentials. */
|
|
1433
1479
|
interface RotationPolicy {
|
|
1434
1480
|
}
|
|
1435
1481
|
/** Your secret. */
|
|
@@ -1701,7 +1747,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1701
1747
|
updated_at: string;
|
|
1702
1748
|
/** The number of versions of your secret. */
|
|
1703
1749
|
versions_total: number;
|
|
1704
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
1750
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
1751
|
+
* types: Arbitrary, username_password.
|
|
1752
|
+
*/
|
|
1705
1753
|
expiration_date?: string;
|
|
1706
1754
|
/** The secret data that is assigned to an `arbitrary` secret. */
|
|
1707
1755
|
payload?: string;
|
|
@@ -1755,7 +1803,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1755
1803
|
updated_at: string;
|
|
1756
1804
|
/** The number of versions of your secret. */
|
|
1757
1805
|
versions_total: number;
|
|
1758
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
1806
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
1807
|
+
* types: Arbitrary, username_password.
|
|
1808
|
+
*/
|
|
1759
1809
|
expiration_date?: string;
|
|
1760
1810
|
}
|
|
1761
1811
|
/** ArbitrarySecretMetadataPatch. */
|
|
@@ -1780,7 +1830,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1780
1830
|
labels?: string[];
|
|
1781
1831
|
/** The secret metadata that a user can customize. */
|
|
1782
1832
|
custom_metadata?: JsonObject;
|
|
1783
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
1833
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
1834
|
+
* types: Arbitrary, username_password.
|
|
1835
|
+
*/
|
|
1784
1836
|
expiration_date?: string;
|
|
1785
1837
|
}
|
|
1786
1838
|
/** ArbitrarySecretPrototype. */
|
|
@@ -1793,7 +1845,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1793
1845
|
* secret group.
|
|
1794
1846
|
*/
|
|
1795
1847
|
description?: string;
|
|
1796
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
1848
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
1849
|
+
* types: Arbitrary, username_password.
|
|
1850
|
+
*/
|
|
1797
1851
|
expiration_date?: string;
|
|
1798
1852
|
/** Labels that you can use to search secrets in your instance. Only 30 labels can be created.
|
|
1799
1853
|
*
|
|
@@ -1850,7 +1904,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1850
1904
|
version_custom_metadata?: JsonObject;
|
|
1851
1905
|
/** A v4 UUID identifier. */
|
|
1852
1906
|
secret_id: string;
|
|
1853
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
1907
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
1908
|
+
* types: Arbitrary, username_password.
|
|
1909
|
+
*/
|
|
1854
1910
|
expiration_date?: string;
|
|
1855
1911
|
/** The secret data that is assigned to an `arbitrary` secret. */
|
|
1856
1912
|
payload?: string;
|
|
@@ -1887,7 +1943,9 @@ declare namespace SecretsManagerV2 {
|
|
|
1887
1943
|
version_custom_metadata?: JsonObject;
|
|
1888
1944
|
/** A v4 UUID identifier. */
|
|
1889
1945
|
secret_id: string;
|
|
1890
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
1946
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
1947
|
+
* types: Arbitrary, username_password.
|
|
1948
|
+
*/
|
|
1891
1949
|
expiration_date?: string;
|
|
1892
1950
|
}
|
|
1893
1951
|
/** ArbitrarySecretVersionPrototype. */
|
|
@@ -1928,10 +1986,10 @@ declare namespace SecretsManagerV2 {
|
|
|
1928
1986
|
created_at: string;
|
|
1929
1987
|
/** The date when a resource was modified. The date format follows `RFC 3339`. */
|
|
1930
1988
|
updated_at: string;
|
|
1931
|
-
/**
|
|
1932
|
-
*
|
|
1933
|
-
*
|
|
1934
|
-
*
|
|
1989
|
+
/** An IBM Cloud API key that can create and manage service IDs. The API key must be assigned the Editor
|
|
1990
|
+
* platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. For more
|
|
1991
|
+
* information, see the
|
|
1992
|
+
* [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).
|
|
1935
1993
|
*/
|
|
1936
1994
|
api_key?: string;
|
|
1937
1995
|
}
|
|
@@ -1954,10 +2012,10 @@ declare namespace SecretsManagerV2 {
|
|
|
1954
2012
|
}
|
|
1955
2013
|
/** The configuration update of the IAM Credentials engine. */
|
|
1956
2014
|
interface IAMCredentialsConfigurationPatch extends ConfigurationPatch {
|
|
1957
|
-
/**
|
|
1958
|
-
*
|
|
1959
|
-
*
|
|
1960
|
-
*
|
|
2015
|
+
/** An IBM Cloud API key that can create and manage service IDs. The API key must be assigned the Editor
|
|
2016
|
+
* platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. For more
|
|
2017
|
+
* information, see the
|
|
2018
|
+
* [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).
|
|
1961
2019
|
*/
|
|
1962
2020
|
api_key: string;
|
|
1963
2021
|
}
|
|
@@ -1970,11 +2028,7 @@ declare namespace SecretsManagerV2 {
|
|
|
1970
2028
|
name: string;
|
|
1971
2029
|
/** The configuration type. */
|
|
1972
2030
|
config_type: string;
|
|
1973
|
-
/** The API key that is
|
|
1974
|
-
*
|
|
1975
|
-
* After the secret reaches the end of its lease (see the `ttl` field), the API key is deleted automatically. If
|
|
1976
|
-
* you want to continue to use the same API key for future read operations, see the `reuse_api_key` field.
|
|
1977
|
-
*/
|
|
2031
|
+
/** The API key that is used to set the iam_credentials engine. */
|
|
1978
2032
|
api_key: string;
|
|
1979
2033
|
}
|
|
1980
2034
|
/** Your IAM credentials secret. */
|
|
@@ -2065,7 +2119,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2065
2119
|
* and API key are generated each time that the secret is read or accessed.
|
|
2066
2120
|
*/
|
|
2067
2121
|
reuse_api_key: boolean;
|
|
2068
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
2122
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
2123
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
2124
|
+
*/
|
|
2069
2125
|
rotation?: RotationPolicy;
|
|
2070
2126
|
/** The date that the secret is scheduled for automatic rotation.
|
|
2071
2127
|
*
|
|
@@ -2168,7 +2224,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2168
2224
|
* and API key are generated each time that the secret is read or accessed.
|
|
2169
2225
|
*/
|
|
2170
2226
|
reuse_api_key: boolean;
|
|
2171
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
2227
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
2228
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
2229
|
+
*/
|
|
2172
2230
|
rotation?: RotationPolicy;
|
|
2173
2231
|
/** The date that the secret is scheduled for automatic rotation.
|
|
2174
2232
|
*
|
|
@@ -2208,7 +2266,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2208
2266
|
* The minimum duration is 1 minute. The maximum is 90 days.
|
|
2209
2267
|
*/
|
|
2210
2268
|
ttl?: string;
|
|
2211
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
2269
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
2270
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
2271
|
+
*/
|
|
2212
2272
|
rotation?: RotationPolicy;
|
|
2213
2273
|
}
|
|
2214
2274
|
/** IAMCredentialsSecretPrototype. */
|
|
@@ -2268,7 +2328,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2268
2328
|
* and API key are generated each time that the secret is read or accessed.
|
|
2269
2329
|
*/
|
|
2270
2330
|
reuse_api_key: boolean;
|
|
2271
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
2331
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
2332
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
2333
|
+
*/
|
|
2272
2334
|
rotation?: RotationPolicy;
|
|
2273
2335
|
/** The secret metadata that a user can customize. */
|
|
2274
2336
|
custom_metadata?: JsonObject;
|
|
@@ -2446,7 +2508,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2446
2508
|
alt_names?: string[];
|
|
2447
2509
|
/** The Common Name (CN) represents the server name protected by the SSL certificate. */
|
|
2448
2510
|
common_name?: string;
|
|
2449
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
2511
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
2512
|
+
* types: Arbitrary, username_password.
|
|
2513
|
+
*/
|
|
2450
2514
|
expiration_date: string;
|
|
2451
2515
|
/** Indicates whether the certificate was imported with an associated intermediate certificate. */
|
|
2452
2516
|
intermediate_included: boolean;
|
|
@@ -2532,7 +2596,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2532
2596
|
alt_names?: string[];
|
|
2533
2597
|
/** The Common Name (CN) represents the server name protected by the SSL certificate. */
|
|
2534
2598
|
common_name?: string;
|
|
2535
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
2599
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
2600
|
+
* types: Arbitrary, username_password.
|
|
2601
|
+
*/
|
|
2536
2602
|
expiration_date: string;
|
|
2537
2603
|
/** Indicates whether the certificate was imported with an associated intermediate certificate. */
|
|
2538
2604
|
intermediate_included: boolean;
|
|
@@ -2645,7 +2711,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2645
2711
|
version_custom_metadata?: JsonObject;
|
|
2646
2712
|
/** A v4 UUID identifier. */
|
|
2647
2713
|
secret_id: string;
|
|
2648
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
2714
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
2715
|
+
* types: Arbitrary, username_password.
|
|
2716
|
+
*/
|
|
2649
2717
|
expiration_date: string;
|
|
2650
2718
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
2651
2719
|
serial_number: string;
|
|
@@ -2694,7 +2762,9 @@ declare namespace SecretsManagerV2 {
|
|
|
2694
2762
|
version_custom_metadata?: JsonObject;
|
|
2695
2763
|
/** A v4 UUID identifier. */
|
|
2696
2764
|
secret_id: string;
|
|
2697
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
2765
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
2766
|
+
* types: Arbitrary, username_password.
|
|
2767
|
+
*/
|
|
2698
2768
|
expiration_date: string;
|
|
2699
2769
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
2700
2770
|
serial_number: string;
|
|
@@ -3016,7 +3086,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3016
3086
|
certificate_template: string;
|
|
3017
3087
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
3018
3088
|
common_name: string;
|
|
3019
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
3089
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
3090
|
+
* types: Arbitrary, username_password.
|
|
3091
|
+
*/
|
|
3020
3092
|
expiration_date: string;
|
|
3021
3093
|
/** The distinguished name that identifies the entity that signed and issued the certificate. */
|
|
3022
3094
|
issuer: string;
|
|
@@ -3030,7 +3102,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3030
3102
|
* for secrets that can be auto-rotated and an existing rotation policy.
|
|
3031
3103
|
*/
|
|
3032
3104
|
next_rotation_date?: string;
|
|
3033
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
3105
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
3106
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
3107
|
+
*/
|
|
3034
3108
|
rotation?: RotationPolicy;
|
|
3035
3109
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
3036
3110
|
serial_number: string;
|
|
@@ -3153,7 +3227,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3153
3227
|
* 1) Subject information, including names and alternate names, are preserved from the CSR rather than by using the
|
|
3154
3228
|
* values that are provided in the other parameters to this operation.
|
|
3155
3229
|
*
|
|
3156
|
-
* 2) Any key usage, for example,
|
|
3230
|
+
* 2) Any key usage, for example, non-repudiation, that is requested in the CSR are added to the basic set of key
|
|
3157
3231
|
* usages used for CA certificates that are signed by the intermediate authority.
|
|
3158
3232
|
*
|
|
3159
3233
|
* 3) Extensions that are requested in the CSR are copied into the issued private certificate.
|
|
@@ -3173,8 +3247,11 @@ declare namespace SecretsManagerV2 {
|
|
|
3173
3247
|
street_address?: string[];
|
|
3174
3248
|
/** The postal code values to define in the subject field of the resulting certificate. */
|
|
3175
3249
|
postal_code?: string[];
|
|
3176
|
-
/** The
|
|
3177
|
-
*
|
|
3250
|
+
/** The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31)
|
|
3251
|
+
* attribute that is in the certificate's distinguished name (DN).
|
|
3252
|
+
*
|
|
3253
|
+
* **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
|
|
3254
|
+
* `serial_number` field represents the certificate's randomly assigned serial number.
|
|
3178
3255
|
*/
|
|
3179
3256
|
serial_number?: string;
|
|
3180
3257
|
/** The type of configuration action. */
|
|
@@ -3234,7 +3311,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3234
3311
|
* 1) Subject information, including names and alternate names, are preserved from the CSR rather than by using the
|
|
3235
3312
|
* values that are provided in the other parameters to this operation.
|
|
3236
3313
|
*
|
|
3237
|
-
* 2) Any key usage, for example,
|
|
3314
|
+
* 2) Any key usage, for example, non-repudiation, that is requested in the CSR are added to the basic set of key
|
|
3238
3315
|
* usages used for CA certificates that are signed by the intermediate authority.
|
|
3239
3316
|
*
|
|
3240
3317
|
* 3) Extensions that are requested in the CSR are copied into the issued private certificate.
|
|
@@ -3254,8 +3331,11 @@ declare namespace SecretsManagerV2 {
|
|
|
3254
3331
|
street_address?: string[];
|
|
3255
3332
|
/** The postal code values to define in the subject field of the resulting certificate. */
|
|
3256
3333
|
postal_code?: string[];
|
|
3257
|
-
/** The
|
|
3258
|
-
*
|
|
3334
|
+
/** The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31)
|
|
3335
|
+
* attribute that is in the certificate's distinguished name (DN).
|
|
3336
|
+
*
|
|
3337
|
+
* **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
|
|
3338
|
+
* `serial_number` field represents the certificate's randomly assigned serial number.
|
|
3259
3339
|
*/
|
|
3260
3340
|
serial_number?: string;
|
|
3261
3341
|
/** The type of configuration action. */
|
|
@@ -3313,7 +3393,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3313
3393
|
* 1) Subject information, including names and alternate names, are preserved from the CSR rather than by using the
|
|
3314
3394
|
* values that are provided in the other parameters to this operation.
|
|
3315
3395
|
*
|
|
3316
|
-
* 2) Any key usage, for example,
|
|
3396
|
+
* 2) Any key usage, for example, non-repudiation, that is requested in the CSR are added to the basic set of key
|
|
3317
3397
|
* usages used for CA certificates that are signed by the intermediate authority.
|
|
3318
3398
|
*
|
|
3319
3399
|
* 3) Extensions that are requested in the CSR are copied into the issued private certificate.
|
|
@@ -3333,8 +3413,11 @@ declare namespace SecretsManagerV2 {
|
|
|
3333
3413
|
street_address?: string[];
|
|
3334
3414
|
/** The postal code values to define in the subject field of the resulting certificate. */
|
|
3335
3415
|
postal_code?: string[];
|
|
3336
|
-
/** The
|
|
3337
|
-
*
|
|
3416
|
+
/** The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31)
|
|
3417
|
+
* attribute that is in the certificate's distinguished name (DN).
|
|
3418
|
+
*
|
|
3419
|
+
* **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
|
|
3420
|
+
* `serial_number` field represents the certificate's randomly assigned serial number.
|
|
3338
3421
|
*/
|
|
3339
3422
|
serial_number?: string;
|
|
3340
3423
|
/** The type of configuration action. */
|
|
@@ -3392,7 +3475,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3392
3475
|
* 1) Subject information, including names and alternate names, are preserved from the CSR rather than by using the
|
|
3393
3476
|
* values that are provided in the other parameters to this operation.
|
|
3394
3477
|
*
|
|
3395
|
-
* 2) Any key usage, for example,
|
|
3478
|
+
* 2) Any key usage, for example, non-repudiation, that is requested in the CSR are added to the basic set of key
|
|
3396
3479
|
* usages used for CA certificates that are signed by the intermediate authority.
|
|
3397
3480
|
*
|
|
3398
3481
|
* 3) Extensions that are requested in the CSR are copied into the issued private certificate.
|
|
@@ -3412,8 +3495,11 @@ declare namespace SecretsManagerV2 {
|
|
|
3412
3495
|
street_address?: string[];
|
|
3413
3496
|
/** The postal code values to define in the subject field of the resulting certificate. */
|
|
3414
3497
|
postal_code?: string[];
|
|
3415
|
-
/** The
|
|
3416
|
-
*
|
|
3498
|
+
/** The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31)
|
|
3499
|
+
* attribute that is in the certificate's distinguished name (DN).
|
|
3500
|
+
*
|
|
3501
|
+
* **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
|
|
3502
|
+
* `serial_number` field represents the certificate's randomly assigned serial number.
|
|
3417
3503
|
*/
|
|
3418
3504
|
serial_number?: string;
|
|
3419
3505
|
/** The type of configuration action. */
|
|
@@ -3454,7 +3540,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3454
3540
|
* certificates that are issued by this certificate authority.
|
|
3455
3541
|
*/
|
|
3456
3542
|
crl_distribution_points_encoded?: boolean;
|
|
3457
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
3543
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
3544
|
+
* types: Arbitrary, username_password.
|
|
3545
|
+
*/
|
|
3458
3546
|
expiration_date?: string;
|
|
3459
3547
|
/** The distinguished name that identifies the entity that signed and issued the certificate. */
|
|
3460
3548
|
issuer?: string;
|
|
@@ -3531,9 +3619,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3531
3619
|
street_address?: string[];
|
|
3532
3620
|
/** The postal code values to define in the subject field of the resulting certificate. */
|
|
3533
3621
|
postal_code?: string[];
|
|
3534
|
-
/** The serial number
|
|
3535
|
-
* this field.
|
|
3536
|
-
*/
|
|
3622
|
+
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
3537
3623
|
serial_number?: string;
|
|
3538
3624
|
/** The configuration data of your Private Certificate. */
|
|
3539
3625
|
data?: PrivateCertificateCAData;
|
|
@@ -3573,7 +3659,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3573
3659
|
* certificates that are issued by this certificate authority.
|
|
3574
3660
|
*/
|
|
3575
3661
|
crl_distribution_points_encoded?: boolean;
|
|
3576
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
3662
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
3663
|
+
* types: Arbitrary, username_password.
|
|
3664
|
+
*/
|
|
3577
3665
|
expiration_date?: string;
|
|
3578
3666
|
/** The distinguished name that identifies the entity that signed and issued the certificate. */
|
|
3579
3667
|
issuer?: string;
|
|
@@ -3727,8 +3815,11 @@ declare namespace SecretsManagerV2 {
|
|
|
3727
3815
|
street_address?: string[];
|
|
3728
3816
|
/** The postal code values to define in the subject field of the resulting certificate. */
|
|
3729
3817
|
postal_code?: string[];
|
|
3730
|
-
/** The
|
|
3731
|
-
*
|
|
3818
|
+
/** The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31)
|
|
3819
|
+
* attribute that is in the certificate's distinguished name (DN).
|
|
3820
|
+
*
|
|
3821
|
+
* **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
|
|
3822
|
+
* `serial_number` field represents the certificate's randomly assigned serial number.
|
|
3732
3823
|
*/
|
|
3733
3824
|
serial_number?: string;
|
|
3734
3825
|
}
|
|
@@ -3754,7 +3845,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3754
3845
|
* certificates that are issued by this certificate authority.
|
|
3755
3846
|
*/
|
|
3756
3847
|
crl_distribution_points_encoded?: boolean;
|
|
3757
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
3848
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
3849
|
+
* types: Arbitrary, username_password.
|
|
3850
|
+
*/
|
|
3758
3851
|
expiration_date?: string;
|
|
3759
3852
|
/** The type of private key to generate. */
|
|
3760
3853
|
key_type?: string;
|
|
@@ -3835,9 +3928,7 @@ declare namespace SecretsManagerV2 {
|
|
|
3835
3928
|
street_address?: string[];
|
|
3836
3929
|
/** The postal code values to define in the subject field of the resulting certificate. */
|
|
3837
3930
|
postal_code?: string[];
|
|
3838
|
-
/** The serial number
|
|
3839
|
-
* this field.
|
|
3840
|
-
*/
|
|
3931
|
+
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
3841
3932
|
serial_number?: string;
|
|
3842
3933
|
/** The configuration data of your Private Certificate. */
|
|
3843
3934
|
data?: PrivateCertificateCAData;
|
|
@@ -3864,7 +3955,9 @@ declare namespace SecretsManagerV2 {
|
|
|
3864
3955
|
* certificates that are issued by this certificate authority.
|
|
3865
3956
|
*/
|
|
3866
3957
|
crl_distribution_points_encoded?: boolean;
|
|
3867
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
3958
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
3959
|
+
* types: Arbitrary, username_password.
|
|
3960
|
+
*/
|
|
3868
3961
|
expiration_date?: string;
|
|
3869
3962
|
/** The type of private key to generate. */
|
|
3870
3963
|
key_type?: string;
|
|
@@ -4019,8 +4112,11 @@ declare namespace SecretsManagerV2 {
|
|
|
4019
4112
|
street_address?: string[];
|
|
4020
4113
|
/** The postal code values to define in the subject field of the resulting certificate. */
|
|
4021
4114
|
postal_code?: string[];
|
|
4022
|
-
/** The
|
|
4023
|
-
*
|
|
4115
|
+
/** The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31)
|
|
4116
|
+
* attribute that is in the certificate's distinguished name (DN).
|
|
4117
|
+
*
|
|
4118
|
+
* **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
|
|
4119
|
+
* `serial_number` field represents the certificate's randomly assigned serial number.
|
|
4024
4120
|
*/
|
|
4025
4121
|
serial_number?: string;
|
|
4026
4122
|
}
|
|
@@ -4172,9 +4268,7 @@ declare namespace SecretsManagerV2 {
|
|
|
4172
4268
|
street_address?: string[];
|
|
4173
4269
|
/** The postal code values to define in the subject field of the resulting certificate. */
|
|
4174
4270
|
postal_code?: string[];
|
|
4175
|
-
/**
|
|
4176
|
-
* this field.
|
|
4177
|
-
*/
|
|
4271
|
+
/** This field is deprecated. You can ignore its value. */
|
|
4178
4272
|
serial_number?: string;
|
|
4179
4273
|
/** This field indicates whether to require a common name to create a private certificate.
|
|
4180
4274
|
*
|
|
@@ -4353,9 +4447,7 @@ declare namespace SecretsManagerV2 {
|
|
|
4353
4447
|
street_address?: string[];
|
|
4354
4448
|
/** The postal code values to define in the subject field of the resulting certificate. */
|
|
4355
4449
|
postal_code?: string[];
|
|
4356
|
-
/**
|
|
4357
|
-
* this field.
|
|
4358
|
-
*/
|
|
4450
|
+
/** This field is deprecated. You can ignore its value. */
|
|
4359
4451
|
serial_number?: string;
|
|
4360
4452
|
/** This field indicates whether to require a common name to create a private certificate.
|
|
4361
4453
|
*
|
|
@@ -4534,9 +4626,7 @@ declare namespace SecretsManagerV2 {
|
|
|
4534
4626
|
street_address?: string[];
|
|
4535
4627
|
/** The postal code values to define in the subject field of the resulting certificate. */
|
|
4536
4628
|
postal_code?: string[];
|
|
4537
|
-
/**
|
|
4538
|
-
* this field.
|
|
4539
|
-
*/
|
|
4629
|
+
/** This field is deprecated. You can ignore its value. */
|
|
4540
4630
|
serial_number?: string;
|
|
4541
4631
|
/** This field indicates whether to require a common name to create a private certificate.
|
|
4542
4632
|
*
|
|
@@ -4620,7 +4710,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4620
4710
|
certificate_template: string;
|
|
4621
4711
|
/** The Common Name (CN) represents the server name that is protected by the SSL certificate. */
|
|
4622
4712
|
common_name: string;
|
|
4623
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
4713
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
4714
|
+
* types: Arbitrary, username_password.
|
|
4715
|
+
*/
|
|
4624
4716
|
expiration_date: string;
|
|
4625
4717
|
/** The distinguished name that identifies the entity that signed and issued the certificate. */
|
|
4626
4718
|
issuer: string;
|
|
@@ -4634,7 +4726,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4634
4726
|
* for secrets that can be auto-rotated and an existing rotation policy.
|
|
4635
4727
|
*/
|
|
4636
4728
|
next_rotation_date?: string;
|
|
4637
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
4729
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
4730
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
4731
|
+
*/
|
|
4638
4732
|
rotation?: RotationPolicy;
|
|
4639
4733
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
4640
4734
|
serial_number: string;
|
|
@@ -4667,7 +4761,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4667
4761
|
labels?: string[];
|
|
4668
4762
|
/** The secret metadata that a user can customize. */
|
|
4669
4763
|
custom_metadata?: JsonObject;
|
|
4670
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
4764
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
4765
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
4766
|
+
*/
|
|
4671
4767
|
rotation?: RotationPolicy;
|
|
4672
4768
|
}
|
|
4673
4769
|
/** PrivateCertificatePrototype. */
|
|
@@ -4734,7 +4830,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4734
4830
|
* exceed the `max_ttl` that is defined in the associated certificate template.
|
|
4735
4831
|
*/
|
|
4736
4832
|
ttl?: string;
|
|
4737
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
4833
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
4834
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
4835
|
+
*/
|
|
4738
4836
|
rotation?: RotationPolicy;
|
|
4739
4837
|
/** The secret metadata that a user can customize. */
|
|
4740
4838
|
custom_metadata?: JsonObject;
|
|
@@ -4773,7 +4871,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4773
4871
|
version_custom_metadata?: JsonObject;
|
|
4774
4872
|
/** A v4 UUID identifier. */
|
|
4775
4873
|
secret_id: string;
|
|
4776
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
4874
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
4875
|
+
* types: Arbitrary, username_password.
|
|
4876
|
+
*/
|
|
4777
4877
|
expiration_date: string;
|
|
4778
4878
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
4779
4879
|
serial_number: string;
|
|
@@ -4834,7 +4934,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4834
4934
|
version_custom_metadata?: JsonObject;
|
|
4835
4935
|
/** A v4 UUID identifier. */
|
|
4836
4936
|
secret_id: string;
|
|
4837
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
4937
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
4938
|
+
* types: Arbitrary, username_password.
|
|
4939
|
+
*/
|
|
4838
4940
|
expiration_date: string;
|
|
4839
4941
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
4840
4942
|
serial_number: string;
|
|
@@ -4909,7 +5011,9 @@ declare namespace SecretsManagerV2 {
|
|
|
4909
5011
|
alt_names?: string[];
|
|
4910
5012
|
/** The Common Name (CN) represents the server name protected by the SSL certificate. */
|
|
4911
5013
|
common_name: string;
|
|
4912
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
5014
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
5015
|
+
* types: Arbitrary, username_password.
|
|
5016
|
+
*/
|
|
4913
5017
|
expiration_date?: string;
|
|
4914
5018
|
/** Issuance information that is associated with your certificate. */
|
|
4915
5019
|
issuance_info?: CertificateIssuanceInfo;
|
|
@@ -4920,14 +5024,16 @@ declare namespace SecretsManagerV2 {
|
|
|
4920
5024
|
*
|
|
4921
5025
|
* The algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be used to
|
|
4922
5026
|
* generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to
|
|
4923
|
-
* provide more encryption protection. Allowed values: `RSA2048`, `RSA4096`, `
|
|
5027
|
+
* provide more encryption protection. Allowed values: `RSA2048`, `RSA4096`, `ECDSA256`, and `ECDSA384`.
|
|
4924
5028
|
*/
|
|
4925
5029
|
key_algorithm: string;
|
|
4926
5030
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
4927
5031
|
serial_number?: string;
|
|
4928
5032
|
/** The date and time that the certificate validity period begins and ends. */
|
|
4929
5033
|
validity?: CertificateValidity;
|
|
4930
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
5034
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
5035
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
5036
|
+
*/
|
|
4931
5037
|
rotation: RotationPolicy;
|
|
4932
5038
|
/** Indicates whether the issued certificate is bundled with intermediate certificates. */
|
|
4933
5039
|
bundle_certs?: boolean;
|
|
@@ -5270,7 +5376,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5270
5376
|
alt_names?: string[];
|
|
5271
5377
|
/** The Common Name (CN) represents the server name protected by the SSL certificate. */
|
|
5272
5378
|
common_name: string;
|
|
5273
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
5379
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
5380
|
+
* types: Arbitrary, username_password.
|
|
5381
|
+
*/
|
|
5274
5382
|
expiration_date?: string;
|
|
5275
5383
|
/** Issuance information that is associated with your certificate. */
|
|
5276
5384
|
issuance_info?: CertificateIssuanceInfo;
|
|
@@ -5281,14 +5389,16 @@ declare namespace SecretsManagerV2 {
|
|
|
5281
5389
|
*
|
|
5282
5390
|
* The algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be used to
|
|
5283
5391
|
* generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to
|
|
5284
|
-
* provide more encryption protection. Allowed values: `RSA2048`, `RSA4096`, `
|
|
5392
|
+
* provide more encryption protection. Allowed values: `RSA2048`, `RSA4096`, `ECDSA256`, and `ECDSA384`.
|
|
5285
5393
|
*/
|
|
5286
5394
|
key_algorithm: string;
|
|
5287
5395
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
5288
5396
|
serial_number?: string;
|
|
5289
5397
|
/** The date and time that the certificate validity period begins and ends. */
|
|
5290
5398
|
validity?: CertificateValidity;
|
|
5291
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
5399
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
5400
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
5401
|
+
*/
|
|
5292
5402
|
rotation: RotationPolicy;
|
|
5293
5403
|
/** Indicates whether the issued certificate is bundled with intermediate certificates. */
|
|
5294
5404
|
bundle_certs?: boolean;
|
|
@@ -5319,7 +5429,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5319
5429
|
labels?: string[];
|
|
5320
5430
|
/** The secret metadata that a user can customize. */
|
|
5321
5431
|
custom_metadata?: JsonObject;
|
|
5322
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
5432
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
5433
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
5434
|
+
*/
|
|
5323
5435
|
rotation?: RotationPolicy;
|
|
5324
5436
|
}
|
|
5325
5437
|
/** PublicCertificatePrototype. */
|
|
@@ -5359,24 +5471,20 @@ declare namespace SecretsManagerV2 {
|
|
|
5359
5471
|
*
|
|
5360
5472
|
* The algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be used to
|
|
5361
5473
|
* generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to
|
|
5362
|
-
* provide more encryption protection. Allowed values: `RSA2048`, `RSA4096`, `
|
|
5474
|
+
* provide more encryption protection. Allowed values: `RSA2048`, `RSA4096`, `ECDSA256`, and `ECDSA384`.
|
|
5363
5475
|
*/
|
|
5364
5476
|
key_algorithm?: string;
|
|
5365
|
-
/**
|
|
5366
|
-
*
|
|
5367
|
-
* To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
|
|
5368
|
-
*/
|
|
5477
|
+
/** The name of the certificate authority configuration. */
|
|
5369
5478
|
ca: string;
|
|
5370
|
-
/**
|
|
5371
|
-
*
|
|
5372
|
-
* To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
|
|
5373
|
-
*/
|
|
5479
|
+
/** The name of the DNS provider configuration. */
|
|
5374
5480
|
dns: string;
|
|
5375
5481
|
/** This field indicates whether your issued certificate is bundled with intermediate certificates. Set to
|
|
5376
5482
|
* `false` for the certificate file to contain only the issued certificate.
|
|
5377
5483
|
*/
|
|
5378
5484
|
bundle_certs?: boolean;
|
|
5379
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
5485
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
5486
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
5487
|
+
*/
|
|
5380
5488
|
rotation?: RotationPolicy;
|
|
5381
5489
|
/** The secret metadata that a user can customize. */
|
|
5382
5490
|
custom_metadata?: JsonObject;
|
|
@@ -5431,7 +5539,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5431
5539
|
version_custom_metadata?: JsonObject;
|
|
5432
5540
|
/** A v4 UUID identifier. */
|
|
5433
5541
|
secret_id: string;
|
|
5434
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
5542
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
5543
|
+
* types: Arbitrary, username_password.
|
|
5544
|
+
*/
|
|
5435
5545
|
expiration_date?: string;
|
|
5436
5546
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
5437
5547
|
serial_number?: string;
|
|
@@ -5480,7 +5590,9 @@ declare namespace SecretsManagerV2 {
|
|
|
5480
5590
|
version_custom_metadata?: JsonObject;
|
|
5481
5591
|
/** A v4 UUID identifier. */
|
|
5482
5592
|
secret_id: string;
|
|
5483
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
5593
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
5594
|
+
* types: Arbitrary, username_password.
|
|
5595
|
+
*/
|
|
5484
5596
|
expiration_date?: string;
|
|
5485
5597
|
/** The unique serial number that was assigned to a certificate by the issuing certificate authority. */
|
|
5486
5598
|
serial_number?: string;
|
|
@@ -5545,9 +5657,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5545
5657
|
updated_at: string;
|
|
5546
5658
|
/** The number of versions of your secret. */
|
|
5547
5659
|
versions_total: number;
|
|
5548
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
5660
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
5661
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
5662
|
+
*/
|
|
5549
5663
|
rotation: RotationPolicy;
|
|
5550
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
5664
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
5665
|
+
* types: Arbitrary, username_password.
|
|
5666
|
+
*/
|
|
5551
5667
|
expiration_date?: string;
|
|
5552
5668
|
/** The date that the secret is scheduled for automatic rotation.
|
|
5553
5669
|
*
|
|
@@ -5609,9 +5725,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5609
5725
|
updated_at: string;
|
|
5610
5726
|
/** The number of versions of your secret. */
|
|
5611
5727
|
versions_total: number;
|
|
5612
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
5728
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
5729
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
5730
|
+
*/
|
|
5613
5731
|
rotation: RotationPolicy;
|
|
5614
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
5732
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
5733
|
+
* types: Arbitrary, username_password.
|
|
5734
|
+
*/
|
|
5615
5735
|
expiration_date?: string;
|
|
5616
5736
|
/** The date that the secret is scheduled for automatic rotation.
|
|
5617
5737
|
*
|
|
@@ -5642,9 +5762,13 @@ declare namespace SecretsManagerV2 {
|
|
|
5642
5762
|
labels?: string[];
|
|
5643
5763
|
/** The secret metadata that a user can customize. */
|
|
5644
5764
|
custom_metadata?: JsonObject;
|
|
5645
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
5765
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
5766
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
5767
|
+
*/
|
|
5646
5768
|
rotation?: RotationPolicy;
|
|
5647
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
5769
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
5770
|
+
* types: Arbitrary, username_password.
|
|
5771
|
+
*/
|
|
5648
5772
|
expiration_date?: string;
|
|
5649
5773
|
}
|
|
5650
5774
|
/** UsernamePasswordSecretPrototype. */
|
|
@@ -5677,13 +5801,17 @@ declare namespace SecretsManagerV2 {
|
|
|
5677
5801
|
username: string;
|
|
5678
5802
|
/** The password that is assigned to an `username_password` secret. */
|
|
5679
5803
|
password: string;
|
|
5680
|
-
/** The date when the secret material expires. The date format follows the `RFC 3339` format.
|
|
5804
|
+
/** The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret
|
|
5805
|
+
* types: Arbitrary, username_password.
|
|
5806
|
+
*/
|
|
5681
5807
|
expiration_date?: string;
|
|
5682
5808
|
/** The secret metadata that a user can customize. */
|
|
5683
5809
|
custom_metadata?: JsonObject;
|
|
5684
5810
|
/** The secret version metadata that a user can customize. */
|
|
5685
5811
|
version_custom_metadata?: JsonObject;
|
|
5686
|
-
/** This field indicates whether Secrets Manager rotates your secrets automatically.
|
|
5812
|
+
/** This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
|
|
5813
|
+
* username_password, private_cert, public_cert, iam_credentials.
|
|
5814
|
+
*/
|
|
5687
5815
|
rotation?: RotationPolicy;
|
|
5688
5816
|
}
|
|
5689
5817
|
/** Your user credentials secret version. */
|
|
@@ -5759,7 +5887,7 @@ declare namespace SecretsManagerV2 {
|
|
|
5759
5887
|
/** UsernamePasswordSecretVersionPrototype. */
|
|
5760
5888
|
interface UsernamePasswordSecretVersionPrototype extends SecretVersionPrototype {
|
|
5761
5889
|
/** The password that is assigned to an `username_password` secret. */
|
|
5762
|
-
password
|
|
5890
|
+
password?: string;
|
|
5763
5891
|
/** The secret metadata that a user can customize. */
|
|
5764
5892
|
custom_metadata?: JsonObject;
|
|
5765
5893
|
/** The secret version metadata that a user can customize. */
|