sailpoint-api-client 1.6.10 → 1.7.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.
Files changed (71) hide show
  1. package/beta/README.md +2 -2
  2. package/beta/api.ts +2117 -205
  3. package/beta/common.ts +2 -2
  4. package/beta/package.json +1 -1
  5. package/dist/beta/api.d.ts +1003 -74
  6. package/dist/beta/api.js +2751 -401
  7. package/dist/beta/api.js.map +1 -1
  8. package/dist/beta/common.js +1 -1
  9. package/dist/beta/common.js.map +1 -1
  10. package/dist/index.d.ts +2 -0
  11. package/dist/index.js +6 -3
  12. package/dist/index.js.map +1 -1
  13. package/dist/index.spec.js +18 -0
  14. package/dist/index.spec.js.map +1 -1
  15. package/dist/v2024/api.d.ts +206 -60
  16. package/dist/v2024/api.js +3283 -760
  17. package/dist/v2024/api.js.map +1 -1
  18. package/dist/v2024/common.js +1 -1
  19. package/dist/v2024/common.js.map +1 -1
  20. package/dist/v2025/api.d.ts +4212 -143
  21. package/dist/v2025/api.js +6580 -963
  22. package/dist/v2025/api.js.map +1 -1
  23. package/dist/v2025/common.js +1 -1
  24. package/dist/v2025/common.js.map +1 -1
  25. package/dist/v2026/api.d.ts +818 -0
  26. package/dist/v2026/api.js +800 -0
  27. package/dist/v2026/api.js.map +1 -0
  28. package/dist/v2026/base.d.ts +66 -0
  29. package/dist/v2026/base.js +89 -0
  30. package/dist/v2026/base.js.map +1 -0
  31. package/dist/v2026/common.d.ts +65 -0
  32. package/dist/v2026/common.js +266 -0
  33. package/dist/v2026/common.js.map +1 -0
  34. package/dist/v2026/configuration.d.ts +91 -0
  35. package/dist/v2026/configuration.js +46 -0
  36. package/dist/v2026/configuration.js.map +1 -0
  37. package/dist/v2026/index.d.ts +13 -0
  38. package/dist/v2026/index.js +32 -0
  39. package/dist/v2026/index.js.map +1 -0
  40. package/dist/v3/api.d.ts +184 -12
  41. package/dist/v3/api.js +1278 -285
  42. package/dist/v3/api.js.map +1 -1
  43. package/dist/v3/common.js +1 -1
  44. package/dist/v3/common.js.map +1 -1
  45. package/index.spec.ts +11 -1
  46. package/index.ts +3 -0
  47. package/package.json +1 -1
  48. package/v2024/README.md +2 -2
  49. package/v2024/api.ts +1443 -288
  50. package/v2024/common.ts +2 -2
  51. package/v2024/package.json +1 -1
  52. package/v2025/README.md +2 -2
  53. package/v2025/api.ts +6944 -441
  54. package/v2025/common.ts +2 -2
  55. package/v2025/package.json +1 -1
  56. package/v2026/.openapi-generator/FILES +12 -0
  57. package/v2026/.openapi-generator/VERSION +1 -0
  58. package/v2026/.openapi-generator-ignore +23 -0
  59. package/v2026/README.md +46 -0
  60. package/v2026/api.ts +1188 -0
  61. package/v2026/base.ts +86 -0
  62. package/v2026/common.ts +165 -0
  63. package/v2026/configuration.ts +110 -0
  64. package/v2026/git_push.sh +57 -0
  65. package/v2026/index.ts +18 -0
  66. package/v2026/package.json +34 -0
  67. package/v2026/tsconfig.json +21 -0
  68. package/v3/README.md +2 -2
  69. package/v3/api.ts +675 -109
  70. package/v3/common.ts +2 -2
  71. package/v3/package.json +1 -1
