sailpoint-api-client 1.4.14 → 1.4.16
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 +608 -414
- package/beta/common.ts +3 -3
- package/beta/package.json +1 -1
- package/configuration.ts +5 -1
- package/dist/beta/api.d.ts +538 -382
- package/dist/beta/api.js +222 -139
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +2 -2
- package/dist/beta/common.js.map +1 -1
- package/dist/configuration.js +6 -2
- package/dist/configuration.js.map +1 -1
- package/dist/v2024/api.d.ts +1872 -1642
- package/dist/v2024/api.js +815 -442
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +2 -2
- package/dist/v2024/common.js.map +1 -1
- package/dist/v3/api.d.ts +492 -168
- package/dist/v3/api.js +117 -69
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +2 -2
- package/dist/v3/common.js.map +1 -1
- package/package.json +9 -3
- package/v2024/README.md +2 -2
- package/v2024/api.ts +2307 -1902
- package/v2024/common.ts +3 -3
- package/v2024/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +531 -175
- package/v3/common.ts +3 -3
- package/v3/package.json +1 -1
package/v3/api.ts
CHANGED
|
@@ -310,6 +310,86 @@ export const AccessItemReviewedByTypeV3 = {
|
|
|
310
310
|
|
|
311
311
|
export type AccessItemReviewedByTypeV3 = typeof AccessItemReviewedByTypeV3[keyof typeof AccessItemReviewedByTypeV3];
|
|
312
312
|
|
|
313
|
+
/**
|
|
314
|
+
* Metadata that describes an access item
|
|
315
|
+
* @export
|
|
316
|
+
* @interface AccessModelMetadata
|
|
317
|
+
*/
|
|
318
|
+
export interface AccessModelMetadata {
|
|
319
|
+
/**
|
|
320
|
+
* Unique identifier for the metadata type
|
|
321
|
+
* @type {string}
|
|
322
|
+
* @memberof AccessModelMetadata
|
|
323
|
+
*/
|
|
324
|
+
'key'?: string;
|
|
325
|
+
/**
|
|
326
|
+
* Human readable name of the metadata type
|
|
327
|
+
* @type {string}
|
|
328
|
+
* @memberof AccessModelMetadata
|
|
329
|
+
*/
|
|
330
|
+
'name'?: string;
|
|
331
|
+
/**
|
|
332
|
+
* Allows selecting multiple values
|
|
333
|
+
* @type {boolean}
|
|
334
|
+
* @memberof AccessModelMetadata
|
|
335
|
+
*/
|
|
336
|
+
'multiselect'?: boolean;
|
|
337
|
+
/**
|
|
338
|
+
* The state of the metadata item
|
|
339
|
+
* @type {string}
|
|
340
|
+
* @memberof AccessModelMetadata
|
|
341
|
+
*/
|
|
342
|
+
'status'?: string;
|
|
343
|
+
/**
|
|
344
|
+
* The type of the metadata item
|
|
345
|
+
* @type {string}
|
|
346
|
+
* @memberof AccessModelMetadata
|
|
347
|
+
*/
|
|
348
|
+
'type'?: string;
|
|
349
|
+
/**
|
|
350
|
+
* The types of objects
|
|
351
|
+
* @type {Array<string>}
|
|
352
|
+
* @memberof AccessModelMetadata
|
|
353
|
+
*/
|
|
354
|
+
'objectTypes'?: Array<string>;
|
|
355
|
+
/**
|
|
356
|
+
* Describes the metadata item
|
|
357
|
+
* @type {string}
|
|
358
|
+
* @memberof AccessModelMetadata
|
|
359
|
+
*/
|
|
360
|
+
'description'?: string;
|
|
361
|
+
/**
|
|
362
|
+
* The value to assign to the metadata item
|
|
363
|
+
* @type {Array<AccessModelMetadataValuesInner>}
|
|
364
|
+
* @memberof AccessModelMetadata
|
|
365
|
+
*/
|
|
366
|
+
'values'?: Array<AccessModelMetadataValuesInner>;
|
|
367
|
+
}
|
|
368
|
+
/**
|
|
369
|
+
* An individual value to assign to the metadata item
|
|
370
|
+
* @export
|
|
371
|
+
* @interface AccessModelMetadataValuesInner
|
|
372
|
+
*/
|
|
373
|
+
export interface AccessModelMetadataValuesInner {
|
|
374
|
+
/**
|
|
375
|
+
* The value to assign to the metdata item
|
|
376
|
+
* @type {string}
|
|
377
|
+
* @memberof AccessModelMetadataValuesInner
|
|
378
|
+
*/
|
|
379
|
+
'value'?: string;
|
|
380
|
+
/**
|
|
381
|
+
* Display name of the value
|
|
382
|
+
* @type {string}
|
|
383
|
+
* @memberof AccessModelMetadataValuesInner
|
|
384
|
+
*/
|
|
385
|
+
'name'?: string;
|
|
386
|
+
/**
|
|
387
|
+
* The status of the individual value
|
|
388
|
+
* @type {string}
|
|
389
|
+
* @memberof AccessModelMetadataValuesInner
|
|
390
|
+
*/
|
|
391
|
+
'status'?: string;
|
|
392
|
+
}
|
|
313
393
|
/**
|
|
314
394
|
* Access Profile
|
|
315
395
|
* @export
|
|
@@ -1257,10 +1337,10 @@ export interface AccessRequestTracking {
|
|
|
1257
1337
|
'requestedItemsDetails'?: Array<RequestedItemDetails>;
|
|
1258
1338
|
/**
|
|
1259
1339
|
* a hash representation of the access requested, useful for longer term tracking client side.
|
|
1260
|
-
* @type {
|
|
1340
|
+
* @type {number}
|
|
1261
1341
|
* @memberof AccessRequestTracking
|
|
1262
1342
|
*/
|
|
1263
|
-
'attributesHash'?:
|
|
1343
|
+
'attributesHash'?: number;
|
|
1264
1344
|
/**
|
|
1265
1345
|
* a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids.
|
|
1266
1346
|
* @type {Array<string>}
|
|
@@ -1447,7 +1527,7 @@ export interface Account {
|
|
|
1447
1527
|
* @type {string}
|
|
1448
1528
|
* @memberof Account
|
|
1449
1529
|
*/
|
|
1450
|
-
'name': string;
|
|
1530
|
+
'name': string | null;
|
|
1451
1531
|
/**
|
|
1452
1532
|
* Creation date of the Object
|
|
1453
1533
|
* @type {string}
|
|
@@ -1504,10 +1584,10 @@ export interface Account {
|
|
|
1504
1584
|
'isMachine'?: boolean;
|
|
1505
1585
|
/**
|
|
1506
1586
|
*
|
|
1507
|
-
* @type {
|
|
1587
|
+
* @type {AccountAllOfRecommendation}
|
|
1508
1588
|
* @memberof Account
|
|
1509
1589
|
*/
|
|
1510
|
-
'recommendation'?:
|
|
1590
|
+
'recommendation'?: AccountAllOfRecommendation;
|
|
1511
1591
|
/**
|
|
1512
1592
|
* The account attributes that are aggregated
|
|
1513
1593
|
* @type {{ [key: string]: any; }}
|
|
@@ -1576,16 +1656,16 @@ export interface Account {
|
|
|
1576
1656
|
'hasEntitlements': boolean;
|
|
1577
1657
|
/**
|
|
1578
1658
|
*
|
|
1579
|
-
* @type {
|
|
1659
|
+
* @type {AccountAllOfIdentity}
|
|
1580
1660
|
* @memberof Account
|
|
1581
1661
|
*/
|
|
1582
|
-
'identity'?:
|
|
1662
|
+
'identity'?: AccountAllOfIdentity;
|
|
1583
1663
|
/**
|
|
1584
1664
|
*
|
|
1585
|
-
* @type {
|
|
1665
|
+
* @type {AccountAllOfSourceOwner}
|
|
1586
1666
|
* @memberof Account
|
|
1587
1667
|
*/
|
|
1588
|
-
'sourceOwner'?:
|
|
1668
|
+
'sourceOwner'?: AccountAllOfSourceOwner | null;
|
|
1589
1669
|
/**
|
|
1590
1670
|
* A string list containing the owning source\'s features
|
|
1591
1671
|
* @type {string}
|
|
@@ -1600,10 +1680,10 @@ export interface Account {
|
|
|
1600
1680
|
'origin'?: AccountOriginV3 | null;
|
|
1601
1681
|
/**
|
|
1602
1682
|
*
|
|
1603
|
-
* @type {
|
|
1683
|
+
* @type {AccountAllOfOwnerIdentity}
|
|
1604
1684
|
* @memberof Account
|
|
1605
1685
|
*/
|
|
1606
|
-
'ownerIdentity'?:
|
|
1686
|
+
'ownerIdentity'?: AccountAllOfOwnerIdentity;
|
|
1607
1687
|
}
|
|
1608
1688
|
|
|
1609
1689
|
export const AccountOriginV3 = {
|
|
@@ -2237,6 +2317,131 @@ export interface AccountActivitySearchedItem {
|
|
|
2237
2317
|
*/
|
|
2238
2318
|
'sources'?: string;
|
|
2239
2319
|
}
|
|
2320
|
+
/**
|
|
2321
|
+
* The identity this account is correlated to
|
|
2322
|
+
* @export
|
|
2323
|
+
* @interface AccountAllOfIdentity
|
|
2324
|
+
*/
|
|
2325
|
+
export interface AccountAllOfIdentity {
|
|
2326
|
+
/**
|
|
2327
|
+
* The ID of the identity
|
|
2328
|
+
* @type {string}
|
|
2329
|
+
* @memberof AccountAllOfIdentity
|
|
2330
|
+
*/
|
|
2331
|
+
'id'?: string;
|
|
2332
|
+
/**
|
|
2333
|
+
* The type of object being referenced
|
|
2334
|
+
* @type {string}
|
|
2335
|
+
* @memberof AccountAllOfIdentity
|
|
2336
|
+
*/
|
|
2337
|
+
'type'?: AccountAllOfIdentityTypeV3;
|
|
2338
|
+
/**
|
|
2339
|
+
* display name of identity
|
|
2340
|
+
* @type {string}
|
|
2341
|
+
* @memberof AccountAllOfIdentity
|
|
2342
|
+
*/
|
|
2343
|
+
'name'?: string;
|
|
2344
|
+
}
|
|
2345
|
+
|
|
2346
|
+
export const AccountAllOfIdentityTypeV3 = {
|
|
2347
|
+
Identity: 'IDENTITY'
|
|
2348
|
+
} as const;
|
|
2349
|
+
|
|
2350
|
+
export type AccountAllOfIdentityTypeV3 = typeof AccountAllOfIdentityTypeV3[keyof typeof AccountAllOfIdentityTypeV3];
|
|
2351
|
+
|
|
2352
|
+
/**
|
|
2353
|
+
*
|
|
2354
|
+
* @export
|
|
2355
|
+
* @interface AccountAllOfOwnerIdentity
|
|
2356
|
+
*/
|
|
2357
|
+
export interface AccountAllOfOwnerIdentity {
|
|
2358
|
+
/**
|
|
2359
|
+
*
|
|
2360
|
+
* @type {DtoType}
|
|
2361
|
+
* @memberof AccountAllOfOwnerIdentity
|
|
2362
|
+
*/
|
|
2363
|
+
'type'?: DtoType;
|
|
2364
|
+
/**
|
|
2365
|
+
* ID of the object to which this reference applies
|
|
2366
|
+
* @type {string}
|
|
2367
|
+
* @memberof AccountAllOfOwnerIdentity
|
|
2368
|
+
*/
|
|
2369
|
+
'id'?: string;
|
|
2370
|
+
/**
|
|
2371
|
+
* Human-readable display name of the object to which this reference applies
|
|
2372
|
+
* @type {string}
|
|
2373
|
+
* @memberof AccountAllOfOwnerIdentity
|
|
2374
|
+
*/
|
|
2375
|
+
'name'?: string;
|
|
2376
|
+
}
|
|
2377
|
+
|
|
2378
|
+
|
|
2379
|
+
/**
|
|
2380
|
+
*
|
|
2381
|
+
* @export
|
|
2382
|
+
* @interface AccountAllOfRecommendation
|
|
2383
|
+
*/
|
|
2384
|
+
export interface AccountAllOfRecommendation {
|
|
2385
|
+
/**
|
|
2386
|
+
* Recommended type of account.
|
|
2387
|
+
* @type {string}
|
|
2388
|
+
* @memberof AccountAllOfRecommendation
|
|
2389
|
+
*/
|
|
2390
|
+
'type': AccountAllOfRecommendationTypeV3;
|
|
2391
|
+
/**
|
|
2392
|
+
* Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria.
|
|
2393
|
+
* @type {string}
|
|
2394
|
+
* @memberof AccountAllOfRecommendation
|
|
2395
|
+
*/
|
|
2396
|
+
'method': AccountAllOfRecommendationMethodV3;
|
|
2397
|
+
}
|
|
2398
|
+
|
|
2399
|
+
export const AccountAllOfRecommendationTypeV3 = {
|
|
2400
|
+
Human: 'HUMAN',
|
|
2401
|
+
Machine: 'MACHINE'
|
|
2402
|
+
} as const;
|
|
2403
|
+
|
|
2404
|
+
export type AccountAllOfRecommendationTypeV3 = typeof AccountAllOfRecommendationTypeV3[keyof typeof AccountAllOfRecommendationTypeV3];
|
|
2405
|
+
export const AccountAllOfRecommendationMethodV3 = {
|
|
2406
|
+
Discovery: 'DISCOVERY',
|
|
2407
|
+
Source: 'SOURCE',
|
|
2408
|
+
Criteria: 'CRITERIA'
|
|
2409
|
+
} as const;
|
|
2410
|
+
|
|
2411
|
+
export type AccountAllOfRecommendationMethodV3 = typeof AccountAllOfRecommendationMethodV3[keyof typeof AccountAllOfRecommendationMethodV3];
|
|
2412
|
+
|
|
2413
|
+
/**
|
|
2414
|
+
* The owner of the source this account belongs to.
|
|
2415
|
+
* @export
|
|
2416
|
+
* @interface AccountAllOfSourceOwner
|
|
2417
|
+
*/
|
|
2418
|
+
export interface AccountAllOfSourceOwner {
|
|
2419
|
+
/**
|
|
2420
|
+
* The ID of the identity
|
|
2421
|
+
* @type {string}
|
|
2422
|
+
* @memberof AccountAllOfSourceOwner
|
|
2423
|
+
*/
|
|
2424
|
+
'id'?: string;
|
|
2425
|
+
/**
|
|
2426
|
+
* The type of object being referenced
|
|
2427
|
+
* @type {string}
|
|
2428
|
+
* @memberof AccountAllOfSourceOwner
|
|
2429
|
+
*/
|
|
2430
|
+
'type'?: AccountAllOfSourceOwnerTypeV3;
|
|
2431
|
+
/**
|
|
2432
|
+
* display name of identity
|
|
2433
|
+
* @type {string}
|
|
2434
|
+
* @memberof AccountAllOfSourceOwner
|
|
2435
|
+
*/
|
|
2436
|
+
'name'?: string;
|
|
2437
|
+
}
|
|
2438
|
+
|
|
2439
|
+
export const AccountAllOfSourceOwnerTypeV3 = {
|
|
2440
|
+
Identity: 'IDENTITY'
|
|
2441
|
+
} as const;
|
|
2442
|
+
|
|
2443
|
+
export type AccountAllOfSourceOwnerTypeV3 = typeof AccountAllOfSourceOwnerTypeV3[keyof typeof AccountAllOfSourceOwnerTypeV3];
|
|
2444
|
+
|
|
2240
2445
|
/**
|
|
2241
2446
|
*
|
|
2242
2447
|
* @export
|
|
@@ -3521,43 +3726,43 @@ export interface AuthUser {
|
|
|
3521
3726
|
* @type {string}
|
|
3522
3727
|
* @memberof AuthUser
|
|
3523
3728
|
*/
|
|
3524
|
-
'identificationNumber'?: string;
|
|
3729
|
+
'identificationNumber'?: string | null;
|
|
3525
3730
|
/**
|
|
3526
3731
|
* Auth user\'s email.
|
|
3527
3732
|
* @type {string}
|
|
3528
3733
|
* @memberof AuthUser
|
|
3529
3734
|
*/
|
|
3530
|
-
'email'?: string;
|
|
3735
|
+
'email'?: string | null;
|
|
3531
3736
|
/**
|
|
3532
3737
|
* Auth user\'s phone number.
|
|
3533
3738
|
* @type {string}
|
|
3534
3739
|
* @memberof AuthUser
|
|
3535
3740
|
*/
|
|
3536
|
-
'phone'?: string;
|
|
3741
|
+
'phone'?: string | null;
|
|
3537
3742
|
/**
|
|
3538
3743
|
* Auth user\'s work phone number.
|
|
3539
3744
|
* @type {string}
|
|
3540
3745
|
* @memberof AuthUser
|
|
3541
3746
|
*/
|
|
3542
|
-
'workPhone'?: string;
|
|
3747
|
+
'workPhone'?: string | null;
|
|
3543
3748
|
/**
|
|
3544
3749
|
* Auth user\'s personal email.
|
|
3545
3750
|
* @type {string}
|
|
3546
3751
|
* @memberof AuthUser
|
|
3547
3752
|
*/
|
|
3548
|
-
'personalEmail'?: string;
|
|
3753
|
+
'personalEmail'?: string | null;
|
|
3549
3754
|
/**
|
|
3550
3755
|
* Auth user\'s first name.
|
|
3551
3756
|
* @type {string}
|
|
3552
3757
|
* @memberof AuthUser
|
|
3553
3758
|
*/
|
|
3554
|
-
'firstname'?: string;
|
|
3759
|
+
'firstname'?: string | null;
|
|
3555
3760
|
/**
|
|
3556
3761
|
* Auth user\'s last name.
|
|
3557
3762
|
* @type {string}
|
|
3558
3763
|
* @memberof AuthUser
|
|
3559
3764
|
*/
|
|
3560
|
-
'lastname'?: string;
|
|
3765
|
+
'lastname'?: string | null;
|
|
3561
3766
|
/**
|
|
3562
3767
|
* Auth user\'s name in displayed format.
|
|
3563
3768
|
* @type {string}
|
|
@@ -3575,7 +3780,7 @@ export interface AuthUser {
|
|
|
3575
3780
|
* @type {string}
|
|
3576
3781
|
* @memberof AuthUser
|
|
3577
3782
|
*/
|
|
3578
|
-
'lastPasswordChangeDate'?: string;
|
|
3783
|
+
'lastPasswordChangeDate'?: string | null;
|
|
3579
3784
|
/**
|
|
3580
3785
|
* Timestamp of the last login (long type value).
|
|
3581
3786
|
* @type {number}
|
|
@@ -3588,12 +3793,18 @@ export interface AuthUser {
|
|
|
3588
3793
|
* @memberof AuthUser
|
|
3589
3794
|
*/
|
|
3590
3795
|
'currentLoginTimestamp'?: number;
|
|
3796
|
+
/**
|
|
3797
|
+
* The date and time when the user was last unlocked.
|
|
3798
|
+
* @type {string}
|
|
3799
|
+
* @memberof AuthUser
|
|
3800
|
+
*/
|
|
3801
|
+
'lastUnlockTimestamp'?: string | null;
|
|
3591
3802
|
/**
|
|
3592
3803
|
* Array of the auth user\'s capabilities.
|
|
3593
3804
|
* @type {Array<string>}
|
|
3594
3805
|
* @memberof AuthUser
|
|
3595
3806
|
*/
|
|
3596
|
-
'capabilities'?: Array<AuthUserCapabilitiesV3
|
|
3807
|
+
'capabilities'?: Array<AuthUserCapabilitiesV3> | null;
|
|
3597
3808
|
}
|
|
3598
3809
|
|
|
3599
3810
|
export const AuthUserCapabilitiesV3 = {
|
|
@@ -4068,7 +4279,7 @@ export interface BaseCommonDto {
|
|
|
4068
4279
|
* @type {string}
|
|
4069
4280
|
* @memberof BaseCommonDto
|
|
4070
4281
|
*/
|
|
4071
|
-
'name': string;
|
|
4282
|
+
'name': string | null;
|
|
4072
4283
|
/**
|
|
4073
4284
|
* Creation date of the Object
|
|
4074
4285
|
* @type {string}
|
|
@@ -5440,7 +5651,7 @@ export interface Certification {
|
|
|
5440
5651
|
* @type {string}
|
|
5441
5652
|
* @memberof Certification
|
|
5442
5653
|
*/
|
|
5443
|
-
'due'?: string;
|
|
5654
|
+
'due'?: string | null;
|
|
5444
5655
|
/**
|
|
5445
5656
|
* The date the reviewer signed off on the Certification.
|
|
5446
5657
|
* @type {string}
|
|
@@ -7596,7 +7807,7 @@ export interface Entitlement {
|
|
|
7596
7807
|
* @type {string}
|
|
7597
7808
|
* @memberof Entitlement
|
|
7598
7809
|
*/
|
|
7599
|
-
'description'?: string;
|
|
7810
|
+
'description'?: string | null;
|
|
7600
7811
|
/**
|
|
7601
7812
|
* True if the entitlement is privileged
|
|
7602
7813
|
* @type {boolean}
|
|
@@ -7609,6 +7820,30 @@ export interface Entitlement {
|
|
|
7609
7820
|
* @memberof Entitlement
|
|
7610
7821
|
*/
|
|
7611
7822
|
'cloudGoverned'?: boolean;
|
|
7823
|
+
/**
|
|
7824
|
+
* True if the entitlement is able to be directly requested
|
|
7825
|
+
* @type {boolean}
|
|
7826
|
+
* @memberof Entitlement
|
|
7827
|
+
*/
|
|
7828
|
+
'requestable'?: boolean;
|
|
7829
|
+
/**
|
|
7830
|
+
*
|
|
7831
|
+
* @type {EntitlementOwner}
|
|
7832
|
+
* @memberof Entitlement
|
|
7833
|
+
*/
|
|
7834
|
+
'owner'?: EntitlementOwner | null;
|
|
7835
|
+
/**
|
|
7836
|
+
* A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated.
|
|
7837
|
+
* @type {{ [key: string]: any; }}
|
|
7838
|
+
* @memberof Entitlement
|
|
7839
|
+
*/
|
|
7840
|
+
'manuallyUpdatedFields'?: { [key: string]: any; } | null;
|
|
7841
|
+
/**
|
|
7842
|
+
*
|
|
7843
|
+
* @type {EntitlementAccessModelMetadata}
|
|
7844
|
+
* @memberof Entitlement
|
|
7845
|
+
*/
|
|
7846
|
+
'accessModelMetadata'?: EntitlementAccessModelMetadata;
|
|
7612
7847
|
/**
|
|
7613
7848
|
* Time when the entitlement was created
|
|
7614
7849
|
* @type {string}
|
|
@@ -7646,6 +7881,19 @@ export interface Entitlement {
|
|
|
7646
7881
|
*/
|
|
7647
7882
|
'directPermissions'?: Array<PermissionDto>;
|
|
7648
7883
|
}
|
|
7884
|
+
/**
|
|
7885
|
+
* Additional data to classify the entitlement
|
|
7886
|
+
* @export
|
|
7887
|
+
* @interface EntitlementAccessModelMetadata
|
|
7888
|
+
*/
|
|
7889
|
+
export interface EntitlementAccessModelMetadata {
|
|
7890
|
+
/**
|
|
7891
|
+
*
|
|
7892
|
+
* @type {Array<AccessModelMetadata>}
|
|
7893
|
+
* @memberof EntitlementAccessModelMetadata
|
|
7894
|
+
*/
|
|
7895
|
+
'attributes'?: Array<AccessModelMetadata>;
|
|
7896
|
+
}
|
|
7649
7897
|
/**
|
|
7650
7898
|
* Entitlement
|
|
7651
7899
|
* @export
|
|
@@ -8032,84 +8280,37 @@ export interface EntitlementDocuments {
|
|
|
8032
8280
|
|
|
8033
8281
|
|
|
8034
8282
|
/**
|
|
8035
|
-
*
|
|
8283
|
+
* The identity that owns the entitlement
|
|
8036
8284
|
* @export
|
|
8037
|
-
* @interface
|
|
8285
|
+
* @interface EntitlementOwner
|
|
8038
8286
|
*/
|
|
8039
|
-
export interface
|
|
8287
|
+
export interface EntitlementOwner {
|
|
8040
8288
|
/**
|
|
8041
|
-
*
|
|
8289
|
+
* The identity ID
|
|
8042
8290
|
* @type {string}
|
|
8043
|
-
* @memberof
|
|
8291
|
+
* @memberof EntitlementOwner
|
|
8044
8292
|
*/
|
|
8045
8293
|
'id'?: string;
|
|
8046
8294
|
/**
|
|
8047
|
-
*
|
|
8048
|
-
* @type {string}
|
|
8049
|
-
* @memberof EntitlementDto
|
|
8050
|
-
*/
|
|
8051
|
-
'name': string;
|
|
8052
|
-
/**
|
|
8053
|
-
* Creation date of the Object
|
|
8054
|
-
* @type {string}
|
|
8055
|
-
* @memberof EntitlementDto
|
|
8056
|
-
*/
|
|
8057
|
-
'created'?: string;
|
|
8058
|
-
/**
|
|
8059
|
-
* Last modification date of the Object
|
|
8060
|
-
* @type {string}
|
|
8061
|
-
* @memberof EntitlementDto
|
|
8062
|
-
*/
|
|
8063
|
-
'modified'?: string;
|
|
8064
|
-
/**
|
|
8065
|
-
* Name of the entitlement attribute
|
|
8066
|
-
* @type {string}
|
|
8067
|
-
* @memberof EntitlementDto
|
|
8068
|
-
*/
|
|
8069
|
-
'attribute'?: string;
|
|
8070
|
-
/**
|
|
8071
|
-
* Raw value of the entitlement
|
|
8072
|
-
* @type {string}
|
|
8073
|
-
* @memberof EntitlementDto
|
|
8074
|
-
*/
|
|
8075
|
-
'value'?: string;
|
|
8076
|
-
/**
|
|
8077
|
-
* Entitlment description
|
|
8295
|
+
* The type of object
|
|
8078
8296
|
* @type {string}
|
|
8079
|
-
* @memberof
|
|
8297
|
+
* @memberof EntitlementOwner
|
|
8080
8298
|
*/
|
|
8081
|
-
'
|
|
8082
|
-
/**
|
|
8083
|
-
* Entitlement attributes
|
|
8084
|
-
* @type {{ [key: string]: any; }}
|
|
8085
|
-
* @memberof EntitlementDto
|
|
8086
|
-
*/
|
|
8087
|
-
'attributes'?: { [key: string]: any; };
|
|
8299
|
+
'type'?: EntitlementOwnerTypeV3;
|
|
8088
8300
|
/**
|
|
8089
|
-
*
|
|
8301
|
+
* The display name of the identity
|
|
8090
8302
|
* @type {string}
|
|
8091
|
-
* @memberof
|
|
8092
|
-
*/
|
|
8093
|
-
'sourceSchemaObjectType'?: string;
|
|
8094
|
-
/**
|
|
8095
|
-
* Determines if this Entitlement is privileged.
|
|
8096
|
-
* @type {boolean}
|
|
8097
|
-
* @memberof EntitlementDto
|
|
8098
|
-
*/
|
|
8099
|
-
'privileged'?: boolean;
|
|
8100
|
-
/**
|
|
8101
|
-
* Determines if this Entitlement is goverened in the cloud.
|
|
8102
|
-
* @type {boolean}
|
|
8103
|
-
* @memberof EntitlementDto
|
|
8104
|
-
*/
|
|
8105
|
-
'cloudGoverned'?: boolean;
|
|
8106
|
-
/**
|
|
8107
|
-
*
|
|
8108
|
-
* @type {EntitlementSource}
|
|
8109
|
-
* @memberof EntitlementDto
|
|
8303
|
+
* @memberof EntitlementOwner
|
|
8110
8304
|
*/
|
|
8111
|
-
'
|
|
8305
|
+
'name'?: string;
|
|
8112
8306
|
}
|
|
8307
|
+
|
|
8308
|
+
export const EntitlementOwnerTypeV3 = {
|
|
8309
|
+
Identity: 'IDENTITY'
|
|
8310
|
+
} as const;
|
|
8311
|
+
|
|
8312
|
+
export type EntitlementOwnerTypeV3 = typeof EntitlementOwnerTypeV3[keyof typeof EntitlementOwnerTypeV3];
|
|
8313
|
+
|
|
8113
8314
|
/**
|
|
8114
8315
|
* Entitlement including a specific set of access.
|
|
8115
8316
|
* @export
|
|
@@ -8507,6 +8708,12 @@ export interface EventAttributes {
|
|
|
8507
8708
|
* @memberof EventAttributes
|
|
8508
8709
|
*/
|
|
8509
8710
|
'attributeToFilter'?: string;
|
|
8711
|
+
/**
|
|
8712
|
+
* Form definition\'s unique identifier.
|
|
8713
|
+
* @type {string}
|
|
8714
|
+
* @memberof EventAttributes
|
|
8715
|
+
*/
|
|
8716
|
+
'formDefinitionId'?: string;
|
|
8510
8717
|
}
|
|
8511
8718
|
/**
|
|
8512
8719
|
* Event
|
|
@@ -10171,7 +10378,7 @@ export interface IdentityCertificationDto {
|
|
|
10171
10378
|
* @type {string}
|
|
10172
10379
|
* @memberof IdentityCertificationDto
|
|
10173
10380
|
*/
|
|
10174
|
-
'due'?: string;
|
|
10381
|
+
'due'?: string | null;
|
|
10175
10382
|
/**
|
|
10176
10383
|
* The date the reviewer signed off on the Certification.
|
|
10177
10384
|
* @type {string}
|
|
@@ -10882,7 +11089,7 @@ export interface IdentityProfile {
|
|
|
10882
11089
|
* @type {string}
|
|
10883
11090
|
* @memberof IdentityProfile
|
|
10884
11091
|
*/
|
|
10885
|
-
'name': string;
|
|
11092
|
+
'name': string | null;
|
|
10886
11093
|
/**
|
|
10887
11094
|
* Creation date of the Object
|
|
10888
11095
|
* @type {string}
|
|
@@ -11435,6 +11642,7 @@ export interface ImportObject {
|
|
|
11435
11642
|
}
|
|
11436
11643
|
|
|
11437
11644
|
export const ImportObjectTypeV3 = {
|
|
11645
|
+
ConnectorRule: 'CONNECTOR_RULE',
|
|
11438
11646
|
IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG',
|
|
11439
11647
|
IdentityProfile: 'IDENTITY_PROFILE',
|
|
11440
11648
|
Rule: 'RULE',
|
|
@@ -11749,7 +11957,7 @@ export interface LifecycleState {
|
|
|
11749
11957
|
* @type {string}
|
|
11750
11958
|
* @memberof LifecycleState
|
|
11751
11959
|
*/
|
|
11752
|
-
'name': string;
|
|
11960
|
+
'name': string | null;
|
|
11753
11961
|
/**
|
|
11754
11962
|
* Creation date of the Object
|
|
11755
11963
|
* @type {string}
|
|
@@ -12419,7 +12627,7 @@ export interface ManagedCluster {
|
|
|
12419
12627
|
* @type {string}
|
|
12420
12628
|
* @memberof ManagedCluster
|
|
12421
12629
|
*/
|
|
12422
|
-
'status'?:
|
|
12630
|
+
'status'?: ManagedClusterStatusV3;
|
|
12423
12631
|
/**
|
|
12424
12632
|
* Public key certificate
|
|
12425
12633
|
* @type {string}
|
|
@@ -12476,6 +12684,15 @@ export interface ManagedCluster {
|
|
|
12476
12684
|
'updatedAt'?: string | null;
|
|
12477
12685
|
}
|
|
12478
12686
|
|
|
12687
|
+
export const ManagedClusterStatusV3 = {
|
|
12688
|
+
Configuring: 'CONFIGURING',
|
|
12689
|
+
Failed: 'FAILED',
|
|
12690
|
+
NoClients: 'NO_CLIENTS',
|
|
12691
|
+
Normal: 'NORMAL',
|
|
12692
|
+
Warning: 'WARNING'
|
|
12693
|
+
} as const;
|
|
12694
|
+
|
|
12695
|
+
export type ManagedClusterStatusV3 = typeof ManagedClusterStatusV3[keyof typeof ManagedClusterStatusV3];
|
|
12479
12696
|
|
|
12480
12697
|
/**
|
|
12481
12698
|
* Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster]
|
|
@@ -15352,6 +15569,12 @@ export interface PendingApproval {
|
|
|
15352
15569
|
* @memberof PendingApproval
|
|
15353
15570
|
*/
|
|
15354
15571
|
'sodViolationContext'?: SodViolationContextCheckCompleted | null;
|
|
15572
|
+
/**
|
|
15573
|
+
* Arbitrary key-value pairs, if any were included in the corresponding access request item
|
|
15574
|
+
* @type {{ [key: string]: string; }}
|
|
15575
|
+
* @memberof PendingApproval
|
|
15576
|
+
*/
|
|
15577
|
+
'clientMetadata'?: { [key: string]: string; } | null;
|
|
15355
15578
|
}
|
|
15356
15579
|
|
|
15357
15580
|
|
|
@@ -16492,11 +16715,73 @@ export const ReportDetailsReportTypeV3 = {
|
|
|
16492
16715
|
export type ReportDetailsReportTypeV3 = typeof ReportDetailsReportTypeV3[keyof typeof ReportDetailsReportTypeV3];
|
|
16493
16716
|
|
|
16494
16717
|
/**
|
|
16495
|
-
* @type ReportDetailsArguments
|
|
16496
16718
|
* The string-object map(dictionary) with the arguments needed for report processing.
|
|
16497
16719
|
* @export
|
|
16720
|
+
* @interface ReportDetailsArguments
|
|
16498
16721
|
*/
|
|
16499
|
-
export
|
|
16722
|
+
export interface ReportDetailsArguments {
|
|
16723
|
+
/**
|
|
16724
|
+
* Source ID.
|
|
16725
|
+
* @type {string}
|
|
16726
|
+
* @memberof ReportDetailsArguments
|
|
16727
|
+
*/
|
|
16728
|
+
'application': string;
|
|
16729
|
+
/**
|
|
16730
|
+
* Source name.
|
|
16731
|
+
* @type {string}
|
|
16732
|
+
* @memberof ReportDetailsArguments
|
|
16733
|
+
*/
|
|
16734
|
+
'sourceName': string;
|
|
16735
|
+
/**
|
|
16736
|
+
* Flag to specify if only correlated identities are included in report.
|
|
16737
|
+
* @type {boolean}
|
|
16738
|
+
* @memberof ReportDetailsArguments
|
|
16739
|
+
*/
|
|
16740
|
+
'correlatedOnly': boolean;
|
|
16741
|
+
/**
|
|
16742
|
+
* Source ID.
|
|
16743
|
+
* @type {string}
|
|
16744
|
+
* @memberof ReportDetailsArguments
|
|
16745
|
+
*/
|
|
16746
|
+
'authoritativeSource': string;
|
|
16747
|
+
/**
|
|
16748
|
+
* Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default.
|
|
16749
|
+
* @type {Array<string>}
|
|
16750
|
+
* @memberof ReportDetailsArguments
|
|
16751
|
+
*/
|
|
16752
|
+
'selectedFormats'?: Array<ReportDetailsArgumentsSelectedFormatsV3>;
|
|
16753
|
+
/**
|
|
16754
|
+
* The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.
|
|
16755
|
+
* @type {Array<Index>}
|
|
16756
|
+
* @memberof ReportDetailsArguments
|
|
16757
|
+
*/
|
|
16758
|
+
'indices'?: Array<Index>;
|
|
16759
|
+
/**
|
|
16760
|
+
* The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.
|
|
16761
|
+
* @type {string}
|
|
16762
|
+
* @memberof ReportDetailsArguments
|
|
16763
|
+
*/
|
|
16764
|
+
'query': string;
|
|
16765
|
+
/**
|
|
16766
|
+
* Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details.
|
|
16767
|
+
* @type {string}
|
|
16768
|
+
* @memberof ReportDetailsArguments
|
|
16769
|
+
*/
|
|
16770
|
+
'columns'?: string;
|
|
16771
|
+
/**
|
|
16772
|
+
* The fields to be used to sort the search results. Use + or - to specify the sort direction.
|
|
16773
|
+
* @type {Array<string>}
|
|
16774
|
+
* @memberof ReportDetailsArguments
|
|
16775
|
+
*/
|
|
16776
|
+
'sort'?: Array<string>;
|
|
16777
|
+
}
|
|
16778
|
+
|
|
16779
|
+
export const ReportDetailsArgumentsSelectedFormatsV3 = {
|
|
16780
|
+
Csv: 'CSV',
|
|
16781
|
+
Pdf: 'PDF'
|
|
16782
|
+
} as const;
|
|
16783
|
+
|
|
16784
|
+
export type ReportDetailsArgumentsSelectedFormatsV3 = typeof ReportDetailsArgumentsSelectedFormatsV3[keyof typeof ReportDetailsArgumentsSelectedFormatsV3];
|
|
16500
16785
|
|
|
16501
16786
|
/**
|
|
16502
16787
|
*
|
|
@@ -16838,7 +17123,7 @@ export type RequestableObjectRequestStatus = typeof RequestableObjectRequestStat
|
|
|
16838
17123
|
|
|
16839
17124
|
|
|
16840
17125
|
/**
|
|
16841
|
-
*
|
|
17126
|
+
* Currently supported requestable object types.
|
|
16842
17127
|
* @export
|
|
16843
17128
|
* @enum {string}
|
|
16844
17129
|
*/
|
|
@@ -16886,6 +17171,12 @@ export type RequestedItemDetailsTypeV3 = typeof RequestedItemDetailsTypeV3[keyof
|
|
|
16886
17171
|
* @interface RequestedItemStatus
|
|
16887
17172
|
*/
|
|
16888
17173
|
export interface RequestedItemStatus {
|
|
17174
|
+
/**
|
|
17175
|
+
* The ID of the access request.
|
|
17176
|
+
* @type {string}
|
|
17177
|
+
* @memberof RequestedItemStatus
|
|
17178
|
+
*/
|
|
17179
|
+
'id'?: string;
|
|
16889
17180
|
/**
|
|
16890
17181
|
* Human-readable display name of the item being requested.
|
|
16891
17182
|
* @type {string}
|
|
@@ -18996,7 +19287,7 @@ export interface Schedule {
|
|
|
18996
19287
|
* @type {ScheduleMonths}
|
|
18997
19288
|
* @memberof Schedule
|
|
18998
19289
|
*/
|
|
18999
|
-
'months'?: ScheduleMonths;
|
|
19290
|
+
'months'?: ScheduleMonths | null;
|
|
19000
19291
|
/**
|
|
19001
19292
|
*
|
|
19002
19293
|
* @type {ScheduleDays}
|
|
@@ -19014,7 +19305,7 @@ export interface Schedule {
|
|
|
19014
19305
|
* @type {string}
|
|
19015
19306
|
* @memberof Schedule
|
|
19016
19307
|
*/
|
|
19017
|
-
'expiration'?: string;
|
|
19308
|
+
'expiration'?: string | null;
|
|
19018
19309
|
/**
|
|
19019
19310
|
* The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST.
|
|
19020
19311
|
* @type {string}
|
|
@@ -19181,7 +19472,7 @@ export interface ScheduleDays {
|
|
|
19181
19472
|
* @type {number}
|
|
19182
19473
|
* @memberof ScheduleDays
|
|
19183
19474
|
*/
|
|
19184
|
-
'interval'?: number;
|
|
19475
|
+
'interval'?: number | null;
|
|
19185
19476
|
}
|
|
19186
19477
|
|
|
19187
19478
|
export const ScheduleDaysTypeV3 = {
|
|
@@ -19214,7 +19505,7 @@ export interface ScheduleHours {
|
|
|
19214
19505
|
* @type {number}
|
|
19215
19506
|
* @memberof ScheduleHours
|
|
19216
19507
|
*/
|
|
19217
|
-
'interval'?: number;
|
|
19508
|
+
'interval'?: number | null;
|
|
19218
19509
|
}
|
|
19219
19510
|
|
|
19220
19511
|
export const ScheduleHoursTypeV3 = {
|
|
@@ -19310,6 +19601,12 @@ export interface ScheduledAttributes {
|
|
|
19310
19601
|
* @memberof ScheduledAttributes
|
|
19311
19602
|
*/
|
|
19312
19603
|
'weeklyTimes'?: Array<string>;
|
|
19604
|
+
/**
|
|
19605
|
+
* Scheduled execution times
|
|
19606
|
+
* @type {Array<string>}
|
|
19607
|
+
* @memberof ScheduledAttributes
|
|
19608
|
+
*/
|
|
19609
|
+
'yearlyTimes'?: Array<string>;
|
|
19313
19610
|
}
|
|
19314
19611
|
|
|
19315
19612
|
export const ScheduledAttributesFrequencyV3 = {
|
|
@@ -20200,7 +20497,7 @@ export interface ServiceDeskIntegrationTemplateDto {
|
|
|
20200
20497
|
* @type {string}
|
|
20201
20498
|
* @memberof ServiceDeskIntegrationTemplateDto
|
|
20202
20499
|
*/
|
|
20203
|
-
'name': string;
|
|
20500
|
+
'name': string | null;
|
|
20204
20501
|
/**
|
|
20205
20502
|
* Creation date of the Object
|
|
20206
20503
|
* @type {string}
|
|
@@ -21500,11 +21797,11 @@ export interface SourceConnectionsDto {
|
|
|
21500
21797
|
*/
|
|
21501
21798
|
'mappingProfiles'?: Array<string>;
|
|
21502
21799
|
/**
|
|
21503
|
-
*
|
|
21504
|
-
* @type {Array<
|
|
21800
|
+
* A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName.
|
|
21801
|
+
* @type {Array<TransformRead>}
|
|
21505
21802
|
* @memberof SourceConnectionsDto
|
|
21506
21803
|
*/
|
|
21507
|
-
'dependentCustomTransforms'?: Array<
|
|
21804
|
+
'dependentCustomTransforms'?: Array<TransformRead>;
|
|
21508
21805
|
/**
|
|
21509
21806
|
*
|
|
21510
21807
|
* @type {Array<DependantAppConnections>}
|
|
@@ -22116,7 +22413,7 @@ export interface TaskResultDetails {
|
|
|
22116
22413
|
'id'?: string;
|
|
22117
22414
|
/**
|
|
22118
22415
|
* Use this property to define what report should be processed in the RDE service.
|
|
22119
|
-
* @type {
|
|
22416
|
+
* @type {string}
|
|
22120
22417
|
* @memberof TaskResultDetails
|
|
22121
22418
|
*/
|
|
22122
22419
|
'reportType'?: TaskResultDetailsReportTypeV3;
|
|
@@ -22176,10 +22473,10 @@ export interface TaskResultDetails {
|
|
|
22176
22473
|
'returns'?: Array<TaskResultDetailsReturnsInner>;
|
|
22177
22474
|
/**
|
|
22178
22475
|
* Extra attributes map(dictionary) needed for the report.
|
|
22179
|
-
* @type {
|
|
22476
|
+
* @type {object}
|
|
22180
22477
|
* @memberof TaskResultDetails
|
|
22181
22478
|
*/
|
|
22182
|
-
'attributes'?:
|
|
22479
|
+
'attributes'?: object;
|
|
22183
22480
|
/**
|
|
22184
22481
|
* Current report state.
|
|
22185
22482
|
* @type {string}
|
|
@@ -24386,6 +24683,12 @@ export interface WorkflowTriggerAttributes {
|
|
|
24386
24683
|
* @memberof WorkflowTriggerAttributes
|
|
24387
24684
|
*/
|
|
24388
24685
|
'attributeToFilter'?: string;
|
|
24686
|
+
/**
|
|
24687
|
+
* Form definition\'s unique identifier.
|
|
24688
|
+
* @type {string}
|
|
24689
|
+
* @memberof WorkflowTriggerAttributes
|
|
24690
|
+
*/
|
|
24691
|
+
'formDefinitionId'?: string;
|
|
24389
24692
|
/**
|
|
24390
24693
|
* A unique name for the external trigger
|
|
24391
24694
|
* @type {string}
|
|
@@ -24434,6 +24737,12 @@ export interface WorkflowTriggerAttributes {
|
|
|
24434
24737
|
* @memberof WorkflowTriggerAttributes
|
|
24435
24738
|
*/
|
|
24436
24739
|
'weeklyTimes'?: Array<string>;
|
|
24740
|
+
/**
|
|
24741
|
+
* Scheduled execution times
|
|
24742
|
+
* @type {Array<string>}
|
|
24743
|
+
* @memberof WorkflowTriggerAttributes
|
|
24744
|
+
*/
|
|
24745
|
+
'yearlyTimes'?: Array<string>;
|
|
24437
24746
|
}
|
|
24438
24747
|
|
|
24439
24748
|
export const WorkflowTriggerAttributesFrequencyV3 = {
|
|
@@ -24454,7 +24763,7 @@ export type WorkflowTriggerAttributesFrequencyV3 = typeof WorkflowTriggerAttribu
|
|
|
24454
24763
|
export const AccessProfilesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
24455
24764
|
return {
|
|
24456
24765
|
/**
|
|
24457
|
-
*
|
|
24766
|
+
* Create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
|
|
24458
24767
|
* @summary Create Access Profile
|
|
24459
24768
|
* @param {AccessProfile} accessProfile
|
|
24460
24769
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24713,16 +25022,16 @@ export const AccessProfilesApiAxiosParamCreator = function (configuration?: Conf
|
|
|
24713
25022
|
};
|
|
24714
25023
|
},
|
|
24715
25024
|
/**
|
|
24716
|
-
*
|
|
25025
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
24717
25026
|
* @summary List Access Profiles
|
|
24718
|
-
* @param {string} [forSubadmin]
|
|
24719
|
-
* @param {number} [limit]
|
|
25027
|
+
* @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
25028
|
+
* @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.
|
|
24720
25029
|
* @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.
|
|
24721
25030
|
* @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.
|
|
24722
|
-
* @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* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in*
|
|
25031
|
+
* @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* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
24723
25032
|
* @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: **name, created, modified**
|
|
24724
|
-
* @param {string} [forSegmentIds]
|
|
24725
|
-
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If
|
|
25033
|
+
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
25034
|
+
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
|
|
24726
25035
|
* @param {*} [axiosOptions] Override http request option.
|
|
24727
25036
|
* @throws {RequiredError}
|
|
24728
25037
|
*/
|
|
@@ -24857,7 +25166,7 @@ export const AccessProfilesApiFp = function(configuration?: Configuration) {
|
|
|
24857
25166
|
const localVarAxiosParamCreator = AccessProfilesApiAxiosParamCreator(configuration)
|
|
24858
25167
|
return {
|
|
24859
25168
|
/**
|
|
24860
|
-
*
|
|
25169
|
+
* Create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
|
|
24861
25170
|
* @summary Create Access Profile
|
|
24862
25171
|
* @param {AccessProfile} accessProfile
|
|
24863
25172
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24927,16 +25236,16 @@ export const AccessProfilesApiFp = function(configuration?: Configuration) {
|
|
|
24927
25236
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24928
25237
|
},
|
|
24929
25238
|
/**
|
|
24930
|
-
*
|
|
25239
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
24931
25240
|
* @summary List Access Profiles
|
|
24932
|
-
* @param {string} [forSubadmin]
|
|
24933
|
-
* @param {number} [limit]
|
|
25241
|
+
* @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
25242
|
+
* @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.
|
|
24934
25243
|
* @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.
|
|
24935
25244
|
* @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.
|
|
24936
|
-
* @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* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in*
|
|
25245
|
+
* @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* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
24937
25246
|
* @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: **name, created, modified**
|
|
24938
|
-
* @param {string} [forSegmentIds]
|
|
24939
|
-
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If
|
|
25247
|
+
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
25248
|
+
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
|
|
24940
25249
|
* @param {*} [axiosOptions] Override http request option.
|
|
24941
25250
|
* @throws {RequiredError}
|
|
24942
25251
|
*/
|
|
@@ -24971,7 +25280,7 @@ export const AccessProfilesApiFactory = function (configuration?: Configuration,
|
|
|
24971
25280
|
const localVarFp = AccessProfilesApiFp(configuration)
|
|
24972
25281
|
return {
|
|
24973
25282
|
/**
|
|
24974
|
-
*
|
|
25283
|
+
* Create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
|
|
24975
25284
|
* @summary Create Access Profile
|
|
24976
25285
|
* @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
|
|
24977
25286
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25021,7 +25330,7 @@ export const AccessProfilesApiFactory = function (configuration?: Configuration,
|
|
|
25021
25330
|
return localVarFp.getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath));
|
|
25022
25331
|
},
|
|
25023
25332
|
/**
|
|
25024
|
-
*
|
|
25333
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
25025
25334
|
* @summary List Access Profiles
|
|
25026
25335
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
25027
25336
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25155,14 +25464,14 @@ export interface AccessProfilesApiGetAccessProfileEntitlementsRequest {
|
|
|
25155
25464
|
*/
|
|
25156
25465
|
export interface AccessProfilesApiListAccessProfilesRequest {
|
|
25157
25466
|
/**
|
|
25158
|
-
*
|
|
25467
|
+
* Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
25159
25468
|
* @type {string}
|
|
25160
25469
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
25161
25470
|
*/
|
|
25162
25471
|
readonly forSubadmin?: string
|
|
25163
25472
|
|
|
25164
25473
|
/**
|
|
25165
|
-
*
|
|
25474
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25166
25475
|
* @type {number}
|
|
25167
25476
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
25168
25477
|
*/
|
|
@@ -25183,7 +25492,7 @@ export interface AccessProfilesApiListAccessProfilesRequest {
|
|
|
25183
25492
|
readonly count?: boolean
|
|
25184
25493
|
|
|
25185
25494
|
/**
|
|
25186
|
-
* 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* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in*
|
|
25495
|
+
* 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* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
25187
25496
|
* @type {string}
|
|
25188
25497
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
25189
25498
|
*/
|
|
@@ -25197,14 +25506,14 @@ export interface AccessProfilesApiListAccessProfilesRequest {
|
|
|
25197
25506
|
readonly sorters?: string
|
|
25198
25507
|
|
|
25199
25508
|
/**
|
|
25200
|
-
*
|
|
25509
|
+
* Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
25201
25510
|
* @type {string}
|
|
25202
25511
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
25203
25512
|
*/
|
|
25204
25513
|
readonly forSegmentIds?: string
|
|
25205
25514
|
|
|
25206
25515
|
/**
|
|
25207
|
-
* Indicates whether the response list should contain unsegmented access profiles. If
|
|
25516
|
+
* Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
|
|
25208
25517
|
* @type {boolean}
|
|
25209
25518
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
25210
25519
|
*/
|
|
@@ -25240,7 +25549,7 @@ export interface AccessProfilesApiPatchAccessProfileRequest {
|
|
|
25240
25549
|
*/
|
|
25241
25550
|
export class AccessProfilesApi extends BaseAPI {
|
|
25242
25551
|
/**
|
|
25243
|
-
*
|
|
25552
|
+
* Create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
|
|
25244
25553
|
* @summary Create Access Profile
|
|
25245
25554
|
* @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
|
|
25246
25555
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25300,7 +25609,7 @@ export class AccessProfilesApi extends BaseAPI {
|
|
|
25300
25609
|
}
|
|
25301
25610
|
|
|
25302
25611
|
/**
|
|
25303
|
-
*
|
|
25612
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
25304
25613
|
* @summary List Access Profiles
|
|
25305
25614
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
25306
25615
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -27817,7 +28126,7 @@ export const AccountsApiFp = function(configuration?: Configuration) {
|
|
|
27817
28126
|
* @param {*} [axiosOptions] Override http request option.
|
|
27818
28127
|
* @throws {RequiredError}
|
|
27819
28128
|
*/
|
|
27820
|
-
async getAccountEntitlements(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
28129
|
+
async getAccountEntitlements(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Entitlement>>> {
|
|
27821
28130
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountEntitlements(id, limit, offset, count, axiosOptions);
|
|
27822
28131
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
27823
28132
|
const localVarOperationServerBasePath = operationServerMap['AccountsApi.getAccountEntitlements']?.[localVarOperationServerIndex]?.url;
|
|
@@ -27963,7 +28272,7 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
|
|
|
27963
28272
|
* @param {*} [axiosOptions] Override http request option.
|
|
27964
28273
|
* @throws {RequiredError}
|
|
27965
28274
|
*/
|
|
27966
|
-
getAccountEntitlements(requestParameters: AccountsApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
28275
|
+
getAccountEntitlements(requestParameters: AccountsApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Entitlement>> {
|
|
27967
28276
|
return localVarFp.getAccountEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath));
|
|
27968
28277
|
},
|
|
27969
28278
|
/**
|
|
@@ -49308,12 +49617,12 @@ export type GetReportFileFormatV3 = typeof GetReportFileFormatV3[keyof typeof Ge
|
|
|
49308
49617
|
export const RequestableObjectsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
49309
49618
|
return {
|
|
49310
49619
|
/**
|
|
49311
|
-
*
|
|
49620
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
49312
49621
|
* @summary Requestable Objects List
|
|
49313
49622
|
* @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
|
|
49314
|
-
* @param {Array<RequestableObjectType>} [types] Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE
|
|
49315
|
-
* @param {string} [term]
|
|
49316
|
-
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of AVAILABLE
|
|
49623
|
+
* @param {Array<RequestableObjectType>} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
49624
|
+
* @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter.
|
|
49625
|
+
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice.
|
|
49317
49626
|
* @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.
|
|
49318
49627
|
* @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.
|
|
49319
49628
|
* @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.
|
|
@@ -49401,12 +49710,12 @@ export const RequestableObjectsApiFp = function(configuration?: Configuration) {
|
|
|
49401
49710
|
const localVarAxiosParamCreator = RequestableObjectsApiAxiosParamCreator(configuration)
|
|
49402
49711
|
return {
|
|
49403
49712
|
/**
|
|
49404
|
-
*
|
|
49713
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
49405
49714
|
* @summary Requestable Objects List
|
|
49406
49715
|
* @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
|
|
49407
|
-
* @param {Array<RequestableObjectType>} [types] Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE
|
|
49408
|
-
* @param {string} [term]
|
|
49409
|
-
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of AVAILABLE
|
|
49716
|
+
* @param {Array<RequestableObjectType>} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
49717
|
+
* @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter.
|
|
49718
|
+
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice.
|
|
49410
49719
|
* @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.
|
|
49411
49720
|
* @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.
|
|
49412
49721
|
* @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.
|
|
@@ -49432,7 +49741,7 @@ export const RequestableObjectsApiFactory = function (configuration?: Configurat
|
|
|
49432
49741
|
const localVarFp = RequestableObjectsApiFp(configuration)
|
|
49433
49742
|
return {
|
|
49434
49743
|
/**
|
|
49435
|
-
*
|
|
49744
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
49436
49745
|
* @summary Requestable Objects List
|
|
49437
49746
|
* @param {RequestableObjectsApiListRequestableObjectsRequest} requestParameters Request parameters.
|
|
49438
49747
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -49458,21 +49767,21 @@ export interface RequestableObjectsApiListRequestableObjectsRequest {
|
|
|
49458
49767
|
readonly identityId?: string
|
|
49459
49768
|
|
|
49460
49769
|
/**
|
|
49461
|
-
* Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE
|
|
49770
|
+
* Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
49462
49771
|
* @type {Array<RequestableObjectType>}
|
|
49463
49772
|
* @memberof RequestableObjectsApiListRequestableObjects
|
|
49464
49773
|
*/
|
|
49465
49774
|
readonly types?: Array<RequestableObjectType>
|
|
49466
49775
|
|
|
49467
49776
|
/**
|
|
49468
|
-
*
|
|
49777
|
+
* Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter.
|
|
49469
49778
|
* @type {string}
|
|
49470
49779
|
* @memberof RequestableObjectsApiListRequestableObjects
|
|
49471
49780
|
*/
|
|
49472
49781
|
readonly term?: string
|
|
49473
49782
|
|
|
49474
49783
|
/**
|
|
49475
|
-
* Filters the result to the specified status/statuses, where each status is one of AVAILABLE
|
|
49784
|
+
* Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice.
|
|
49476
49785
|
* @type {Array<RequestableObjectRequestStatus>}
|
|
49477
49786
|
* @memberof RequestableObjectsApiListRequestableObjects
|
|
49478
49787
|
*/
|
|
@@ -49522,7 +49831,7 @@ export interface RequestableObjectsApiListRequestableObjectsRequest {
|
|
|
49522
49831
|
*/
|
|
49523
49832
|
export class RequestableObjectsApi extends BaseAPI {
|
|
49524
49833
|
/**
|
|
49525
|
-
*
|
|
49834
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
49526
49835
|
* @summary Requestable Objects List
|
|
49527
49836
|
* @param {RequestableObjectsApiListRequestableObjectsRequest} requestParameters Request parameters.
|
|
49528
49837
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -54139,7 +54448,7 @@ export type SearchGetIndexV3 = typeof SearchGetIndexV3[keyof typeof SearchGetInd
|
|
|
54139
54448
|
export const SearchAttributeConfigurationApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
54140
54449
|
return {
|
|
54141
54450
|
/**
|
|
54142
|
-
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create
|
|
54451
|
+
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.**
|
|
54143
54452
|
* @summary Create Extended Search Attributes
|
|
54144
54453
|
* @param {SearchAttributeConfig} searchAttributeConfig
|
|
54145
54454
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -54225,12 +54534,14 @@ export const SearchAttributeConfigurationApiAxiosParamCreator = function (config
|
|
|
54225
54534
|
};
|
|
54226
54535
|
},
|
|
54227
54536
|
/**
|
|
54228
|
-
* Get a list of attribute/application
|
|
54537
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
54229
54538
|
* @summary List Extended Search Attributes
|
|
54539
|
+
* @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.
|
|
54540
|
+
* @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.
|
|
54230
54541
|
* @param {*} [axiosOptions] Override http request option.
|
|
54231
54542
|
* @throws {RequiredError}
|
|
54232
54543
|
*/
|
|
54233
|
-
getSearchAttributeConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54544
|
+
getSearchAttributeConfig: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54234
54545
|
const localVarPath = `/accounts/search-attribute-config`;
|
|
54235
54546
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54236
54547
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -54251,6 +54562,14 @@ export const SearchAttributeConfigurationApiAxiosParamCreator = function (config
|
|
|
54251
54562
|
// oauth required
|
|
54252
54563
|
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
54253
54564
|
|
|
54565
|
+
if (limit !== undefined) {
|
|
54566
|
+
localVarQueryParameter['limit'] = limit;
|
|
54567
|
+
}
|
|
54568
|
+
|
|
54569
|
+
if (offset !== undefined) {
|
|
54570
|
+
localVarQueryParameter['offset'] = offset;
|
|
54571
|
+
}
|
|
54572
|
+
|
|
54254
54573
|
|
|
54255
54574
|
|
|
54256
54575
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -54363,7 +54682,7 @@ export const SearchAttributeConfigurationApiFp = function(configuration?: Config
|
|
|
54363
54682
|
const localVarAxiosParamCreator = SearchAttributeConfigurationApiAxiosParamCreator(configuration)
|
|
54364
54683
|
return {
|
|
54365
54684
|
/**
|
|
54366
|
-
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create
|
|
54685
|
+
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.**
|
|
54367
54686
|
* @summary Create Extended Search Attributes
|
|
54368
54687
|
* @param {SearchAttributeConfig} searchAttributeConfig
|
|
54369
54688
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -54389,13 +54708,15 @@ export const SearchAttributeConfigurationApiFp = function(configuration?: Config
|
|
|
54389
54708
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
54390
54709
|
},
|
|
54391
54710
|
/**
|
|
54392
|
-
* Get a list of attribute/application
|
|
54711
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
54393
54712
|
* @summary List Extended Search Attributes
|
|
54713
|
+
* @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.
|
|
54714
|
+
* @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.
|
|
54394
54715
|
* @param {*} [axiosOptions] Override http request option.
|
|
54395
54716
|
* @throws {RequiredError}
|
|
54396
54717
|
*/
|
|
54397
|
-
async getSearchAttributeConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchAttributeConfig>>> {
|
|
54398
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchAttributeConfig(axiosOptions);
|
|
54718
|
+
async getSearchAttributeConfig(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchAttributeConfig>>> {
|
|
54719
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchAttributeConfig(limit, offset, axiosOptions);
|
|
54399
54720
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
54400
54721
|
const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationApi.getSearchAttributeConfig']?.[localVarOperationServerIndex]?.url;
|
|
54401
54722
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -54438,7 +54759,7 @@ export const SearchAttributeConfigurationApiFactory = function (configuration?:
|
|
|
54438
54759
|
const localVarFp = SearchAttributeConfigurationApiFp(configuration)
|
|
54439
54760
|
return {
|
|
54440
54761
|
/**
|
|
54441
|
-
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create
|
|
54762
|
+
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.**
|
|
54442
54763
|
* @summary Create Extended Search Attributes
|
|
54443
54764
|
* @param {SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
54444
54765
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -54458,13 +54779,14 @@ export const SearchAttributeConfigurationApiFactory = function (configuration?:
|
|
|
54458
54779
|
return localVarFp.deleteSearchAttributeConfig(requestParameters.name, axiosOptions).then((request) => request(axios, basePath));
|
|
54459
54780
|
},
|
|
54460
54781
|
/**
|
|
54461
|
-
* Get a list of attribute/application
|
|
54782
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
54462
54783
|
* @summary List Extended Search Attributes
|
|
54784
|
+
* @param {SearchAttributeConfigurationApiGetSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
54463
54785
|
* @param {*} [axiosOptions] Override http request option.
|
|
54464
54786
|
* @throws {RequiredError}
|
|
54465
54787
|
*/
|
|
54466
|
-
getSearchAttributeConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SearchAttributeConfig>> {
|
|
54467
|
-
return localVarFp.getSearchAttributeConfig(axiosOptions).then((request) => request(axios, basePath));
|
|
54788
|
+
getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SearchAttributeConfig>> {
|
|
54789
|
+
return localVarFp.getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath));
|
|
54468
54790
|
},
|
|
54469
54791
|
/**
|
|
54470
54792
|
* Get an extended attribute configuration by name.
|
|
@@ -54517,6 +54839,27 @@ export interface SearchAttributeConfigurationApiDeleteSearchAttributeConfigReque
|
|
|
54517
54839
|
readonly name: string
|
|
54518
54840
|
}
|
|
54519
54841
|
|
|
54842
|
+
/**
|
|
54843
|
+
* Request parameters for getSearchAttributeConfig operation in SearchAttributeConfigurationApi.
|
|
54844
|
+
* @export
|
|
54845
|
+
* @interface SearchAttributeConfigurationApiGetSearchAttributeConfigRequest
|
|
54846
|
+
*/
|
|
54847
|
+
export interface SearchAttributeConfigurationApiGetSearchAttributeConfigRequest {
|
|
54848
|
+
/**
|
|
54849
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
54850
|
+
* @type {number}
|
|
54851
|
+
* @memberof SearchAttributeConfigurationApiGetSearchAttributeConfig
|
|
54852
|
+
*/
|
|
54853
|
+
readonly limit?: number
|
|
54854
|
+
|
|
54855
|
+
/**
|
|
54856
|
+
* 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.
|
|
54857
|
+
* @type {number}
|
|
54858
|
+
* @memberof SearchAttributeConfigurationApiGetSearchAttributeConfig
|
|
54859
|
+
*/
|
|
54860
|
+
readonly offset?: number
|
|
54861
|
+
}
|
|
54862
|
+
|
|
54520
54863
|
/**
|
|
54521
54864
|
* Request parameters for getSingleSearchAttributeConfig operation in SearchAttributeConfigurationApi.
|
|
54522
54865
|
* @export
|
|
@@ -54560,7 +54903,7 @@ export interface SearchAttributeConfigurationApiPatchSearchAttributeConfigReques
|
|
|
54560
54903
|
*/
|
|
54561
54904
|
export class SearchAttributeConfigurationApi extends BaseAPI {
|
|
54562
54905
|
/**
|
|
54563
|
-
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create
|
|
54906
|
+
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.**
|
|
54564
54907
|
* @summary Create Extended Search Attributes
|
|
54565
54908
|
* @param {SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
54566
54909
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -54584,14 +54927,15 @@ export class SearchAttributeConfigurationApi extends BaseAPI {
|
|
|
54584
54927
|
}
|
|
54585
54928
|
|
|
54586
54929
|
/**
|
|
54587
|
-
* Get a list of attribute/application
|
|
54930
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
54588
54931
|
* @summary List Extended Search Attributes
|
|
54932
|
+
* @param {SearchAttributeConfigurationApiGetSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
54589
54933
|
* @param {*} [axiosOptions] Override http request option.
|
|
54590
54934
|
* @throws {RequiredError}
|
|
54591
54935
|
* @memberof SearchAttributeConfigurationApi
|
|
54592
54936
|
*/
|
|
54593
|
-
public getSearchAttributeConfig(axiosOptions?: RawAxiosRequestConfig) {
|
|
54594
|
-
return SearchAttributeConfigurationApiFp(this.configuration).getSearchAttributeConfig(axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
54937
|
+
public getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
|
|
54938
|
+
return SearchAttributeConfigurationApiFp(this.configuration).getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
54595
54939
|
}
|
|
54596
54940
|
|
|
54597
54941
|
/**
|
|
@@ -56916,15 +57260,15 @@ export const SourcesApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
56916
57260
|
/**
|
|
56917
57261
|
* Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC).
|
|
56918
57262
|
* @summary Get Source Connections by ID
|
|
56919
|
-
* @param {string}
|
|
57263
|
+
* @param {string} sourceId Source ID.
|
|
56920
57264
|
* @param {*} [axiosOptions] Override http request option.
|
|
56921
57265
|
* @throws {RequiredError}
|
|
56922
57266
|
*/
|
|
56923
|
-
getSourceConnections: async (
|
|
56924
|
-
// verify required parameter '
|
|
56925
|
-
assertParamExists('getSourceConnections', '
|
|
57267
|
+
getSourceConnections: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57268
|
+
// verify required parameter 'sourceId' is not null or undefined
|
|
57269
|
+
assertParamExists('getSourceConnections', 'sourceId', sourceId)
|
|
56926
57270
|
const localVarPath = `/sources/{sourceId}/connections`
|
|
56927
|
-
.replace(`{${"
|
|
57271
|
+
.replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId)));
|
|
56928
57272
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56929
57273
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
56930
57274
|
let baseOptions;
|
|
@@ -57890,12 +58234,12 @@ export const SourcesApiFp = function(configuration?: Configuration) {
|
|
|
57890
58234
|
/**
|
|
57891
58235
|
* Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC).
|
|
57892
58236
|
* @summary Get Source Connections by ID
|
|
57893
|
-
* @param {string}
|
|
58237
|
+
* @param {string} sourceId Source ID.
|
|
57894
58238
|
* @param {*} [axiosOptions] Override http request option.
|
|
57895
58239
|
* @throws {RequiredError}
|
|
57896
58240
|
*/
|
|
57897
|
-
async getSourceConnections(
|
|
57898
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConnections(
|
|
58241
|
+
async getSourceConnections(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceConnectionsDto>> {
|
|
58242
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConnections(sourceId, axiosOptions);
|
|
57899
58243
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
57900
58244
|
const localVarOperationServerBasePath = operationServerMap['SourcesApi.getSourceConnections']?.[localVarOperationServerIndex]?.url;
|
|
57901
58245
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -58237,7 +58581,7 @@ export const SourcesApiFactory = function (configuration?: Configuration, basePa
|
|
|
58237
58581
|
* @throws {RequiredError}
|
|
58238
58582
|
*/
|
|
58239
58583
|
getSourceConnections(requestParameters: SourcesApiGetSourceConnectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SourceConnectionsDto> {
|
|
58240
|
-
return localVarFp.getSourceConnections(requestParameters.
|
|
58584
|
+
return localVarFp.getSourceConnections(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath));
|
|
58241
58585
|
},
|
|
58242
58586
|
/**
|
|
58243
58587
|
* This endpoint fetches source health by source\'s id
|
|
@@ -58592,7 +58936,7 @@ export interface SourcesApiGetSourceConnectionsRequest {
|
|
|
58592
58936
|
* @type {string}
|
|
58593
58937
|
* @memberof SourcesApiGetSourceConnections
|
|
58594
58938
|
*/
|
|
58595
|
-
readonly
|
|
58939
|
+
readonly sourceId: string
|
|
58596
58940
|
}
|
|
58597
58941
|
|
|
58598
58942
|
/**
|
|
@@ -59109,7 +59453,7 @@ export class SourcesApi extends BaseAPI {
|
|
|
59109
59453
|
* @memberof SourcesApi
|
|
59110
59454
|
*/
|
|
59111
59455
|
public getSourceConnections(requestParameters: SourcesApiGetSourceConnectionsRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
59112
|
-
return SourcesApiFp(this.configuration).getSourceConnections(requestParameters.
|
|
59456
|
+
return SourcesApiFp(this.configuration).getSourceConnections(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
59113
59457
|
}
|
|
59114
59458
|
|
|
59115
59459
|
/**
|
|
@@ -61236,10 +61580,11 @@ export const WorkItemsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
61236
61580
|
* This API completes a work item. Either an admin, or the owning/current user must make this request.
|
|
61237
61581
|
* @summary Complete a Work Item
|
|
61238
61582
|
* @param {string} id The ID of the work item
|
|
61583
|
+
* @param {string | null} [body] Body is the request payload to create form definition request
|
|
61239
61584
|
* @param {*} [axiosOptions] Override http request option.
|
|
61240
61585
|
* @throws {RequiredError}
|
|
61241
61586
|
*/
|
|
61242
|
-
completeWorkItem: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
61587
|
+
completeWorkItem: async (id: string, body?: string | null, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
61243
61588
|
// verify required parameter 'id' is not null or undefined
|
|
61244
61589
|
assertParamExists('completeWorkItem', 'id', id)
|
|
61245
61590
|
const localVarPath = `/work-items/{id}`
|
|
@@ -61265,9 +61610,12 @@ export const WorkItemsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
61265
61610
|
|
|
61266
61611
|
|
|
61267
61612
|
|
|
61613
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
61614
|
+
|
|
61268
61615
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
61269
61616
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
61270
61617
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
61618
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
61271
61619
|
|
|
61272
61620
|
return {
|
|
61273
61621
|
url: toPathString(localVarUrlObj),
|
|
@@ -61786,11 +62134,12 @@ export const WorkItemsApiFp = function(configuration?: Configuration) {
|
|
|
61786
62134
|
* This API completes a work item. Either an admin, or the owning/current user must make this request.
|
|
61787
62135
|
* @summary Complete a Work Item
|
|
61788
62136
|
* @param {string} id The ID of the work item
|
|
62137
|
+
* @param {string | null} [body] Body is the request payload to create form definition request
|
|
61789
62138
|
* @param {*} [axiosOptions] Override http request option.
|
|
61790
62139
|
* @throws {RequiredError}
|
|
61791
62140
|
*/
|
|
61792
|
-
async completeWorkItem(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkItems>> {
|
|
61793
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.completeWorkItem(id, axiosOptions);
|
|
62141
|
+
async completeWorkItem(id: string, body?: string | null, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkItems>> {
|
|
62142
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.completeWorkItem(id, body, axiosOptions);
|
|
61794
62143
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
61795
62144
|
const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.completeWorkItem']?.[localVarOperationServerIndex]?.url;
|
|
61796
62145
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -61972,7 +62321,7 @@ export const WorkItemsApiFactory = function (configuration?: Configuration, base
|
|
|
61972
62321
|
* @throws {RequiredError}
|
|
61973
62322
|
*/
|
|
61974
62323
|
completeWorkItem(requestParameters: WorkItemsApiCompleteWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<WorkItems> {
|
|
61975
|
-
return localVarFp.completeWorkItem(requestParameters.id, axiosOptions).then((request) => request(axios, basePath));
|
|
62324
|
+
return localVarFp.completeWorkItem(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(axios, basePath));
|
|
61976
62325
|
},
|
|
61977
62326
|
/**
|
|
61978
62327
|
* This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.
|
|
@@ -62124,6 +62473,13 @@ export interface WorkItemsApiCompleteWorkItemRequest {
|
|
|
62124
62473
|
* @memberof WorkItemsApiCompleteWorkItem
|
|
62125
62474
|
*/
|
|
62126
62475
|
readonly id: string
|
|
62476
|
+
|
|
62477
|
+
/**
|
|
62478
|
+
* Body is the request payload to create form definition request
|
|
62479
|
+
* @type {string}
|
|
62480
|
+
* @memberof WorkItemsApiCompleteWorkItem
|
|
62481
|
+
*/
|
|
62482
|
+
readonly body?: string | null
|
|
62127
62483
|
}
|
|
62128
62484
|
|
|
62129
62485
|
/**
|
|
@@ -62369,7 +62725,7 @@ export class WorkItemsApi extends BaseAPI {
|
|
|
62369
62725
|
* @memberof WorkItemsApi
|
|
62370
62726
|
*/
|
|
62371
62727
|
public completeWorkItem(requestParameters: WorkItemsApiCompleteWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
62372
|
-
return WorkItemsApiFp(this.configuration).completeWorkItem(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
62728
|
+
return WorkItemsApiFp(this.configuration).completeWorkItem(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
62373
62729
|
}
|
|
62374
62730
|
|
|
62375
62731
|
/**
|