sailpoint-api-client 1.8.61 → 1.8.63
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 +36 -0
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.js +99 -9
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +2 -2
- package/dist/nerm/common.js +2 -2
- package/dist/nermv2025/common.js +2 -2
- package/dist/v2024/api.js +77 -7
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +2 -2
- package/dist/v2025/api.js +77 -7
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +2 -2
- package/dist/v2026/api.d.ts +740 -13
- package/dist/v2026/api.js +726 -24
- package/dist/v2026/api.js.map +1 -1
- package/dist/v2026/common.js +2 -2
- package/dist/v3/api.js +77 -7
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +2 -2
- package/nerm/README.md +2 -2
- package/nerm/common.ts +2 -2
- package/nerm/package.json +1 -1
- package/nermv2025/README.md +2 -2
- package/nermv2025/common.ts +2 -2
- package/nermv2025/package.json +1 -1
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/api.ts +28 -0
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +28 -0
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v2026/README.md +2 -2
- package/v2026/api.ts +1086 -13
- package/v2026/common.ts +2 -2
- package/v2026/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +32 -4
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/v2026/api.d.ts
CHANGED
|
@@ -18442,6 +18442,365 @@ export interface EntitlementBulkUpdateRequestV2026 {
|
|
|
18442
18442
|
*/
|
|
18443
18443
|
'jsonPatch': Array<JsonPatchOperationV2026>;
|
|
18444
18444
|
}
|
|
18445
|
+
/**
|
|
18446
|
+
*
|
|
18447
|
+
* @export
|
|
18448
|
+
* @interface EntitlementConnectionBulkUpdateItemV2026
|
|
18449
|
+
*/
|
|
18450
|
+
export interface EntitlementConnectionBulkUpdateItemV2026 {
|
|
18451
|
+
/**
|
|
18452
|
+
* Connection ID to update.
|
|
18453
|
+
* @type {string}
|
|
18454
|
+
* @memberof EntitlementConnectionBulkUpdateItemV2026
|
|
18455
|
+
*/
|
|
18456
|
+
'connectionId': string;
|
|
18457
|
+
/**
|
|
18458
|
+
* Target connection type.
|
|
18459
|
+
* @type {string}
|
|
18460
|
+
* @memberof EntitlementConnectionBulkUpdateItemV2026
|
|
18461
|
+
*/
|
|
18462
|
+
'type': EntitlementConnectionBulkUpdateItemV2026TypeV2026;
|
|
18463
|
+
}
|
|
18464
|
+
export declare const EntitlementConnectionBulkUpdateItemV2026TypeV2026: {
|
|
18465
|
+
readonly Jit: "JIT";
|
|
18466
|
+
readonly Standing: "STANDING";
|
|
18467
|
+
};
|
|
18468
|
+
export type EntitlementConnectionBulkUpdateItemV2026TypeV2026 = typeof EntitlementConnectionBulkUpdateItemV2026TypeV2026[keyof typeof EntitlementConnectionBulkUpdateItemV2026TypeV2026];
|
|
18469
|
+
/**
|
|
18470
|
+
*
|
|
18471
|
+
* @export
|
|
18472
|
+
* @interface EntitlementConnectionBulkUpdateResultItemV2026
|
|
18473
|
+
*/
|
|
18474
|
+
export interface EntitlementConnectionBulkUpdateResultItemV2026 {
|
|
18475
|
+
/**
|
|
18476
|
+
* Connection ID processed in this row.
|
|
18477
|
+
* @type {string}
|
|
18478
|
+
* @memberof EntitlementConnectionBulkUpdateResultItemV2026
|
|
18479
|
+
*/
|
|
18480
|
+
'connectionId'?: string;
|
|
18481
|
+
/**
|
|
18482
|
+
* Requested or resulting connection type for the row.
|
|
18483
|
+
* @type {string}
|
|
18484
|
+
* @memberof EntitlementConnectionBulkUpdateResultItemV2026
|
|
18485
|
+
*/
|
|
18486
|
+
'type'?: string;
|
|
18487
|
+
/**
|
|
18488
|
+
* Item-level result status code.
|
|
18489
|
+
* @type {number}
|
|
18490
|
+
* @memberof EntitlementConnectionBulkUpdateResultItemV2026
|
|
18491
|
+
*/
|
|
18492
|
+
'status'?: number;
|
|
18493
|
+
/**
|
|
18494
|
+
* Item-level result message.
|
|
18495
|
+
* @type {string}
|
|
18496
|
+
* @memberof EntitlementConnectionBulkUpdateResultItemV2026
|
|
18497
|
+
*/
|
|
18498
|
+
'description'?: string;
|
|
18499
|
+
}
|
|
18500
|
+
/**
|
|
18501
|
+
* Privilege classification details for the entitlement.
|
|
18502
|
+
* @export
|
|
18503
|
+
* @interface EntitlementConnectionSearchHitEntitlementPrivilegeLevelV2026
|
|
18504
|
+
*/
|
|
18505
|
+
export interface EntitlementConnectionSearchHitEntitlementPrivilegeLevelV2026 {
|
|
18506
|
+
/**
|
|
18507
|
+
* Effective privilege level.
|
|
18508
|
+
* @type {string}
|
|
18509
|
+
* @memberof EntitlementConnectionSearchHitEntitlementPrivilegeLevelV2026
|
|
18510
|
+
*/
|
|
18511
|
+
'effective'?: string;
|
|
18512
|
+
}
|
|
18513
|
+
/**
|
|
18514
|
+
* Entitlement object embedded in entitlement connection search responses.
|
|
18515
|
+
* @export
|
|
18516
|
+
* @interface EntitlementConnectionSearchHitEntitlementV2026
|
|
18517
|
+
*/
|
|
18518
|
+
export interface EntitlementConnectionSearchHitEntitlementV2026 {
|
|
18519
|
+
/**
|
|
18520
|
+
* Entitlement identifier.
|
|
18521
|
+
* @type {string}
|
|
18522
|
+
* @memberof EntitlementConnectionSearchHitEntitlementV2026
|
|
18523
|
+
*/
|
|
18524
|
+
'id'?: string;
|
|
18525
|
+
/**
|
|
18526
|
+
* Entitlement name.
|
|
18527
|
+
* @type {string}
|
|
18528
|
+
* @memberof EntitlementConnectionSearchHitEntitlementV2026
|
|
18529
|
+
*/
|
|
18530
|
+
'name'?: string;
|
|
18531
|
+
/**
|
|
18532
|
+
* Human-readable entitlement label.
|
|
18533
|
+
* @type {string}
|
|
18534
|
+
* @memberof EntitlementConnectionSearchHitEntitlementV2026
|
|
18535
|
+
*/
|
|
18536
|
+
'displayName'?: string;
|
|
18537
|
+
/**
|
|
18538
|
+
* Entitlement description.
|
|
18539
|
+
* @type {string}
|
|
18540
|
+
* @memberof EntitlementConnectionSearchHitEntitlementV2026
|
|
18541
|
+
*/
|
|
18542
|
+
'description'?: string;
|
|
18543
|
+
/**
|
|
18544
|
+
* Source attribute carrying entitlement values.
|
|
18545
|
+
* @type {string}
|
|
18546
|
+
* @memberof EntitlementConnectionSearchHitEntitlementV2026
|
|
18547
|
+
*/
|
|
18548
|
+
'attribute'?: string;
|
|
18549
|
+
/**
|
|
18550
|
+
* Source entitlement value.
|
|
18551
|
+
* @type {string}
|
|
18552
|
+
* @memberof EntitlementConnectionSearchHitEntitlementV2026
|
|
18553
|
+
*/
|
|
18554
|
+
'value'?: string;
|
|
18555
|
+
/**
|
|
18556
|
+
* Source schema object type for the entitlement.
|
|
18557
|
+
* @type {string}
|
|
18558
|
+
* @memberof EntitlementConnectionSearchHitEntitlementV2026
|
|
18559
|
+
*/
|
|
18560
|
+
'sourceSchemaObjectType'?: string;
|
|
18561
|
+
/**
|
|
18562
|
+
*
|
|
18563
|
+
* @type {EntitlementConnectionSearchHitEntitlementPrivilegeLevelV2026}
|
|
18564
|
+
* @memberof EntitlementConnectionSearchHitEntitlementV2026
|
|
18565
|
+
*/
|
|
18566
|
+
'privilegeLevel'?: EntitlementConnectionSearchHitEntitlementPrivilegeLevelV2026;
|
|
18567
|
+
}
|
|
18568
|
+
/**
|
|
18569
|
+
* Entitlement connection record returned by search-backed list endpoints.
|
|
18570
|
+
* @export
|
|
18571
|
+
* @interface EntitlementConnectionSearchHitV2026
|
|
18572
|
+
*/
|
|
18573
|
+
export interface EntitlementConnectionSearchHitV2026 {
|
|
18574
|
+
/**
|
|
18575
|
+
* Connection ID as represented in search results.
|
|
18576
|
+
* @type {string}
|
|
18577
|
+
* @memberof EntitlementConnectionSearchHitV2026
|
|
18578
|
+
*/
|
|
18579
|
+
'id'?: string;
|
|
18580
|
+
/**
|
|
18581
|
+
* Identity summary object from search index.
|
|
18582
|
+
* @type {{ [key: string]: any; }}
|
|
18583
|
+
* @memberof EntitlementConnectionSearchHitV2026
|
|
18584
|
+
*/
|
|
18585
|
+
'identity'?: {
|
|
18586
|
+
[key: string]: any;
|
|
18587
|
+
};
|
|
18588
|
+
/**
|
|
18589
|
+
* Machine identity summary object when available.
|
|
18590
|
+
* @type {{ [key: string]: any; }}
|
|
18591
|
+
* @memberof EntitlementConnectionSearchHitV2026
|
|
18592
|
+
*/
|
|
18593
|
+
'machineIdentity'?: {
|
|
18594
|
+
[key: string]: any;
|
|
18595
|
+
};
|
|
18596
|
+
/**
|
|
18597
|
+
* Account summary object.
|
|
18598
|
+
* @type {{ [key: string]: any; }}
|
|
18599
|
+
* @memberof EntitlementConnectionSearchHitV2026
|
|
18600
|
+
*/
|
|
18601
|
+
'account'?: {
|
|
18602
|
+
[key: string]: any;
|
|
18603
|
+
};
|
|
18604
|
+
/**
|
|
18605
|
+
*
|
|
18606
|
+
* @type {EntitlementConnectionSearchHitEntitlementV2026}
|
|
18607
|
+
* @memberof EntitlementConnectionSearchHitV2026
|
|
18608
|
+
*/
|
|
18609
|
+
'entitlement'?: EntitlementConnectionSearchHitEntitlementV2026;
|
|
18610
|
+
/**
|
|
18611
|
+
* Source summary object.
|
|
18612
|
+
* @type {{ [key: string]: any; }}
|
|
18613
|
+
* @memberof EntitlementConnectionSearchHitV2026
|
|
18614
|
+
*/
|
|
18615
|
+
'source'?: {
|
|
18616
|
+
[key: string]: any;
|
|
18617
|
+
};
|
|
18618
|
+
/**
|
|
18619
|
+
* Connection state object.
|
|
18620
|
+
* @type {{ [key: string]: any; }}
|
|
18621
|
+
* @memberof EntitlementConnectionSearchHitV2026
|
|
18622
|
+
*/
|
|
18623
|
+
'state'?: {
|
|
18624
|
+
[key: string]: any;
|
|
18625
|
+
};
|
|
18626
|
+
/**
|
|
18627
|
+
* JIT timestamps for lifecycle events.
|
|
18628
|
+
* @type {{ [key: string]: any; }}
|
|
18629
|
+
* @memberof EntitlementConnectionSearchHitV2026
|
|
18630
|
+
*/
|
|
18631
|
+
'jit'?: {
|
|
18632
|
+
[key: string]: any;
|
|
18633
|
+
};
|
|
18634
|
+
/**
|
|
18635
|
+
* Indicates whether the connection is marked as standalone.
|
|
18636
|
+
* @type {boolean}
|
|
18637
|
+
* @memberof EntitlementConnectionSearchHitV2026
|
|
18638
|
+
*/
|
|
18639
|
+
'standalone'?: boolean;
|
|
18640
|
+
/**
|
|
18641
|
+
* Connection type classification.
|
|
18642
|
+
* @type {string}
|
|
18643
|
+
* @memberof EntitlementConnectionSearchHitV2026
|
|
18644
|
+
*/
|
|
18645
|
+
'type'?: EntitlementConnectionSearchHitV2026TypeV2026;
|
|
18646
|
+
}
|
|
18647
|
+
export declare const EntitlementConnectionSearchHitV2026TypeV2026: {
|
|
18648
|
+
readonly Jit: "JIT";
|
|
18649
|
+
readonly Standing: "STANDING";
|
|
18650
|
+
readonly Na: "NA";
|
|
18651
|
+
};
|
|
18652
|
+
export type EntitlementConnectionSearchHitV2026TypeV2026 = typeof EntitlementConnectionSearchHitV2026TypeV2026[keyof typeof EntitlementConnectionSearchHitV2026TypeV2026];
|
|
18653
|
+
/**
|
|
18654
|
+
* Entitlement connection entity returned by patch APIs.
|
|
18655
|
+
* @export
|
|
18656
|
+
* @interface EntitlementConnectionV2026
|
|
18657
|
+
*/
|
|
18658
|
+
export interface EntitlementConnectionV2026 {
|
|
18659
|
+
/**
|
|
18660
|
+
* Tenant identifier that owns the connection.
|
|
18661
|
+
* @type {string}
|
|
18662
|
+
* @memberof EntitlementConnectionV2026
|
|
18663
|
+
*/
|
|
18664
|
+
'tenantId'?: string;
|
|
18665
|
+
/**
|
|
18666
|
+
* Entitlement connection identifier.
|
|
18667
|
+
* @type {string}
|
|
18668
|
+
* @memberof EntitlementConnectionV2026
|
|
18669
|
+
*/
|
|
18670
|
+
'connectionId'?: string;
|
|
18671
|
+
/**
|
|
18672
|
+
* Identity identifier associated with the connection.
|
|
18673
|
+
* @type {string}
|
|
18674
|
+
* @memberof EntitlementConnectionV2026
|
|
18675
|
+
*/
|
|
18676
|
+
'identityId'?: string;
|
|
18677
|
+
/**
|
|
18678
|
+
* Machine identity identifier when the connection is machine-backed.
|
|
18679
|
+
* @type {string}
|
|
18680
|
+
* @memberof EntitlementConnectionV2026
|
|
18681
|
+
*/
|
|
18682
|
+
'machineIdentityId'?: string;
|
|
18683
|
+
/**
|
|
18684
|
+
* Account identifier for the connected source account.
|
|
18685
|
+
* @type {string}
|
|
18686
|
+
* @memberof EntitlementConnectionV2026
|
|
18687
|
+
*/
|
|
18688
|
+
'accountId'?: string;
|
|
18689
|
+
/**
|
|
18690
|
+
* Entitlement identifier on the source.
|
|
18691
|
+
* @type {string}
|
|
18692
|
+
* @memberof EntitlementConnectionV2026
|
|
18693
|
+
*/
|
|
18694
|
+
'entitlementId'?: string;
|
|
18695
|
+
/**
|
|
18696
|
+
* Source identifier that provides the account and entitlement.
|
|
18697
|
+
* @type {string}
|
|
18698
|
+
* @memberof EntitlementConnectionV2026
|
|
18699
|
+
*/
|
|
18700
|
+
'sourceId'?: string;
|
|
18701
|
+
/**
|
|
18702
|
+
* Indicates whether the connection is marked as standalone.
|
|
18703
|
+
* @type {boolean}
|
|
18704
|
+
* @memberof EntitlementConnectionV2026
|
|
18705
|
+
*/
|
|
18706
|
+
'standalone'?: boolean;
|
|
18707
|
+
/**
|
|
18708
|
+
* Entitlement attribute name on the source.
|
|
18709
|
+
* @type {string}
|
|
18710
|
+
* @memberof EntitlementConnectionV2026
|
|
18711
|
+
*/
|
|
18712
|
+
'attributeName'?: string;
|
|
18713
|
+
/**
|
|
18714
|
+
* Entitlement attribute value on the source.
|
|
18715
|
+
* @type {string}
|
|
18716
|
+
* @memberof EntitlementConnectionV2026
|
|
18717
|
+
*/
|
|
18718
|
+
'attributeValue'?: string;
|
|
18719
|
+
/**
|
|
18720
|
+
* Connection type classification.
|
|
18721
|
+
* @type {string}
|
|
18722
|
+
* @memberof EntitlementConnectionV2026
|
|
18723
|
+
*/
|
|
18724
|
+
'type'?: EntitlementConnectionV2026TypeV2026;
|
|
18725
|
+
/**
|
|
18726
|
+
* Current lifecycle state of the connection.
|
|
18727
|
+
* @type {string}
|
|
18728
|
+
* @memberof EntitlementConnectionV2026
|
|
18729
|
+
*/
|
|
18730
|
+
'state'?: string;
|
|
18731
|
+
/**
|
|
18732
|
+
* Time the connection state was last updated.
|
|
18733
|
+
* @type {string}
|
|
18734
|
+
* @memberof EntitlementConnectionV2026
|
|
18735
|
+
*/
|
|
18736
|
+
'stateChanged'?: string;
|
|
18737
|
+
/**
|
|
18738
|
+
* Identifier of the actor that last changed state.
|
|
18739
|
+
* @type {string}
|
|
18740
|
+
* @memberof EntitlementConnectionV2026
|
|
18741
|
+
*/
|
|
18742
|
+
'stateChangedBy'?: string;
|
|
18743
|
+
/**
|
|
18744
|
+
* Time JIT activation occurred.
|
|
18745
|
+
* @type {string}
|
|
18746
|
+
* @memberof EntitlementConnectionV2026
|
|
18747
|
+
*/
|
|
18748
|
+
'jitActivation'?: string;
|
|
18749
|
+
/**
|
|
18750
|
+
* Time provisioning completed for JIT activation.
|
|
18751
|
+
* @type {string}
|
|
18752
|
+
* @memberof EntitlementConnectionV2026
|
|
18753
|
+
*/
|
|
18754
|
+
'jitProvision'?: string;
|
|
18755
|
+
/**
|
|
18756
|
+
* Time JIT deactivation occurred.
|
|
18757
|
+
* @type {string}
|
|
18758
|
+
* @memberof EntitlementConnectionV2026
|
|
18759
|
+
*/
|
|
18760
|
+
'jitDeactivation'?: string;
|
|
18761
|
+
/**
|
|
18762
|
+
* Time deprovisioning completed after JIT deactivation.
|
|
18763
|
+
* @type {string}
|
|
18764
|
+
* @memberof EntitlementConnectionV2026
|
|
18765
|
+
*/
|
|
18766
|
+
'jitDeprovision'?: string;
|
|
18767
|
+
/**
|
|
18768
|
+
* Time when JIT access expires.
|
|
18769
|
+
* @type {string}
|
|
18770
|
+
* @memberof EntitlementConnectionV2026
|
|
18771
|
+
*/
|
|
18772
|
+
'jitExpiration'?: string;
|
|
18773
|
+
/**
|
|
18774
|
+
* Time after which the connection is eligible for deletion.
|
|
18775
|
+
* @type {string}
|
|
18776
|
+
* @memberof EntitlementConnectionV2026
|
|
18777
|
+
*/
|
|
18778
|
+
'deleteAfter'?: string;
|
|
18779
|
+
/**
|
|
18780
|
+
* Time when the connection was created.
|
|
18781
|
+
* @type {string}
|
|
18782
|
+
* @memberof EntitlementConnectionV2026
|
|
18783
|
+
*/
|
|
18784
|
+
'created'?: string;
|
|
18785
|
+
/**
|
|
18786
|
+
* Time when the connection was last modified.
|
|
18787
|
+
* @type {string}
|
|
18788
|
+
* @memberof EntitlementConnectionV2026
|
|
18789
|
+
*/
|
|
18790
|
+
'modified'?: string;
|
|
18791
|
+
/**
|
|
18792
|
+
* Display value for the actor associated with the latest change.
|
|
18793
|
+
* @type {string}
|
|
18794
|
+
* @memberof EntitlementConnectionV2026
|
|
18795
|
+
*/
|
|
18796
|
+
'actorName'?: string;
|
|
18797
|
+
}
|
|
18798
|
+
export declare const EntitlementConnectionV2026TypeV2026: {
|
|
18799
|
+
readonly Jit: "JIT";
|
|
18800
|
+
readonly Standing: "STANDING";
|
|
18801
|
+
readonly Na: "NA";
|
|
18802
|
+
};
|
|
18803
|
+
export type EntitlementConnectionV2026TypeV2026 = typeof EntitlementConnectionV2026TypeV2026[keyof typeof EntitlementConnectionV2026TypeV2026];
|
|
18445
18804
|
/**
|
|
18446
18805
|
* Indicates whether the entitlement\'s display name and/or description have been manually updated.
|
|
18447
18806
|
* @export
|
|
@@ -27082,6 +27441,19 @@ export interface ListDeploys200ResponseV2026 {
|
|
|
27082
27441
|
*/
|
|
27083
27442
|
'items'?: Array<DeployResponseV2026>;
|
|
27084
27443
|
}
|
|
27444
|
+
/**
|
|
27445
|
+
*
|
|
27446
|
+
* @export
|
|
27447
|
+
* @interface ListEntitlementConnections412ResponseV2026
|
|
27448
|
+
*/
|
|
27449
|
+
export interface ListEntitlementConnections412ResponseV2026 {
|
|
27450
|
+
/**
|
|
27451
|
+
* A message describing the error
|
|
27452
|
+
* @type {object}
|
|
27453
|
+
* @memberof ListEntitlementConnections412ResponseV2026
|
|
27454
|
+
*/
|
|
27455
|
+
'message'?: object;
|
|
27456
|
+
}
|
|
27085
27457
|
/**
|
|
27086
27458
|
*
|
|
27087
27459
|
* @export
|
|
@@ -51653,19 +52025,6 @@ export declare const UncorrelatedAccountsReportArgumentsV2026SelectedFormatsV202
|
|
|
51653
52025
|
readonly Pdf: "PDF";
|
|
51654
52026
|
};
|
|
51655
52027
|
export type UncorrelatedAccountsReportArgumentsV2026SelectedFormatsV2026 = typeof UncorrelatedAccountsReportArgumentsV2026SelectedFormatsV2026[keyof typeof UncorrelatedAccountsReportArgumentsV2026SelectedFormatsV2026];
|
|
51656
|
-
/**
|
|
51657
|
-
*
|
|
51658
|
-
* @export
|
|
51659
|
-
* @interface UpdateAccessProfilesInBulk412ResponseV2026
|
|
51660
|
-
*/
|
|
51661
|
-
export interface UpdateAccessProfilesInBulk412ResponseV2026 {
|
|
51662
|
-
/**
|
|
51663
|
-
* A message describing the error
|
|
51664
|
-
* @type {object}
|
|
51665
|
-
* @memberof UpdateAccessProfilesInBulk412ResponseV2026
|
|
51666
|
-
*/
|
|
51667
|
-
'message'?: object;
|
|
51668
|
-
}
|
|
51669
52028
|
/**
|
|
51670
52029
|
*
|
|
51671
52030
|
* @export
|
|
@@ -70145,6 +70504,374 @@ export declare class DimensionsV2026Api extends BaseAPI {
|
|
|
70145
70504
|
*/
|
|
70146
70505
|
patchDimension(requestParameters: DimensionsV2026ApiPatchDimensionRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DimensionV2026, any>>;
|
|
70147
70506
|
}
|
|
70507
|
+
/**
|
|
70508
|
+
* EntitlementConnectionsV2026Api - axios parameter creator
|
|
70509
|
+
* @export
|
|
70510
|
+
*/
|
|
70511
|
+
export declare const EntitlementConnectionsV2026ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
70512
|
+
/**
|
|
70513
|
+
* Returns entitlement connections for the tenant. This endpoint proxies to Search and supports standard collection query parameters. The `filters` and `sorters` values support the Entitlement Connections search fields documented by ECS.
|
|
70514
|
+
* @summary List entitlement connections
|
|
70515
|
+
* @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.
|
|
70516
|
+
* @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.
|
|
70517
|
+
* @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.
|
|
70518
|
+
* @param {string} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement.
|
|
70519
|
+
* @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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le*
|
|
70520
|
+
* @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: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** Prefix a field with `-` for descending order.
|
|
70521
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70522
|
+
* @throws {RequiredError}
|
|
70523
|
+
*/
|
|
70524
|
+
listEntitlementConnections: (offset?: number, limit?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
70525
|
+
/**
|
|
70526
|
+
* Returns entitlement connections constrained to the authenticated identity. This endpoint proxies to Search and supports standard collection query parameters.
|
|
70527
|
+
* @summary List my entitlement connections
|
|
70528
|
+
* @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.
|
|
70529
|
+
* @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.
|
|
70530
|
+
* @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.
|
|
70531
|
+
* @param {string} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement.
|
|
70532
|
+
* @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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* The authenticated identity scope is always applied by the service.
|
|
70533
|
+
* @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: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration**
|
|
70534
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70535
|
+
* @throws {RequiredError}
|
|
70536
|
+
*/
|
|
70537
|
+
listEntitlementConnectionsForCurrentIdentity: (offset?: number, limit?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
70538
|
+
/**
|
|
70539
|
+
* Applies JSON Patch operations to an entitlement connection selected by `connectionId`.
|
|
70540
|
+
* @summary Update entitlement connection
|
|
70541
|
+
* @param {string} connectionId Connection ID (UUID with or without hyphens).
|
|
70542
|
+
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026
|
|
70543
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70544
|
+
* @throws {RequiredError}
|
|
70545
|
+
*/
|
|
70546
|
+
patchEntitlementConnectionById: (connectionId: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
70547
|
+
/**
|
|
70548
|
+
* Applies JSON Patch operations to a single entitlement connection selected by `entitlementId`, `identityId`, and `accountId`.
|
|
70549
|
+
* @summary Update connection by query
|
|
70550
|
+
* @param {string} entitlementId Entitlement ID (UUID with or without hyphens).
|
|
70551
|
+
* @param {string} identityId Identity ID (UUID with or without hyphens).
|
|
70552
|
+
* @param {string} accountId Account ID (UUID with or without hyphens).
|
|
70553
|
+
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026
|
|
70554
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70555
|
+
* @throws {RequiredError}
|
|
70556
|
+
*/
|
|
70557
|
+
patchEntitlementConnectionByQuery: (entitlementId: string, identityId: string, accountId: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
70558
|
+
/**
|
|
70559
|
+
* Updates connection type for up to 100 connections in one request. The API returns per-item results in a 207 Multi-Status response.
|
|
70560
|
+
* @summary Update connections in bulk
|
|
70561
|
+
* @param {Array<EntitlementConnectionBulkUpdateItemV2026>} entitlementConnectionBulkUpdateItemV2026
|
|
70562
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70563
|
+
* @throws {RequiredError}
|
|
70564
|
+
*/
|
|
70565
|
+
updateEntitlementConnectionsBulk: (entitlementConnectionBulkUpdateItemV2026: Array<EntitlementConnectionBulkUpdateItemV2026>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
70566
|
+
};
|
|
70567
|
+
/**
|
|
70568
|
+
* EntitlementConnectionsV2026Api - functional programming interface
|
|
70569
|
+
* @export
|
|
70570
|
+
*/
|
|
70571
|
+
export declare const EntitlementConnectionsV2026ApiFp: (configuration?: Configuration) => {
|
|
70572
|
+
/**
|
|
70573
|
+
* Returns entitlement connections for the tenant. This endpoint proxies to Search and supports standard collection query parameters. The `filters` and `sorters` values support the Entitlement Connections search fields documented by ECS.
|
|
70574
|
+
* @summary List entitlement connections
|
|
70575
|
+
* @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.
|
|
70576
|
+
* @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.
|
|
70577
|
+
* @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.
|
|
70578
|
+
* @param {string} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement.
|
|
70579
|
+
* @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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le*
|
|
70580
|
+
* @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: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** Prefix a field with `-` for descending order.
|
|
70581
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70582
|
+
* @throws {RequiredError}
|
|
70583
|
+
*/
|
|
70584
|
+
listEntitlementConnections(offset?: number, limit?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementConnectionSearchHitV2026>>>;
|
|
70585
|
+
/**
|
|
70586
|
+
* Returns entitlement connections constrained to the authenticated identity. This endpoint proxies to Search and supports standard collection query parameters.
|
|
70587
|
+
* @summary List my entitlement connections
|
|
70588
|
+
* @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.
|
|
70589
|
+
* @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.
|
|
70590
|
+
* @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.
|
|
70591
|
+
* @param {string} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement.
|
|
70592
|
+
* @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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* The authenticated identity scope is always applied by the service.
|
|
70593
|
+
* @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: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration**
|
|
70594
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70595
|
+
* @throws {RequiredError}
|
|
70596
|
+
*/
|
|
70597
|
+
listEntitlementConnectionsForCurrentIdentity(offset?: number, limit?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementConnectionSearchHitV2026>>>;
|
|
70598
|
+
/**
|
|
70599
|
+
* Applies JSON Patch operations to an entitlement connection selected by `connectionId`.
|
|
70600
|
+
* @summary Update entitlement connection
|
|
70601
|
+
* @param {string} connectionId Connection ID (UUID with or without hyphens).
|
|
70602
|
+
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026
|
|
70603
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70604
|
+
* @throws {RequiredError}
|
|
70605
|
+
*/
|
|
70606
|
+
patchEntitlementConnectionById(connectionId: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementConnectionV2026>>;
|
|
70607
|
+
/**
|
|
70608
|
+
* Applies JSON Patch operations to a single entitlement connection selected by `entitlementId`, `identityId`, and `accountId`.
|
|
70609
|
+
* @summary Update connection by query
|
|
70610
|
+
* @param {string} entitlementId Entitlement ID (UUID with or without hyphens).
|
|
70611
|
+
* @param {string} identityId Identity ID (UUID with or without hyphens).
|
|
70612
|
+
* @param {string} accountId Account ID (UUID with or without hyphens).
|
|
70613
|
+
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026
|
|
70614
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70615
|
+
* @throws {RequiredError}
|
|
70616
|
+
*/
|
|
70617
|
+
patchEntitlementConnectionByQuery(entitlementId: string, identityId: string, accountId: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementConnectionV2026>>;
|
|
70618
|
+
/**
|
|
70619
|
+
* Updates connection type for up to 100 connections in one request. The API returns per-item results in a 207 Multi-Status response.
|
|
70620
|
+
* @summary Update connections in bulk
|
|
70621
|
+
* @param {Array<EntitlementConnectionBulkUpdateItemV2026>} entitlementConnectionBulkUpdateItemV2026
|
|
70622
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70623
|
+
* @throws {RequiredError}
|
|
70624
|
+
*/
|
|
70625
|
+
updateEntitlementConnectionsBulk(entitlementConnectionBulkUpdateItemV2026: Array<EntitlementConnectionBulkUpdateItemV2026>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementConnectionBulkUpdateResultItemV2026>>>;
|
|
70626
|
+
};
|
|
70627
|
+
/**
|
|
70628
|
+
* EntitlementConnectionsV2026Api - factory interface
|
|
70629
|
+
* @export
|
|
70630
|
+
*/
|
|
70631
|
+
export declare const EntitlementConnectionsV2026ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
70632
|
+
/**
|
|
70633
|
+
* Returns entitlement connections for the tenant. This endpoint proxies to Search and supports standard collection query parameters. The `filters` and `sorters` values support the Entitlement Connections search fields documented by ECS.
|
|
70634
|
+
* @summary List entitlement connections
|
|
70635
|
+
* @param {EntitlementConnectionsV2026ApiListEntitlementConnectionsRequest} requestParameters Request parameters.
|
|
70636
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70637
|
+
* @throws {RequiredError}
|
|
70638
|
+
*/
|
|
70639
|
+
listEntitlementConnections(requestParameters?: EntitlementConnectionsV2026ApiListEntitlementConnectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementConnectionSearchHitV2026>>;
|
|
70640
|
+
/**
|
|
70641
|
+
* Returns entitlement connections constrained to the authenticated identity. This endpoint proxies to Search and supports standard collection query parameters.
|
|
70642
|
+
* @summary List my entitlement connections
|
|
70643
|
+
* @param {EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentityRequest} requestParameters Request parameters.
|
|
70644
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70645
|
+
* @throws {RequiredError}
|
|
70646
|
+
*/
|
|
70647
|
+
listEntitlementConnectionsForCurrentIdentity(requestParameters?: EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementConnectionSearchHitV2026>>;
|
|
70648
|
+
/**
|
|
70649
|
+
* Applies JSON Patch operations to an entitlement connection selected by `connectionId`.
|
|
70650
|
+
* @summary Update entitlement connection
|
|
70651
|
+
* @param {EntitlementConnectionsV2026ApiPatchEntitlementConnectionByIdRequest} requestParameters Request parameters.
|
|
70652
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70653
|
+
* @throws {RequiredError}
|
|
70654
|
+
*/
|
|
70655
|
+
patchEntitlementConnectionById(requestParameters: EntitlementConnectionsV2026ApiPatchEntitlementConnectionByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<EntitlementConnectionV2026>;
|
|
70656
|
+
/**
|
|
70657
|
+
* Applies JSON Patch operations to a single entitlement connection selected by `entitlementId`, `identityId`, and `accountId`.
|
|
70658
|
+
* @summary Update connection by query
|
|
70659
|
+
* @param {EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQueryRequest} requestParameters Request parameters.
|
|
70660
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70661
|
+
* @throws {RequiredError}
|
|
70662
|
+
*/
|
|
70663
|
+
patchEntitlementConnectionByQuery(requestParameters: EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQueryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<EntitlementConnectionV2026>;
|
|
70664
|
+
/**
|
|
70665
|
+
* Updates connection type for up to 100 connections in one request. The API returns per-item results in a 207 Multi-Status response.
|
|
70666
|
+
* @summary Update connections in bulk
|
|
70667
|
+
* @param {EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulkRequest} requestParameters Request parameters.
|
|
70668
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70669
|
+
* @throws {RequiredError}
|
|
70670
|
+
*/
|
|
70671
|
+
updateEntitlementConnectionsBulk(requestParameters: EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementConnectionBulkUpdateResultItemV2026>>;
|
|
70672
|
+
};
|
|
70673
|
+
/**
|
|
70674
|
+
* Request parameters for listEntitlementConnections operation in EntitlementConnectionsV2026Api.
|
|
70675
|
+
* @export
|
|
70676
|
+
* @interface EntitlementConnectionsV2026ApiListEntitlementConnectionsRequest
|
|
70677
|
+
*/
|
|
70678
|
+
export interface EntitlementConnectionsV2026ApiListEntitlementConnectionsRequest {
|
|
70679
|
+
/**
|
|
70680
|
+
* 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.
|
|
70681
|
+
* @type {number}
|
|
70682
|
+
* @memberof EntitlementConnectionsV2026ApiListEntitlementConnections
|
|
70683
|
+
*/
|
|
70684
|
+
readonly offset?: number;
|
|
70685
|
+
/**
|
|
70686
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
70687
|
+
* @type {number}
|
|
70688
|
+
* @memberof EntitlementConnectionsV2026ApiListEntitlementConnections
|
|
70689
|
+
*/
|
|
70690
|
+
readonly limit?: number;
|
|
70691
|
+
/**
|
|
70692
|
+
* 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.
|
|
70693
|
+
* @type {boolean}
|
|
70694
|
+
* @memberof EntitlementConnectionsV2026ApiListEntitlementConnections
|
|
70695
|
+
*/
|
|
70696
|
+
readonly count?: boolean;
|
|
70697
|
+
/**
|
|
70698
|
+
* Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement.
|
|
70699
|
+
* @type {string}
|
|
70700
|
+
* @memberof EntitlementConnectionsV2026ApiListEntitlementConnections
|
|
70701
|
+
*/
|
|
70702
|
+
readonly searchAfter?: string;
|
|
70703
|
+
/**
|
|
70704
|
+
* 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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le*
|
|
70705
|
+
* @type {string}
|
|
70706
|
+
* @memberof EntitlementConnectionsV2026ApiListEntitlementConnections
|
|
70707
|
+
*/
|
|
70708
|
+
readonly filters?: string;
|
|
70709
|
+
/**
|
|
70710
|
+
* 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: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** Prefix a field with `-` for descending order.
|
|
70711
|
+
* @type {string}
|
|
70712
|
+
* @memberof EntitlementConnectionsV2026ApiListEntitlementConnections
|
|
70713
|
+
*/
|
|
70714
|
+
readonly sorters?: string;
|
|
70715
|
+
}
|
|
70716
|
+
/**
|
|
70717
|
+
* Request parameters for listEntitlementConnectionsForCurrentIdentity operation in EntitlementConnectionsV2026Api.
|
|
70718
|
+
* @export
|
|
70719
|
+
* @interface EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentityRequest
|
|
70720
|
+
*/
|
|
70721
|
+
export interface EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentityRequest {
|
|
70722
|
+
/**
|
|
70723
|
+
* 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.
|
|
70724
|
+
* @type {number}
|
|
70725
|
+
* @memberof EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentity
|
|
70726
|
+
*/
|
|
70727
|
+
readonly offset?: number;
|
|
70728
|
+
/**
|
|
70729
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
70730
|
+
* @type {number}
|
|
70731
|
+
* @memberof EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentity
|
|
70732
|
+
*/
|
|
70733
|
+
readonly limit?: number;
|
|
70734
|
+
/**
|
|
70735
|
+
* 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.
|
|
70736
|
+
* @type {boolean}
|
|
70737
|
+
* @memberof EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentity
|
|
70738
|
+
*/
|
|
70739
|
+
readonly count?: boolean;
|
|
70740
|
+
/**
|
|
70741
|
+
* Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement.
|
|
70742
|
+
* @type {string}
|
|
70743
|
+
* @memberof EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentity
|
|
70744
|
+
*/
|
|
70745
|
+
readonly searchAfter?: string;
|
|
70746
|
+
/**
|
|
70747
|
+
* 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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* The authenticated identity scope is always applied by the service.
|
|
70748
|
+
* @type {string}
|
|
70749
|
+
* @memberof EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentity
|
|
70750
|
+
*/
|
|
70751
|
+
readonly filters?: string;
|
|
70752
|
+
/**
|
|
70753
|
+
* 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: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration**
|
|
70754
|
+
* @type {string}
|
|
70755
|
+
* @memberof EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentity
|
|
70756
|
+
*/
|
|
70757
|
+
readonly sorters?: string;
|
|
70758
|
+
}
|
|
70759
|
+
/**
|
|
70760
|
+
* Request parameters for patchEntitlementConnectionById operation in EntitlementConnectionsV2026Api.
|
|
70761
|
+
* @export
|
|
70762
|
+
* @interface EntitlementConnectionsV2026ApiPatchEntitlementConnectionByIdRequest
|
|
70763
|
+
*/
|
|
70764
|
+
export interface EntitlementConnectionsV2026ApiPatchEntitlementConnectionByIdRequest {
|
|
70765
|
+
/**
|
|
70766
|
+
* Connection ID (UUID with or without hyphens).
|
|
70767
|
+
* @type {string}
|
|
70768
|
+
* @memberof EntitlementConnectionsV2026ApiPatchEntitlementConnectionById
|
|
70769
|
+
*/
|
|
70770
|
+
readonly connectionId: string;
|
|
70771
|
+
/**
|
|
70772
|
+
*
|
|
70773
|
+
* @type {Array<JsonPatchOperationV2026>}
|
|
70774
|
+
* @memberof EntitlementConnectionsV2026ApiPatchEntitlementConnectionById
|
|
70775
|
+
*/
|
|
70776
|
+
readonly jsonPatchOperationV2026: Array<JsonPatchOperationV2026>;
|
|
70777
|
+
}
|
|
70778
|
+
/**
|
|
70779
|
+
* Request parameters for patchEntitlementConnectionByQuery operation in EntitlementConnectionsV2026Api.
|
|
70780
|
+
* @export
|
|
70781
|
+
* @interface EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQueryRequest
|
|
70782
|
+
*/
|
|
70783
|
+
export interface EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQueryRequest {
|
|
70784
|
+
/**
|
|
70785
|
+
* Entitlement ID (UUID with or without hyphens).
|
|
70786
|
+
* @type {string}
|
|
70787
|
+
* @memberof EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQuery
|
|
70788
|
+
*/
|
|
70789
|
+
readonly entitlementId: string;
|
|
70790
|
+
/**
|
|
70791
|
+
* Identity ID (UUID with or without hyphens).
|
|
70792
|
+
* @type {string}
|
|
70793
|
+
* @memberof EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQuery
|
|
70794
|
+
*/
|
|
70795
|
+
readonly identityId: string;
|
|
70796
|
+
/**
|
|
70797
|
+
* Account ID (UUID with or without hyphens).
|
|
70798
|
+
* @type {string}
|
|
70799
|
+
* @memberof EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQuery
|
|
70800
|
+
*/
|
|
70801
|
+
readonly accountId: string;
|
|
70802
|
+
/**
|
|
70803
|
+
*
|
|
70804
|
+
* @type {Array<JsonPatchOperationV2026>}
|
|
70805
|
+
* @memberof EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQuery
|
|
70806
|
+
*/
|
|
70807
|
+
readonly jsonPatchOperationV2026: Array<JsonPatchOperationV2026>;
|
|
70808
|
+
}
|
|
70809
|
+
/**
|
|
70810
|
+
* Request parameters for updateEntitlementConnectionsBulk operation in EntitlementConnectionsV2026Api.
|
|
70811
|
+
* @export
|
|
70812
|
+
* @interface EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulkRequest
|
|
70813
|
+
*/
|
|
70814
|
+
export interface EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulkRequest {
|
|
70815
|
+
/**
|
|
70816
|
+
*
|
|
70817
|
+
* @type {Array<EntitlementConnectionBulkUpdateItemV2026>}
|
|
70818
|
+
* @memberof EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulk
|
|
70819
|
+
*/
|
|
70820
|
+
readonly entitlementConnectionBulkUpdateItemV2026: Array<EntitlementConnectionBulkUpdateItemV2026>;
|
|
70821
|
+
}
|
|
70822
|
+
/**
|
|
70823
|
+
* EntitlementConnectionsV2026Api - object-oriented interface
|
|
70824
|
+
* @export
|
|
70825
|
+
* @class EntitlementConnectionsV2026Api
|
|
70826
|
+
* @extends {BaseAPI}
|
|
70827
|
+
*/
|
|
70828
|
+
export declare class EntitlementConnectionsV2026Api extends BaseAPI {
|
|
70829
|
+
/**
|
|
70830
|
+
* Returns entitlement connections for the tenant. This endpoint proxies to Search and supports standard collection query parameters. The `filters` and `sorters` values support the Entitlement Connections search fields documented by ECS.
|
|
70831
|
+
* @summary List entitlement connections
|
|
70832
|
+
* @param {EntitlementConnectionsV2026ApiListEntitlementConnectionsRequest} requestParameters Request parameters.
|
|
70833
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70834
|
+
* @throws {RequiredError}
|
|
70835
|
+
* @memberof EntitlementConnectionsV2026Api
|
|
70836
|
+
*/
|
|
70837
|
+
listEntitlementConnections(requestParameters?: EntitlementConnectionsV2026ApiListEntitlementConnectionsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementConnectionSearchHitV2026[], any>>;
|
|
70838
|
+
/**
|
|
70839
|
+
* Returns entitlement connections constrained to the authenticated identity. This endpoint proxies to Search and supports standard collection query parameters.
|
|
70840
|
+
* @summary List my entitlement connections
|
|
70841
|
+
* @param {EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentityRequest} requestParameters Request parameters.
|
|
70842
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70843
|
+
* @throws {RequiredError}
|
|
70844
|
+
* @memberof EntitlementConnectionsV2026Api
|
|
70845
|
+
*/
|
|
70846
|
+
listEntitlementConnectionsForCurrentIdentity(requestParameters?: EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentityRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementConnectionSearchHitV2026[], any>>;
|
|
70847
|
+
/**
|
|
70848
|
+
* Applies JSON Patch operations to an entitlement connection selected by `connectionId`.
|
|
70849
|
+
* @summary Update entitlement connection
|
|
70850
|
+
* @param {EntitlementConnectionsV2026ApiPatchEntitlementConnectionByIdRequest} requestParameters Request parameters.
|
|
70851
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70852
|
+
* @throws {RequiredError}
|
|
70853
|
+
* @memberof EntitlementConnectionsV2026Api
|
|
70854
|
+
*/
|
|
70855
|
+
patchEntitlementConnectionById(requestParameters: EntitlementConnectionsV2026ApiPatchEntitlementConnectionByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementConnectionV2026, any>>;
|
|
70856
|
+
/**
|
|
70857
|
+
* Applies JSON Patch operations to a single entitlement connection selected by `entitlementId`, `identityId`, and `accountId`.
|
|
70858
|
+
* @summary Update connection by query
|
|
70859
|
+
* @param {EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQueryRequest} requestParameters Request parameters.
|
|
70860
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70861
|
+
* @throws {RequiredError}
|
|
70862
|
+
* @memberof EntitlementConnectionsV2026Api
|
|
70863
|
+
*/
|
|
70864
|
+
patchEntitlementConnectionByQuery(requestParameters: EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQueryRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementConnectionV2026, any>>;
|
|
70865
|
+
/**
|
|
70866
|
+
* Updates connection type for up to 100 connections in one request. The API returns per-item results in a 207 Multi-Status response.
|
|
70867
|
+
* @summary Update connections in bulk
|
|
70868
|
+
* @param {EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulkRequest} requestParameters Request parameters.
|
|
70869
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
70870
|
+
* @throws {RequiredError}
|
|
70871
|
+
* @memberof EntitlementConnectionsV2026Api
|
|
70872
|
+
*/
|
|
70873
|
+
updateEntitlementConnectionsBulk(requestParameters: EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulkRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementConnectionBulkUpdateResultItemV2026[], any>>;
|
|
70874
|
+
}
|
|
70148
70875
|
/**
|
|
70149
70876
|
* EntitlementsV2026Api - axios parameter creator
|
|
70150
70877
|
* @export
|