@ibm-cloud/secrets-manager 0.0.4 → 0.1.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/auth/index.d.ts +2 -2
- package/auth/index.js +9 -9
- package/auth/index.js.map +1 -1
- package/lib/common.d.ts +3 -0
- package/lib/common.js +6 -2
- package/lib/common.js.map +1 -1
- package/package.json +22 -16
- package/readme.md +81 -29
- package/secrets-manager/v1.d.ts +1138 -0
- package/{ibm-cloud-secrets-manager-api → secrets-manager}/v1.js +184 -121
- package/secrets-manager/v1.js.map +1 -0
- package/ibm-cloud-secrets-manager-api/v1.d.ts +0 -842
- package/ibm-cloud-secrets-manager-api/v1.js.map +0 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
/**
|
|
3
|
-
* (C) Copyright IBM Corp.
|
|
3
|
+
* (C) Copyright IBM Corp. 2021.
|
|
4
4
|
*
|
|
5
5
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
6
|
* you may not use this file except in compliance with the License.
|
|
@@ -28,27 +28,29 @@ var __extends = (this && this.__extends) || (function () {
|
|
|
28
28
|
};
|
|
29
29
|
})();
|
|
30
30
|
/**
|
|
31
|
-
* IBM OpenAPI SDK Code Generator Version: 3.
|
|
31
|
+
* IBM OpenAPI SDK Code Generator Version: 3.30.0-bd714324-20210406-200538
|
|
32
32
|
*/
|
|
33
33
|
var extend = require("extend");
|
|
34
34
|
var ibm_cloud_sdk_core_1 = require("ibm-cloud-sdk-core");
|
|
35
35
|
var common_1 = require("../lib/common");
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* With IBM Cloud® Secrets Manager, you can create, lease, and centrally manage secrets that are used in IBM Cloud
|
|
38
|
+
* services or your custom-built applications. Secrets are stored in a dedicated instance of Secrets Manager, built on
|
|
39
|
+
* open source HashiCorp Vault.
|
|
38
40
|
*/
|
|
39
|
-
var
|
|
40
|
-
__extends(
|
|
41
|
+
var SecretsManagerV1 = /** @class */ (function (_super) {
|
|
42
|
+
__extends(SecretsManagerV1, _super);
|
|
41
43
|
/**
|
|
42
|
-
* Construct a
|
|
44
|
+
* Construct a SecretsManagerV1 object.
|
|
43
45
|
*
|
|
44
46
|
* @param {Object} options - Options for the service.
|
|
45
|
-
* @param {string} [options.serviceUrl] - The base url to use when contacting the service
|
|
47
|
+
* @param {string} [options.serviceUrl] - The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
|
|
46
48
|
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
|
|
47
49
|
* @param {Authenticator} options.authenticator - The Authenticator object used to authenticate requests to the service
|
|
48
50
|
* @constructor
|
|
49
|
-
* @returns {
|
|
51
|
+
* @returns {SecretsManagerV1}
|
|
50
52
|
*/
|
|
51
|
-
function
|
|
53
|
+
function SecretsManagerV1(options) {
|
|
52
54
|
var _this = this;
|
|
53
55
|
options = options || {};
|
|
54
56
|
_this = _super.call(this, options) || this;
|
|
@@ -56,7 +58,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
56
58
|
_this.setServiceUrl(options.serviceUrl);
|
|
57
59
|
}
|
|
58
60
|
else {
|
|
59
|
-
_this.setServiceUrl(
|
|
61
|
+
_this.setServiceUrl(SecretsManagerV1.DEFAULT_SERVICE_URL);
|
|
60
62
|
}
|
|
61
63
|
return _this;
|
|
62
64
|
}
|
|
@@ -64,15 +66,15 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
64
66
|
* Factory method
|
|
65
67
|
************************/
|
|
66
68
|
/**
|
|
67
|
-
* Constructs an instance of
|
|
69
|
+
* Constructs an instance of SecretsManagerV1 with passed in options and external configuration.
|
|
68
70
|
*
|
|
69
71
|
* @param {UserOptions} [options] - The parameters to send to the service.
|
|
70
72
|
* @param {string} [options.serviceName] - The name of the service to configure
|
|
71
73
|
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service
|
|
72
74
|
* @param {string} [options.serviceUrl] - The URL for the service
|
|
73
|
-
* @returns {
|
|
75
|
+
* @returns {SecretsManagerV1}
|
|
74
76
|
*/
|
|
75
|
-
|
|
77
|
+
SecretsManagerV1.newInstance = function (options) {
|
|
76
78
|
options = options || {};
|
|
77
79
|
if (!options.serviceName) {
|
|
78
80
|
options.serviceName = this.DEFAULT_SERVICE_NAME;
|
|
@@ -80,7 +82,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
80
82
|
if (!options.authenticator) {
|
|
81
83
|
options.authenticator = ibm_cloud_sdk_core_1.getAuthenticatorFromEnvironment(options.serviceName);
|
|
82
84
|
}
|
|
83
|
-
var service = new
|
|
85
|
+
var service = new SecretsManagerV1(options);
|
|
84
86
|
service.configureService(options.serviceName);
|
|
85
87
|
if (options.serviceUrl) {
|
|
86
88
|
service.setServiceUrl(options.serviceUrl);
|
|
@@ -97,22 +99,22 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
97
99
|
*
|
|
98
100
|
* @param {Object} params - The parameters to send to the service.
|
|
99
101
|
* @param {string} params.secretType - The secret type.
|
|
100
|
-
* @param {
|
|
102
|
+
* @param {EngineConfigOneOf} params.engineConfigOneOf - The base request for setting secret engine configuration.
|
|
101
103
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
102
|
-
* @returns {Promise<
|
|
104
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.Empty>>}
|
|
103
105
|
*/
|
|
104
|
-
|
|
106
|
+
SecretsManagerV1.prototype.putConfig = function (params) {
|
|
105
107
|
var _params = Object.assign({}, params);
|
|
106
|
-
var requiredParams = ['secretType', '
|
|
108
|
+
var requiredParams = ['secretType', 'engineConfigOneOf'];
|
|
107
109
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
108
110
|
if (missingParams) {
|
|
109
111
|
return Promise.reject(missingParams);
|
|
110
112
|
}
|
|
111
|
-
var body = _params.
|
|
113
|
+
var body = _params.engineConfigOneOf;
|
|
112
114
|
var path = {
|
|
113
115
|
'secret_type': _params.secretType
|
|
114
116
|
};
|
|
115
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
117
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'putConfig');
|
|
116
118
|
var parameters = {
|
|
117
119
|
options: {
|
|
118
120
|
url: '/api/v1/config/{secret_type}',
|
|
@@ -132,14 +134,14 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
132
134
|
/**
|
|
133
135
|
* Get the configuration for a secret type.
|
|
134
136
|
*
|
|
135
|
-
* Retrieves
|
|
137
|
+
* Retrieves the configuration that is associated with the given secret type.
|
|
136
138
|
*
|
|
137
139
|
* @param {Object} params - The parameters to send to the service.
|
|
138
140
|
* @param {string} params.secretType - The secret type.
|
|
139
141
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
140
|
-
* @returns {Promise<
|
|
142
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.GetConfig>>}
|
|
141
143
|
*/
|
|
142
|
-
|
|
144
|
+
SecretsManagerV1.prototype.getConfig = function (params) {
|
|
143
145
|
var _params = Object.assign({}, params);
|
|
144
146
|
var requiredParams = ['secretType'];
|
|
145
147
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -149,7 +151,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
149
151
|
var path = {
|
|
150
152
|
'secret_type': _params.secretType
|
|
151
153
|
};
|
|
152
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
154
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'getConfig');
|
|
153
155
|
var parameters = {
|
|
154
156
|
options: {
|
|
155
157
|
url: '/api/v1/config/{secret_type}',
|
|
@@ -171,7 +173,9 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
171
173
|
/**
|
|
172
174
|
* Set secret policies.
|
|
173
175
|
*
|
|
174
|
-
* Creates or updates one or more policies
|
|
176
|
+
* Creates or updates one or more policies, such as an [automatic rotation
|
|
177
|
+
* policy](http://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-rotate-secrets#auto-rotate-secret), for the
|
|
178
|
+
* specified secret.
|
|
175
179
|
*
|
|
176
180
|
* @param {Object} params - The parameters to send to the service.
|
|
177
181
|
* @param {string} params.secretType - The secret type.
|
|
@@ -180,9 +184,9 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
180
184
|
* @param {SecretPolicyRotation[]} params.resources - A collection of resources.
|
|
181
185
|
* @param {string} [params.policy] - The type of policy that is associated with the specified secret.
|
|
182
186
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
183
|
-
* @returns {Promise<
|
|
187
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.GetSecretPoliciesOneOf>>}
|
|
184
188
|
*/
|
|
185
|
-
|
|
189
|
+
SecretsManagerV1.prototype.putPolicy = function (params) {
|
|
186
190
|
var _params = Object.assign({}, params);
|
|
187
191
|
var requiredParams = ['secretType', 'id', 'metadata', 'resources'];
|
|
188
192
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -200,7 +204,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
200
204
|
'secret_type': _params.secretType,
|
|
201
205
|
'id': _params.id
|
|
202
206
|
};
|
|
203
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
207
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'putPolicy');
|
|
204
208
|
var parameters = {
|
|
205
209
|
options: {
|
|
206
210
|
url: '/api/v1/secrets/{secret_type}/{id}/policies',
|
|
@@ -229,9 +233,9 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
229
233
|
* @param {string} params.id - The v4 UUID that uniquely identifies the secret.
|
|
230
234
|
* @param {string} [params.policy] - The type of policy that is associated with the specified secret.
|
|
231
235
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
232
|
-
* @returns {Promise<
|
|
236
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.GetSecretPoliciesOneOf>>}
|
|
233
237
|
*/
|
|
234
|
-
|
|
238
|
+
SecretsManagerV1.prototype.getPolicy = function (params) {
|
|
235
239
|
var _params = Object.assign({}, params);
|
|
236
240
|
var requiredParams = ['secretType', 'id'];
|
|
237
241
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -245,7 +249,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
245
249
|
'secret_type': _params.secretType,
|
|
246
250
|
'id': _params.id
|
|
247
251
|
};
|
|
248
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
252
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'getPolicy');
|
|
249
253
|
var parameters = {
|
|
250
254
|
options: {
|
|
251
255
|
url: '/api/v1/secrets/{secret_type}/{id}/policies',
|
|
@@ -266,17 +270,21 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
266
270
|
* secretGroups
|
|
267
271
|
************************/
|
|
268
272
|
/**
|
|
269
|
-
* Create secret group.
|
|
273
|
+
* Create a secret group.
|
|
274
|
+
*
|
|
275
|
+
* Creates a secret group that you can use to organize secrets and control who on your team has access to them.
|
|
270
276
|
*
|
|
271
|
-
*
|
|
277
|
+
* A successful request returns the ID value of the secret group, along with other metadata. To learn more about
|
|
278
|
+
* secret groups, check out the
|
|
279
|
+
* [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-secret-groups).
|
|
272
280
|
*
|
|
273
281
|
* @param {Object} params - The parameters to send to the service.
|
|
274
282
|
* @param {CollectionMetadata} params.metadata - The metadata that describes the resource array.
|
|
275
283
|
* @param {SecretGroupResource[]} params.resources - A collection of resources.
|
|
276
284
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
277
|
-
* @returns {Promise<
|
|
285
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.SecretGroupDef>>}
|
|
278
286
|
*/
|
|
279
|
-
|
|
287
|
+
SecretsManagerV1.prototype.createSecretGroup = function (params) {
|
|
280
288
|
var _params = Object.assign({}, params);
|
|
281
289
|
var requiredParams = ['metadata', 'resources'];
|
|
282
290
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -287,7 +295,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
287
295
|
'metadata': _params.metadata,
|
|
288
296
|
'resources': _params.resources
|
|
289
297
|
};
|
|
290
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
298
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'createSecretGroup');
|
|
291
299
|
var parameters = {
|
|
292
300
|
options: {
|
|
293
301
|
url: '/api/v1/secret_groups',
|
|
@@ -307,15 +315,15 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
307
315
|
/**
|
|
308
316
|
* List secret groups.
|
|
309
317
|
*
|
|
310
|
-
* Retrieves the list of secret groups.
|
|
318
|
+
* Retrieves the list of secret groups that are available in your Secrets Manager instance.
|
|
311
319
|
*
|
|
312
320
|
* @param {Object} [params] - The parameters to send to the service.
|
|
313
321
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
314
|
-
* @returns {Promise<
|
|
322
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.SecretGroupDef>>}
|
|
315
323
|
*/
|
|
316
|
-
|
|
324
|
+
SecretsManagerV1.prototype.listSecretGroups = function (params) {
|
|
317
325
|
var _params = Object.assign({}, params);
|
|
318
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
326
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'listSecretGroups');
|
|
319
327
|
var parameters = {
|
|
320
328
|
options: {
|
|
321
329
|
url: '/api/v1/secret_groups',
|
|
@@ -331,16 +339,16 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
331
339
|
};
|
|
332
340
|
;
|
|
333
341
|
/**
|
|
334
|
-
*
|
|
342
|
+
* Get a secret group.
|
|
335
343
|
*
|
|
336
|
-
* Retrieves
|
|
344
|
+
* Retrieves the metadata of an existing secret group by specifying the ID of the group.
|
|
337
345
|
*
|
|
338
346
|
* @param {Object} params - The parameters to send to the service.
|
|
339
347
|
* @param {string} params.id - The v4 UUID that uniquely identifies the secret group.
|
|
340
348
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
341
|
-
* @returns {Promise<
|
|
349
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.SecretGroupDef>>}
|
|
342
350
|
*/
|
|
343
|
-
|
|
351
|
+
SecretsManagerV1.prototype.getSecretGroup = function (params) {
|
|
344
352
|
var _params = Object.assign({}, params);
|
|
345
353
|
var requiredParams = ['id'];
|
|
346
354
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -350,7 +358,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
350
358
|
var path = {
|
|
351
359
|
'id': _params.id
|
|
352
360
|
};
|
|
353
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
361
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'getSecretGroup');
|
|
354
362
|
var parameters = {
|
|
355
363
|
options: {
|
|
356
364
|
url: '/api/v1/secret_groups/{id}',
|
|
@@ -367,18 +375,18 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
367
375
|
};
|
|
368
376
|
;
|
|
369
377
|
/**
|
|
370
|
-
* Update secret group
|
|
378
|
+
* Update a secret group.
|
|
371
379
|
*
|
|
372
|
-
* Updates the metadata of
|
|
380
|
+
* Updates the metadata of an existing secret group, such as its name or description.
|
|
373
381
|
*
|
|
374
382
|
* @param {Object} params - The parameters to send to the service.
|
|
375
383
|
* @param {string} params.id - The v4 UUID that uniquely identifies the secret group.
|
|
376
384
|
* @param {CollectionMetadata} params.metadata - The metadata that describes the resource array.
|
|
377
385
|
* @param {SecretGroupMetadataUpdatable[]} params.resources - A collection of resources.
|
|
378
386
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
379
|
-
* @returns {Promise<
|
|
387
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.SecretGroupDef>>}
|
|
380
388
|
*/
|
|
381
|
-
|
|
389
|
+
SecretsManagerV1.prototype.updateSecretGroupMetadata = function (params) {
|
|
382
390
|
var _params = Object.assign({}, params);
|
|
383
391
|
var requiredParams = ['id', 'metadata', 'resources'];
|
|
384
392
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -392,7 +400,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
392
400
|
var path = {
|
|
393
401
|
'id': _params.id
|
|
394
402
|
};
|
|
395
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
403
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'updateSecretGroupMetadata');
|
|
396
404
|
var parameters = {
|
|
397
405
|
options: {
|
|
398
406
|
url: '/api/v1/secret_groups/{id}',
|
|
@@ -415,12 +423,15 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
415
423
|
*
|
|
416
424
|
* Deletes a secret group by specifying the ID of the secret group.
|
|
417
425
|
*
|
|
426
|
+
* **Note:** To delete a secret group, it must be empty. If you need to remove a secret group that contains secrets,
|
|
427
|
+
* you must first [delete the secrets](#delete-secret) that are associated with the group.
|
|
428
|
+
*
|
|
418
429
|
* @param {Object} params - The parameters to send to the service.
|
|
419
430
|
* @param {string} params.id - The v4 UUID that uniquely identifies the secret group.
|
|
420
431
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
421
|
-
* @returns {Promise<
|
|
432
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.Empty>>}
|
|
422
433
|
*/
|
|
423
|
-
|
|
434
|
+
SecretsManagerV1.prototype.deleteSecretGroup = function (params) {
|
|
424
435
|
var _params = Object.assign({}, params);
|
|
425
436
|
var requiredParams = ['id'];
|
|
426
437
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -430,7 +441,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
430
441
|
var path = {
|
|
431
442
|
'id': _params.id
|
|
432
443
|
};
|
|
433
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
444
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'deleteSecretGroup');
|
|
434
445
|
var parameters = {
|
|
435
446
|
options: {
|
|
436
447
|
url: '/api/v1/secret_groups/{id}',
|
|
@@ -438,9 +449,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
438
449
|
path: path,
|
|
439
450
|
},
|
|
440
451
|
defaultOptions: extend(true, {}, this.baseOptions, {
|
|
441
|
-
headers: extend(true, sdkHeaders, {
|
|
442
|
-
'Accept': 'application/json',
|
|
443
|
-
}, _params.headers),
|
|
452
|
+
headers: extend(true, sdkHeaders, {}, _params.headers),
|
|
444
453
|
}),
|
|
445
454
|
};
|
|
446
455
|
return this.createRequest(parameters);
|
|
@@ -450,18 +459,24 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
450
459
|
* secrets
|
|
451
460
|
************************/
|
|
452
461
|
/**
|
|
453
|
-
* Create secret.
|
|
462
|
+
* Create a secret.
|
|
463
|
+
*
|
|
464
|
+
* Creates a secret that you can use to access or authenticate to a protected resource.
|
|
465
|
+
*
|
|
466
|
+
* A successful request stores the secret in your dedicated instance based on the secret type and data that you
|
|
467
|
+
* specify. The response returns the ID value of the secret, along with other metadata.
|
|
454
468
|
*
|
|
455
|
-
*
|
|
469
|
+
* To learn more about the types of secrets that you can create with Secrets Manager, check out the
|
|
470
|
+
* [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-secret-basics).
|
|
456
471
|
*
|
|
457
472
|
* @param {Object} params - The parameters to send to the service.
|
|
458
473
|
* @param {string} params.secretType - The secret type.
|
|
459
474
|
* @param {CollectionMetadata} params.metadata - The metadata that describes the resource array.
|
|
460
475
|
* @param {SecretResource[]} params.resources - A collection of resources.
|
|
461
476
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
462
|
-
* @returns {Promise<
|
|
477
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.CreateSecret>>}
|
|
463
478
|
*/
|
|
464
|
-
|
|
479
|
+
SecretsManagerV1.prototype.createSecret = function (params) {
|
|
465
480
|
var _params = Object.assign({}, params);
|
|
466
481
|
var requiredParams = ['secretType', 'metadata', 'resources'];
|
|
467
482
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -475,7 +490,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
475
490
|
var path = {
|
|
476
491
|
'secret_type': _params.secretType
|
|
477
492
|
};
|
|
478
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
493
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'createSecret');
|
|
479
494
|
var parameters = {
|
|
480
495
|
options: {
|
|
481
496
|
url: '/api/v1/secrets/{secret_type}',
|
|
@@ -494,25 +509,27 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
494
509
|
};
|
|
495
510
|
;
|
|
496
511
|
/**
|
|
497
|
-
* List secrets
|
|
512
|
+
* List secrets by type.
|
|
498
513
|
*
|
|
499
|
-
* Retrieves a list of secrets
|
|
514
|
+
* Retrieves a list of secrets based on the type that you specify.
|
|
500
515
|
*
|
|
501
516
|
* @param {Object} params - The parameters to send to the service.
|
|
502
517
|
* @param {string} params.secretType - The secret type.
|
|
503
|
-
* @param {number} [params.limit] - The number of secrets to retrieve. By default,
|
|
504
|
-
*
|
|
505
|
-
*
|
|
518
|
+
* @param {number} [params.limit] - The number of secrets to retrieve. By default, list operations return the first
|
|
519
|
+
* 200 items. To retrieve a different set of items, use `limit` with `offset` to page through your available
|
|
520
|
+
* resources.
|
|
521
|
+
*
|
|
506
522
|
* **Usage:** If you have 20 secrets in your instance, and you want to retrieve only the first 5 secrets, use
|
|
507
523
|
* `../secrets/{secret-type}?limit=5`.
|
|
508
524
|
* @param {number} [params.offset] - The number of secrets to skip. By specifying `offset`, you retrieve a subset of
|
|
509
|
-
*
|
|
510
|
-
*
|
|
525
|
+
* items that starts with the `offset` value. Use `offset` with `limit` to page through your available resources.
|
|
526
|
+
*
|
|
527
|
+
* **Usage:** If you have 100 secrets in your instance, and you want to retrieve secrets 26 through 50, use
|
|
511
528
|
* `../secrets/{secret-type}?offset=25&limit=25`.
|
|
512
529
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
513
|
-
* @returns {Promise<
|
|
530
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.ListSecrets>>}
|
|
514
531
|
*/
|
|
515
|
-
|
|
532
|
+
SecretsManagerV1.prototype.listSecrets = function (params) {
|
|
516
533
|
var _params = Object.assign({}, params);
|
|
517
534
|
var requiredParams = ['secretType'];
|
|
518
535
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -526,7 +543,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
526
543
|
var path = {
|
|
527
544
|
'secret_type': _params.secretType
|
|
528
545
|
};
|
|
529
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
546
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'listSecrets');
|
|
530
547
|
var parameters = {
|
|
531
548
|
options: {
|
|
532
549
|
url: '/api/v1/secrets/{secret_type}',
|
|
@@ -544,30 +561,51 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
544
561
|
};
|
|
545
562
|
;
|
|
546
563
|
/**
|
|
547
|
-
* List
|
|
564
|
+
* List all secrets.
|
|
548
565
|
*
|
|
549
|
-
* Retrieves a list of secrets
|
|
566
|
+
* Retrieves a list of all secrets in your Secrets Manager instance.
|
|
550
567
|
*
|
|
551
568
|
* @param {Object} [params] - The parameters to send to the service.
|
|
552
|
-
* @param {number} [params.limit] - The number of secrets to retrieve. By default,
|
|
553
|
-
*
|
|
554
|
-
*
|
|
569
|
+
* @param {number} [params.limit] - The number of secrets to retrieve. By default, list operations return the first
|
|
570
|
+
* 200 items. To retrieve a different set of items, use `limit` with `offset` to page through your available
|
|
571
|
+
* resources.
|
|
572
|
+
*
|
|
555
573
|
* **Usage:** If you have 20 secrets in your instance, and you want to retrieve only the first 5 secrets, use
|
|
556
574
|
* `../secrets/{secret-type}?limit=5`.
|
|
557
575
|
* @param {number} [params.offset] - The number of secrets to skip. By specifying `offset`, you retrieve a subset of
|
|
558
|
-
*
|
|
559
|
-
*
|
|
576
|
+
* items that starts with the `offset` value. Use `offset` with `limit` to page through your available resources.
|
|
577
|
+
*
|
|
578
|
+
* **Usage:** If you have 100 secrets in your instance, and you want to retrieve secrets 26 through 50, use
|
|
560
579
|
* `../secrets/{secret-type}?offset=25&limit=25`.
|
|
580
|
+
* @param {string} [params.search] - Filter secrets that contain the specified string. The fields that are searched
|
|
581
|
+
* include: id, name, description, labels, secret_type.
|
|
582
|
+
*
|
|
583
|
+
* **Usage:** If you want to list only the secrets that contain the string "text", use
|
|
584
|
+
* `../secrets/{secret-type}?search=text`.
|
|
585
|
+
* @param {string} [params.sortBy] - Sort a list of secrets by the specified field.
|
|
586
|
+
*
|
|
587
|
+
* **Usage:** To sort a list of secrets by their creation date, use
|
|
588
|
+
* `../secrets/{secret-type}?sort_by=creation_date`.
|
|
589
|
+
* @param {string[]} [params.groups] - Filter secrets by groups.
|
|
590
|
+
*
|
|
591
|
+
* You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets
|
|
592
|
+
* that are in the default secret group, use the `default` keyword.
|
|
593
|
+
*
|
|
594
|
+
* **Usage:** To retrieve a list of secrets that are associated with an existing secret group or the default group,
|
|
595
|
+
* use `../secrets?groups={secret_group_ID},default`.
|
|
561
596
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
562
|
-
* @returns {Promise<
|
|
597
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.ListSecrets>>}
|
|
563
598
|
*/
|
|
564
|
-
|
|
599
|
+
SecretsManagerV1.prototype.listAllSecrets = function (params) {
|
|
565
600
|
var _params = Object.assign({}, params);
|
|
566
601
|
var query = {
|
|
567
602
|
'limit': _params.limit,
|
|
568
|
-
'offset': _params.offset
|
|
603
|
+
'offset': _params.offset,
|
|
604
|
+
'search': _params.search,
|
|
605
|
+
'sort_by': _params.sortBy,
|
|
606
|
+
'groups': _params.groups
|
|
569
607
|
};
|
|
570
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
608
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'listAllSecrets');
|
|
571
609
|
var parameters = {
|
|
572
610
|
options: {
|
|
573
611
|
url: '/api/v1/secrets',
|
|
@@ -584,17 +622,21 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
584
622
|
};
|
|
585
623
|
;
|
|
586
624
|
/**
|
|
587
|
-
*
|
|
625
|
+
* Get a secret.
|
|
588
626
|
*
|
|
589
627
|
* Retrieves a secret and its details by specifying the ID of the secret.
|
|
590
628
|
*
|
|
629
|
+
* A successful request returns the secret data that is associated with your secret, along with other metadata. To
|
|
630
|
+
* view only the details of a specified secret without retrieving its value, use the [Get secret
|
|
631
|
+
* metadata](#get-secret-metadata) method.
|
|
632
|
+
*
|
|
591
633
|
* @param {Object} params - The parameters to send to the service.
|
|
592
634
|
* @param {string} params.secretType - The secret type.
|
|
593
635
|
* @param {string} params.id - The v4 UUID that uniquely identifies the secret.
|
|
594
636
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
595
|
-
* @returns {Promise<
|
|
637
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.GetSecret>>}
|
|
596
638
|
*/
|
|
597
|
-
|
|
639
|
+
SecretsManagerV1.prototype.getSecret = function (params) {
|
|
598
640
|
var _params = Object.assign({}, params);
|
|
599
641
|
var requiredParams = ['secretType', 'id'];
|
|
600
642
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -605,7 +647,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
605
647
|
'secret_type': _params.secretType,
|
|
606
648
|
'id': _params.id
|
|
607
649
|
};
|
|
608
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
650
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'getSecret');
|
|
609
651
|
var parameters = {
|
|
610
652
|
options: {
|
|
611
653
|
url: '/api/v1/secrets/{secret_type}/{id}',
|
|
@@ -624,18 +666,20 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
624
666
|
/**
|
|
625
667
|
* Invoke an action on a secret.
|
|
626
668
|
*
|
|
627
|
-
* Invokes an action on a specified secret.
|
|
628
|
-
*
|
|
669
|
+
* Invokes an action on a specified secret. This method supports the following actions:
|
|
670
|
+
*
|
|
671
|
+
* - `rotate`: Replace the value of an `arbitrary` or `username_password` secret.
|
|
672
|
+
* - `delete_credentials`: Delete the API key that is associated with an `iam_credentials` secret.
|
|
629
673
|
*
|
|
630
674
|
* @param {Object} params - The parameters to send to the service.
|
|
631
675
|
* @param {string} params.secretType - The secret type.
|
|
632
676
|
* @param {string} params.id - The v4 UUID that uniquely identifies the secret.
|
|
633
677
|
* @param {string} params.action - The action to perform on the specified secret.
|
|
634
|
-
* @param {SecretActionOneOf} params.secretActionOneOf - The base request for invoking an action on a secret.
|
|
678
|
+
* @param {SecretActionOneOf} params.secretActionOneOf - The base request body for invoking an action on a secret.
|
|
635
679
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
636
|
-
* @returns {Promise<
|
|
680
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.GetSecret>>}
|
|
637
681
|
*/
|
|
638
|
-
|
|
682
|
+
SecretsManagerV1.prototype.updateSecret = function (params) {
|
|
639
683
|
var _params = Object.assign({}, params);
|
|
640
684
|
var requiredParams = ['secretType', 'id', 'action', 'secretActionOneOf'];
|
|
641
685
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -650,7 +694,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
650
694
|
'secret_type': _params.secretType,
|
|
651
695
|
'id': _params.id
|
|
652
696
|
};
|
|
653
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
697
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'updateSecret');
|
|
654
698
|
var parameters = {
|
|
655
699
|
options: {
|
|
656
700
|
url: '/api/v1/secrets/{secret_type}/{id}',
|
|
@@ -678,9 +722,9 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
678
722
|
* @param {string} params.secretType - The secret type.
|
|
679
723
|
* @param {string} params.id - The v4 UUID that uniquely identifies the secret.
|
|
680
724
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
681
|
-
* @returns {Promise<
|
|
725
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.Empty>>}
|
|
682
726
|
*/
|
|
683
|
-
|
|
727
|
+
SecretsManagerV1.prototype.deleteSecret = function (params) {
|
|
684
728
|
var _params = Object.assign({}, params);
|
|
685
729
|
var requiredParams = ['secretType', 'id'];
|
|
686
730
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -691,7 +735,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
691
735
|
'secret_type': _params.secretType,
|
|
692
736
|
'id': _params.id
|
|
693
737
|
};
|
|
694
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
738
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'deleteSecret');
|
|
695
739
|
var parameters = {
|
|
696
740
|
options: {
|
|
697
741
|
url: '/api/v1/secrets/{secret_type}/{id}',
|
|
@@ -706,17 +750,20 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
706
750
|
};
|
|
707
751
|
;
|
|
708
752
|
/**
|
|
709
|
-
*
|
|
753
|
+
* Get secret metadata.
|
|
710
754
|
*
|
|
711
|
-
* Retrieves the details of a secret by specifying the ID.
|
|
755
|
+
* Retrieves the details of a secret by specifying the ID.
|
|
756
|
+
*
|
|
757
|
+
* A successful request returns only metadata about the secret, such as its name and creation date. To retrieve the
|
|
758
|
+
* value of a secret, use the [Get a secret](#get-secret) method.
|
|
712
759
|
*
|
|
713
760
|
* @param {Object} params - The parameters to send to the service.
|
|
714
761
|
* @param {string} params.secretType - The secret type.
|
|
715
762
|
* @param {string} params.id - The v4 UUID that uniquely identifies the secret.
|
|
716
763
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
717
|
-
* @returns {Promise<
|
|
764
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.SecretMetadataRequest>>}
|
|
718
765
|
*/
|
|
719
|
-
|
|
766
|
+
SecretsManagerV1.prototype.getSecretMetadata = function (params) {
|
|
720
767
|
var _params = Object.assign({}, params);
|
|
721
768
|
var requiredParams = ['secretType', 'id'];
|
|
722
769
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -727,7 +774,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
727
774
|
'secret_type': _params.secretType,
|
|
728
775
|
'id': _params.id
|
|
729
776
|
};
|
|
730
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
777
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'getSecretMetadata');
|
|
731
778
|
var parameters = {
|
|
732
779
|
options: {
|
|
733
780
|
url: '/api/v1/secrets/{secret_type}/{id}/metadata',
|
|
@@ -746,7 +793,10 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
746
793
|
/**
|
|
747
794
|
* Update secret metadata.
|
|
748
795
|
*
|
|
749
|
-
* Updates the metadata of a secret
|
|
796
|
+
* Updates the metadata of a secret, such as its name or description.
|
|
797
|
+
*
|
|
798
|
+
* To update the actual contents of a secret, rotate the secret by using the [Invoke an action on a
|
|
799
|
+
* secret](#update-secret) method.
|
|
750
800
|
*
|
|
751
801
|
* @param {Object} params - The parameters to send to the service.
|
|
752
802
|
* @param {string} params.secretType - The secret type.
|
|
@@ -754,9 +804,9 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
754
804
|
* @param {CollectionMetadata} params.metadata - The metadata that describes the resource array.
|
|
755
805
|
* @param {SecretMetadata[]} params.resources - A collection of resources.
|
|
756
806
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
757
|
-
* @returns {Promise<
|
|
807
|
+
* @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.SecretMetadataRequest>>}
|
|
758
808
|
*/
|
|
759
|
-
|
|
809
|
+
SecretsManagerV1.prototype.updateSecretMetadata = function (params) {
|
|
760
810
|
var _params = Object.assign({}, params);
|
|
761
811
|
var requiredParams = ['secretType', 'id', 'metadata', 'resources'];
|
|
762
812
|
var missingParams = ibm_cloud_sdk_core_1.getMissingParams(_params, requiredParams);
|
|
@@ -771,7 +821,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
771
821
|
'secret_type': _params.secretType,
|
|
772
822
|
'id': _params.id
|
|
773
823
|
};
|
|
774
|
-
var sdkHeaders = common_1.getSdkHeaders(
|
|
824
|
+
var sdkHeaders = common_1.getSdkHeaders(SecretsManagerV1.DEFAULT_SERVICE_NAME, 'v1', 'updateSecretMetadata');
|
|
775
825
|
var parameters = {
|
|
776
826
|
options: {
|
|
777
827
|
url: '/api/v1/secrets/{secret_type}/{id}/metadata',
|
|
@@ -789,14 +839,14 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
789
839
|
return this.createRequest(parameters);
|
|
790
840
|
};
|
|
791
841
|
;
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
return
|
|
842
|
+
SecretsManagerV1.DEFAULT_SERVICE_URL = 'https://secrets-manager.cloud.ibm.com';
|
|
843
|
+
SecretsManagerV1.DEFAULT_SERVICE_NAME = 'secrets_manager';
|
|
844
|
+
return SecretsManagerV1;
|
|
795
845
|
}(ibm_cloud_sdk_core_1.BaseService));
|
|
796
846
|
/*************************
|
|
797
847
|
* interfaces
|
|
798
848
|
************************/
|
|
799
|
-
(function (
|
|
849
|
+
(function (SecretsManagerV1) {
|
|
800
850
|
/** Constants for the `putConfig` operation. */
|
|
801
851
|
var PutConfigConstants;
|
|
802
852
|
(function (PutConfigConstants) {
|
|
@@ -805,7 +855,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
805
855
|
(function (SecretType) {
|
|
806
856
|
SecretType["IAM_CREDENTIALS"] = "iam_credentials";
|
|
807
857
|
})(SecretType = PutConfigConstants.SecretType || (PutConfigConstants.SecretType = {}));
|
|
808
|
-
})(PutConfigConstants =
|
|
858
|
+
})(PutConfigConstants = SecretsManagerV1.PutConfigConstants || (SecretsManagerV1.PutConfigConstants = {}));
|
|
809
859
|
/** Constants for the `getConfig` operation. */
|
|
810
860
|
var GetConfigConstants;
|
|
811
861
|
(function (GetConfigConstants) {
|
|
@@ -814,7 +864,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
814
864
|
(function (SecretType) {
|
|
815
865
|
SecretType["IAM_CREDENTIALS"] = "iam_credentials";
|
|
816
866
|
})(SecretType = GetConfigConstants.SecretType || (GetConfigConstants.SecretType = {}));
|
|
817
|
-
})(GetConfigConstants =
|
|
867
|
+
})(GetConfigConstants = SecretsManagerV1.GetConfigConstants || (SecretsManagerV1.GetConfigConstants = {}));
|
|
818
868
|
/** Constants for the `putPolicy` operation. */
|
|
819
869
|
var PutPolicyConstants;
|
|
820
870
|
(function (PutPolicyConstants) {
|
|
@@ -828,7 +878,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
828
878
|
(function (Policy) {
|
|
829
879
|
Policy["ROTATION"] = "rotation";
|
|
830
880
|
})(Policy = PutPolicyConstants.Policy || (PutPolicyConstants.Policy = {}));
|
|
831
|
-
})(PutPolicyConstants =
|
|
881
|
+
})(PutPolicyConstants = SecretsManagerV1.PutPolicyConstants || (SecretsManagerV1.PutPolicyConstants = {}));
|
|
832
882
|
/** Constants for the `getPolicy` operation. */
|
|
833
883
|
var GetPolicyConstants;
|
|
834
884
|
(function (GetPolicyConstants) {
|
|
@@ -842,7 +892,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
842
892
|
(function (Policy) {
|
|
843
893
|
Policy["ROTATION"] = "rotation";
|
|
844
894
|
})(Policy = GetPolicyConstants.Policy || (GetPolicyConstants.Policy = {}));
|
|
845
|
-
})(GetPolicyConstants =
|
|
895
|
+
})(GetPolicyConstants = SecretsManagerV1.GetPolicyConstants || (SecretsManagerV1.GetPolicyConstants = {}));
|
|
846
896
|
/** Constants for the `createSecret` operation. */
|
|
847
897
|
var CreateSecretConstants;
|
|
848
898
|
(function (CreateSecretConstants) {
|
|
@@ -853,7 +903,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
853
903
|
SecretType["USERNAME_PASSWORD"] = "username_password";
|
|
854
904
|
SecretType["IAM_CREDENTIALS"] = "iam_credentials";
|
|
855
905
|
})(SecretType = CreateSecretConstants.SecretType || (CreateSecretConstants.SecretType = {}));
|
|
856
|
-
})(CreateSecretConstants =
|
|
906
|
+
})(CreateSecretConstants = SecretsManagerV1.CreateSecretConstants || (SecretsManagerV1.CreateSecretConstants = {}));
|
|
857
907
|
/** Constants for the `listSecrets` operation. */
|
|
858
908
|
var ListSecretsConstants;
|
|
859
909
|
(function (ListSecretsConstants) {
|
|
@@ -864,7 +914,20 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
864
914
|
SecretType["USERNAME_PASSWORD"] = "username_password";
|
|
865
915
|
SecretType["IAM_CREDENTIALS"] = "iam_credentials";
|
|
866
916
|
})(SecretType = ListSecretsConstants.SecretType || (ListSecretsConstants.SecretType = {}));
|
|
867
|
-
})(ListSecretsConstants =
|
|
917
|
+
})(ListSecretsConstants = SecretsManagerV1.ListSecretsConstants || (SecretsManagerV1.ListSecretsConstants = {}));
|
|
918
|
+
/** Constants for the `listAllSecrets` operation. */
|
|
919
|
+
var ListAllSecretsConstants;
|
|
920
|
+
(function (ListAllSecretsConstants) {
|
|
921
|
+
/** Sort a list of secrets by the specified field. **Usage:** To sort a list of secrets by their creation date, use `../secrets/{secret-type}?sort_by=creation_date`. */
|
|
922
|
+
var SortBy;
|
|
923
|
+
(function (SortBy) {
|
|
924
|
+
SortBy["ID"] = "id";
|
|
925
|
+
SortBy["CREATION_DATE"] = "creation_date";
|
|
926
|
+
SortBy["EXPIRATION_DATE"] = "expiration_date";
|
|
927
|
+
SortBy["SECRET_TYPE"] = "secret_type";
|
|
928
|
+
SortBy["NAME"] = "name";
|
|
929
|
+
})(SortBy = ListAllSecretsConstants.SortBy || (ListAllSecretsConstants.SortBy = {}));
|
|
930
|
+
})(ListAllSecretsConstants = SecretsManagerV1.ListAllSecretsConstants || (SecretsManagerV1.ListAllSecretsConstants = {}));
|
|
868
931
|
/** Constants for the `getSecret` operation. */
|
|
869
932
|
var GetSecretConstants;
|
|
870
933
|
(function (GetSecretConstants) {
|
|
@@ -875,7 +938,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
875
938
|
SecretType["USERNAME_PASSWORD"] = "username_password";
|
|
876
939
|
SecretType["IAM_CREDENTIALS"] = "iam_credentials";
|
|
877
940
|
})(SecretType = GetSecretConstants.SecretType || (GetSecretConstants.SecretType = {}));
|
|
878
|
-
})(GetSecretConstants =
|
|
941
|
+
})(GetSecretConstants = SecretsManagerV1.GetSecretConstants || (SecretsManagerV1.GetSecretConstants = {}));
|
|
879
942
|
/** Constants for the `updateSecret` operation. */
|
|
880
943
|
var UpdateSecretConstants;
|
|
881
944
|
(function (UpdateSecretConstants) {
|
|
@@ -892,7 +955,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
892
955
|
Action["ROTATE"] = "rotate";
|
|
893
956
|
Action["DELETE_CREDENTIALS"] = "delete_credentials";
|
|
894
957
|
})(Action = UpdateSecretConstants.Action || (UpdateSecretConstants.Action = {}));
|
|
895
|
-
})(UpdateSecretConstants =
|
|
958
|
+
})(UpdateSecretConstants = SecretsManagerV1.UpdateSecretConstants || (SecretsManagerV1.UpdateSecretConstants = {}));
|
|
896
959
|
/** Constants for the `deleteSecret` operation. */
|
|
897
960
|
var DeleteSecretConstants;
|
|
898
961
|
(function (DeleteSecretConstants) {
|
|
@@ -903,7 +966,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
903
966
|
SecretType["USERNAME_PASSWORD"] = "username_password";
|
|
904
967
|
SecretType["IAM_CREDENTIALS"] = "iam_credentials";
|
|
905
968
|
})(SecretType = DeleteSecretConstants.SecretType || (DeleteSecretConstants.SecretType = {}));
|
|
906
|
-
})(DeleteSecretConstants =
|
|
969
|
+
})(DeleteSecretConstants = SecretsManagerV1.DeleteSecretConstants || (SecretsManagerV1.DeleteSecretConstants = {}));
|
|
907
970
|
/** Constants for the `getSecretMetadata` operation. */
|
|
908
971
|
var GetSecretMetadataConstants;
|
|
909
972
|
(function (GetSecretMetadataConstants) {
|
|
@@ -914,7 +977,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
914
977
|
SecretType["USERNAME_PASSWORD"] = "username_password";
|
|
915
978
|
SecretType["IAM_CREDENTIALS"] = "iam_credentials";
|
|
916
979
|
})(SecretType = GetSecretMetadataConstants.SecretType || (GetSecretMetadataConstants.SecretType = {}));
|
|
917
|
-
})(GetSecretMetadataConstants =
|
|
980
|
+
})(GetSecretMetadataConstants = SecretsManagerV1.GetSecretMetadataConstants || (SecretsManagerV1.GetSecretMetadataConstants = {}));
|
|
918
981
|
/** Constants for the `updateSecretMetadata` operation. */
|
|
919
982
|
var UpdateSecretMetadataConstants;
|
|
920
983
|
(function (UpdateSecretMetadataConstants) {
|
|
@@ -925,7 +988,7 @@ var IbmCloudSecretsManagerApiV1 = /** @class */ (function (_super) {
|
|
|
925
988
|
SecretType["USERNAME_PASSWORD"] = "username_password";
|
|
926
989
|
SecretType["IAM_CREDENTIALS"] = "iam_credentials";
|
|
927
990
|
})(SecretType = UpdateSecretMetadataConstants.SecretType || (UpdateSecretMetadataConstants.SecretType = {}));
|
|
928
|
-
})(UpdateSecretMetadataConstants =
|
|
929
|
-
})(
|
|
930
|
-
module.exports =
|
|
991
|
+
})(UpdateSecretMetadataConstants = SecretsManagerV1.UpdateSecretMetadataConstants || (SecretsManagerV1.UpdateSecretMetadataConstants = {}));
|
|
992
|
+
})(SecretsManagerV1 || (SecretsManagerV1 = {}));
|
|
993
|
+
module.exports = SecretsManagerV1;
|
|
931
994
|
//# sourceMappingURL=v1.js.map
|