package/v2026/api.ts ADDED
@@ -0,0 +1,1188 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Identity Security Cloud v2026 API
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: v2026
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import type { Configuration } from '../configuration';
17
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
+ import globalAxios from 'axios';
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
22
+ import type { RequestArgs } from './base';
23
+ // @ts-ignore
24
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
25
+
26
+ /**
27
+ *
28
+ * @export
29
+ * @interface ArrayInnerV2026
30
+ */
31
+ export interface ArrayInnerV2026 {
32
+ }
33
+ /**
34
+ *
35
+ * @export
36
+ * @interface ErrorMessageDtoV2026
37
+ */
38
+ export interface ErrorMessageDtoV2026 {
39
+ /**
40
+ * The locale for the message text, a BCP 47 language tag.
41
+ * @type {string}
42
+ * @memberof ErrorMessageDtoV2026
43
+ */
44
+ 'locale'?: string | null;
45
+ /**
46
+ *
47
+ * @type {LocaleOriginV2026}
48
+ * @memberof ErrorMessageDtoV2026
49
+ */
50
+ 'localeOrigin'?: LocaleOriginV2026 | null;
51
+ /**
52
+ * Actual text of the error message in the indicated locale.
53
+ * @type {string}
54
+ * @memberof ErrorMessageDtoV2026
55
+ */
56
+ 'text'?: string;
57
+ }
58
+
59
+
60
+ /**
61
+ *
62
+ * @export
63
+ * @interface ErrorResponseDtoV2026
64
+ */
65
+ export interface ErrorResponseDtoV2026 {
66
+ /**
67
+ * Fine-grained error code providing more detail of the error.
68
+ * @type {string}
69
+ * @memberof ErrorResponseDtoV2026
70
+ */
71
+ 'detailCode'?: string;
72
+ /**
73
+ * Unique tracking id for the error.
74
+ * @type {string}
75
+ * @memberof ErrorResponseDtoV2026
76
+ */
77
+ 'trackingId'?: string;
78
+ /**
79
+ * Generic localized reason for error
80
+ * @type {Array<ErrorMessageDtoV2026>}
81
+ * @memberof ErrorResponseDtoV2026
82
+ */
83
+ 'messages'?: Array<ErrorMessageDtoV2026>;
84
+ /**
85
+ * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
86
+ * @type {Array<ErrorMessageDtoV2026>}
87
+ * @memberof ErrorResponseDtoV2026
88
+ */
89
+ 'causes'?: Array<ErrorMessageDtoV2026>;
90
+ }
91
+ /**
92
+ *
93
+ * @export
94
+ * @interface GetTaskStatus401ResponseV2026
95
+ */
96
+ export interface GetTaskStatus401ResponseV2026 {
97
+ /**
98
+ * A message describing the error
99
+ * @type {object}
100
+ * @memberof GetTaskStatus401ResponseV2026
101
+ */
102
+ 'error'?: object;
103
+ }
104
+ /**
105
+ *
106
+ * @export
107
+ * @interface GetTaskStatus429ResponseV2026
108
+ */
109
+ export interface GetTaskStatus429ResponseV2026 {
110
+ /**
111
+ * A message describing the error
112
+ * @type {object}
113
+ * @memberof GetTaskStatus429ResponseV2026
114
+ */
115
+ 'message'?: object;
116
+ }
117
+ /**
118
+ * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)
119
+ * @export
120
+ * @interface JsonPatchOperationV2026
121
+ */
122
+ export interface JsonPatchOperationV2026 {
123
+ /**
124
+ * The operation to be performed
125
+ * @type {string}
126
+ * @memberof JsonPatchOperationV2026
127
+ */
128
+ 'op': JsonPatchOperationV2026OpV2026;
129
+ /**
130
+ * A string JSON Pointer representing the target path to an element to be affected by the operation
131
+ * @type {string}
132
+ * @memberof JsonPatchOperationV2026
133
+ */
134
+ 'path': string;
135
+ /**
136
+ *
137
+ * @type {JsonPatchOperationValueV2026}
138
+ * @memberof JsonPatchOperationV2026
139
+ */
140
+ 'value'?: JsonPatchOperationValueV2026;
141
+ }
142
+
143
+ export const JsonPatchOperationV2026OpV2026 = {
144
+ Add: 'add',
145
+ Remove: 'remove',
146
+ Replace: 'replace',
147
+ Move: 'move',
148
+ Copy: 'copy',
149
+ Test: 'test'
150
+ } as const;
151
+
152
+ export type JsonPatchOperationV2026OpV2026 = typeof JsonPatchOperationV2026OpV2026[keyof typeof JsonPatchOperationV2026OpV2026];
153
+
154
+ /**
155
+ * @type JsonPatchOperationValueV2026
156
+ * The value to be used for the operation, required for \"add\" and \"replace\" operations
157
+ * @export
158
+ */
159
+ export type JsonPatchOperationValueV2026 = Array<ArrayInnerV2026> | boolean | number | object | string;
160
+
161
+ /**
162
+ * 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.
163
+ * @export
164
+ * @enum {string}
165
+ */
166
+
167
+ export const LocaleOriginV2026 = {
168
+ Default: 'DEFAULT',
169
+ Request: 'REQUEST'
170
+ } as const;
171
+
172
+ export type LocaleOriginV2026 = typeof LocaleOriginV2026[keyof typeof LocaleOriginV2026];
173
+
174
+
175
+ /**
176
+ * Localized error message to indicate a failed invocation or error if any.
177
+ * @export
178
+ * @interface LocalizedMessageV2026
179
+ */
180
+ export interface LocalizedMessageV2026 {
181
+ /**
182
+ * Message locale
183
+ * @type {string}
184
+ * @memberof LocalizedMessageV2026
185
+ */
186
+ 'locale': string;
187
+ /**
188
+ * Message text
189
+ * @type {string}
190
+ * @memberof LocalizedMessageV2026
191
+ */
192
+ 'message': string;
193
+ }
194
+ /**
195
+ *
196
+ * @export
197
+ * @interface TargetV2026
198
+ */
199
+ export interface TargetV2026 {
200
+ /**
201
+ * Target ID
202
+ * @type {string}
203
+ * @memberof TargetV2026
204
+ */
205
+ 'id'?: string;
206
+ /**
207
+ * Target type
208
+ * @type {string}
209
+ * @memberof TargetV2026
210
+ */
211
+ 'type'?: TargetV2026TypeV2026 | null;
212
+ /**
213
+ * Target name
214
+ * @type {string}
215
+ * @memberof TargetV2026
216
+ */
217
+ 'name'?: string;
218
+ }
219
+
220
+ export const TargetV2026TypeV2026 = {
221
+ Application: 'APPLICATION',
222
+ Identity: 'IDENTITY'
223
+ } as const;
224
+
225
+ export type TargetV2026TypeV2026 = typeof TargetV2026TypeV2026[keyof typeof TargetV2026TypeV2026];
226
+
227
+ /**
228
+ * Definition of a type of task, used to invoke tasks
229
+ * @export
230
+ * @interface TaskDefinitionSummaryV2026
231
+ */
232
+ export interface TaskDefinitionSummaryV2026 {
233
+ /**
234
+ * System-generated unique ID of the TaskDefinition
235
+ * @type {string}
236
+ * @memberof TaskDefinitionSummaryV2026
237
+ */
238
+ 'id': string;
239
+ /**
240
+ * Name of the TaskDefinition
241
+ * @type {string}
242
+ * @memberof TaskDefinitionSummaryV2026
243
+ */
244
+ 'uniqueName': string;
245
+ /**
246
+ * Description of the TaskDefinition
247
+ * @type {string}
248
+ * @memberof TaskDefinitionSummaryV2026
249
+ */
250
+ 'description': string | null;
251
+ /**
252
+ * Name of the parent of the TaskDefinition
253
+ * @type {string}
254
+ * @memberof TaskDefinitionSummaryV2026
255
+ */
256
+ 'parentName': string;
257
+ /**
258
+ * Executor of the TaskDefinition
259
+ * @type {string}
260
+ * @memberof TaskDefinitionSummaryV2026
261
+ */
262
+ 'executor': string | null;
263
+ /**
264
+ * Formal parameters of the TaskDefinition, without values
265
+ * @type {{ [key: string]: any; }}
266
+ * @memberof TaskDefinitionSummaryV2026
267
+ */
268
+ 'arguments': { [key: string]: any; };
269
+ }
270
+ /**
271
+ * Task return details
272
+ * @export
273
+ * @interface TaskReturnDetailsV2026
274
+ */
275
+ export interface TaskReturnDetailsV2026 {
276
+ /**
277
+ * Display name of the TaskReturnDetails
278
+ * @type {string}
279
+ * @memberof TaskReturnDetailsV2026
280
+ */
281
+ 'name': string;
282
+ /**
283
+ * Attribute the TaskReturnDetails is for
284
+ * @type {string}
285
+ * @memberof TaskReturnDetailsV2026
286
+ */
287
+ 'attributeName': string;
288
+ }
289
+ /**
290
+ *
291
+ * @export
292
+ * @interface TaskStatusMessageParametersInnerV2026
293
+ */
294
+ export interface TaskStatusMessageParametersInnerV2026 {
295
+ }
296
+ /**
297
+ * TaskStatus Message
298
+ * @export
299
+ * @interface TaskStatusMessageV2026
300
+ */
301
+ export interface TaskStatusMessageV2026 {
302
+ /**
303
+ * Type of the message
304
+ * @type {string}
305
+ * @memberof TaskStatusMessageV2026
306
+ */
307
+ 'type': TaskStatusMessageV2026TypeV2026;
308
+ /**
309
+ *
310
+ * @type {LocalizedMessageV2026}
311
+ * @memberof TaskStatusMessageV2026
312
+ */
313
+ 'localizedText': LocalizedMessageV2026 | null;
314
+ /**
315
+ * Key of the message
316
+ * @type {string}
317
+ * @memberof TaskStatusMessageV2026
318
+ */
319
+ 'key': string;
320
+ /**
321
+ * Message parameters for internationalization
322
+ * @type {Array<TaskStatusMessageParametersInnerV2026>}
323
+ * @memberof TaskStatusMessageV2026
324
+ */
325
+ 'parameters': Array<TaskStatusMessageParametersInnerV2026> | null;
326
+ }
327
+
328
+ export const TaskStatusMessageV2026TypeV2026 = {
329
+ Info: 'INFO',
330
+ Warn: 'WARN',
331
+ Error: 'ERROR'
332
+ } as const;
333
+
334
+ export type TaskStatusMessageV2026TypeV2026 = typeof TaskStatusMessageV2026TypeV2026[keyof typeof TaskStatusMessageV2026TypeV2026];
335
+
336
+ /**
337
+ * Details and current status of a specific task
338
+ * @export
339
+ * @interface TaskStatusV2026
340
+ */
341
+ export interface TaskStatusV2026 {
342
+ /**
343
+ * System-generated unique ID of the task this TaskStatus represents
344
+ * @type {string}
345
+ * @memberof TaskStatusV2026
346
+ */
347
+ 'id': string;
348
+ /**
349
+ * Type of task this TaskStatus represents
350
+ * @type {string}
351
+ * @memberof TaskStatusV2026
352
+ */
353
+ 'type': TaskStatusV2026TypeV2026;
354
+ /**
355
+ * Name of the task this TaskStatus represents
356
+ * @type {string}
357
+ * @memberof TaskStatusV2026
358
+ */
359
+ 'uniqueName': string;
360
+ /**
361
+ * Description of the task this TaskStatus represents
362
+ * @type {string}
363
+ * @memberof TaskStatusV2026
364
+ */
365
+ 'description': string;
366
+ /**
367
+ * Name of the parent of the task this TaskStatus represents
368
+ * @type {string}
369
+ * @memberof TaskStatusV2026
370
+ */
371
+ 'parentName': string | null;
372
+ /**
373
+ * Service to execute the task this TaskStatus represents
374
+ * @type {string}
375
+ * @memberof TaskStatusV2026
376
+ */
377
+ 'launcher': string;
378
+ /**
379
+ *
380
+ * @type {TargetV2026}
381
+ * @memberof TaskStatusV2026
382
+ */
383
+ 'target'?: TargetV2026 | null;
384
+ /**
385
+ * Creation date of the task this TaskStatus represents
386
+ * @type {string}
387
+ * @memberof TaskStatusV2026
388
+ */
389
+ 'created': string;
390
+ /**
391
+ * Last modification date of the task this TaskStatus represents
392
+ * @type {string}
393
+ * @memberof TaskStatusV2026
394
+ */
395
+ 'modified': string;
396
+ /**
397
+ * Launch date of the task this TaskStatus represents
398
+ * @type {string}
399
+ * @memberof TaskStatusV2026
400
+ */
401
+ 'launched': string | null;
402
+ /**
403
+ * Completion date of the task this TaskStatus represents
404
+ * @type {string}
405
+ * @memberof TaskStatusV2026
406
+ */
407
+ 'completed': string | null;
408
+ /**
409
+ * Completion status of the task this TaskStatus represents
410
+ * @type {string}
411
+ * @memberof TaskStatusV2026
412
+ */
413
+ 'completionStatus': TaskStatusV2026CompletionStatusV2026 | null;
414
+ /**
415
+ * Messages associated with the task this TaskStatus represents
416
+ * @type {Array<TaskStatusMessageV2026>}
417
+ * @memberof TaskStatusV2026
418
+ */
419
+ 'messages': Array<TaskStatusMessageV2026>;
420
+ /**
421
+ * Return values from the task this TaskStatus represents
422
+ * @type {Array<TaskReturnDetailsV2026>}
423
+ * @memberof TaskStatusV2026
424
+ */
425
+ 'returns': Array<TaskReturnDetailsV2026>;
426
+ /**
427
+ * Attributes of the task this TaskStatus represents
428
+ * @type {{ [key: string]: any; }}
429
+ * @memberof TaskStatusV2026
430
+ */
431
+ 'attributes': { [key: string]: any; };
432
+ /**
433
+ * Current progress of the task this TaskStatus represents
434
+ * @type {string}
435
+ * @memberof TaskStatusV2026
436
+ */
437
+ 'progress': string | null;
438
+ /**
439
+ * Current percentage completion of the task this TaskStatus represents
440
+ * @type {number}
441
+ * @memberof TaskStatusV2026
442
+ */
443
+ 'percentComplete': number;
444
+ /**
445
+ *
446
+ * @type {TaskDefinitionSummaryV2026}
447
+ * @memberof TaskStatusV2026
448
+ */
449
+ 'taskDefinitionSummary'?: TaskDefinitionSummaryV2026;
450
+ }
451
+
452
+ export const TaskStatusV2026TypeV2026 = {
453
+ Quartz: 'QUARTZ',
454
+ Qpoc: 'QPOC',
455
+ QueuedTask: 'QUEUED_TASK'
456
+ } as const;
457
+
458
+ export type TaskStatusV2026TypeV2026 = typeof TaskStatusV2026TypeV2026[keyof typeof TaskStatusV2026TypeV2026];
459
+ export const TaskStatusV2026CompletionStatusV2026 = {
460
+ Success: 'SUCCESS',
461
+ Warning: 'WARNING',
462
+ Error: 'ERROR',
463
+ Terminated: 'TERMINATED',
464
+ Temperror: 'TEMPERROR'
465
+ } as const;
466
+
467
+ export type TaskStatusV2026CompletionStatusV2026 = typeof TaskStatusV2026CompletionStatusV2026[keyof typeof TaskStatusV2026CompletionStatusV2026];
468
+
469
+
470
+ /**
471
+ * TaskManagementV2026Api - axios parameter creator
472
+ * @export
473
+ */
474
+ export const TaskManagementV2026ApiAxiosParamCreator = function (configuration?: Configuration) {
475
+ return {
476
+ /**
477
+ * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2026/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks.
478
+ * @summary Retrieve pending task list headers
479
+ * @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.
480
+ * @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.
481
+ * @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&#x3D;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.
482
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
483
+ * @param {*} [axiosOptions] Override http request option.
484
+ * @deprecated
485
+ * @throws {RequiredError}
486
+ */
487
+ getPendingTaskHeaders: async (offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
488
+ if (xSailPointExperimental === undefined) {
489
+ xSailPointExperimental = 'true';
490
+ }
491
+
492
+ const localVarPath = `/task-status/pending-tasks`;
493
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
494
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
495
+ let baseOptions;
496
+ if (configuration) {
497
+ baseOptions = configuration.baseOptions;
498
+ }
499
+
500
+ const localVarRequestOptions = { method: 'HEAD', ...baseOptions, ...axiosOptions};
501
+ const localVarHeaderParameter = {} as any;
502
+ const localVarQueryParameter = {} as any;
503
+
504
+ // authentication userAuth required
505
+ // oauth required
506
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
507
+
508
+ // authentication userAuth required
509
+ // oauth required
510
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
511
+
512
+ // authentication applicationAuth required
513
+ // oauth required
514
+ await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
515
+
516
+ if (offset !== undefined) {
517
+ localVarQueryParameter['offset'] = offset;
518
+ }
519
+
520
+ if (limit !== undefined) {
521
+ localVarQueryParameter['limit'] = limit;
522
+ }
523
+
524
+ if (count !== undefined) {
525
+ localVarQueryParameter['count'] = count;
526
+ }
527
+
528
+
529
+
530
+ if (xSailPointExperimental != null) {
531
+ localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
532
+ }
533
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
534
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
535
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
536
+
537
+ return {
538
+ url: toPathString(localVarUrlObj),
539
+ axiosOptions: localVarRequestOptions,
540
+ };
541
+ },
542
+ /**
543
+ * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2026/task-status?filters=completionStatus isnull 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.
544
+ * @summary Retrieve pending task status list
545
+ * @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.
546
+ * @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.
547
+ * @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&#x3D;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.
548
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
549
+ * @param {*} [axiosOptions] Override http request option.
550
+ * @deprecated
551
+ * @throws {RequiredError}
552
+ */
553
+ getPendingTasks: async (offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
554
+ if (xSailPointExperimental === undefined) {
555
+ xSailPointExperimental = 'true';
556
+ }
557
+
558
+ const localVarPath = `/task-status/pending-tasks`;
559
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
560
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
561
+ let baseOptions;
562
+ if (configuration) {
563
+ baseOptions = configuration.baseOptions;
564
+ }
565
+
566
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
567
+ const localVarHeaderParameter = {} as any;
568
+ const localVarQueryParameter = {} as any;
569
+
570
+ // authentication userAuth required
571
+ // oauth required
572
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
573
+
574
+ // authentication userAuth required
575
+ // oauth required
576
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
577
+
578
+ // authentication applicationAuth required
579
+ // oauth required
580
+ await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
581
+
582
+ if (offset !== undefined) {
583
+ localVarQueryParameter['offset'] = offset;
584
+ }
585
+
586
+ if (limit !== undefined) {
587
+ localVarQueryParameter['limit'] = limit;
588
+ }
589
+
590
+ if (count !== undefined) {
591
+ localVarQueryParameter['count'] = count;
592
+ }
593
+
594
+
595
+
596
+ if (xSailPointExperimental != null) {
597
+ localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
598
+ }
599
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
600
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
601
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
602
+
603
+ return {
604
+ url: toPathString(localVarUrlObj),
605
+ axiosOptions: localVarRequestOptions,
606
+ };
607
+ },
608
+ /**
609
+ * 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.
610
+ * @summary Get task status by id
611
+ * @param {string} id Task ID.
612
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
613
+ * @param {*} [axiosOptions] Override http request option.
614
+ * @throws {RequiredError}
615
+ */
616
+ getTaskStatus: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
617
+ // verify required parameter 'id' is not null or undefined
618
+ assertParamExists('getTaskStatus', 'id', id)
619
+ if (xSailPointExperimental === undefined) {
620
+ xSailPointExperimental = 'true';
621
+ }
622
+
623
+ const localVarPath = `/task-status/{id}`
624
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
625
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
626
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
627
+ let baseOptions;
628
+ if (configuration) {
629
+ baseOptions = configuration.baseOptions;
630
+ }
631
+
632
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
633
+ const localVarHeaderParameter = {} as any;
634
+ const localVarQueryParameter = {} as any;
635
+
636
+ // authentication userAuth required
637
+ // oauth required
638
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
639
+
640
+ // authentication userAuth required
641
+ // oauth required
642
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
643
+
644
+ // authentication applicationAuth required
645
+ // oauth required
646
+ await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
647
+
648
+
649
+
650
+ if (xSailPointExperimental != null) {
651
+ localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
652
+ }
653
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
654
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
655
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
656
+
657
+ return {
658
+ url: toPathString(localVarUrlObj),
659
+ axiosOptions: localVarRequestOptions,
660
+ };
661
+ },
662
+ /**
663
+ * Use this endpoint to get a list of statuses for **all** tasks, including completed, 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. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field.
664
+ * @summary Retrieve task status list
665
+ * @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.
666
+ * @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.
667
+ * @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&#x3D;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.
668
+ * @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, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** 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, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION
669
+ * @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**
670
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
671
+ * @param {*} [axiosOptions] Override http request option.
672
+ * @throws {RequiredError}
673
+ */
674
+ getTaskStatusList: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
675
+ if (xSailPointExperimental === undefined) {
676
+ xSailPointExperimental = 'true';
677
+ }
678
+
679
+ const localVarPath = `/task-status`;
680
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
681
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
682
+ let baseOptions;
683
+ if (configuration) {
684
+ baseOptions = configuration.baseOptions;
685
+ }
686
+
687
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
688
+ const localVarHeaderParameter = {} as any;
689
+ const localVarQueryParameter = {} as any;
690
+
691
+ // authentication userAuth required
692
+ // oauth required
693
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
694
+
695
+ // authentication userAuth required
696
+ // oauth required
697
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
698
+
699
+ // authentication applicationAuth required
700
+ // oauth required
701
+ await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
702
+
703
+ if (limit !== undefined) {
704
+ localVarQueryParameter['limit'] = limit;
705
+ }
706
+
707
+ if (offset !== undefined) {
708
+ localVarQueryParameter['offset'] = offset;
709
+ }
710
+
711
+ if (count !== undefined) {
712
+ localVarQueryParameter['count'] = count;
713
+ }
714
+
715
+ if (filters !== undefined) {
716
+ localVarQueryParameter['filters'] = filters;
717
+ }
718
+
719
+ if (sorters !== undefined) {
720
+ localVarQueryParameter['sorters'] = sorters;
721
+ }
722
+
723
+
724
+
725
+ if (xSailPointExperimental != null) {
726
+ localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
727
+ }
728
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
729
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
730
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
731
+
732
+ return {
733
+ url: toPathString(localVarUrlObj),
734
+ axiosOptions: localVarRequestOptions,
735
+ };
736
+ },
737
+ /**
738
+ * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
739
+ * @summary Update task status by id
740
+ * @param {string} id Task ID.
741
+ * @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
742
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
743
+ * @param {*} [axiosOptions] Override http request option.
744
+ * @throws {RequiredError}
745
+ */
746
+ updateTaskStatus: async (id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
747
+ // verify required parameter 'id' is not null or undefined
748
+ assertParamExists('updateTaskStatus', 'id', id)
749
+ // verify required parameter 'jsonPatchOperationV2026' is not null or undefined
750
+ assertParamExists('updateTaskStatus', 'jsonPatchOperationV2026', jsonPatchOperationV2026)
751
+ if (xSailPointExperimental === undefined) {
752
+ xSailPointExperimental = 'true';
753
+ }
754
+
755
+ const localVarPath = `/task-status/{id}`
756
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
757
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
758
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
759
+ let baseOptions;
760
+ if (configuration) {
761
+ baseOptions = configuration.baseOptions;
762
+ }
763
+
764
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions};
765
+ const localVarHeaderParameter = {} as any;
766
+ const localVarQueryParameter = {} as any;
767
+
768
+ // authentication userAuth required
769
+ // oauth required
770
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
771
+
772
+ // authentication userAuth required
773
+ // oauth required
774
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
775
+
776
+
777
+
778
+ localVarHeaderParameter['Content-Type'] = 'application/json-patch+json';
779
+
780
+ if (xSailPointExperimental != null) {
781
+ localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
782
+ }
783
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
784
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
785
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
786
+ localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2026, localVarRequestOptions, configuration)
787
+
788
+ return {
789
+ url: toPathString(localVarUrlObj),
790
+ axiosOptions: localVarRequestOptions,
791
+ };
792
+ },
793
+ }
794
+ };
795
+
796
+ /**
797
+ * TaskManagementV2026Api - functional programming interface
798
+ * @export
799
+ */
800
+ export const TaskManagementV2026ApiFp = function(configuration?: Configuration) {
801
+ const localVarAxiosParamCreator = TaskManagementV2026ApiAxiosParamCreator(configuration)
802
+ return {
803
+ /**
804
+ * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2026/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks.
805
+ * @summary Retrieve pending task list headers
806
+ * @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.
807
+ * @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.
808
+ * @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&#x3D;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.
809
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
810
+ * @param {*} [axiosOptions] Override http request option.
811
+ * @deprecated
812
+ * @throws {RequiredError}
813
+ */
814
+ async getPendingTaskHeaders(offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
815
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingTaskHeaders(offset, limit, count, xSailPointExperimental, axiosOptions);
816
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
817
+ const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.getPendingTaskHeaders']?.[localVarOperationServerIndex]?.url;
818
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
819
+ },
820
+ /**
821
+ * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2026/task-status?filters=completionStatus isnull 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.
822
+ * @summary Retrieve pending task status list
823
+ * @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.
824
+ * @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.
825
+ * @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&#x3D;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.
826
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
827
+ * @param {*} [axiosOptions] Override http request option.
828
+ * @deprecated
829
+ * @throws {RequiredError}
830
+ */
831
+ async getPendingTasks(offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskStatusV2026>>> {
832
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingTasks(offset, limit, count, xSailPointExperimental, axiosOptions);
833
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
834
+ const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.getPendingTasks']?.[localVarOperationServerIndex]?.url;
835
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
836
+ },
837
+ /**
838
+ * 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.
839
+ * @summary Get task status by id
840
+ * @param {string} id Task ID.
841
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
842
+ * @param {*} [axiosOptions] Override http request option.
843
+ * @throws {RequiredError}
844
+ */
845
+ async getTaskStatus(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2026>> {
846
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatus(id, xSailPointExperimental, axiosOptions);
847
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
848
+ const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.getTaskStatus']?.[localVarOperationServerIndex]?.url;
849
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
850
+ },
851
+ /**
852
+ * Use this endpoint to get a list of statuses for **all** tasks, including completed, 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. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field.
853
+ * @summary Retrieve task status list
854
+ * @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.
855
+ * @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.
856
+ * @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&#x3D;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.
857
+ * @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, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** 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, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION
858
+ * @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**
859
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
860
+ * @param {*} [axiosOptions] Override http request option.
861
+ * @throws {RequiredError}
862
+ */
863
+ async getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskStatusV2026>>> {
864
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatusList(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions);
865
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
866
+ const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.getTaskStatusList']?.[localVarOperationServerIndex]?.url;
867
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
868
+ },
869
+ /**
870
+ * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
871
+ * @summary Update task status by id
872
+ * @param {string} id Task ID.
873
+ * @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
874
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
875
+ * @param {*} [axiosOptions] Override http request option.
876
+ * @throws {RequiredError}
877
+ */
878
+ async updateTaskStatus(id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2026>> {
879
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateTaskStatus(id, jsonPatchOperationV2026, xSailPointExperimental, axiosOptions);
880
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
881
+ const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.updateTaskStatus']?.[localVarOperationServerIndex]?.url;
882
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
883
+ },
884
+ }
885
+ };
886
+
887
+ /**
888
+ * TaskManagementV2026Api - factory interface
889
+ * @export
890
+ */
891
+ export const TaskManagementV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
892
+ const localVarFp = TaskManagementV2026ApiFp(configuration)
893
+ return {
894
+ /**
895
+ * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2026/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks.
896
+ * @summary Retrieve pending task list headers
897
+ * @param {TaskManagementV2026ApiGetPendingTaskHeadersRequest} requestParameters Request parameters.
898
+ * @param {*} [axiosOptions] Override http request option.
899
+ * @deprecated
900
+ * @throws {RequiredError}
901
+ */
902
+ getPendingTaskHeaders(requestParameters: TaskManagementV2026ApiGetPendingTaskHeadersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void> {
903
+ return localVarFp.getPendingTaskHeaders(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
904
+ },
905
+ /**
906
+ * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2026/task-status?filters=completionStatus isnull 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.
907
+ * @summary Retrieve pending task status list
908
+ * @param {TaskManagementV2026ApiGetPendingTasksRequest} requestParameters Request parameters.
909
+ * @param {*} [axiosOptions] Override http request option.
910
+ * @deprecated
911
+ * @throws {RequiredError}
912
+ */
913
+ getPendingTasks(requestParameters: TaskManagementV2026ApiGetPendingTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<TaskStatusV2026>> {
914
+ return localVarFp.getPendingTasks(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
915
+ },
916
+ /**
917
+ * 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.
918
+ * @summary Get task status by id
919
+ * @param {TaskManagementV2026ApiGetTaskStatusRequest} requestParameters Request parameters.
920
+ * @param {*} [axiosOptions] Override http request option.
921
+ * @throws {RequiredError}
922
+ */
923
+ getTaskStatus(requestParameters: TaskManagementV2026ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TaskStatusV2026> {
924
+ return localVarFp.getTaskStatus(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
925
+ },
926
+ /**
927
+ * Use this endpoint to get a list of statuses for **all** tasks, including completed, 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. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field.
928
+ * @summary Retrieve task status list
929
+ * @param {TaskManagementV2026ApiGetTaskStatusListRequest} requestParameters Request parameters.
930
+ * @param {*} [axiosOptions] Override http request option.
931
+ * @throws {RequiredError}
932
+ */
933
+ getTaskStatusList(requestParameters: TaskManagementV2026ApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<TaskStatusV2026>> {
934
+ return localVarFp.getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
935
+ },
936
+ /**
937
+ * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
938
+ * @summary Update task status by id
939
+ * @param {TaskManagementV2026ApiUpdateTaskStatusRequest} requestParameters Request parameters.
940
+ * @param {*} [axiosOptions] Override http request option.
941
+ * @throws {RequiredError}
942
+ */
943
+ updateTaskStatus(requestParameters: TaskManagementV2026ApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TaskStatusV2026> {
944
+ return localVarFp.updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
945
+ },
946
+ };
947
+ };
948
+
949
+ /**
950
+ * Request parameters for getPendingTaskHeaders operation in TaskManagementV2026Api.
951
+ * @export
952
+ * @interface TaskManagementV2026ApiGetPendingTaskHeadersRequest
953
+ */
954
+ export interface TaskManagementV2026ApiGetPendingTaskHeadersRequest {
955
+ /**
956
+ * 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.
957
+ * @type {number}
958
+ * @memberof TaskManagementV2026ApiGetPendingTaskHeaders
959
+ */
960
+ readonly offset?: number
961
+
962
+ /**
963
+ * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
964
+ * @type {number}
965
+ * @memberof TaskManagementV2026ApiGetPendingTaskHeaders
966
+ */
967
+ readonly limit?: number
968
+
969
+ /**
970
+ * 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&#x3D;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.
971
+ * @type {boolean}
972
+ * @memberof TaskManagementV2026ApiGetPendingTaskHeaders
973
+ */
974
+ readonly count?: boolean
975
+
976
+ /**
977
+ * Use this header to enable this experimental API.
978
+ * @type {string}
979
+ * @memberof TaskManagementV2026ApiGetPendingTaskHeaders
980
+ */
981
+ readonly xSailPointExperimental?: string
982
+ }
983
+
984
+ /**
985
+ * Request parameters for getPendingTasks operation in TaskManagementV2026Api.
986
+ * @export
987
+ * @interface TaskManagementV2026ApiGetPendingTasksRequest
988
+ */
989
+ export interface TaskManagementV2026ApiGetPendingTasksRequest {
990
+ /**
991
+ * 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.
992
+ * @type {number}
993
+ * @memberof TaskManagementV2026ApiGetPendingTasks
994
+ */
995
+ readonly offset?: number
996
+
997
+ /**
998
+ * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
999
+ * @type {number}
1000
+ * @memberof TaskManagementV2026ApiGetPendingTasks
1001
+ */
1002
+ readonly limit?: number
1003
+
1004
+ /**
1005
+ * 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&#x3D;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.
1006
+ * @type {boolean}
1007
+ * @memberof TaskManagementV2026ApiGetPendingTasks
1008
+ */
1009
+ readonly count?: boolean
1010
+
1011
+ /**
1012
+ * Use this header to enable this experimental API.
1013
+ * @type {string}
1014
+ * @memberof TaskManagementV2026ApiGetPendingTasks
1015
+ */
1016
+ readonly xSailPointExperimental?: string
1017
+ }
1018
+
1019
+ /**
1020
+ * Request parameters for getTaskStatus operation in TaskManagementV2026Api.
1021
+ * @export
1022
+ * @interface TaskManagementV2026ApiGetTaskStatusRequest
1023
+ */
1024
+ export interface TaskManagementV2026ApiGetTaskStatusRequest {
1025
+ /**
1026
+ * Task ID.
1027
+ * @type {string}
1028
+ * @memberof TaskManagementV2026ApiGetTaskStatus
1029
+ */
1030
+ readonly id: string
1031
+
1032
+ /**
1033
+ * Use this header to enable this experimental API.
1034
+ * @type {string}
1035
+ * @memberof TaskManagementV2026ApiGetTaskStatus
1036
+ */
1037
+ readonly xSailPointExperimental?: string
1038
+ }
1039
+
1040
+ /**
1041
+ * Request parameters for getTaskStatusList operation in TaskManagementV2026Api.
1042
+ * @export
1043
+ * @interface TaskManagementV2026ApiGetTaskStatusListRequest
1044
+ */
1045
+ export interface TaskManagementV2026ApiGetTaskStatusListRequest {
1046
+ /**
1047
+ * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
1048
+ * @type {number}
1049
+ * @memberof TaskManagementV2026ApiGetTaskStatusList
1050
+ */
1051
+ readonly limit?: number
1052
+
1053
+ /**
1054
+ * 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.
1055
+ * @type {number}
1056
+ * @memberof TaskManagementV2026ApiGetTaskStatusList
1057
+ */
1058
+ readonly offset?: number
1059
+
1060
+ /**
1061
+ * 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&#x3D;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.
1062
+ * @type {boolean}
1063
+ * @memberof TaskManagementV2026ApiGetTaskStatusList
1064
+ */
1065
+ readonly count?: boolean
1066
+
1067
+ /**
1068
+ * 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, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** 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, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION
1069
+ * @type {string}
1070
+ * @memberof TaskManagementV2026ApiGetTaskStatusList
1071
+ */
1072
+ readonly filters?: string
1073
+
1074
+ /**
1075
+ * 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**
1076
+ * @type {string}
1077
+ * @memberof TaskManagementV2026ApiGetTaskStatusList
1078
+ */
1079
+ readonly sorters?: string
1080
+
1081
+ /**
1082
+ * Use this header to enable this experimental API.
1083
+ * @type {string}
1084
+ * @memberof TaskManagementV2026ApiGetTaskStatusList
1085
+ */
1086
+ readonly xSailPointExperimental?: string
1087
+ }
1088
+
1089
+ /**
1090
+ * Request parameters for updateTaskStatus operation in TaskManagementV2026Api.
1091
+ * @export
1092
+ * @interface TaskManagementV2026ApiUpdateTaskStatusRequest
1093
+ */
1094
+ export interface TaskManagementV2026ApiUpdateTaskStatusRequest {
1095
+ /**
1096
+ * Task ID.
1097
+ * @type {string}
1098
+ * @memberof TaskManagementV2026ApiUpdateTaskStatus
1099
+ */
1100
+ readonly id: string
1101
+
1102
+ /**
1103
+ * The JSONPatch payload used to update the object.
1104
+ * @type {Array<JsonPatchOperationV2026>}
1105
+ * @memberof TaskManagementV2026ApiUpdateTaskStatus
1106
+ */
1107
+ readonly jsonPatchOperationV2026: Array<JsonPatchOperationV2026>
1108
+
1109
+ /**
1110
+ * Use this header to enable this experimental API.
1111
+ * @type {string}
1112
+ * @memberof TaskManagementV2026ApiUpdateTaskStatus
1113
+ */
1114
+ readonly xSailPointExperimental?: string
1115
+ }
1116
+
1117
+ /**
1118
+ * TaskManagementV2026Api - object-oriented interface
1119
+ * @export
1120
+ * @class TaskManagementV2026Api
1121
+ * @extends {BaseAPI}
1122
+ */
1123
+ export class TaskManagementV2026Api extends BaseAPI {
1124
+ /**
1125
+ * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2026/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks.
1126
+ * @summary Retrieve pending task list headers
1127
+ * @param {TaskManagementV2026ApiGetPendingTaskHeadersRequest} requestParameters Request parameters.
1128
+ * @param {*} [axiosOptions] Override http request option.
1129
+ * @deprecated
1130
+ * @throws {RequiredError}
1131
+ * @memberof TaskManagementV2026Api
1132
+ */
1133
+ public getPendingTaskHeaders(requestParameters: TaskManagementV2026ApiGetPendingTaskHeadersRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
1134
+ return TaskManagementV2026ApiFp(this.configuration).getPendingTaskHeaders(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath));
1135
+ }
1136
+
1137
+ /**
1138
+ * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2026/task-status?filters=completionStatus isnull 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.
1139
+ * @summary Retrieve pending task status list
1140
+ * @param {TaskManagementV2026ApiGetPendingTasksRequest} requestParameters Request parameters.
1141
+ * @param {*} [axiosOptions] Override http request option.
1142
+ * @deprecated
1143
+ * @throws {RequiredError}
1144
+ * @memberof TaskManagementV2026Api
1145
+ */
1146
+ public getPendingTasks(requestParameters: TaskManagementV2026ApiGetPendingTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
1147
+ return TaskManagementV2026ApiFp(this.configuration).getPendingTasks(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath));
1148
+ }
1149
+
1150
+ /**
1151
+ * 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.
1152
+ * @summary Get task status by id
1153
+ * @param {TaskManagementV2026ApiGetTaskStatusRequest} requestParameters Request parameters.
1154
+ * @param {*} [axiosOptions] Override http request option.
1155
+ * @throws {RequiredError}
1156
+ * @memberof TaskManagementV2026Api
1157
+ */
1158
+ public getTaskStatus(requestParameters: TaskManagementV2026ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) {
1159
+ return TaskManagementV2026ApiFp(this.configuration).getTaskStatus(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath));
1160
+ }
1161
+
1162
+ /**
1163
+ * Use this endpoint to get a list of statuses for **all** tasks, including completed, 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. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field.
1164
+ * @summary Retrieve task status list
1165
+ * @param {TaskManagementV2026ApiGetTaskStatusListRequest} requestParameters Request parameters.
1166
+ * @param {*} [axiosOptions] Override http request option.
1167
+ * @throws {RequiredError}
1168
+ * @memberof TaskManagementV2026Api
1169
+ */
1170
+ public getTaskStatusList(requestParameters: TaskManagementV2026ApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
1171
+ return TaskManagementV2026ApiFp(this.configuration).getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath));
1172
+ }
1173
+
1174
+ /**
1175
+ * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
1176
+ * @summary Update task status by id
1177
+ * @param {TaskManagementV2026ApiUpdateTaskStatusRequest} requestParameters Request parameters.
1178
+ * @param {*} [axiosOptions] Override http request option.
1179
+ * @throws {RequiredError}
1180
+ * @memberof TaskManagementV2026Api
1181
+ */
1182
+ public updateTaskStatus(requestParameters: TaskManagementV2026ApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) {
1183
+ return TaskManagementV2026ApiFp(this.configuration).updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath));
1184
+ }
1185
+ }
1186
+
1187
+
1188
+