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
package/v2026/api.ts
ADDED
|
@@ -0,0 +1,1180 @@
|
|
|
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
|
+
* 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=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
|
+
* @throws {RequiredError}
|
|
485
|
+
*/
|
|
486
|
+
getPendingTaskHeaders: async (offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
487
|
+
if (xSailPointExperimental === undefined) {
|
|
488
|
+
xSailPointExperimental = 'true';
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
const localVarPath = `/task-status/pending-tasks`;
|
|
492
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
493
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
494
|
+
let baseOptions;
|
|
495
|
+
if (configuration) {
|
|
496
|
+
baseOptions = configuration.baseOptions;
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
const localVarRequestOptions = { method: 'HEAD', ...baseOptions, ...axiosOptions};
|
|
500
|
+
const localVarHeaderParameter = {} as any;
|
|
501
|
+
const localVarQueryParameter = {} as any;
|
|
502
|
+
|
|
503
|
+
// authentication userAuth required
|
|
504
|
+
// oauth required
|
|
505
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
506
|
+
|
|
507
|
+
// authentication userAuth required
|
|
508
|
+
// oauth required
|
|
509
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
510
|
+
|
|
511
|
+
// authentication applicationAuth required
|
|
512
|
+
// oauth required
|
|
513
|
+
await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
|
|
514
|
+
|
|
515
|
+
if (offset !== undefined) {
|
|
516
|
+
localVarQueryParameter['offset'] = offset;
|
|
517
|
+
}
|
|
518
|
+
|
|
519
|
+
if (limit !== undefined) {
|
|
520
|
+
localVarQueryParameter['limit'] = limit;
|
|
521
|
+
}
|
|
522
|
+
|
|
523
|
+
if (count !== undefined) {
|
|
524
|
+
localVarQueryParameter['count'] = count;
|
|
525
|
+
}
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
if (xSailPointExperimental != null) {
|
|
530
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
531
|
+
}
|
|
532
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
533
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
534
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
535
|
+
|
|
536
|
+
return {
|
|
537
|
+
url: toPathString(localVarUrlObj),
|
|
538
|
+
axiosOptions: localVarRequestOptions,
|
|
539
|
+
};
|
|
540
|
+
},
|
|
541
|
+
/**
|
|
542
|
+
* 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
|
|
543
|
+
* @summary Retrieve pending task status list
|
|
544
|
+
* @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.
|
|
545
|
+
* @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.
|
|
546
|
+
* @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.
|
|
547
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
548
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
549
|
+
* @throws {RequiredError}
|
|
550
|
+
*/
|
|
551
|
+
getPendingTasks: async (offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
552
|
+
if (xSailPointExperimental === undefined) {
|
|
553
|
+
xSailPointExperimental = 'true';
|
|
554
|
+
}
|
|
555
|
+
|
|
556
|
+
const localVarPath = `/task-status/pending-tasks`;
|
|
557
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
558
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
559
|
+
let baseOptions;
|
|
560
|
+
if (configuration) {
|
|
561
|
+
baseOptions = configuration.baseOptions;
|
|
562
|
+
}
|
|
563
|
+
|
|
564
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
565
|
+
const localVarHeaderParameter = {} as any;
|
|
566
|
+
const localVarQueryParameter = {} as any;
|
|
567
|
+
|
|
568
|
+
// authentication userAuth required
|
|
569
|
+
// oauth required
|
|
570
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
571
|
+
|
|
572
|
+
// authentication userAuth required
|
|
573
|
+
// oauth required
|
|
574
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
575
|
+
|
|
576
|
+
// authentication applicationAuth required
|
|
577
|
+
// oauth required
|
|
578
|
+
await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
|
|
579
|
+
|
|
580
|
+
if (offset !== undefined) {
|
|
581
|
+
localVarQueryParameter['offset'] = offset;
|
|
582
|
+
}
|
|
583
|
+
|
|
584
|
+
if (limit !== undefined) {
|
|
585
|
+
localVarQueryParameter['limit'] = limit;
|
|
586
|
+
}
|
|
587
|
+
|
|
588
|
+
if (count !== undefined) {
|
|
589
|
+
localVarQueryParameter['count'] = count;
|
|
590
|
+
}
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
if (xSailPointExperimental != null) {
|
|
595
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
596
|
+
}
|
|
597
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
598
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
599
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
600
|
+
|
|
601
|
+
return {
|
|
602
|
+
url: toPathString(localVarUrlObj),
|
|
603
|
+
axiosOptions: localVarRequestOptions,
|
|
604
|
+
};
|
|
605
|
+
},
|
|
606
|
+
/**
|
|
607
|
+
* 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.
|
|
608
|
+
* @summary Get task status by id
|
|
609
|
+
* @param {string} id Task ID.
|
|
610
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
611
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
612
|
+
* @throws {RequiredError}
|
|
613
|
+
*/
|
|
614
|
+
getTaskStatus: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
615
|
+
// verify required parameter 'id' is not null or undefined
|
|
616
|
+
assertParamExists('getTaskStatus', 'id', id)
|
|
617
|
+
if (xSailPointExperimental === undefined) {
|
|
618
|
+
xSailPointExperimental = 'true';
|
|
619
|
+
}
|
|
620
|
+
|
|
621
|
+
const localVarPath = `/task-status/{id}`
|
|
622
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
623
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
624
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
625
|
+
let baseOptions;
|
|
626
|
+
if (configuration) {
|
|
627
|
+
baseOptions = configuration.baseOptions;
|
|
628
|
+
}
|
|
629
|
+
|
|
630
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
631
|
+
const localVarHeaderParameter = {} as any;
|
|
632
|
+
const localVarQueryParameter = {} as any;
|
|
633
|
+
|
|
634
|
+
// authentication userAuth required
|
|
635
|
+
// oauth required
|
|
636
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
637
|
+
|
|
638
|
+
// authentication userAuth required
|
|
639
|
+
// oauth required
|
|
640
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
641
|
+
|
|
642
|
+
// authentication applicationAuth required
|
|
643
|
+
// oauth required
|
|
644
|
+
await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
if (xSailPointExperimental != null) {
|
|
649
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
650
|
+
}
|
|
651
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
652
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
653
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
654
|
+
|
|
655
|
+
return {
|
|
656
|
+
url: toPathString(localVarUrlObj),
|
|
657
|
+
axiosOptions: localVarRequestOptions,
|
|
658
|
+
};
|
|
659
|
+
},
|
|
660
|
+
/**
|
|
661
|
+
* 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
|
|
662
|
+
* @summary Retrieve task status list
|
|
663
|
+
* @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.
|
|
664
|
+
* @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.
|
|
665
|
+
* @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.
|
|
666
|
+
* @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*
|
|
667
|
+
* @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**
|
|
668
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
669
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
670
|
+
* @throws {RequiredError}
|
|
671
|
+
*/
|
|
672
|
+
getTaskStatusList: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
673
|
+
if (xSailPointExperimental === undefined) {
|
|
674
|
+
xSailPointExperimental = 'true';
|
|
675
|
+
}
|
|
676
|
+
|
|
677
|
+
const localVarPath = `/task-status`;
|
|
678
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
679
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
680
|
+
let baseOptions;
|
|
681
|
+
if (configuration) {
|
|
682
|
+
baseOptions = configuration.baseOptions;
|
|
683
|
+
}
|
|
684
|
+
|
|
685
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
686
|
+
const localVarHeaderParameter = {} as any;
|
|
687
|
+
const localVarQueryParameter = {} as any;
|
|
688
|
+
|
|
689
|
+
// authentication userAuth required
|
|
690
|
+
// oauth required
|
|
691
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
692
|
+
|
|
693
|
+
// authentication userAuth required
|
|
694
|
+
// oauth required
|
|
695
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
696
|
+
|
|
697
|
+
// authentication applicationAuth required
|
|
698
|
+
// oauth required
|
|
699
|
+
await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
|
|
700
|
+
|
|
701
|
+
if (limit !== undefined) {
|
|
702
|
+
localVarQueryParameter['limit'] = limit;
|
|
703
|
+
}
|
|
704
|
+
|
|
705
|
+
if (offset !== undefined) {
|
|
706
|
+
localVarQueryParameter['offset'] = offset;
|
|
707
|
+
}
|
|
708
|
+
|
|
709
|
+
if (count !== undefined) {
|
|
710
|
+
localVarQueryParameter['count'] = count;
|
|
711
|
+
}
|
|
712
|
+
|
|
713
|
+
if (filters !== undefined) {
|
|
714
|
+
localVarQueryParameter['filters'] = filters;
|
|
715
|
+
}
|
|
716
|
+
|
|
717
|
+
if (sorters !== undefined) {
|
|
718
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
719
|
+
}
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
if (xSailPointExperimental != null) {
|
|
724
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
725
|
+
}
|
|
726
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
727
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
728
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
729
|
+
|
|
730
|
+
return {
|
|
731
|
+
url: toPathString(localVarUrlObj),
|
|
732
|
+
axiosOptions: localVarRequestOptions,
|
|
733
|
+
};
|
|
734
|
+
},
|
|
735
|
+
/**
|
|
736
|
+
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
737
|
+
* @summary Update task status by id
|
|
738
|
+
* @param {string} id Task ID.
|
|
739
|
+
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
740
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
741
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
742
|
+
* @throws {RequiredError}
|
|
743
|
+
*/
|
|
744
|
+
updateTaskStatus: async (id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
745
|
+
// verify required parameter 'id' is not null or undefined
|
|
746
|
+
assertParamExists('updateTaskStatus', 'id', id)
|
|
747
|
+
// verify required parameter 'jsonPatchOperationV2026' is not null or undefined
|
|
748
|
+
assertParamExists('updateTaskStatus', 'jsonPatchOperationV2026', jsonPatchOperationV2026)
|
|
749
|
+
if (xSailPointExperimental === undefined) {
|
|
750
|
+
xSailPointExperimental = 'true';
|
|
751
|
+
}
|
|
752
|
+
|
|
753
|
+
const localVarPath = `/task-status/{id}`
|
|
754
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
755
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
756
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
757
|
+
let baseOptions;
|
|
758
|
+
if (configuration) {
|
|
759
|
+
baseOptions = configuration.baseOptions;
|
|
760
|
+
}
|
|
761
|
+
|
|
762
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions};
|
|
763
|
+
const localVarHeaderParameter = {} as any;
|
|
764
|
+
const localVarQueryParameter = {} as any;
|
|
765
|
+
|
|
766
|
+
// authentication userAuth required
|
|
767
|
+
// oauth required
|
|
768
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
769
|
+
|
|
770
|
+
// authentication userAuth required
|
|
771
|
+
// oauth required
|
|
772
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
localVarHeaderParameter['Content-Type'] = 'application/json-patch+json';
|
|
777
|
+
|
|
778
|
+
if (xSailPointExperimental != null) {
|
|
779
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
780
|
+
}
|
|
781
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
782
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
783
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
784
|
+
localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2026, localVarRequestOptions, configuration)
|
|
785
|
+
|
|
786
|
+
return {
|
|
787
|
+
url: toPathString(localVarUrlObj),
|
|
788
|
+
axiosOptions: localVarRequestOptions,
|
|
789
|
+
};
|
|
790
|
+
},
|
|
791
|
+
}
|
|
792
|
+
};
|
|
793
|
+
|
|
794
|
+
/**
|
|
795
|
+
* TaskManagementV2026Api - functional programming interface
|
|
796
|
+
* @export
|
|
797
|
+
*/
|
|
798
|
+
export const TaskManagementV2026ApiFp = function(configuration?: Configuration) {
|
|
799
|
+
const localVarAxiosParamCreator = TaskManagementV2026ApiAxiosParamCreator(configuration)
|
|
800
|
+
return {
|
|
801
|
+
/**
|
|
802
|
+
* Responds with headers only for list of task statuses for pending tasks.
|
|
803
|
+
* @summary Retrieve pending task list headers
|
|
804
|
+
* @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.
|
|
805
|
+
* @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.
|
|
806
|
+
* @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.
|
|
807
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
808
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
809
|
+
* @throws {RequiredError}
|
|
810
|
+
*/
|
|
811
|
+
async getPendingTaskHeaders(offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
812
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingTaskHeaders(offset, limit, count, xSailPointExperimental, axiosOptions);
|
|
813
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
814
|
+
const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.getPendingTaskHeaders']?.[localVarOperationServerIndex]?.url;
|
|
815
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
816
|
+
},
|
|
817
|
+
/**
|
|
818
|
+
* 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
|
|
819
|
+
* @summary Retrieve pending task status list
|
|
820
|
+
* @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.
|
|
821
|
+
* @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.
|
|
822
|
+
* @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.
|
|
823
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
824
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
825
|
+
* @throws {RequiredError}
|
|
826
|
+
*/
|
|
827
|
+
async getPendingTasks(offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskStatusV2026>>> {
|
|
828
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingTasks(offset, limit, count, xSailPointExperimental, axiosOptions);
|
|
829
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
830
|
+
const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.getPendingTasks']?.[localVarOperationServerIndex]?.url;
|
|
831
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
832
|
+
},
|
|
833
|
+
/**
|
|
834
|
+
* 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.
|
|
835
|
+
* @summary Get task status by id
|
|
836
|
+
* @param {string} id Task ID.
|
|
837
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
838
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
839
|
+
* @throws {RequiredError}
|
|
840
|
+
*/
|
|
841
|
+
async getTaskStatus(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2026>> {
|
|
842
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatus(id, xSailPointExperimental, axiosOptions);
|
|
843
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
844
|
+
const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.getTaskStatus']?.[localVarOperationServerIndex]?.url;
|
|
845
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
846
|
+
},
|
|
847
|
+
/**
|
|
848
|
+
* 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
|
|
849
|
+
* @summary Retrieve task status list
|
|
850
|
+
* @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.
|
|
851
|
+
* @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.
|
|
852
|
+
* @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.
|
|
853
|
+
* @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*
|
|
854
|
+
* @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**
|
|
855
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
856
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
857
|
+
* @throws {RequiredError}
|
|
858
|
+
*/
|
|
859
|
+
async getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskStatusV2026>>> {
|
|
860
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatusList(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions);
|
|
861
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
862
|
+
const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.getTaskStatusList']?.[localVarOperationServerIndex]?.url;
|
|
863
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
864
|
+
},
|
|
865
|
+
/**
|
|
866
|
+
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
867
|
+
* @summary Update task status by id
|
|
868
|
+
* @param {string} id Task ID.
|
|
869
|
+
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
870
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
871
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
872
|
+
* @throws {RequiredError}
|
|
873
|
+
*/
|
|
874
|
+
async updateTaskStatus(id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2026>> {
|
|
875
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateTaskStatus(id, jsonPatchOperationV2026, xSailPointExperimental, axiosOptions);
|
|
876
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
877
|
+
const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.updateTaskStatus']?.[localVarOperationServerIndex]?.url;
|
|
878
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
879
|
+
},
|
|
880
|
+
}
|
|
881
|
+
};
|
|
882
|
+
|
|
883
|
+
/**
|
|
884
|
+
* TaskManagementV2026Api - factory interface
|
|
885
|
+
* @export
|
|
886
|
+
*/
|
|
887
|
+
export const TaskManagementV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
888
|
+
const localVarFp = TaskManagementV2026ApiFp(configuration)
|
|
889
|
+
return {
|
|
890
|
+
/**
|
|
891
|
+
* Responds with headers only for list of task statuses for pending tasks.
|
|
892
|
+
* @summary Retrieve pending task list headers
|
|
893
|
+
* @param {TaskManagementV2026ApiGetPendingTaskHeadersRequest} requestParameters Request parameters.
|
|
894
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
895
|
+
* @throws {RequiredError}
|
|
896
|
+
*/
|
|
897
|
+
getPendingTaskHeaders(requestParameters: TaskManagementV2026ApiGetPendingTaskHeadersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
898
|
+
return localVarFp.getPendingTaskHeaders(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
|
|
899
|
+
},
|
|
900
|
+
/**
|
|
901
|
+
* 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
|
|
902
|
+
* @summary Retrieve pending task status list
|
|
903
|
+
* @param {TaskManagementV2026ApiGetPendingTasksRequest} requestParameters Request parameters.
|
|
904
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
905
|
+
* @throws {RequiredError}
|
|
906
|
+
*/
|
|
907
|
+
getPendingTasks(requestParameters: TaskManagementV2026ApiGetPendingTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<TaskStatusV2026>> {
|
|
908
|
+
return localVarFp.getPendingTasks(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
|
|
909
|
+
},
|
|
910
|
+
/**
|
|
911
|
+
* 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.
|
|
912
|
+
* @summary Get task status by id
|
|
913
|
+
* @param {TaskManagementV2026ApiGetTaskStatusRequest} requestParameters Request parameters.
|
|
914
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
915
|
+
* @throws {RequiredError}
|
|
916
|
+
*/
|
|
917
|
+
getTaskStatus(requestParameters: TaskManagementV2026ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TaskStatusV2026> {
|
|
918
|
+
return localVarFp.getTaskStatus(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
|
|
919
|
+
},
|
|
920
|
+
/**
|
|
921
|
+
* 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
|
|
922
|
+
* @summary Retrieve task status list
|
|
923
|
+
* @param {TaskManagementV2026ApiGetTaskStatusListRequest} requestParameters Request parameters.
|
|
924
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
925
|
+
* @throws {RequiredError}
|
|
926
|
+
*/
|
|
927
|
+
getTaskStatusList(requestParameters: TaskManagementV2026ApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<TaskStatusV2026>> {
|
|
928
|
+
return localVarFp.getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
|
|
929
|
+
},
|
|
930
|
+
/**
|
|
931
|
+
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
932
|
+
* @summary Update task status by id
|
|
933
|
+
* @param {TaskManagementV2026ApiUpdateTaskStatusRequest} requestParameters Request parameters.
|
|
934
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
935
|
+
* @throws {RequiredError}
|
|
936
|
+
*/
|
|
937
|
+
updateTaskStatus(requestParameters: TaskManagementV2026ApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TaskStatusV2026> {
|
|
938
|
+
return localVarFp.updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
|
|
939
|
+
},
|
|
940
|
+
};
|
|
941
|
+
};
|
|
942
|
+
|
|
943
|
+
/**
|
|
944
|
+
* Request parameters for getPendingTaskHeaders operation in TaskManagementV2026Api.
|
|
945
|
+
* @export
|
|
946
|
+
* @interface TaskManagementV2026ApiGetPendingTaskHeadersRequest
|
|
947
|
+
*/
|
|
948
|
+
export interface TaskManagementV2026ApiGetPendingTaskHeadersRequest {
|
|
949
|
+
/**
|
|
950
|
+
* 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.
|
|
951
|
+
* @type {number}
|
|
952
|
+
* @memberof TaskManagementV2026ApiGetPendingTaskHeaders
|
|
953
|
+
*/
|
|
954
|
+
readonly offset?: number
|
|
955
|
+
|
|
956
|
+
/**
|
|
957
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
958
|
+
* @type {number}
|
|
959
|
+
* @memberof TaskManagementV2026ApiGetPendingTaskHeaders
|
|
960
|
+
*/
|
|
961
|
+
readonly limit?: number
|
|
962
|
+
|
|
963
|
+
/**
|
|
964
|
+
* 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.
|
|
965
|
+
* @type {boolean}
|
|
966
|
+
* @memberof TaskManagementV2026ApiGetPendingTaskHeaders
|
|
967
|
+
*/
|
|
968
|
+
readonly count?: boolean
|
|
969
|
+
|
|
970
|
+
/**
|
|
971
|
+
* Use this header to enable this experimental API.
|
|
972
|
+
* @type {string}
|
|
973
|
+
* @memberof TaskManagementV2026ApiGetPendingTaskHeaders
|
|
974
|
+
*/
|
|
975
|
+
readonly xSailPointExperimental?: string
|
|
976
|
+
}
|
|
977
|
+
|
|
978
|
+
/**
|
|
979
|
+
* Request parameters for getPendingTasks operation in TaskManagementV2026Api.
|
|
980
|
+
* @export
|
|
981
|
+
* @interface TaskManagementV2026ApiGetPendingTasksRequest
|
|
982
|
+
*/
|
|
983
|
+
export interface TaskManagementV2026ApiGetPendingTasksRequest {
|
|
984
|
+
/**
|
|
985
|
+
* 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.
|
|
986
|
+
* @type {number}
|
|
987
|
+
* @memberof TaskManagementV2026ApiGetPendingTasks
|
|
988
|
+
*/
|
|
989
|
+
readonly offset?: number
|
|
990
|
+
|
|
991
|
+
/**
|
|
992
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
993
|
+
* @type {number}
|
|
994
|
+
* @memberof TaskManagementV2026ApiGetPendingTasks
|
|
995
|
+
*/
|
|
996
|
+
readonly limit?: number
|
|
997
|
+
|
|
998
|
+
/**
|
|
999
|
+
* 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.
|
|
1000
|
+
* @type {boolean}
|
|
1001
|
+
* @memberof TaskManagementV2026ApiGetPendingTasks
|
|
1002
|
+
*/
|
|
1003
|
+
readonly count?: boolean
|
|
1004
|
+
|
|
1005
|
+
/**
|
|
1006
|
+
* Use this header to enable this experimental API.
|
|
1007
|
+
* @type {string}
|
|
1008
|
+
* @memberof TaskManagementV2026ApiGetPendingTasks
|
|
1009
|
+
*/
|
|
1010
|
+
readonly xSailPointExperimental?: string
|
|
1011
|
+
}
|
|
1012
|
+
|
|
1013
|
+
/**
|
|
1014
|
+
* Request parameters for getTaskStatus operation in TaskManagementV2026Api.
|
|
1015
|
+
* @export
|
|
1016
|
+
* @interface TaskManagementV2026ApiGetTaskStatusRequest
|
|
1017
|
+
*/
|
|
1018
|
+
export interface TaskManagementV2026ApiGetTaskStatusRequest {
|
|
1019
|
+
/**
|
|
1020
|
+
* Task ID.
|
|
1021
|
+
* @type {string}
|
|
1022
|
+
* @memberof TaskManagementV2026ApiGetTaskStatus
|
|
1023
|
+
*/
|
|
1024
|
+
readonly id: string
|
|
1025
|
+
|
|
1026
|
+
/**
|
|
1027
|
+
* Use this header to enable this experimental API.
|
|
1028
|
+
* @type {string}
|
|
1029
|
+
* @memberof TaskManagementV2026ApiGetTaskStatus
|
|
1030
|
+
*/
|
|
1031
|
+
readonly xSailPointExperimental?: string
|
|
1032
|
+
}
|
|
1033
|
+
|
|
1034
|
+
/**
|
|
1035
|
+
* Request parameters for getTaskStatusList operation in TaskManagementV2026Api.
|
|
1036
|
+
* @export
|
|
1037
|
+
* @interface TaskManagementV2026ApiGetTaskStatusListRequest
|
|
1038
|
+
*/
|
|
1039
|
+
export interface TaskManagementV2026ApiGetTaskStatusListRequest {
|
|
1040
|
+
/**
|
|
1041
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1042
|
+
* @type {number}
|
|
1043
|
+
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
1044
|
+
*/
|
|
1045
|
+
readonly limit?: number
|
|
1046
|
+
|
|
1047
|
+
/**
|
|
1048
|
+
* 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.
|
|
1049
|
+
* @type {number}
|
|
1050
|
+
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
1051
|
+
*/
|
|
1052
|
+
readonly offset?: number
|
|
1053
|
+
|
|
1054
|
+
/**
|
|
1055
|
+
* 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.
|
|
1056
|
+
* @type {boolean}
|
|
1057
|
+
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
1058
|
+
*/
|
|
1059
|
+
readonly count?: boolean
|
|
1060
|
+
|
|
1061
|
+
/**
|
|
1062
|
+
* 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*
|
|
1063
|
+
* @type {string}
|
|
1064
|
+
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
1065
|
+
*/
|
|
1066
|
+
readonly filters?: string
|
|
1067
|
+
|
|
1068
|
+
/**
|
|
1069
|
+
* 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**
|
|
1070
|
+
* @type {string}
|
|
1071
|
+
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
1072
|
+
*/
|
|
1073
|
+
readonly sorters?: string
|
|
1074
|
+
|
|
1075
|
+
/**
|
|
1076
|
+
* Use this header to enable this experimental API.
|
|
1077
|
+
* @type {string}
|
|
1078
|
+
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
1079
|
+
*/
|
|
1080
|
+
readonly xSailPointExperimental?: string
|
|
1081
|
+
}
|
|
1082
|
+
|
|
1083
|
+
/**
|
|
1084
|
+
* Request parameters for updateTaskStatus operation in TaskManagementV2026Api.
|
|
1085
|
+
* @export
|
|
1086
|
+
* @interface TaskManagementV2026ApiUpdateTaskStatusRequest
|
|
1087
|
+
*/
|
|
1088
|
+
export interface TaskManagementV2026ApiUpdateTaskStatusRequest {
|
|
1089
|
+
/**
|
|
1090
|
+
* Task ID.
|
|
1091
|
+
* @type {string}
|
|
1092
|
+
* @memberof TaskManagementV2026ApiUpdateTaskStatus
|
|
1093
|
+
*/
|
|
1094
|
+
readonly id: string
|
|
1095
|
+
|
|
1096
|
+
/**
|
|
1097
|
+
* The JSONPatch payload used to update the object.
|
|
1098
|
+
* @type {Array<JsonPatchOperationV2026>}
|
|
1099
|
+
* @memberof TaskManagementV2026ApiUpdateTaskStatus
|
|
1100
|
+
*/
|
|
1101
|
+
readonly jsonPatchOperationV2026: Array<JsonPatchOperationV2026>
|
|
1102
|
+
|
|
1103
|
+
/**
|
|
1104
|
+
* Use this header to enable this experimental API.
|
|
1105
|
+
* @type {string}
|
|
1106
|
+
* @memberof TaskManagementV2026ApiUpdateTaskStatus
|
|
1107
|
+
*/
|
|
1108
|
+
readonly xSailPointExperimental?: string
|
|
1109
|
+
}
|
|
1110
|
+
|
|
1111
|
+
/**
|
|
1112
|
+
* TaskManagementV2026Api - object-oriented interface
|
|
1113
|
+
* @export
|
|
1114
|
+
* @class TaskManagementV2026Api
|
|
1115
|
+
* @extends {BaseAPI}
|
|
1116
|
+
*/
|
|
1117
|
+
export class TaskManagementV2026Api extends BaseAPI {
|
|
1118
|
+
/**
|
|
1119
|
+
* Responds with headers only for list of task statuses for pending tasks.
|
|
1120
|
+
* @summary Retrieve pending task list headers
|
|
1121
|
+
* @param {TaskManagementV2026ApiGetPendingTaskHeadersRequest} requestParameters Request parameters.
|
|
1122
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1123
|
+
* @throws {RequiredError}
|
|
1124
|
+
* @memberof TaskManagementV2026Api
|
|
1125
|
+
*/
|
|
1126
|
+
public getPendingTaskHeaders(requestParameters: TaskManagementV2026ApiGetPendingTaskHeadersRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
|
|
1127
|
+
return TaskManagementV2026ApiFp(this.configuration).getPendingTaskHeaders(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
1128
|
+
}
|
|
1129
|
+
|
|
1130
|
+
/**
|
|
1131
|
+
* 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
|
|
1132
|
+
* @summary Retrieve pending task status list
|
|
1133
|
+
* @param {TaskManagementV2026ApiGetPendingTasksRequest} requestParameters Request parameters.
|
|
1134
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1135
|
+
* @throws {RequiredError}
|
|
1136
|
+
* @memberof TaskManagementV2026Api
|
|
1137
|
+
*/
|
|
1138
|
+
public getPendingTasks(requestParameters: TaskManagementV2026ApiGetPendingTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
|
|
1139
|
+
return TaskManagementV2026ApiFp(this.configuration).getPendingTasks(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
1140
|
+
}
|
|
1141
|
+
|
|
1142
|
+
/**
|
|
1143
|
+
* 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.
|
|
1144
|
+
* @summary Get task status by id
|
|
1145
|
+
* @param {TaskManagementV2026ApiGetTaskStatusRequest} requestParameters Request parameters.
|
|
1146
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1147
|
+
* @throws {RequiredError}
|
|
1148
|
+
* @memberof TaskManagementV2026Api
|
|
1149
|
+
*/
|
|
1150
|
+
public getTaskStatus(requestParameters: TaskManagementV2026ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
1151
|
+
return TaskManagementV2026ApiFp(this.configuration).getTaskStatus(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
1152
|
+
}
|
|
1153
|
+
|
|
1154
|
+
/**
|
|
1155
|
+
* 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
|
|
1156
|
+
* @summary Retrieve task status list
|
|
1157
|
+
* @param {TaskManagementV2026ApiGetTaskStatusListRequest} requestParameters Request parameters.
|
|
1158
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1159
|
+
* @throws {RequiredError}
|
|
1160
|
+
* @memberof TaskManagementV2026Api
|
|
1161
|
+
*/
|
|
1162
|
+
public getTaskStatusList(requestParameters: TaskManagementV2026ApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
|
|
1163
|
+
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));
|
|
1164
|
+
}
|
|
1165
|
+
|
|
1166
|
+
/**
|
|
1167
|
+
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
1168
|
+
* @summary Update task status by id
|
|
1169
|
+
* @param {TaskManagementV2026ApiUpdateTaskStatusRequest} requestParameters Request parameters.
|
|
1170
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1171
|
+
* @throws {RequiredError}
|
|
1172
|
+
* @memberof TaskManagementV2026Api
|
|
1173
|
+
*/
|
|
1174
|
+
public updateTaskStatus(requestParameters: TaskManagementV2026ApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
1175
|
+
return TaskManagementV2026ApiFp(this.configuration).updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
1176
|
+
}
|
|
1177
|
+
}
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
|