sailpoint-api-client 1.6.9 → 1.7.0
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/beta/README.md +2 -2
- package/beta/api.ts +264 -550
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +248 -392
- package/dist/beta/api.js +104 -416
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.js +6 -3
- package/dist/index.js.map +1 -1
- package/dist/index.spec.js +18 -0
- package/dist/index.spec.js.map +1 -1
- package/dist/v2024/api.d.ts +123 -361
- package/dist/v2024/api.js +93 -410
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v2025/api.d.ts +1643 -412
- package/dist/v2025/api.js +2844 -1167
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +1 -1
- package/dist/v2026/api.d.ts +810 -0
- package/dist/v2026/api.js +792 -0
- package/dist/v2026/api.js.map +1 -0
- package/dist/v2026/base.d.ts +66 -0
- package/dist/v2026/base.js +89 -0
- package/dist/v2026/base.js.map +1 -0
- package/dist/v2026/common.d.ts +65 -0
- package/dist/v2026/common.js +266 -0
- package/dist/v2026/common.js.map +1 -0
- package/dist/v2026/configuration.d.ts +91 -0
- package/dist/v2026/configuration.js +46 -0
- package/dist/v2026/configuration.js.map +1 -0
- package/dist/v2026/index.d.ts +13 -0
- package/dist/v2026/index.js +32 -0
- package/dist/v2026/index.js.map +1 -0
- package/dist/v3/api.d.ts +85 -365
- package/dist/v3/api.js +67 -383
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +1 -1
- package/index.spec.ts +11 -1
- package/index.ts +3 -0
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/api.ts +134 -517
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +2816 -770
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v2026/.openapi-generator/FILES +12 -0
- package/v2026/.openapi-generator/VERSION +1 -0
- package/v2026/.openapi-generator-ignore +23 -0
- package/v2026/README.md +46 -0
- package/v2026/api.ts +1180 -0
- package/v2026/base.ts +86 -0
- package/v2026/common.ts +165 -0
- package/v2026/configuration.ts +110 -0
- package/v2026/git_push.sh +57 -0
- package/v2026/index.ts +18 -0
- package/v2026/package.json +34 -0
- package/v2026/tsconfig.json +21 -0
- package/v3/README.md +2 -2
- package/v3/api.ts +93 -518
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
|
@@ -0,0 +1,792 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Identity Security Cloud v2026 API
|
|
6
|
+
* Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v2026
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __extends = (this && this.__extends) || (function () {
|
|
16
|
+
var extendStatics = function (d, b) {
|
|
17
|
+
extendStatics = Object.setPrototypeOf ||
|
|
18
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
19
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
20
|
+
return extendStatics(d, b);
|
|
21
|
+
};
|
|
22
|
+
return function (d, b) {
|
|
23
|
+
if (typeof b !== "function" && b !== null)
|
|
24
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
25
|
+
extendStatics(d, b);
|
|
26
|
+
function __() { this.constructor = d; }
|
|
27
|
+
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
28
|
+
};
|
|
29
|
+
})();
|
|
30
|
+
var __assign = (this && this.__assign) || function () {
|
|
31
|
+
__assign = Object.assign || function(t) {
|
|
32
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
33
|
+
s = arguments[i];
|
|
34
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
35
|
+
t[p] = s[p];
|
|
36
|
+
}
|
|
37
|
+
return t;
|
|
38
|
+
};
|
|
39
|
+
return __assign.apply(this, arguments);
|
|
40
|
+
};
|
|
41
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
42
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
43
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
44
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
45
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
46
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
47
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
48
|
+
});
|
|
49
|
+
};
|
|
50
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
51
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
52
|
+
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
53
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
54
|
+
function step(op) {
|
|
55
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
56
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
57
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
58
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
59
|
+
switch (op[0]) {
|
|
60
|
+
case 0: case 1: t = op; break;
|
|
61
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
62
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
63
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
64
|
+
default:
|
|
65
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
66
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
67
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
68
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
69
|
+
if (t[2]) _.ops.pop();
|
|
70
|
+
_.trys.pop(); continue;
|
|
71
|
+
}
|
|
72
|
+
op = body.call(thisArg, _);
|
|
73
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
74
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
75
|
+
}
|
|
76
|
+
};
|
|
77
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
78
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
79
|
+
};
|
|
80
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
81
|
+
exports.TaskManagementV2026Api = exports.TaskManagementV2026ApiFactory = exports.TaskManagementV2026ApiFp = exports.TaskManagementV2026ApiAxiosParamCreator = exports.TaskStatusV2026CompletionStatusV2026 = exports.TaskStatusV2026TypeV2026 = exports.TaskStatusMessageV2026TypeV2026 = exports.TargetV2026TypeV2026 = exports.LocaleOriginV2026 = exports.JsonPatchOperationV2026OpV2026 = void 0;
|
|
82
|
+
var axios_1 = __importDefault(require("axios"));
|
|
83
|
+
// Some imports not used depending on template conditions
|
|
84
|
+
// @ts-ignore
|
|
85
|
+
var common_1 = require("./common");
|
|
86
|
+
// @ts-ignore
|
|
87
|
+
var base_1 = require("./base");
|
|
88
|
+
exports.JsonPatchOperationV2026OpV2026 = {
|
|
89
|
+
Add: 'add',
|
|
90
|
+
Remove: 'remove',
|
|
91
|
+
Replace: 'replace',
|
|
92
|
+
Move: 'move',
|
|
93
|
+
Copy: 'copy',
|
|
94
|
+
Test: 'test'
|
|
95
|
+
};
|
|
96
|
+
/**
|
|
97
|
+
* An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.
|
|
98
|
+
* @export
|
|
99
|
+
* @enum {string}
|
|
100
|
+
*/
|
|
101
|
+
exports.LocaleOriginV2026 = {
|
|
102
|
+
Default: 'DEFAULT',
|
|
103
|
+
Request: 'REQUEST'
|
|
104
|
+
};
|
|
105
|
+
exports.TargetV2026TypeV2026 = {
|
|
106
|
+
Application: 'APPLICATION',
|
|
107
|
+
Identity: 'IDENTITY'
|
|
108
|
+
};
|
|
109
|
+
exports.TaskStatusMessageV2026TypeV2026 = {
|
|
110
|
+
Info: 'INFO',
|
|
111
|
+
Warn: 'WARN',
|
|
112
|
+
Error: 'ERROR'
|
|
113
|
+
};
|
|
114
|
+
exports.TaskStatusV2026TypeV2026 = {
|
|
115
|
+
Quartz: 'QUARTZ',
|
|
116
|
+
Qpoc: 'QPOC',
|
|
117
|
+
QueuedTask: 'QUEUED_TASK'
|
|
118
|
+
};
|
|
119
|
+
exports.TaskStatusV2026CompletionStatusV2026 = {
|
|
120
|
+
Success: 'SUCCESS',
|
|
121
|
+
Warning: 'WARNING',
|
|
122
|
+
Error: 'ERROR',
|
|
123
|
+
Terminated: 'TERMINATED',
|
|
124
|
+
Temperror: 'TEMPERROR'
|
|
125
|
+
};
|
|
126
|
+
/**
|
|
127
|
+
* TaskManagementV2026Api - axios parameter creator
|
|
128
|
+
* @export
|
|
129
|
+
*/
|
|
130
|
+
var TaskManagementV2026ApiAxiosParamCreator = function (configuration) {
|
|
131
|
+
var _this = this;
|
|
132
|
+
return {
|
|
133
|
+
/**
|
|
134
|
+
* Responds with headers only for list of task statuses for pending tasks.
|
|
135
|
+
* @summary Retrieve pending task list headers
|
|
136
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
137
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
138
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
139
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
140
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
141
|
+
* @throws {RequiredError}
|
|
142
|
+
*/
|
|
143
|
+
getPendingTaskHeaders: function (offset, limit, count, xSailPointExperimental, axiosOptions) {
|
|
144
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
145
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
146
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
147
|
+
return __generator(this, function (_a) {
|
|
148
|
+
switch (_a.label) {
|
|
149
|
+
case 0:
|
|
150
|
+
if (xSailPointExperimental === undefined) {
|
|
151
|
+
xSailPointExperimental = 'true';
|
|
152
|
+
}
|
|
153
|
+
localVarPath = "/task-status/pending-tasks";
|
|
154
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
155
|
+
if (configuration) {
|
|
156
|
+
baseOptions = configuration.baseOptions;
|
|
157
|
+
}
|
|
158
|
+
localVarRequestOptions = __assign(__assign({ method: 'HEAD' }, baseOptions), axiosOptions);
|
|
159
|
+
localVarHeaderParameter = {};
|
|
160
|
+
localVarQueryParameter = {};
|
|
161
|
+
// authentication userAuth required
|
|
162
|
+
// oauth required
|
|
163
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [], configuration)
|
|
164
|
+
// authentication userAuth required
|
|
165
|
+
// oauth required
|
|
166
|
+
];
|
|
167
|
+
case 1:
|
|
168
|
+
// authentication userAuth required
|
|
169
|
+
// oauth required
|
|
170
|
+
_a.sent();
|
|
171
|
+
// authentication userAuth required
|
|
172
|
+
// oauth required
|
|
173
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [], configuration)
|
|
174
|
+
// authentication applicationAuth required
|
|
175
|
+
// oauth required
|
|
176
|
+
];
|
|
177
|
+
case 2:
|
|
178
|
+
// authentication userAuth required
|
|
179
|
+
// oauth required
|
|
180
|
+
_a.sent();
|
|
181
|
+
// authentication applicationAuth required
|
|
182
|
+
// oauth required
|
|
183
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "applicationAuth", [], configuration)];
|
|
184
|
+
case 3:
|
|
185
|
+
// authentication applicationAuth required
|
|
186
|
+
// oauth required
|
|
187
|
+
_a.sent();
|
|
188
|
+
if (offset !== undefined) {
|
|
189
|
+
localVarQueryParameter['offset'] = offset;
|
|
190
|
+
}
|
|
191
|
+
if (limit !== undefined) {
|
|
192
|
+
localVarQueryParameter['limit'] = limit;
|
|
193
|
+
}
|
|
194
|
+
if (count !== undefined) {
|
|
195
|
+
localVarQueryParameter['count'] = count;
|
|
196
|
+
}
|
|
197
|
+
if (xSailPointExperimental != null) {
|
|
198
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
199
|
+
}
|
|
200
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
201
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
202
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
203
|
+
return [2 /*return*/, {
|
|
204
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
205
|
+
axiosOptions: localVarRequestOptions,
|
|
206
|
+
}];
|
|
207
|
+
}
|
|
208
|
+
});
|
|
209
|
+
});
|
|
210
|
+
},
|
|
211
|
+
/**
|
|
212
|
+
* Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. Possible tasks to be returned: Cloud Account Aggregation, Cloud Group Aggregation, Cloud Process Uncorrelated Accounts, Cloud Refresh Role, Source Application Discovery, AI Agent Aggregation, Cloud Entitlement Import, Cloud Uncorrelated Refresh, Cloud Identity Aggregation, Cloud Attribute Synchronization, Identity Refresh
|
|
213
|
+
* @summary Retrieve pending task status list
|
|
214
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
215
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
216
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
217
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
218
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
219
|
+
* @throws {RequiredError}
|
|
220
|
+
*/
|
|
221
|
+
getPendingTasks: function (offset, limit, count, xSailPointExperimental, axiosOptions) {
|
|
222
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
223
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
224
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
225
|
+
return __generator(this, function (_a) {
|
|
226
|
+
switch (_a.label) {
|
|
227
|
+
case 0:
|
|
228
|
+
if (xSailPointExperimental === undefined) {
|
|
229
|
+
xSailPointExperimental = 'true';
|
|
230
|
+
}
|
|
231
|
+
localVarPath = "/task-status/pending-tasks";
|
|
232
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
233
|
+
if (configuration) {
|
|
234
|
+
baseOptions = configuration.baseOptions;
|
|
235
|
+
}
|
|
236
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
237
|
+
localVarHeaderParameter = {};
|
|
238
|
+
localVarQueryParameter = {};
|
|
239
|
+
// authentication userAuth required
|
|
240
|
+
// oauth required
|
|
241
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [], configuration)
|
|
242
|
+
// authentication userAuth required
|
|
243
|
+
// oauth required
|
|
244
|
+
];
|
|
245
|
+
case 1:
|
|
246
|
+
// authentication userAuth required
|
|
247
|
+
// oauth required
|
|
248
|
+
_a.sent();
|
|
249
|
+
// authentication userAuth required
|
|
250
|
+
// oauth required
|
|
251
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [], configuration)
|
|
252
|
+
// authentication applicationAuth required
|
|
253
|
+
// oauth required
|
|
254
|
+
];
|
|
255
|
+
case 2:
|
|
256
|
+
// authentication userAuth required
|
|
257
|
+
// oauth required
|
|
258
|
+
_a.sent();
|
|
259
|
+
// authentication applicationAuth required
|
|
260
|
+
// oauth required
|
|
261
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "applicationAuth", [], configuration)];
|
|
262
|
+
case 3:
|
|
263
|
+
// authentication applicationAuth required
|
|
264
|
+
// oauth required
|
|
265
|
+
_a.sent();
|
|
266
|
+
if (offset !== undefined) {
|
|
267
|
+
localVarQueryParameter['offset'] = offset;
|
|
268
|
+
}
|
|
269
|
+
if (limit !== undefined) {
|
|
270
|
+
localVarQueryParameter['limit'] = limit;
|
|
271
|
+
}
|
|
272
|
+
if (count !== undefined) {
|
|
273
|
+
localVarQueryParameter['count'] = count;
|
|
274
|
+
}
|
|
275
|
+
if (xSailPointExperimental != null) {
|
|
276
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
277
|
+
}
|
|
278
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
279
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
280
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
281
|
+
return [2 /*return*/, {
|
|
282
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
283
|
+
axiosOptions: localVarRequestOptions,
|
|
284
|
+
}];
|
|
285
|
+
}
|
|
286
|
+
});
|
|
287
|
+
});
|
|
288
|
+
},
|
|
289
|
+
/**
|
|
290
|
+
* Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
291
|
+
* @summary Get task status by id
|
|
292
|
+
* @param {string} id Task ID.
|
|
293
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
294
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
295
|
+
* @throws {RequiredError}
|
|
296
|
+
*/
|
|
297
|
+
getTaskStatus: function (id, xSailPointExperimental, axiosOptions) {
|
|
298
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
299
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
300
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
301
|
+
return __generator(this, function (_a) {
|
|
302
|
+
switch (_a.label) {
|
|
303
|
+
case 0:
|
|
304
|
+
// verify required parameter 'id' is not null or undefined
|
|
305
|
+
(0, common_1.assertParamExists)('getTaskStatus', 'id', id);
|
|
306
|
+
if (xSailPointExperimental === undefined) {
|
|
307
|
+
xSailPointExperimental = 'true';
|
|
308
|
+
}
|
|
309
|
+
localVarPath = "/task-status/{id}"
|
|
310
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
311
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
312
|
+
if (configuration) {
|
|
313
|
+
baseOptions = configuration.baseOptions;
|
|
314
|
+
}
|
|
315
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
316
|
+
localVarHeaderParameter = {};
|
|
317
|
+
localVarQueryParameter = {};
|
|
318
|
+
// authentication userAuth required
|
|
319
|
+
// oauth required
|
|
320
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [], configuration)
|
|
321
|
+
// authentication userAuth required
|
|
322
|
+
// oauth required
|
|
323
|
+
];
|
|
324
|
+
case 1:
|
|
325
|
+
// authentication userAuth required
|
|
326
|
+
// oauth required
|
|
327
|
+
_a.sent();
|
|
328
|
+
// authentication userAuth required
|
|
329
|
+
// oauth required
|
|
330
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [], configuration)
|
|
331
|
+
// authentication applicationAuth required
|
|
332
|
+
// oauth required
|
|
333
|
+
];
|
|
334
|
+
case 2:
|
|
335
|
+
// authentication userAuth required
|
|
336
|
+
// oauth required
|
|
337
|
+
_a.sent();
|
|
338
|
+
// authentication applicationAuth required
|
|
339
|
+
// oauth required
|
|
340
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "applicationAuth", [], configuration)];
|
|
341
|
+
case 3:
|
|
342
|
+
// authentication applicationAuth required
|
|
343
|
+
// oauth required
|
|
344
|
+
_a.sent();
|
|
345
|
+
if (xSailPointExperimental != null) {
|
|
346
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
347
|
+
}
|
|
348
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
349
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
350
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
351
|
+
return [2 /*return*/, {
|
|
352
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
353
|
+
axiosOptions: localVarRequestOptions,
|
|
354
|
+
}];
|
|
355
|
+
}
|
|
356
|
+
});
|
|
357
|
+
});
|
|
358
|
+
},
|
|
359
|
+
/**
|
|
360
|
+
* Use this endpoint to get a list of statuses for **all** tasks which include finished, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for only **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. Possible tasks to be returned: Cloud Account Aggregation, Cloud Group Aggregation, Cloud Process Uncorrelated Accounts, Cloud Refresh Role, Source Application Discovery, AI Agent Aggregation, Cloud Entitlement Import, Cloud Uncorrelated Refresh, Cloud Identity Aggregation, Cloud Attribute Synchronization, Identity Refresh
|
|
361
|
+
* @summary Retrieve task status list
|
|
362
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
363
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
364
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
365
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in*
|
|
366
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created**
|
|
367
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
368
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
369
|
+
* @throws {RequiredError}
|
|
370
|
+
*/
|
|
371
|
+
getTaskStatusList: function (limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions) {
|
|
372
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
373
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
374
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
375
|
+
return __generator(this, function (_a) {
|
|
376
|
+
switch (_a.label) {
|
|
377
|
+
case 0:
|
|
378
|
+
if (xSailPointExperimental === undefined) {
|
|
379
|
+
xSailPointExperimental = 'true';
|
|
380
|
+
}
|
|
381
|
+
localVarPath = "/task-status";
|
|
382
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
383
|
+
if (configuration) {
|
|
384
|
+
baseOptions = configuration.baseOptions;
|
|
385
|
+
}
|
|
386
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
387
|
+
localVarHeaderParameter = {};
|
|
388
|
+
localVarQueryParameter = {};
|
|
389
|
+
// authentication userAuth required
|
|
390
|
+
// oauth required
|
|
391
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [], configuration)
|
|
392
|
+
// authentication userAuth required
|
|
393
|
+
// oauth required
|
|
394
|
+
];
|
|
395
|
+
case 1:
|
|
396
|
+
// authentication userAuth required
|
|
397
|
+
// oauth required
|
|
398
|
+
_a.sent();
|
|
399
|
+
// authentication userAuth required
|
|
400
|
+
// oauth required
|
|
401
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [], configuration)
|
|
402
|
+
// authentication applicationAuth required
|
|
403
|
+
// oauth required
|
|
404
|
+
];
|
|
405
|
+
case 2:
|
|
406
|
+
// authentication userAuth required
|
|
407
|
+
// oauth required
|
|
408
|
+
_a.sent();
|
|
409
|
+
// authentication applicationAuth required
|
|
410
|
+
// oauth required
|
|
411
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "applicationAuth", [], configuration)];
|
|
412
|
+
case 3:
|
|
413
|
+
// authentication applicationAuth required
|
|
414
|
+
// oauth required
|
|
415
|
+
_a.sent();
|
|
416
|
+
if (limit !== undefined) {
|
|
417
|
+
localVarQueryParameter['limit'] = limit;
|
|
418
|
+
}
|
|
419
|
+
if (offset !== undefined) {
|
|
420
|
+
localVarQueryParameter['offset'] = offset;
|
|
421
|
+
}
|
|
422
|
+
if (count !== undefined) {
|
|
423
|
+
localVarQueryParameter['count'] = count;
|
|
424
|
+
}
|
|
425
|
+
if (filters !== undefined) {
|
|
426
|
+
localVarQueryParameter['filters'] = filters;
|
|
427
|
+
}
|
|
428
|
+
if (sorters !== undefined) {
|
|
429
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
430
|
+
}
|
|
431
|
+
if (xSailPointExperimental != null) {
|
|
432
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
433
|
+
}
|
|
434
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
435
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
436
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
437
|
+
return [2 /*return*/, {
|
|
438
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
439
|
+
axiosOptions: localVarRequestOptions,
|
|
440
|
+
}];
|
|
441
|
+
}
|
|
442
|
+
});
|
|
443
|
+
});
|
|
444
|
+
},
|
|
445
|
+
/**
|
|
446
|
+
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
447
|
+
* @summary Update task status by id
|
|
448
|
+
* @param {string} id Task ID.
|
|
449
|
+
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
450
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
451
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
452
|
+
* @throws {RequiredError}
|
|
453
|
+
*/
|
|
454
|
+
updateTaskStatus: function (id, jsonPatchOperationV2026, xSailPointExperimental, axiosOptions) {
|
|
455
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
456
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
457
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
458
|
+
return __generator(this, function (_a) {
|
|
459
|
+
switch (_a.label) {
|
|
460
|
+
case 0:
|
|
461
|
+
// verify required parameter 'id' is not null or undefined
|
|
462
|
+
(0, common_1.assertParamExists)('updateTaskStatus', 'id', id);
|
|
463
|
+
// verify required parameter 'jsonPatchOperationV2026' is not null or undefined
|
|
464
|
+
(0, common_1.assertParamExists)('updateTaskStatus', 'jsonPatchOperationV2026', jsonPatchOperationV2026);
|
|
465
|
+
if (xSailPointExperimental === undefined) {
|
|
466
|
+
xSailPointExperimental = 'true';
|
|
467
|
+
}
|
|
468
|
+
localVarPath = "/task-status/{id}"
|
|
469
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
470
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
471
|
+
if (configuration) {
|
|
472
|
+
baseOptions = configuration.baseOptions;
|
|
473
|
+
}
|
|
474
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), axiosOptions);
|
|
475
|
+
localVarHeaderParameter = {};
|
|
476
|
+
localVarQueryParameter = {};
|
|
477
|
+
// authentication userAuth required
|
|
478
|
+
// oauth required
|
|
479
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [], configuration)
|
|
480
|
+
// authentication userAuth required
|
|
481
|
+
// oauth required
|
|
482
|
+
];
|
|
483
|
+
case 1:
|
|
484
|
+
// authentication userAuth required
|
|
485
|
+
// oauth required
|
|
486
|
+
_a.sent();
|
|
487
|
+
// authentication userAuth required
|
|
488
|
+
// oauth required
|
|
489
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [], configuration)];
|
|
490
|
+
case 2:
|
|
491
|
+
// authentication userAuth required
|
|
492
|
+
// oauth required
|
|
493
|
+
_a.sent();
|
|
494
|
+
localVarHeaderParameter['Content-Type'] = 'application/json-patch+json';
|
|
495
|
+
if (xSailPointExperimental != null) {
|
|
496
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
497
|
+
}
|
|
498
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
499
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
500
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
501
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(jsonPatchOperationV2026, localVarRequestOptions, configuration);
|
|
502
|
+
return [2 /*return*/, {
|
|
503
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
504
|
+
axiosOptions: localVarRequestOptions,
|
|
505
|
+
}];
|
|
506
|
+
}
|
|
507
|
+
});
|
|
508
|
+
});
|
|
509
|
+
},
|
|
510
|
+
};
|
|
511
|
+
};
|
|
512
|
+
exports.TaskManagementV2026ApiAxiosParamCreator = TaskManagementV2026ApiAxiosParamCreator;
|
|
513
|
+
/**
|
|
514
|
+
* TaskManagementV2026Api - functional programming interface
|
|
515
|
+
* @export
|
|
516
|
+
*/
|
|
517
|
+
var TaskManagementV2026ApiFp = function (configuration) {
|
|
518
|
+
var localVarAxiosParamCreator = (0, exports.TaskManagementV2026ApiAxiosParamCreator)(configuration);
|
|
519
|
+
return {
|
|
520
|
+
/**
|
|
521
|
+
* Responds with headers only for list of task statuses for pending tasks.
|
|
522
|
+
* @summary Retrieve pending task list headers
|
|
523
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
524
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
525
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
526
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
527
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
528
|
+
* @throws {RequiredError}
|
|
529
|
+
*/
|
|
530
|
+
getPendingTaskHeaders: function (offset, limit, count, xSailPointExperimental, axiosOptions) {
|
|
531
|
+
var _a, _b, _c;
|
|
532
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
533
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
534
|
+
return __generator(this, function (_d) {
|
|
535
|
+
switch (_d.label) {
|
|
536
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPendingTaskHeaders(offset, limit, count, xSailPointExperimental, axiosOptions)];
|
|
537
|
+
case 1:
|
|
538
|
+
localVarAxiosArgs = _d.sent();
|
|
539
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
540
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['TaskManagementV2026Api.getPendingTaskHeaders']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
541
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
542
|
+
}
|
|
543
|
+
});
|
|
544
|
+
});
|
|
545
|
+
},
|
|
546
|
+
/**
|
|
547
|
+
* Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. Possible tasks to be returned: Cloud Account Aggregation, Cloud Group Aggregation, Cloud Process Uncorrelated Accounts, Cloud Refresh Role, Source Application Discovery, AI Agent Aggregation, Cloud Entitlement Import, Cloud Uncorrelated Refresh, Cloud Identity Aggregation, Cloud Attribute Synchronization, Identity Refresh
|
|
548
|
+
* @summary Retrieve pending task status list
|
|
549
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
550
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
551
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
552
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
553
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
554
|
+
* @throws {RequiredError}
|
|
555
|
+
*/
|
|
556
|
+
getPendingTasks: function (offset, limit, count, xSailPointExperimental, axiosOptions) {
|
|
557
|
+
var _a, _b, _c;
|
|
558
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
559
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
560
|
+
return __generator(this, function (_d) {
|
|
561
|
+
switch (_d.label) {
|
|
562
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPendingTasks(offset, limit, count, xSailPointExperimental, axiosOptions)];
|
|
563
|
+
case 1:
|
|
564
|
+
localVarAxiosArgs = _d.sent();
|
|
565
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
566
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['TaskManagementV2026Api.getPendingTasks']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
567
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
568
|
+
}
|
|
569
|
+
});
|
|
570
|
+
});
|
|
571
|
+
},
|
|
572
|
+
/**
|
|
573
|
+
* Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
574
|
+
* @summary Get task status by id
|
|
575
|
+
* @param {string} id Task ID.
|
|
576
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
577
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
578
|
+
* @throws {RequiredError}
|
|
579
|
+
*/
|
|
580
|
+
getTaskStatus: function (id, xSailPointExperimental, axiosOptions) {
|
|
581
|
+
var _a, _b, _c;
|
|
582
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
583
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
584
|
+
return __generator(this, function (_d) {
|
|
585
|
+
switch (_d.label) {
|
|
586
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getTaskStatus(id, xSailPointExperimental, axiosOptions)];
|
|
587
|
+
case 1:
|
|
588
|
+
localVarAxiosArgs = _d.sent();
|
|
589
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
590
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['TaskManagementV2026Api.getTaskStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
591
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
592
|
+
}
|
|
593
|
+
});
|
|
594
|
+
});
|
|
595
|
+
},
|
|
596
|
+
/**
|
|
597
|
+
* Use this endpoint to get a list of statuses for **all** tasks which include finished, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for only **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. Possible tasks to be returned: Cloud Account Aggregation, Cloud Group Aggregation, Cloud Process Uncorrelated Accounts, Cloud Refresh Role, Source Application Discovery, AI Agent Aggregation, Cloud Entitlement Import, Cloud Uncorrelated Refresh, Cloud Identity Aggregation, Cloud Attribute Synchronization, Identity Refresh
|
|
598
|
+
* @summary Retrieve task status list
|
|
599
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
600
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
601
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
602
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in*
|
|
603
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created**
|
|
604
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
605
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
606
|
+
* @throws {RequiredError}
|
|
607
|
+
*/
|
|
608
|
+
getTaskStatusList: function (limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions) {
|
|
609
|
+
var _a, _b, _c;
|
|
610
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
611
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
612
|
+
return __generator(this, function (_d) {
|
|
613
|
+
switch (_d.label) {
|
|
614
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getTaskStatusList(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions)];
|
|
615
|
+
case 1:
|
|
616
|
+
localVarAxiosArgs = _d.sent();
|
|
617
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
618
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['TaskManagementV2026Api.getTaskStatusList']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
619
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
620
|
+
}
|
|
621
|
+
});
|
|
622
|
+
});
|
|
623
|
+
},
|
|
624
|
+
/**
|
|
625
|
+
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
626
|
+
* @summary Update task status by id
|
|
627
|
+
* @param {string} id Task ID.
|
|
628
|
+
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
629
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
630
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
631
|
+
* @throws {RequiredError}
|
|
632
|
+
*/
|
|
633
|
+
updateTaskStatus: function (id, jsonPatchOperationV2026, xSailPointExperimental, axiosOptions) {
|
|
634
|
+
var _a, _b, _c;
|
|
635
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
636
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
637
|
+
return __generator(this, function (_d) {
|
|
638
|
+
switch (_d.label) {
|
|
639
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateTaskStatus(id, jsonPatchOperationV2026, xSailPointExperimental, axiosOptions)];
|
|
640
|
+
case 1:
|
|
641
|
+
localVarAxiosArgs = _d.sent();
|
|
642
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
643
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['TaskManagementV2026Api.updateTaskStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
644
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
645
|
+
}
|
|
646
|
+
});
|
|
647
|
+
});
|
|
648
|
+
},
|
|
649
|
+
};
|
|
650
|
+
};
|
|
651
|
+
exports.TaskManagementV2026ApiFp = TaskManagementV2026ApiFp;
|
|
652
|
+
/**
|
|
653
|
+
* TaskManagementV2026Api - factory interface
|
|
654
|
+
* @export
|
|
655
|
+
*/
|
|
656
|
+
var TaskManagementV2026ApiFactory = function (configuration, basePath, axios) {
|
|
657
|
+
var localVarFp = (0, exports.TaskManagementV2026ApiFp)(configuration);
|
|
658
|
+
return {
|
|
659
|
+
/**
|
|
660
|
+
* Responds with headers only for list of task statuses for pending tasks.
|
|
661
|
+
* @summary Retrieve pending task list headers
|
|
662
|
+
* @param {TaskManagementV2026ApiGetPendingTaskHeadersRequest} requestParameters Request parameters.
|
|
663
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
664
|
+
* @throws {RequiredError}
|
|
665
|
+
*/
|
|
666
|
+
getPendingTaskHeaders: function (requestParameters, axiosOptions) {
|
|
667
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
668
|
+
return localVarFp.getPendingTaskHeaders(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
669
|
+
},
|
|
670
|
+
/**
|
|
671
|
+
* Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. Possible tasks to be returned: Cloud Account Aggregation, Cloud Group Aggregation, Cloud Process Uncorrelated Accounts, Cloud Refresh Role, Source Application Discovery, AI Agent Aggregation, Cloud Entitlement Import, Cloud Uncorrelated Refresh, Cloud Identity Aggregation, Cloud Attribute Synchronization, Identity Refresh
|
|
672
|
+
* @summary Retrieve pending task status list
|
|
673
|
+
* @param {TaskManagementV2026ApiGetPendingTasksRequest} requestParameters Request parameters.
|
|
674
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
675
|
+
* @throws {RequiredError}
|
|
676
|
+
*/
|
|
677
|
+
getPendingTasks: function (requestParameters, axiosOptions) {
|
|
678
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
679
|
+
return localVarFp.getPendingTasks(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
680
|
+
},
|
|
681
|
+
/**
|
|
682
|
+
* Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
683
|
+
* @summary Get task status by id
|
|
684
|
+
* @param {TaskManagementV2026ApiGetTaskStatusRequest} requestParameters Request parameters.
|
|
685
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
686
|
+
* @throws {RequiredError}
|
|
687
|
+
*/
|
|
688
|
+
getTaskStatus: function (requestParameters, axiosOptions) {
|
|
689
|
+
return localVarFp.getTaskStatus(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
690
|
+
},
|
|
691
|
+
/**
|
|
692
|
+
* Use this endpoint to get a list of statuses for **all** tasks which include finished, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for only **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. Possible tasks to be returned: Cloud Account Aggregation, Cloud Group Aggregation, Cloud Process Uncorrelated Accounts, Cloud Refresh Role, Source Application Discovery, AI Agent Aggregation, Cloud Entitlement Import, Cloud Uncorrelated Refresh, Cloud Identity Aggregation, Cloud Attribute Synchronization, Identity Refresh
|
|
693
|
+
* @summary Retrieve task status list
|
|
694
|
+
* @param {TaskManagementV2026ApiGetTaskStatusListRequest} requestParameters Request parameters.
|
|
695
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
696
|
+
* @throws {RequiredError}
|
|
697
|
+
*/
|
|
698
|
+
getTaskStatusList: function (requestParameters, axiosOptions) {
|
|
699
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
700
|
+
return localVarFp.getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
701
|
+
},
|
|
702
|
+
/**
|
|
703
|
+
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
704
|
+
* @summary Update task status by id
|
|
705
|
+
* @param {TaskManagementV2026ApiUpdateTaskStatusRequest} requestParameters Request parameters.
|
|
706
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
707
|
+
* @throws {RequiredError}
|
|
708
|
+
*/
|
|
709
|
+
updateTaskStatus: function (requestParameters, axiosOptions) {
|
|
710
|
+
return localVarFp.updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2026, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
711
|
+
},
|
|
712
|
+
};
|
|
713
|
+
};
|
|
714
|
+
exports.TaskManagementV2026ApiFactory = TaskManagementV2026ApiFactory;
|
|
715
|
+
/**
|
|
716
|
+
* TaskManagementV2026Api - object-oriented interface
|
|
717
|
+
* @export
|
|
718
|
+
* @class TaskManagementV2026Api
|
|
719
|
+
* @extends {BaseAPI}
|
|
720
|
+
*/
|
|
721
|
+
var TaskManagementV2026Api = /** @class */ (function (_super) {
|
|
722
|
+
__extends(TaskManagementV2026Api, _super);
|
|
723
|
+
function TaskManagementV2026Api() {
|
|
724
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
725
|
+
}
|
|
726
|
+
/**
|
|
727
|
+
* Responds with headers only for list of task statuses for pending tasks.
|
|
728
|
+
* @summary Retrieve pending task list headers
|
|
729
|
+
* @param {TaskManagementV2026ApiGetPendingTaskHeadersRequest} requestParameters Request parameters.
|
|
730
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
731
|
+
* @throws {RequiredError}
|
|
732
|
+
* @memberof TaskManagementV2026Api
|
|
733
|
+
*/
|
|
734
|
+
TaskManagementV2026Api.prototype.getPendingTaskHeaders = function (requestParameters, axiosOptions) {
|
|
735
|
+
var _this = this;
|
|
736
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
737
|
+
return (0, exports.TaskManagementV2026ApiFp)(this.configuration).getPendingTaskHeaders(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
738
|
+
};
|
|
739
|
+
/**
|
|
740
|
+
* Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. Possible tasks to be returned: Cloud Account Aggregation, Cloud Group Aggregation, Cloud Process Uncorrelated Accounts, Cloud Refresh Role, Source Application Discovery, AI Agent Aggregation, Cloud Entitlement Import, Cloud Uncorrelated Refresh, Cloud Identity Aggregation, Cloud Attribute Synchronization, Identity Refresh
|
|
741
|
+
* @summary Retrieve pending task status list
|
|
742
|
+
* @param {TaskManagementV2026ApiGetPendingTasksRequest} requestParameters Request parameters.
|
|
743
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
744
|
+
* @throws {RequiredError}
|
|
745
|
+
* @memberof TaskManagementV2026Api
|
|
746
|
+
*/
|
|
747
|
+
TaskManagementV2026Api.prototype.getPendingTasks = function (requestParameters, axiosOptions) {
|
|
748
|
+
var _this = this;
|
|
749
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
750
|
+
return (0, exports.TaskManagementV2026ApiFp)(this.configuration).getPendingTasks(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
751
|
+
};
|
|
752
|
+
/**
|
|
753
|
+
* Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
754
|
+
* @summary Get task status by id
|
|
755
|
+
* @param {TaskManagementV2026ApiGetTaskStatusRequest} requestParameters Request parameters.
|
|
756
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
757
|
+
* @throws {RequiredError}
|
|
758
|
+
* @memberof TaskManagementV2026Api
|
|
759
|
+
*/
|
|
760
|
+
TaskManagementV2026Api.prototype.getTaskStatus = function (requestParameters, axiosOptions) {
|
|
761
|
+
var _this = this;
|
|
762
|
+
return (0, exports.TaskManagementV2026ApiFp)(this.configuration).getTaskStatus(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
763
|
+
};
|
|
764
|
+
/**
|
|
765
|
+
* Use this endpoint to get a list of statuses for **all** tasks which include finished, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for only **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. Possible tasks to be returned: Cloud Account Aggregation, Cloud Group Aggregation, Cloud Process Uncorrelated Accounts, Cloud Refresh Role, Source Application Discovery, AI Agent Aggregation, Cloud Entitlement Import, Cloud Uncorrelated Refresh, Cloud Identity Aggregation, Cloud Attribute Synchronization, Identity Refresh
|
|
766
|
+
* @summary Retrieve task status list
|
|
767
|
+
* @param {TaskManagementV2026ApiGetTaskStatusListRequest} requestParameters Request parameters.
|
|
768
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
769
|
+
* @throws {RequiredError}
|
|
770
|
+
* @memberof TaskManagementV2026Api
|
|
771
|
+
*/
|
|
772
|
+
TaskManagementV2026Api.prototype.getTaskStatusList = function (requestParameters, axiosOptions) {
|
|
773
|
+
var _this = this;
|
|
774
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
775
|
+
return (0, exports.TaskManagementV2026ApiFp)(this.configuration).getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
776
|
+
};
|
|
777
|
+
/**
|
|
778
|
+
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
779
|
+
* @summary Update task status by id
|
|
780
|
+
* @param {TaskManagementV2026ApiUpdateTaskStatusRequest} requestParameters Request parameters.
|
|
781
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
782
|
+
* @throws {RequiredError}
|
|
783
|
+
* @memberof TaskManagementV2026Api
|
|
784
|
+
*/
|
|
785
|
+
TaskManagementV2026Api.prototype.updateTaskStatus = function (requestParameters, axiosOptions) {
|
|
786
|
+
var _this = this;
|
|
787
|
+
return (0, exports.TaskManagementV2026ApiFp)(this.configuration).updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2026, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
788
|
+
};
|
|
789
|
+
return TaskManagementV2026Api;
|
|
790
|
+
}(base_1.BaseAPI));
|
|
791
|
+
exports.TaskManagementV2026Api = TaskManagementV2026Api;
|
|
792
|
+
//# sourceMappingURL=api.js.map
|