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/dist/v3/api.d.ts
CHANGED
|
@@ -281,6 +281,86 @@ export declare const AccessItemReviewedByTypeV3: {
|
|
|
281
281
|
readonly Identity: "IDENTITY";
|
|
282
282
|
};
|
|
283
283
|
export type AccessItemReviewedByTypeV3 = typeof AccessItemReviewedByTypeV3[keyof typeof AccessItemReviewedByTypeV3];
|
|
284
|
+
/**
|
|
285
|
+
* Metadata that describes an access item
|
|
286
|
+
* @export
|
|
287
|
+
* @interface AccessModelMetadata
|
|
288
|
+
*/
|
|
289
|
+
export interface AccessModelMetadata {
|
|
290
|
+
/**
|
|
291
|
+
* Unique identifier for the metadata type
|
|
292
|
+
* @type {string}
|
|
293
|
+
* @memberof AccessModelMetadata
|
|
294
|
+
*/
|
|
295
|
+
'key'?: string;
|
|
296
|
+
/**
|
|
297
|
+
* Human readable name of the metadata type
|
|
298
|
+
* @type {string}
|
|
299
|
+
* @memberof AccessModelMetadata
|
|
300
|
+
*/
|
|
301
|
+
'name'?: string;
|
|
302
|
+
/**
|
|
303
|
+
* Allows selecting multiple values
|
|
304
|
+
* @type {boolean}
|
|
305
|
+
* @memberof AccessModelMetadata
|
|
306
|
+
*/
|
|
307
|
+
'multiselect'?: boolean;
|
|
308
|
+
/**
|
|
309
|
+
* The state of the metadata item
|
|
310
|
+
* @type {string}
|
|
311
|
+
* @memberof AccessModelMetadata
|
|
312
|
+
*/
|
|
313
|
+
'status'?: string;
|
|
314
|
+
/**
|
|
315
|
+
* The type of the metadata item
|
|
316
|
+
* @type {string}
|
|
317
|
+
* @memberof AccessModelMetadata
|
|
318
|
+
*/
|
|
319
|
+
'type'?: string;
|
|
320
|
+
/**
|
|
321
|
+
* The types of objects
|
|
322
|
+
* @type {Array<string>}
|
|
323
|
+
* @memberof AccessModelMetadata
|
|
324
|
+
*/
|
|
325
|
+
'objectTypes'?: Array<string>;
|
|
326
|
+
/**
|
|
327
|
+
* Describes the metadata item
|
|
328
|
+
* @type {string}
|
|
329
|
+
* @memberof AccessModelMetadata
|
|
330
|
+
*/
|
|
331
|
+
'description'?: string;
|
|
332
|
+
/**
|
|
333
|
+
* The value to assign to the metadata item
|
|
334
|
+
* @type {Array<AccessModelMetadataValuesInner>}
|
|
335
|
+
* @memberof AccessModelMetadata
|
|
336
|
+
*/
|
|
337
|
+
'values'?: Array<AccessModelMetadataValuesInner>;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* An individual value to assign to the metadata item
|
|
341
|
+
* @export
|
|
342
|
+
* @interface AccessModelMetadataValuesInner
|
|
343
|
+
*/
|
|
344
|
+
export interface AccessModelMetadataValuesInner {
|
|
345
|
+
/**
|
|
346
|
+
* The value to assign to the metdata item
|
|
347
|
+
* @type {string}
|
|
348
|
+
* @memberof AccessModelMetadataValuesInner
|
|
349
|
+
*/
|
|
350
|
+
'value'?: string;
|
|
351
|
+
/**
|
|
352
|
+
* Display name of the value
|
|
353
|
+
* @type {string}
|
|
354
|
+
* @memberof AccessModelMetadataValuesInner
|
|
355
|
+
*/
|
|
356
|
+
'name'?: string;
|
|
357
|
+
/**
|
|
358
|
+
* The status of the individual value
|
|
359
|
+
* @type {string}
|
|
360
|
+
* @memberof AccessModelMetadataValuesInner
|
|
361
|
+
*/
|
|
362
|
+
'status'?: string;
|
|
363
|
+
}
|
|
284
364
|
/**
|
|
285
365
|
* Access Profile
|
|
286
366
|
* @export
|
|
@@ -1209,10 +1289,10 @@ export interface AccessRequestTracking {
|
|
|
1209
1289
|
'requestedItemsDetails'?: Array<RequestedItemDetails>;
|
|
1210
1290
|
/**
|
|
1211
1291
|
* a hash representation of the access requested, useful for longer term tracking client side.
|
|
1212
|
-
* @type {
|
|
1292
|
+
* @type {number}
|
|
1213
1293
|
* @memberof AccessRequestTracking
|
|
1214
1294
|
*/
|
|
1215
|
-
'attributesHash'?:
|
|
1295
|
+
'attributesHash'?: number;
|
|
1216
1296
|
/**
|
|
1217
1297
|
* a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids.
|
|
1218
1298
|
* @type {Array<string>}
|
|
@@ -1387,7 +1467,7 @@ export interface Account {
|
|
|
1387
1467
|
* @type {string}
|
|
1388
1468
|
* @memberof Account
|
|
1389
1469
|
*/
|
|
1390
|
-
'name': string;
|
|
1470
|
+
'name': string | null;
|
|
1391
1471
|
/**
|
|
1392
1472
|
* Creation date of the Object
|
|
1393
1473
|
* @type {string}
|
|
@@ -1444,10 +1524,10 @@ export interface Account {
|
|
|
1444
1524
|
'isMachine'?: boolean;
|
|
1445
1525
|
/**
|
|
1446
1526
|
*
|
|
1447
|
-
* @type {
|
|
1527
|
+
* @type {AccountAllOfRecommendation}
|
|
1448
1528
|
* @memberof Account
|
|
1449
1529
|
*/
|
|
1450
|
-
'recommendation'?:
|
|
1530
|
+
'recommendation'?: AccountAllOfRecommendation;
|
|
1451
1531
|
/**
|
|
1452
1532
|
* The account attributes that are aggregated
|
|
1453
1533
|
* @type {{ [key: string]: any; }}
|
|
@@ -1518,16 +1598,16 @@ export interface Account {
|
|
|
1518
1598
|
'hasEntitlements': boolean;
|
|
1519
1599
|
/**
|
|
1520
1600
|
*
|
|
1521
|
-
* @type {
|
|
1601
|
+
* @type {AccountAllOfIdentity}
|
|
1522
1602
|
* @memberof Account
|
|
1523
1603
|
*/
|
|
1524
|
-
'identity'?:
|
|
1604
|
+
'identity'?: AccountAllOfIdentity;
|
|
1525
1605
|
/**
|
|
1526
1606
|
*
|
|
1527
|
-
* @type {
|
|
1607
|
+
* @type {AccountAllOfSourceOwner}
|
|
1528
1608
|
* @memberof Account
|
|
1529
1609
|
*/
|
|
1530
|
-
'sourceOwner'?:
|
|
1610
|
+
'sourceOwner'?: AccountAllOfSourceOwner | null;
|
|
1531
1611
|
/**
|
|
1532
1612
|
* A string list containing the owning source\'s features
|
|
1533
1613
|
* @type {string}
|
|
@@ -1542,10 +1622,10 @@ export interface Account {
|
|
|
1542
1622
|
'origin'?: AccountOriginV3 | null;
|
|
1543
1623
|
/**
|
|
1544
1624
|
*
|
|
1545
|
-
* @type {
|
|
1625
|
+
* @type {AccountAllOfOwnerIdentity}
|
|
1546
1626
|
* @memberof Account
|
|
1547
1627
|
*/
|
|
1548
|
-
'ownerIdentity'?:
|
|
1628
|
+
'ownerIdentity'?: AccountAllOfOwnerIdentity;
|
|
1549
1629
|
}
|
|
1550
1630
|
export declare const AccountOriginV3: {
|
|
1551
1631
|
readonly Aggregated: "AGGREGATED";
|
|
@@ -2163,6 +2243,119 @@ export interface AccountActivitySearchedItem {
|
|
|
2163
2243
|
*/
|
|
2164
2244
|
'sources'?: string;
|
|
2165
2245
|
}
|
|
2246
|
+
/**
|
|
2247
|
+
* The identity this account is correlated to
|
|
2248
|
+
* @export
|
|
2249
|
+
* @interface AccountAllOfIdentity
|
|
2250
|
+
*/
|
|
2251
|
+
export interface AccountAllOfIdentity {
|
|
2252
|
+
/**
|
|
2253
|
+
* The ID of the identity
|
|
2254
|
+
* @type {string}
|
|
2255
|
+
* @memberof AccountAllOfIdentity
|
|
2256
|
+
*/
|
|
2257
|
+
'id'?: string;
|
|
2258
|
+
/**
|
|
2259
|
+
* The type of object being referenced
|
|
2260
|
+
* @type {string}
|
|
2261
|
+
* @memberof AccountAllOfIdentity
|
|
2262
|
+
*/
|
|
2263
|
+
'type'?: AccountAllOfIdentityTypeV3;
|
|
2264
|
+
/**
|
|
2265
|
+
* display name of identity
|
|
2266
|
+
* @type {string}
|
|
2267
|
+
* @memberof AccountAllOfIdentity
|
|
2268
|
+
*/
|
|
2269
|
+
'name'?: string;
|
|
2270
|
+
}
|
|
2271
|
+
export declare const AccountAllOfIdentityTypeV3: {
|
|
2272
|
+
readonly Identity: "IDENTITY";
|
|
2273
|
+
};
|
|
2274
|
+
export type AccountAllOfIdentityTypeV3 = typeof AccountAllOfIdentityTypeV3[keyof typeof AccountAllOfIdentityTypeV3];
|
|
2275
|
+
/**
|
|
2276
|
+
*
|
|
2277
|
+
* @export
|
|
2278
|
+
* @interface AccountAllOfOwnerIdentity
|
|
2279
|
+
*/
|
|
2280
|
+
export interface AccountAllOfOwnerIdentity {
|
|
2281
|
+
/**
|
|
2282
|
+
*
|
|
2283
|
+
* @type {DtoType}
|
|
2284
|
+
* @memberof AccountAllOfOwnerIdentity
|
|
2285
|
+
*/
|
|
2286
|
+
'type'?: DtoType;
|
|
2287
|
+
/**
|
|
2288
|
+
* ID of the object to which this reference applies
|
|
2289
|
+
* @type {string}
|
|
2290
|
+
* @memberof AccountAllOfOwnerIdentity
|
|
2291
|
+
*/
|
|
2292
|
+
'id'?: string;
|
|
2293
|
+
/**
|
|
2294
|
+
* Human-readable display name of the object to which this reference applies
|
|
2295
|
+
* @type {string}
|
|
2296
|
+
* @memberof AccountAllOfOwnerIdentity
|
|
2297
|
+
*/
|
|
2298
|
+
'name'?: string;
|
|
2299
|
+
}
|
|
2300
|
+
/**
|
|
2301
|
+
*
|
|
2302
|
+
* @export
|
|
2303
|
+
* @interface AccountAllOfRecommendation
|
|
2304
|
+
*/
|
|
2305
|
+
export interface AccountAllOfRecommendation {
|
|
2306
|
+
/**
|
|
2307
|
+
* Recommended type of account.
|
|
2308
|
+
* @type {string}
|
|
2309
|
+
* @memberof AccountAllOfRecommendation
|
|
2310
|
+
*/
|
|
2311
|
+
'type': AccountAllOfRecommendationTypeV3;
|
|
2312
|
+
/**
|
|
2313
|
+
* 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.
|
|
2314
|
+
* @type {string}
|
|
2315
|
+
* @memberof AccountAllOfRecommendation
|
|
2316
|
+
*/
|
|
2317
|
+
'method': AccountAllOfRecommendationMethodV3;
|
|
2318
|
+
}
|
|
2319
|
+
export declare const AccountAllOfRecommendationTypeV3: {
|
|
2320
|
+
readonly Human: "HUMAN";
|
|
2321
|
+
readonly Machine: "MACHINE";
|
|
2322
|
+
};
|
|
2323
|
+
export type AccountAllOfRecommendationTypeV3 = typeof AccountAllOfRecommendationTypeV3[keyof typeof AccountAllOfRecommendationTypeV3];
|
|
2324
|
+
export declare const AccountAllOfRecommendationMethodV3: {
|
|
2325
|
+
readonly Discovery: "DISCOVERY";
|
|
2326
|
+
readonly Source: "SOURCE";
|
|
2327
|
+
readonly Criteria: "CRITERIA";
|
|
2328
|
+
};
|
|
2329
|
+
export type AccountAllOfRecommendationMethodV3 = typeof AccountAllOfRecommendationMethodV3[keyof typeof AccountAllOfRecommendationMethodV3];
|
|
2330
|
+
/**
|
|
2331
|
+
* The owner of the source this account belongs to.
|
|
2332
|
+
* @export
|
|
2333
|
+
* @interface AccountAllOfSourceOwner
|
|
2334
|
+
*/
|
|
2335
|
+
export interface AccountAllOfSourceOwner {
|
|
2336
|
+
/**
|
|
2337
|
+
* The ID of the identity
|
|
2338
|
+
* @type {string}
|
|
2339
|
+
* @memberof AccountAllOfSourceOwner
|
|
2340
|
+
*/
|
|
2341
|
+
'id'?: string;
|
|
2342
|
+
/**
|
|
2343
|
+
* The type of object being referenced
|
|
2344
|
+
* @type {string}
|
|
2345
|
+
* @memberof AccountAllOfSourceOwner
|
|
2346
|
+
*/
|
|
2347
|
+
'type'?: AccountAllOfSourceOwnerTypeV3;
|
|
2348
|
+
/**
|
|
2349
|
+
* display name of identity
|
|
2350
|
+
* @type {string}
|
|
2351
|
+
* @memberof AccountAllOfSourceOwner
|
|
2352
|
+
*/
|
|
2353
|
+
'name'?: string;
|
|
2354
|
+
}
|
|
2355
|
+
export declare const AccountAllOfSourceOwnerTypeV3: {
|
|
2356
|
+
readonly Identity: "IDENTITY";
|
|
2357
|
+
};
|
|
2358
|
+
export type AccountAllOfSourceOwnerTypeV3 = typeof AccountAllOfSourceOwnerTypeV3[keyof typeof AccountAllOfSourceOwnerTypeV3];
|
|
2166
2359
|
/**
|
|
2167
2360
|
*
|
|
2168
2361
|
* @export
|
|
@@ -3407,43 +3600,43 @@ export interface AuthUser {
|
|
|
3407
3600
|
* @type {string}
|
|
3408
3601
|
* @memberof AuthUser
|
|
3409
3602
|
*/
|
|
3410
|
-
'identificationNumber'?: string;
|
|
3603
|
+
'identificationNumber'?: string | null;
|
|
3411
3604
|
/**
|
|
3412
3605
|
* Auth user\'s email.
|
|
3413
3606
|
* @type {string}
|
|
3414
3607
|
* @memberof AuthUser
|
|
3415
3608
|
*/
|
|
3416
|
-
'email'?: string;
|
|
3609
|
+
'email'?: string | null;
|
|
3417
3610
|
/**
|
|
3418
3611
|
* Auth user\'s phone number.
|
|
3419
3612
|
* @type {string}
|
|
3420
3613
|
* @memberof AuthUser
|
|
3421
3614
|
*/
|
|
3422
|
-
'phone'?: string;
|
|
3615
|
+
'phone'?: string | null;
|
|
3423
3616
|
/**
|
|
3424
3617
|
* Auth user\'s work phone number.
|
|
3425
3618
|
* @type {string}
|
|
3426
3619
|
* @memberof AuthUser
|
|
3427
3620
|
*/
|
|
3428
|
-
'workPhone'?: string;
|
|
3621
|
+
'workPhone'?: string | null;
|
|
3429
3622
|
/**
|
|
3430
3623
|
* Auth user\'s personal email.
|
|
3431
3624
|
* @type {string}
|
|
3432
3625
|
* @memberof AuthUser
|
|
3433
3626
|
*/
|
|
3434
|
-
'personalEmail'?: string;
|
|
3627
|
+
'personalEmail'?: string | null;
|
|
3435
3628
|
/**
|
|
3436
3629
|
* Auth user\'s first name.
|
|
3437
3630
|
* @type {string}
|
|
3438
3631
|
* @memberof AuthUser
|
|
3439
3632
|
*/
|
|
3440
|
-
'firstname'?: string;
|
|
3633
|
+
'firstname'?: string | null;
|
|
3441
3634
|
/**
|
|
3442
3635
|
* Auth user\'s last name.
|
|
3443
3636
|
* @type {string}
|
|
3444
3637
|
* @memberof AuthUser
|
|
3445
3638
|
*/
|
|
3446
|
-
'lastname'?: string;
|
|
3639
|
+
'lastname'?: string | null;
|
|
3447
3640
|
/**
|
|
3448
3641
|
* Auth user\'s name in displayed format.
|
|
3449
3642
|
* @type {string}
|
|
@@ -3461,7 +3654,7 @@ export interface AuthUser {
|
|
|
3461
3654
|
* @type {string}
|
|
3462
3655
|
* @memberof AuthUser
|
|
3463
3656
|
*/
|
|
3464
|
-
'lastPasswordChangeDate'?: string;
|
|
3657
|
+
'lastPasswordChangeDate'?: string | null;
|
|
3465
3658
|
/**
|
|
3466
3659
|
* Timestamp of the last login (long type value).
|
|
3467
3660
|
* @type {number}
|
|
@@ -3474,12 +3667,18 @@ export interface AuthUser {
|
|
|
3474
3667
|
* @memberof AuthUser
|
|
3475
3668
|
*/
|
|
3476
3669
|
'currentLoginTimestamp'?: number;
|
|
3670
|
+
/**
|
|
3671
|
+
* The date and time when the user was last unlocked.
|
|
3672
|
+
* @type {string}
|
|
3673
|
+
* @memberof AuthUser
|
|
3674
|
+
*/
|
|
3675
|
+
'lastUnlockTimestamp'?: string | null;
|
|
3477
3676
|
/**
|
|
3478
3677
|
* Array of the auth user\'s capabilities.
|
|
3479
3678
|
* @type {Array<string>}
|
|
3480
3679
|
* @memberof AuthUser
|
|
3481
3680
|
*/
|
|
3482
|
-
'capabilities'?: Array<AuthUserCapabilitiesV3
|
|
3681
|
+
'capabilities'?: Array<AuthUserCapabilitiesV3> | null;
|
|
3483
3682
|
}
|
|
3484
3683
|
export declare const AuthUserCapabilitiesV3: {
|
|
3485
3684
|
readonly CertAdmin: "CERT_ADMIN";
|
|
@@ -3948,7 +4147,7 @@ export interface BaseCommonDto {
|
|
|
3948
4147
|
* @type {string}
|
|
3949
4148
|
* @memberof BaseCommonDto
|
|
3950
4149
|
*/
|
|
3951
|
-
'name': string;
|
|
4150
|
+
'name': string | null;
|
|
3952
4151
|
/**
|
|
3953
4152
|
* Creation date of the Object
|
|
3954
4153
|
* @type {string}
|
|
@@ -5258,7 +5457,7 @@ export interface Certification {
|
|
|
5258
5457
|
* @type {string}
|
|
5259
5458
|
* @memberof Certification
|
|
5260
5459
|
*/
|
|
5261
|
-
'due'?: string;
|
|
5460
|
+
'due'?: string | null;
|
|
5262
5461
|
/**
|
|
5263
5462
|
* The date the reviewer signed off on the Certification.
|
|
5264
5463
|
* @type {string}
|
|
@@ -7364,7 +7563,7 @@ export interface Entitlement {
|
|
|
7364
7563
|
* @type {string}
|
|
7365
7564
|
* @memberof Entitlement
|
|
7366
7565
|
*/
|
|
7367
|
-
'description'?: string;
|
|
7566
|
+
'description'?: string | null;
|
|
7368
7567
|
/**
|
|
7369
7568
|
* True if the entitlement is privileged
|
|
7370
7569
|
* @type {boolean}
|
|
@@ -7377,6 +7576,32 @@ export interface Entitlement {
|
|
|
7377
7576
|
* @memberof Entitlement
|
|
7378
7577
|
*/
|
|
7379
7578
|
'cloudGoverned'?: boolean;
|
|
7579
|
+
/**
|
|
7580
|
+
* True if the entitlement is able to be directly requested
|
|
7581
|
+
* @type {boolean}
|
|
7582
|
+
* @memberof Entitlement
|
|
7583
|
+
*/
|
|
7584
|
+
'requestable'?: boolean;
|
|
7585
|
+
/**
|
|
7586
|
+
*
|
|
7587
|
+
* @type {EntitlementOwner}
|
|
7588
|
+
* @memberof Entitlement
|
|
7589
|
+
*/
|
|
7590
|
+
'owner'?: EntitlementOwner | null;
|
|
7591
|
+
/**
|
|
7592
|
+
* 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.
|
|
7593
|
+
* @type {{ [key: string]: any; }}
|
|
7594
|
+
* @memberof Entitlement
|
|
7595
|
+
*/
|
|
7596
|
+
'manuallyUpdatedFields'?: {
|
|
7597
|
+
[key: string]: any;
|
|
7598
|
+
} | null;
|
|
7599
|
+
/**
|
|
7600
|
+
*
|
|
7601
|
+
* @type {EntitlementAccessModelMetadata}
|
|
7602
|
+
* @memberof Entitlement
|
|
7603
|
+
*/
|
|
7604
|
+
'accessModelMetadata'?: EntitlementAccessModelMetadata;
|
|
7380
7605
|
/**
|
|
7381
7606
|
* Time when the entitlement was created
|
|
7382
7607
|
* @type {string}
|
|
@@ -7416,6 +7641,19 @@ export interface Entitlement {
|
|
|
7416
7641
|
*/
|
|
7417
7642
|
'directPermissions'?: Array<PermissionDto>;
|
|
7418
7643
|
}
|
|
7644
|
+
/**
|
|
7645
|
+
* Additional data to classify the entitlement
|
|
7646
|
+
* @export
|
|
7647
|
+
* @interface EntitlementAccessModelMetadata
|
|
7648
|
+
*/
|
|
7649
|
+
export interface EntitlementAccessModelMetadata {
|
|
7650
|
+
/**
|
|
7651
|
+
*
|
|
7652
|
+
* @type {Array<AccessModelMetadata>}
|
|
7653
|
+
* @memberof EntitlementAccessModelMetadata
|
|
7654
|
+
*/
|
|
7655
|
+
'attributes'?: Array<AccessModelMetadata>;
|
|
7656
|
+
}
|
|
7419
7657
|
/**
|
|
7420
7658
|
* Entitlement
|
|
7421
7659
|
* @export
|
|
@@ -7804,86 +8042,34 @@ export interface EntitlementDocuments {
|
|
|
7804
8042
|
'_version'?: string;
|
|
7805
8043
|
}
|
|
7806
8044
|
/**
|
|
7807
|
-
*
|
|
8045
|
+
* The identity that owns the entitlement
|
|
7808
8046
|
* @export
|
|
7809
|
-
* @interface
|
|
8047
|
+
* @interface EntitlementOwner
|
|
7810
8048
|
*/
|
|
7811
|
-
export interface
|
|
8049
|
+
export interface EntitlementOwner {
|
|
7812
8050
|
/**
|
|
7813
|
-
*
|
|
8051
|
+
* The identity ID
|
|
7814
8052
|
* @type {string}
|
|
7815
|
-
* @memberof
|
|
8053
|
+
* @memberof EntitlementOwner
|
|
7816
8054
|
*/
|
|
7817
8055
|
'id'?: string;
|
|
7818
8056
|
/**
|
|
7819
|
-
*
|
|
7820
|
-
* @type {string}
|
|
7821
|
-
* @memberof EntitlementDto
|
|
7822
|
-
*/
|
|
7823
|
-
'name': string;
|
|
7824
|
-
/**
|
|
7825
|
-
* Creation date of the Object
|
|
7826
|
-
* @type {string}
|
|
7827
|
-
* @memberof EntitlementDto
|
|
7828
|
-
*/
|
|
7829
|
-
'created'?: string;
|
|
7830
|
-
/**
|
|
7831
|
-
* Last modification date of the Object
|
|
7832
|
-
* @type {string}
|
|
7833
|
-
* @memberof EntitlementDto
|
|
7834
|
-
*/
|
|
7835
|
-
'modified'?: string;
|
|
7836
|
-
/**
|
|
7837
|
-
* Name of the entitlement attribute
|
|
7838
|
-
* @type {string}
|
|
7839
|
-
* @memberof EntitlementDto
|
|
7840
|
-
*/
|
|
7841
|
-
'attribute'?: string;
|
|
7842
|
-
/**
|
|
7843
|
-
* Raw value of the entitlement
|
|
7844
|
-
* @type {string}
|
|
7845
|
-
* @memberof EntitlementDto
|
|
7846
|
-
*/
|
|
7847
|
-
'value'?: string;
|
|
7848
|
-
/**
|
|
7849
|
-
* Entitlment description
|
|
8057
|
+
* The type of object
|
|
7850
8058
|
* @type {string}
|
|
7851
|
-
* @memberof
|
|
8059
|
+
* @memberof EntitlementOwner
|
|
7852
8060
|
*/
|
|
7853
|
-
'
|
|
8061
|
+
'type'?: EntitlementOwnerTypeV3;
|
|
7854
8062
|
/**
|
|
7855
|
-
*
|
|
7856
|
-
* @type {{ [key: string]: any; }}
|
|
7857
|
-
* @memberof EntitlementDto
|
|
7858
|
-
*/
|
|
7859
|
-
'attributes'?: {
|
|
7860
|
-
[key: string]: any;
|
|
7861
|
-
};
|
|
7862
|
-
/**
|
|
7863
|
-
* Schema objectType on the given application that maps to an Account Group
|
|
8063
|
+
* The display name of the identity
|
|
7864
8064
|
* @type {string}
|
|
7865
|
-
* @memberof
|
|
8065
|
+
* @memberof EntitlementOwner
|
|
7866
8066
|
*/
|
|
7867
|
-
'
|
|
7868
|
-
/**
|
|
7869
|
-
* Determines if this Entitlement is privileged.
|
|
7870
|
-
* @type {boolean}
|
|
7871
|
-
* @memberof EntitlementDto
|
|
7872
|
-
*/
|
|
7873
|
-
'privileged'?: boolean;
|
|
7874
|
-
/**
|
|
7875
|
-
* Determines if this Entitlement is goverened in the cloud.
|
|
7876
|
-
* @type {boolean}
|
|
7877
|
-
* @memberof EntitlementDto
|
|
7878
|
-
*/
|
|
7879
|
-
'cloudGoverned'?: boolean;
|
|
7880
|
-
/**
|
|
7881
|
-
*
|
|
7882
|
-
* @type {EntitlementSource}
|
|
7883
|
-
* @memberof EntitlementDto
|
|
7884
|
-
*/
|
|
7885
|
-
'source'?: EntitlementSource;
|
|
8067
|
+
'name'?: string;
|
|
7886
8068
|
}
|
|
8069
|
+
export declare const EntitlementOwnerTypeV3: {
|
|
8070
|
+
readonly Identity: "IDENTITY";
|
|
8071
|
+
};
|
|
8072
|
+
export type EntitlementOwnerTypeV3 = typeof EntitlementOwnerTypeV3[keyof typeof EntitlementOwnerTypeV3];
|
|
7887
8073
|
/**
|
|
7888
8074
|
* Entitlement including a specific set of access.
|
|
7889
8075
|
* @export
|
|
@@ -8275,6 +8461,12 @@ export interface EventAttributes {
|
|
|
8275
8461
|
* @memberof EventAttributes
|
|
8276
8462
|
*/
|
|
8277
8463
|
'attributeToFilter'?: string;
|
|
8464
|
+
/**
|
|
8465
|
+
* Form definition\'s unique identifier.
|
|
8466
|
+
* @type {string}
|
|
8467
|
+
* @memberof EventAttributes
|
|
8468
|
+
*/
|
|
8469
|
+
'formDefinitionId'?: string;
|
|
8278
8470
|
}
|
|
8279
8471
|
/**
|
|
8280
8472
|
* Event
|
|
@@ -9911,7 +10103,7 @@ export interface IdentityCertificationDto {
|
|
|
9911
10103
|
* @type {string}
|
|
9912
10104
|
* @memberof IdentityCertificationDto
|
|
9913
10105
|
*/
|
|
9914
|
-
'due'?: string;
|
|
10106
|
+
'due'?: string | null;
|
|
9915
10107
|
/**
|
|
9916
10108
|
* The date the reviewer signed off on the Certification.
|
|
9917
10109
|
* @type {string}
|
|
@@ -10619,7 +10811,7 @@ export interface IdentityProfile {
|
|
|
10619
10811
|
* @type {string}
|
|
10620
10812
|
* @memberof IdentityProfile
|
|
10621
10813
|
*/
|
|
10622
|
-
'name': string;
|
|
10814
|
+
'name': string | null;
|
|
10623
10815
|
/**
|
|
10624
10816
|
* Creation date of the Object
|
|
10625
10817
|
* @type {string}
|
|
@@ -11156,6 +11348,7 @@ export interface ImportObject {
|
|
|
11156
11348
|
'name'?: string;
|
|
11157
11349
|
}
|
|
11158
11350
|
export declare const ImportObjectTypeV3: {
|
|
11351
|
+
readonly ConnectorRule: "CONNECTOR_RULE";
|
|
11159
11352
|
readonly IdentityObjectConfig: "IDENTITY_OBJECT_CONFIG";
|
|
11160
11353
|
readonly IdentityProfile: "IDENTITY_PROFILE";
|
|
11161
11354
|
readonly Rule: "RULE";
|
|
@@ -11463,7 +11656,7 @@ export interface LifecycleState {
|
|
|
11463
11656
|
* @type {string}
|
|
11464
11657
|
* @memberof LifecycleState
|
|
11465
11658
|
*/
|
|
11466
|
-
'name': string;
|
|
11659
|
+
'name': string | null;
|
|
11467
11660
|
/**
|
|
11468
11661
|
* Creation date of the Object
|
|
11469
11662
|
* @type {string}
|
|
@@ -12119,7 +12312,7 @@ export interface ManagedCluster {
|
|
|
12119
12312
|
* @type {string}
|
|
12120
12313
|
* @memberof ManagedCluster
|
|
12121
12314
|
*/
|
|
12122
|
-
'status'?:
|
|
12315
|
+
'status'?: ManagedClusterStatusV3;
|
|
12123
12316
|
/**
|
|
12124
12317
|
* Public key certificate
|
|
12125
12318
|
* @type {string}
|
|
@@ -12175,6 +12368,14 @@ export interface ManagedCluster {
|
|
|
12175
12368
|
*/
|
|
12176
12369
|
'updatedAt'?: string | null;
|
|
12177
12370
|
}
|
|
12371
|
+
export declare const ManagedClusterStatusV3: {
|
|
12372
|
+
readonly Configuring: "CONFIGURING";
|
|
12373
|
+
readonly Failed: "FAILED";
|
|
12374
|
+
readonly NoClients: "NO_CLIENTS";
|
|
12375
|
+
readonly Normal: "NORMAL";
|
|
12376
|
+
readonly Warning: "WARNING";
|
|
12377
|
+
};
|
|
12378
|
+
export type ManagedClusterStatusV3 = typeof ManagedClusterStatusV3[keyof typeof ManagedClusterStatusV3];
|
|
12178
12379
|
/**
|
|
12179
12380
|
* Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster]
|
|
12180
12381
|
* @export
|
|
@@ -14976,6 +15177,14 @@ export interface PendingApproval {
|
|
|
14976
15177
|
* @memberof PendingApproval
|
|
14977
15178
|
*/
|
|
14978
15179
|
'sodViolationContext'?: SodViolationContextCheckCompleted | null;
|
|
15180
|
+
/**
|
|
15181
|
+
* Arbitrary key-value pairs, if any were included in the corresponding access request item
|
|
15182
|
+
* @type {{ [key: string]: string; }}
|
|
15183
|
+
* @memberof PendingApproval
|
|
15184
|
+
*/
|
|
15185
|
+
'clientMetadata'?: {
|
|
15186
|
+
[key: string]: string;
|
|
15187
|
+
} | null;
|
|
14979
15188
|
}
|
|
14980
15189
|
/**
|
|
14981
15190
|
* Enum represents action that is being processed on an approval.
|
|
@@ -16073,11 +16282,71 @@ export declare const ReportDetailsReportTypeV3: {
|
|
|
16073
16282
|
};
|
|
16074
16283
|
export type ReportDetailsReportTypeV3 = typeof ReportDetailsReportTypeV3[keyof typeof ReportDetailsReportTypeV3];
|
|
16075
16284
|
/**
|
|
16076
|
-
* @type ReportDetailsArguments
|
|
16077
16285
|
* The string-object map(dictionary) with the arguments needed for report processing.
|
|
16078
16286
|
* @export
|
|
16287
|
+
* @interface ReportDetailsArguments
|
|
16079
16288
|
*/
|
|
16080
|
-
export
|
|
16289
|
+
export interface ReportDetailsArguments {
|
|
16290
|
+
/**
|
|
16291
|
+
* Source ID.
|
|
16292
|
+
* @type {string}
|
|
16293
|
+
* @memberof ReportDetailsArguments
|
|
16294
|
+
*/
|
|
16295
|
+
'application': string;
|
|
16296
|
+
/**
|
|
16297
|
+
* Source name.
|
|
16298
|
+
* @type {string}
|
|
16299
|
+
* @memberof ReportDetailsArguments
|
|
16300
|
+
*/
|
|
16301
|
+
'sourceName': string;
|
|
16302
|
+
/**
|
|
16303
|
+
* Flag to specify if only correlated identities are included in report.
|
|
16304
|
+
* @type {boolean}
|
|
16305
|
+
* @memberof ReportDetailsArguments
|
|
16306
|
+
*/
|
|
16307
|
+
'correlatedOnly': boolean;
|
|
16308
|
+
/**
|
|
16309
|
+
* Source ID.
|
|
16310
|
+
* @type {string}
|
|
16311
|
+
* @memberof ReportDetailsArguments
|
|
16312
|
+
*/
|
|
16313
|
+
'authoritativeSource': string;
|
|
16314
|
+
/**
|
|
16315
|
+
* 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.
|
|
16316
|
+
* @type {Array<string>}
|
|
16317
|
+
* @memberof ReportDetailsArguments
|
|
16318
|
+
*/
|
|
16319
|
+
'selectedFormats'?: Array<ReportDetailsArgumentsSelectedFormatsV3>;
|
|
16320
|
+
/**
|
|
16321
|
+
* The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.
|
|
16322
|
+
* @type {Array<Index>}
|
|
16323
|
+
* @memberof ReportDetailsArguments
|
|
16324
|
+
*/
|
|
16325
|
+
'indices'?: Array<Index>;
|
|
16326
|
+
/**
|
|
16327
|
+
* 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.
|
|
16328
|
+
* @type {string}
|
|
16329
|
+
* @memberof ReportDetailsArguments
|
|
16330
|
+
*/
|
|
16331
|
+
'query': string;
|
|
16332
|
+
/**
|
|
16333
|
+
* 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.
|
|
16334
|
+
* @type {string}
|
|
16335
|
+
* @memberof ReportDetailsArguments
|
|
16336
|
+
*/
|
|
16337
|
+
'columns'?: string;
|
|
16338
|
+
/**
|
|
16339
|
+
* The fields to be used to sort the search results. Use + or - to specify the sort direction.
|
|
16340
|
+
* @type {Array<string>}
|
|
16341
|
+
* @memberof ReportDetailsArguments
|
|
16342
|
+
*/
|
|
16343
|
+
'sort'?: Array<string>;
|
|
16344
|
+
}
|
|
16345
|
+
export declare const ReportDetailsArgumentsSelectedFormatsV3: {
|
|
16346
|
+
readonly Csv: "CSV";
|
|
16347
|
+
readonly Pdf: "PDF";
|
|
16348
|
+
};
|
|
16349
|
+
export type ReportDetailsArgumentsSelectedFormatsV3 = typeof ReportDetailsArgumentsSelectedFormatsV3[keyof typeof ReportDetailsArgumentsSelectedFormatsV3];
|
|
16081
16350
|
/**
|
|
16082
16351
|
*
|
|
16083
16352
|
* @export
|
|
@@ -16396,7 +16665,7 @@ export declare const RequestableObjectRequestStatus: {
|
|
|
16396
16665
|
};
|
|
16397
16666
|
export type RequestableObjectRequestStatus = typeof RequestableObjectRequestStatus[keyof typeof RequestableObjectRequestStatus];
|
|
16398
16667
|
/**
|
|
16399
|
-
*
|
|
16668
|
+
* Currently supported requestable object types.
|
|
16400
16669
|
* @export
|
|
16401
16670
|
* @enum {string}
|
|
16402
16671
|
*/
|
|
@@ -16437,6 +16706,12 @@ export type RequestedItemDetailsTypeV3 = typeof RequestedItemDetailsTypeV3[keyof
|
|
|
16437
16706
|
* @interface RequestedItemStatus
|
|
16438
16707
|
*/
|
|
16439
16708
|
export interface RequestedItemStatus {
|
|
16709
|
+
/**
|
|
16710
|
+
* The ID of the access request.
|
|
16711
|
+
* @type {string}
|
|
16712
|
+
* @memberof RequestedItemStatus
|
|
16713
|
+
*/
|
|
16714
|
+
'id'?: string;
|
|
16440
16715
|
/**
|
|
16441
16716
|
* Human-readable display name of the item being requested.
|
|
16442
16717
|
* @type {string}
|
|
@@ -18500,7 +18775,7 @@ export interface Schedule {
|
|
|
18500
18775
|
* @type {ScheduleMonths}
|
|
18501
18776
|
* @memberof Schedule
|
|
18502
18777
|
*/
|
|
18503
|
-
'months'?: ScheduleMonths;
|
|
18778
|
+
'months'?: ScheduleMonths | null;
|
|
18504
18779
|
/**
|
|
18505
18780
|
*
|
|
18506
18781
|
* @type {ScheduleDays}
|
|
@@ -18518,7 +18793,7 @@ export interface Schedule {
|
|
|
18518
18793
|
* @type {string}
|
|
18519
18794
|
* @memberof Schedule
|
|
18520
18795
|
*/
|
|
18521
|
-
'expiration'?: string;
|
|
18796
|
+
'expiration'?: string | null;
|
|
18522
18797
|
/**
|
|
18523
18798
|
* 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.
|
|
18524
18799
|
* @type {string}
|
|
@@ -18674,7 +18949,7 @@ export interface ScheduleDays {
|
|
|
18674
18949
|
* @type {number}
|
|
18675
18950
|
* @memberof ScheduleDays
|
|
18676
18951
|
*/
|
|
18677
|
-
'interval'?: number;
|
|
18952
|
+
'interval'?: number | null;
|
|
18678
18953
|
}
|
|
18679
18954
|
export declare const ScheduleDaysTypeV3: {
|
|
18680
18955
|
readonly List: "LIST";
|
|
@@ -18704,7 +18979,7 @@ export interface ScheduleHours {
|
|
|
18704
18979
|
* @type {number}
|
|
18705
18980
|
* @memberof ScheduleHours
|
|
18706
18981
|
*/
|
|
18707
|
-
'interval'?: number;
|
|
18982
|
+
'interval'?: number | null;
|
|
18708
18983
|
}
|
|
18709
18984
|
export declare const ScheduleHoursTypeV3: {
|
|
18710
18985
|
readonly List: "LIST";
|
|
@@ -18790,6 +19065,12 @@ export interface ScheduledAttributes {
|
|
|
18790
19065
|
* @memberof ScheduledAttributes
|
|
18791
19066
|
*/
|
|
18792
19067
|
'weeklyTimes'?: Array<string>;
|
|
19068
|
+
/**
|
|
19069
|
+
* Scheduled execution times
|
|
19070
|
+
* @type {Array<string>}
|
|
19071
|
+
* @memberof ScheduledAttributes
|
|
19072
|
+
*/
|
|
19073
|
+
'yearlyTimes'?: Array<string>;
|
|
18793
19074
|
}
|
|
18794
19075
|
export declare const ScheduledAttributesFrequencyV3: {
|
|
18795
19076
|
readonly Daily: "daily";
|
|
@@ -19652,7 +19933,7 @@ export interface ServiceDeskIntegrationTemplateDto {
|
|
|
19652
19933
|
* @type {string}
|
|
19653
19934
|
* @memberof ServiceDeskIntegrationTemplateDto
|
|
19654
19935
|
*/
|
|
19655
|
-
'name': string;
|
|
19936
|
+
'name': string | null;
|
|
19656
19937
|
/**
|
|
19657
19938
|
* Creation date of the Object
|
|
19658
19939
|
* @type {string}
|
|
@@ -20907,11 +21188,11 @@ export interface SourceConnectionsDto {
|
|
|
20907
21188
|
*/
|
|
20908
21189
|
'mappingProfiles'?: Array<string>;
|
|
20909
21190
|
/**
|
|
20910
|
-
*
|
|
20911
|
-
* @type {Array<
|
|
21191
|
+
* 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.
|
|
21192
|
+
* @type {Array<TransformRead>}
|
|
20912
21193
|
* @memberof SourceConnectionsDto
|
|
20913
21194
|
*/
|
|
20914
|
-
'dependentCustomTransforms'?: Array<
|
|
21195
|
+
'dependentCustomTransforms'?: Array<TransformRead>;
|
|
20915
21196
|
/**
|
|
20916
21197
|
*
|
|
20917
21198
|
* @type {Array<DependantAppConnections>}
|
|
@@ -21498,7 +21779,7 @@ export interface TaskResultDetails {
|
|
|
21498
21779
|
'id'?: string;
|
|
21499
21780
|
/**
|
|
21500
21781
|
* Use this property to define what report should be processed in the RDE service.
|
|
21501
|
-
* @type {
|
|
21782
|
+
* @type {string}
|
|
21502
21783
|
* @memberof TaskResultDetails
|
|
21503
21784
|
*/
|
|
21504
21785
|
'reportType'?: TaskResultDetailsReportTypeV3;
|
|
@@ -21558,12 +21839,10 @@ export interface TaskResultDetails {
|
|
|
21558
21839
|
'returns'?: Array<TaskResultDetailsReturnsInner>;
|
|
21559
21840
|
/**
|
|
21560
21841
|
* Extra attributes map(dictionary) needed for the report.
|
|
21561
|
-
* @type {
|
|
21842
|
+
* @type {object}
|
|
21562
21843
|
* @memberof TaskResultDetails
|
|
21563
21844
|
*/
|
|
21564
|
-
'attributes'?:
|
|
21565
|
-
[key: string]: object;
|
|
21566
|
-
};
|
|
21845
|
+
'attributes'?: object;
|
|
21567
21846
|
/**
|
|
21568
21847
|
* Current report state.
|
|
21569
21848
|
* @type {string}
|
|
@@ -23684,6 +23963,12 @@ export interface WorkflowTriggerAttributes {
|
|
|
23684
23963
|
* @memberof WorkflowTriggerAttributes
|
|
23685
23964
|
*/
|
|
23686
23965
|
'attributeToFilter'?: string;
|
|
23966
|
+
/**
|
|
23967
|
+
* Form definition\'s unique identifier.
|
|
23968
|
+
* @type {string}
|
|
23969
|
+
* @memberof WorkflowTriggerAttributes
|
|
23970
|
+
*/
|
|
23971
|
+
'formDefinitionId'?: string;
|
|
23687
23972
|
/**
|
|
23688
23973
|
* A unique name for the external trigger
|
|
23689
23974
|
* @type {string}
|
|
@@ -23732,6 +24017,12 @@ export interface WorkflowTriggerAttributes {
|
|
|
23732
24017
|
* @memberof WorkflowTriggerAttributes
|
|
23733
24018
|
*/
|
|
23734
24019
|
'weeklyTimes'?: Array<string>;
|
|
24020
|
+
/**
|
|
24021
|
+
* Scheduled execution times
|
|
24022
|
+
* @type {Array<string>}
|
|
24023
|
+
* @memberof WorkflowTriggerAttributes
|
|
24024
|
+
*/
|
|
24025
|
+
'yearlyTimes'?: Array<string>;
|
|
23735
24026
|
}
|
|
23736
24027
|
export declare const WorkflowTriggerAttributesFrequencyV3: {
|
|
23737
24028
|
readonly Daily: "daily";
|
|
@@ -23747,7 +24038,7 @@ export type WorkflowTriggerAttributesFrequencyV3 = typeof WorkflowTriggerAttribu
|
|
|
23747
24038
|
*/
|
|
23748
24039
|
export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23749
24040
|
/**
|
|
23750
|
-
*
|
|
24041
|
+
* 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.
|
|
23751
24042
|
* @summary Create Access Profile
|
|
23752
24043
|
* @param {AccessProfile} accessProfile
|
|
23753
24044
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23792,16 +24083,16 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
23792
24083
|
*/
|
|
23793
24084
|
getAccessProfileEntitlements: (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23794
24085
|
/**
|
|
23795
|
-
*
|
|
24086
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
23796
24087
|
* @summary List Access Profiles
|
|
23797
|
-
* @param {string} [forSubadmin]
|
|
23798
|
-
* @param {number} [limit]
|
|
24088
|
+
* @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.
|
|
24089
|
+
* @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.
|
|
23799
24090
|
* @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.
|
|
23800
24091
|
* @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.
|
|
23801
|
-
* @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*
|
|
24092
|
+
* @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.
|
|
23802
24093
|
* @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**
|
|
23803
|
-
* @param {string} [forSegmentIds]
|
|
23804
|
-
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If
|
|
24094
|
+
* @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.
|
|
24095
|
+
* @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.
|
|
23805
24096
|
* @param {*} [axiosOptions] Override http request option.
|
|
23806
24097
|
* @throws {RequiredError}
|
|
23807
24098
|
*/
|
|
@@ -23822,7 +24113,7 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
23822
24113
|
*/
|
|
23823
24114
|
export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
23824
24115
|
/**
|
|
23825
|
-
*
|
|
24116
|
+
* 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.
|
|
23826
24117
|
* @summary Create Access Profile
|
|
23827
24118
|
* @param {AccessProfile} accessProfile
|
|
23828
24119
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23867,16 +24158,16 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
23867
24158
|
*/
|
|
23868
24159
|
getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Entitlement>>>;
|
|
23869
24160
|
/**
|
|
23870
|
-
*
|
|
24161
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
23871
24162
|
* @summary List Access Profiles
|
|
23872
|
-
* @param {string} [forSubadmin]
|
|
23873
|
-
* @param {number} [limit]
|
|
24163
|
+
* @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.
|
|
24164
|
+
* @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.
|
|
23874
24165
|
* @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.
|
|
23875
24166
|
* @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.
|
|
23876
|
-
* @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*
|
|
24167
|
+
* @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.
|
|
23877
24168
|
* @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**
|
|
23878
|
-
* @param {string} [forSegmentIds]
|
|
23879
|
-
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If
|
|
24169
|
+
* @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.
|
|
24170
|
+
* @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.
|
|
23880
24171
|
* @param {*} [axiosOptions] Override http request option.
|
|
23881
24172
|
* @throws {RequiredError}
|
|
23882
24173
|
*/
|
|
@@ -23897,7 +24188,7 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
23897
24188
|
*/
|
|
23898
24189
|
export declare const AccessProfilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
23899
24190
|
/**
|
|
23900
|
-
*
|
|
24191
|
+
* 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.
|
|
23901
24192
|
* @summary Create Access Profile
|
|
23902
24193
|
* @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
|
|
23903
24194
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23937,7 +24228,7 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
23937
24228
|
*/
|
|
23938
24229
|
getAccessProfileEntitlements(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Entitlement>>;
|
|
23939
24230
|
/**
|
|
23940
|
-
*
|
|
24231
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
23941
24232
|
* @summary List Access Profiles
|
|
23942
24233
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
23943
24234
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24055,13 +24346,13 @@ export interface AccessProfilesApiGetAccessProfileEntitlementsRequest {
|
|
|
24055
24346
|
*/
|
|
24056
24347
|
export interface AccessProfilesApiListAccessProfilesRequest {
|
|
24057
24348
|
/**
|
|
24058
|
-
*
|
|
24349
|
+
* 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.
|
|
24059
24350
|
* @type {string}
|
|
24060
24351
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
24061
24352
|
*/
|
|
24062
24353
|
readonly forSubadmin?: string;
|
|
24063
24354
|
/**
|
|
24064
|
-
*
|
|
24355
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
24065
24356
|
* @type {number}
|
|
24066
24357
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
24067
24358
|
*/
|
|
@@ -24079,7 +24370,7 @@ export interface AccessProfilesApiListAccessProfilesRequest {
|
|
|
24079
24370
|
*/
|
|
24080
24371
|
readonly count?: boolean;
|
|
24081
24372
|
/**
|
|
24082
|
-
* 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*
|
|
24373
|
+
* 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.
|
|
24083
24374
|
* @type {string}
|
|
24084
24375
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
24085
24376
|
*/
|
|
@@ -24091,13 +24382,13 @@ export interface AccessProfilesApiListAccessProfilesRequest {
|
|
|
24091
24382
|
*/
|
|
24092
24383
|
readonly sorters?: string;
|
|
24093
24384
|
/**
|
|
24094
|
-
*
|
|
24385
|
+
* 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.
|
|
24095
24386
|
* @type {string}
|
|
24096
24387
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
24097
24388
|
*/
|
|
24098
24389
|
readonly forSegmentIds?: string;
|
|
24099
24390
|
/**
|
|
24100
|
-
* Indicates whether the response list should contain unsegmented access profiles. If
|
|
24391
|
+
* 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.
|
|
24101
24392
|
* @type {boolean}
|
|
24102
24393
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
24103
24394
|
*/
|
|
@@ -24130,7 +24421,7 @@ export interface AccessProfilesApiPatchAccessProfileRequest {
|
|
|
24130
24421
|
*/
|
|
24131
24422
|
export declare class AccessProfilesApi extends BaseAPI {
|
|
24132
24423
|
/**
|
|
24133
|
-
*
|
|
24424
|
+
* 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.
|
|
24134
24425
|
* @summary Create Access Profile
|
|
24135
24426
|
* @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
|
|
24136
24427
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24175,7 +24466,7 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
24175
24466
|
*/
|
|
24176
24467
|
getAccessProfileEntitlements(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlement[], any>>;
|
|
24177
24468
|
/**
|
|
24178
|
-
*
|
|
24469
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
24179
24470
|
* @summary List Access Profiles
|
|
24180
24471
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
24181
24472
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25360,7 +25651,7 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
25360
25651
|
* @param {*} [axiosOptions] Override http request option.
|
|
25361
25652
|
* @throws {RequiredError}
|
|
25362
25653
|
*/
|
|
25363
|
-
getAccountEntitlements(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
25654
|
+
getAccountEntitlements(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Entitlement>>>;
|
|
25364
25655
|
/**
|
|
25365
25656
|
* List accounts.
|
|
25366
25657
|
* @summary Accounts List
|
|
@@ -25462,7 +25753,7 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
25462
25753
|
* @param {*} [axiosOptions] Override http request option.
|
|
25463
25754
|
* @throws {RequiredError}
|
|
25464
25755
|
*/
|
|
25465
|
-
getAccountEntitlements(requestParameters: AccountsApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
25756
|
+
getAccountEntitlements(requestParameters: AccountsApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Entitlement>>;
|
|
25466
25757
|
/**
|
|
25467
25758
|
* List accounts.
|
|
25468
25759
|
* @summary Accounts List
|
|
@@ -25785,7 +26076,7 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
25785
26076
|
* @throws {RequiredError}
|
|
25786
26077
|
* @memberof AccountsApi
|
|
25787
26078
|
*/
|
|
25788
|
-
getAccountEntitlements(requestParameters: AccountsApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
26079
|
+
getAccountEntitlements(requestParameters: AccountsApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlement[], any>>;
|
|
25789
26080
|
/**
|
|
25790
26081
|
* List accounts.
|
|
25791
26082
|
* @summary Accounts List
|
|
@@ -36722,12 +37013,12 @@ export type GetReportFileFormatV3 = typeof GetReportFileFormatV3[keyof typeof Ge
|
|
|
36722
37013
|
*/
|
|
36723
37014
|
export declare const RequestableObjectsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
36724
37015
|
/**
|
|
36725
|
-
*
|
|
37016
|
+
* 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.
|
|
36726
37017
|
* @summary Requestable Objects List
|
|
36727
37018
|
* @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.
|
|
36728
|
-
* @param {Array<RequestableObjectType>} [types] Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE
|
|
36729
|
-
* @param {string} [term]
|
|
36730
|
-
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of AVAILABLE
|
|
37019
|
+
* @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.
|
|
37020
|
+
* @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.
|
|
37021
|
+
* @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.
|
|
36731
37022
|
* @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.
|
|
36732
37023
|
* @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.
|
|
36733
37024
|
* @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.
|
|
@@ -36744,12 +37035,12 @@ export declare const RequestableObjectsApiAxiosParamCreator: (configuration?: Co
|
|
|
36744
37035
|
*/
|
|
36745
37036
|
export declare const RequestableObjectsApiFp: (configuration?: Configuration) => {
|
|
36746
37037
|
/**
|
|
36747
|
-
*
|
|
37038
|
+
* 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.
|
|
36748
37039
|
* @summary Requestable Objects List
|
|
36749
37040
|
* @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.
|
|
36750
|
-
* @param {Array<RequestableObjectType>} [types] Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE
|
|
36751
|
-
* @param {string} [term]
|
|
36752
|
-
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of AVAILABLE
|
|
37041
|
+
* @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.
|
|
37042
|
+
* @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.
|
|
37043
|
+
* @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.
|
|
36753
37044
|
* @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.
|
|
36754
37045
|
* @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.
|
|
36755
37046
|
* @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.
|
|
@@ -36766,7 +37057,7 @@ export declare const RequestableObjectsApiFp: (configuration?: Configuration) =>
|
|
|
36766
37057
|
*/
|
|
36767
37058
|
export declare const RequestableObjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
36768
37059
|
/**
|
|
36769
|
-
*
|
|
37060
|
+
* 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.
|
|
36770
37061
|
* @summary Requestable Objects List
|
|
36771
37062
|
* @param {RequestableObjectsApiListRequestableObjectsRequest} requestParameters Request parameters.
|
|
36772
37063
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -36787,19 +37078,19 @@ export interface RequestableObjectsApiListRequestableObjectsRequest {
|
|
|
36787
37078
|
*/
|
|
36788
37079
|
readonly identityId?: string;
|
|
36789
37080
|
/**
|
|
36790
|
-
* Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE
|
|
37081
|
+
* 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.
|
|
36791
37082
|
* @type {Array<RequestableObjectType>}
|
|
36792
37083
|
* @memberof RequestableObjectsApiListRequestableObjects
|
|
36793
37084
|
*/
|
|
36794
37085
|
readonly types?: Array<RequestableObjectType>;
|
|
36795
37086
|
/**
|
|
36796
|
-
*
|
|
37087
|
+
* 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.
|
|
36797
37088
|
* @type {string}
|
|
36798
37089
|
* @memberof RequestableObjectsApiListRequestableObjects
|
|
36799
37090
|
*/
|
|
36800
37091
|
readonly term?: string;
|
|
36801
37092
|
/**
|
|
36802
|
-
* Filters the result to the specified status/statuses, where each status is one of AVAILABLE
|
|
37093
|
+
* 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.
|
|
36803
37094
|
* @type {Array<RequestableObjectRequestStatus>}
|
|
36804
37095
|
* @memberof RequestableObjectsApiListRequestableObjects
|
|
36805
37096
|
*/
|
|
@@ -36843,7 +37134,7 @@ export interface RequestableObjectsApiListRequestableObjectsRequest {
|
|
|
36843
37134
|
*/
|
|
36844
37135
|
export declare class RequestableObjectsApi extends BaseAPI {
|
|
36845
37136
|
/**
|
|
36846
|
-
*
|
|
37137
|
+
* 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.
|
|
36847
37138
|
* @summary Requestable Objects List
|
|
36848
37139
|
* @param {RequestableObjectsApiListRequestableObjectsRequest} requestParameters Request parameters.
|
|
36849
37140
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39253,7 +39544,7 @@ export type SearchGetIndexV3 = typeof SearchGetIndexV3[keyof typeof SearchGetInd
|
|
|
39253
39544
|
*/
|
|
39254
39545
|
export declare const SearchAttributeConfigurationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
39255
39546
|
/**
|
|
39256
|
-
* 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
|
|
39547
|
+
* 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`.**
|
|
39257
39548
|
* @summary Create Extended Search Attributes
|
|
39258
39549
|
* @param {SearchAttributeConfig} searchAttributeConfig
|
|
39259
39550
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39269,12 +39560,14 @@ export declare const SearchAttributeConfigurationApiAxiosParamCreator: (configur
|
|
|
39269
39560
|
*/
|
|
39270
39561
|
deleteSearchAttributeConfig: (name: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39271
39562
|
/**
|
|
39272
|
-
* Get a list of attribute/application
|
|
39563
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
39273
39564
|
* @summary List Extended Search Attributes
|
|
39565
|
+
* @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.
|
|
39566
|
+
* @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.
|
|
39274
39567
|
* @param {*} [axiosOptions] Override http request option.
|
|
39275
39568
|
* @throws {RequiredError}
|
|
39276
39569
|
*/
|
|
39277
|
-
getSearchAttributeConfig: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39570
|
+
getSearchAttributeConfig: (limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39278
39571
|
/**
|
|
39279
39572
|
* Get an extended attribute configuration by name.
|
|
39280
39573
|
* @summary Get Extended Search Attribute
|
|
@@ -39299,7 +39592,7 @@ export declare const SearchAttributeConfigurationApiAxiosParamCreator: (configur
|
|
|
39299
39592
|
*/
|
|
39300
39593
|
export declare const SearchAttributeConfigurationApiFp: (configuration?: Configuration) => {
|
|
39301
39594
|
/**
|
|
39302
|
-
* 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
|
|
39595
|
+
* 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`.**
|
|
39303
39596
|
* @summary Create Extended Search Attributes
|
|
39304
39597
|
* @param {SearchAttributeConfig} searchAttributeConfig
|
|
39305
39598
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39315,12 +39608,14 @@ export declare const SearchAttributeConfigurationApiFp: (configuration?: Configu
|
|
|
39315
39608
|
*/
|
|
39316
39609
|
deleteSearchAttributeConfig(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
39317
39610
|
/**
|
|
39318
|
-
* Get a list of attribute/application
|
|
39611
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
39319
39612
|
* @summary List Extended Search Attributes
|
|
39613
|
+
* @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.
|
|
39614
|
+
* @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.
|
|
39320
39615
|
* @param {*} [axiosOptions] Override http request option.
|
|
39321
39616
|
* @throws {RequiredError}
|
|
39322
39617
|
*/
|
|
39323
|
-
getSearchAttributeConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchAttributeConfig>>>;
|
|
39618
|
+
getSearchAttributeConfig(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchAttributeConfig>>>;
|
|
39324
39619
|
/**
|
|
39325
39620
|
* Get an extended attribute configuration by name.
|
|
39326
39621
|
* @summary Get Extended Search Attribute
|
|
@@ -39345,7 +39640,7 @@ export declare const SearchAttributeConfigurationApiFp: (configuration?: Configu
|
|
|
39345
39640
|
*/
|
|
39346
39641
|
export declare const SearchAttributeConfigurationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
39347
39642
|
/**
|
|
39348
|
-
* 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
|
|
39643
|
+
* 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`.**
|
|
39349
39644
|
* @summary Create Extended Search Attributes
|
|
39350
39645
|
* @param {SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
39351
39646
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39361,12 +39656,13 @@ export declare const SearchAttributeConfigurationApiFactory: (configuration?: Co
|
|
|
39361
39656
|
*/
|
|
39362
39657
|
deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
39363
39658
|
/**
|
|
39364
|
-
* Get a list of attribute/application
|
|
39659
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
39365
39660
|
* @summary List Extended Search Attributes
|
|
39661
|
+
* @param {SearchAttributeConfigurationApiGetSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
39366
39662
|
* @param {*} [axiosOptions] Override http request option.
|
|
39367
39663
|
* @throws {RequiredError}
|
|
39368
39664
|
*/
|
|
39369
|
-
getSearchAttributeConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SearchAttributeConfig>>;
|
|
39665
|
+
getSearchAttributeConfig(requestParameters?: SearchAttributeConfigurationApiGetSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SearchAttributeConfig>>;
|
|
39370
39666
|
/**
|
|
39371
39667
|
* Get an extended attribute configuration by name.
|
|
39372
39668
|
* @summary Get Extended Search Attribute
|
|
@@ -39410,6 +39706,25 @@ export interface SearchAttributeConfigurationApiDeleteSearchAttributeConfigReque
|
|
|
39410
39706
|
*/
|
|
39411
39707
|
readonly name: string;
|
|
39412
39708
|
}
|
|
39709
|
+
/**
|
|
39710
|
+
* Request parameters for getSearchAttributeConfig operation in SearchAttributeConfigurationApi.
|
|
39711
|
+
* @export
|
|
39712
|
+
* @interface SearchAttributeConfigurationApiGetSearchAttributeConfigRequest
|
|
39713
|
+
*/
|
|
39714
|
+
export interface SearchAttributeConfigurationApiGetSearchAttributeConfigRequest {
|
|
39715
|
+
/**
|
|
39716
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
39717
|
+
* @type {number}
|
|
39718
|
+
* @memberof SearchAttributeConfigurationApiGetSearchAttributeConfig
|
|
39719
|
+
*/
|
|
39720
|
+
readonly limit?: number;
|
|
39721
|
+
/**
|
|
39722
|
+
* 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.
|
|
39723
|
+
* @type {number}
|
|
39724
|
+
* @memberof SearchAttributeConfigurationApiGetSearchAttributeConfig
|
|
39725
|
+
*/
|
|
39726
|
+
readonly offset?: number;
|
|
39727
|
+
}
|
|
39413
39728
|
/**
|
|
39414
39729
|
* Request parameters for getSingleSearchAttributeConfig operation in SearchAttributeConfigurationApi.
|
|
39415
39730
|
* @export
|
|
@@ -39450,7 +39765,7 @@ export interface SearchAttributeConfigurationApiPatchSearchAttributeConfigReques
|
|
|
39450
39765
|
*/
|
|
39451
39766
|
export declare class SearchAttributeConfigurationApi extends BaseAPI {
|
|
39452
39767
|
/**
|
|
39453
|
-
* 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
|
|
39768
|
+
* 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`.**
|
|
39454
39769
|
* @summary Create Extended Search Attributes
|
|
39455
39770
|
* @param {SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
39456
39771
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39468,13 +39783,14 @@ export declare class SearchAttributeConfigurationApi extends BaseAPI {
|
|
|
39468
39783
|
*/
|
|
39469
39784
|
deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
39470
39785
|
/**
|
|
39471
|
-
* Get a list of attribute/application
|
|
39786
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
39472
39787
|
* @summary List Extended Search Attributes
|
|
39788
|
+
* @param {SearchAttributeConfigurationApiGetSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
39473
39789
|
* @param {*} [axiosOptions] Override http request option.
|
|
39474
39790
|
* @throws {RequiredError}
|
|
39475
39791
|
* @memberof SearchAttributeConfigurationApi
|
|
39476
39792
|
*/
|
|
39477
|
-
getSearchAttributeConfig(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchAttributeConfig[], any>>;
|
|
39793
|
+
getSearchAttributeConfig(requestParameters?: SearchAttributeConfigurationApiGetSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchAttributeConfig[], any>>;
|
|
39478
39794
|
/**
|
|
39479
39795
|
* Get an extended attribute configuration by name.
|
|
39480
39796
|
* @summary Get Extended Search Attribute
|
|
@@ -40519,11 +40835,11 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
40519
40835
|
/**
|
|
40520
40836
|
* 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).
|
|
40521
40837
|
* @summary Get Source Connections by ID
|
|
40522
|
-
* @param {string}
|
|
40838
|
+
* @param {string} sourceId Source ID.
|
|
40523
40839
|
* @param {*} [axiosOptions] Override http request option.
|
|
40524
40840
|
* @throws {RequiredError}
|
|
40525
40841
|
*/
|
|
40526
|
-
getSourceConnections: (
|
|
40842
|
+
getSourceConnections: (sourceId: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40527
40843
|
/**
|
|
40528
40844
|
* This endpoint fetches source health by source\'s id
|
|
40529
40845
|
* @summary Fetches source health by id
|
|
@@ -40764,11 +41080,11 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
40764
41080
|
/**
|
|
40765
41081
|
* 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).
|
|
40766
41082
|
* @summary Get Source Connections by ID
|
|
40767
|
-
* @param {string}
|
|
41083
|
+
* @param {string} sourceId Source ID.
|
|
40768
41084
|
* @param {*} [axiosOptions] Override http request option.
|
|
40769
41085
|
* @throws {RequiredError}
|
|
40770
41086
|
*/
|
|
40771
|
-
getSourceConnections(
|
|
41087
|
+
getSourceConnections(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceConnectionsDto>>;
|
|
40772
41088
|
/**
|
|
40773
41089
|
* This endpoint fetches source health by source\'s id
|
|
40774
41090
|
* @summary Fetches source health by id
|
|
@@ -41311,7 +41627,7 @@ export interface SourcesApiGetSourceConnectionsRequest {
|
|
|
41311
41627
|
* @type {string}
|
|
41312
41628
|
* @memberof SourcesApiGetSourceConnections
|
|
41313
41629
|
*/
|
|
41314
|
-
readonly
|
|
41630
|
+
readonly sourceId: string;
|
|
41315
41631
|
}
|
|
41316
41632
|
/**
|
|
41317
41633
|
* Request parameters for getSourceHealth operation in SourcesApi.
|
|
@@ -42909,10 +43225,11 @@ export declare const WorkItemsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
42909
43225
|
* This API completes a work item. Either an admin, or the owning/current user must make this request.
|
|
42910
43226
|
* @summary Complete a Work Item
|
|
42911
43227
|
* @param {string} id The ID of the work item
|
|
43228
|
+
* @param {string | null} [body] Body is the request payload to create form definition request
|
|
42912
43229
|
* @param {*} [axiosOptions] Override http request option.
|
|
42913
43230
|
* @throws {RequiredError}
|
|
42914
43231
|
*/
|
|
42915
|
-
completeWorkItem: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
43232
|
+
completeWorkItem: (id: string, body?: string | null, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
42916
43233
|
/**
|
|
42917
43234
|
* This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.
|
|
42918
43235
|
* @summary Completed Work Items
|
|
@@ -43031,10 +43348,11 @@ export declare const WorkItemsApiFp: (configuration?: Configuration) => {
|
|
|
43031
43348
|
* This API completes a work item. Either an admin, or the owning/current user must make this request.
|
|
43032
43349
|
* @summary Complete a Work Item
|
|
43033
43350
|
* @param {string} id The ID of the work item
|
|
43351
|
+
* @param {string | null} [body] Body is the request payload to create form definition request
|
|
43034
43352
|
* @param {*} [axiosOptions] Override http request option.
|
|
43035
43353
|
* @throws {RequiredError}
|
|
43036
43354
|
*/
|
|
43037
|
-
completeWorkItem(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkItems>>;
|
|
43355
|
+
completeWorkItem(id: string, body?: string | null, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkItems>>;
|
|
43038
43356
|
/**
|
|
43039
43357
|
* This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.
|
|
43040
43358
|
* @summary Completed Work Items
|
|
@@ -43281,6 +43599,12 @@ export interface WorkItemsApiCompleteWorkItemRequest {
|
|
|
43281
43599
|
* @memberof WorkItemsApiCompleteWorkItem
|
|
43282
43600
|
*/
|
|
43283
43601
|
readonly id: string;
|
|
43602
|
+
/**
|
|
43603
|
+
* Body is the request payload to create form definition request
|
|
43604
|
+
* @type {string}
|
|
43605
|
+
* @memberof WorkItemsApiCompleteWorkItem
|
|
43606
|
+
*/
|
|
43607
|
+
readonly body?: string | null;
|
|
43284
43608
|
}
|
|
43285
43609
|
/**
|
|
43286
43610
|
* Request parameters for getCompletedWorkItems operation in WorkItemsApi.
|