sailpoint-api-client 1.8.8 → 1.8.10
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/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/common.js +2 -2
- package/dist/beta/common.js.map +1 -1
- package/dist/nerm/common.js +2 -2
- package/dist/nerm/common.js.map +1 -1
- package/dist/nermv2025/common.js +2 -2
- package/dist/nermv2025/common.js.map +1 -1
- package/dist/v2024/common.js +2 -2
- package/dist/v2024/common.js.map +1 -1
- package/dist/v2025/api.d.ts +14 -38
- package/dist/v2025/api.js +23 -47
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +2 -2
- package/dist/v2025/common.js.map +1 -1
- package/dist/v2026/api.d.ts +499 -561
- package/dist/v2026/api.js +292 -395
- package/dist/v2026/api.js.map +1 -1
- package/dist/v2026/common.js +2 -2
- package/dist/v2026/common.js.map +1 -1
- package/dist/v3/common.js +2 -2
- package/dist/v3/common.js.map +1 -1
- 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/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +23 -71
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v2026/README.md +2 -2
- package/v2026/api.ts +793 -911
- package/v2026/common.ts +2 -2
- package/v2026/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/v2026/api.d.ts
CHANGED
|
@@ -2244,12 +2244,6 @@ export interface AccessRequestConfigV2026 {
|
|
|
2244
2244
|
* @memberof AccessRequestConfigV2026
|
|
2245
2245
|
*/
|
|
2246
2246
|
'approvalsMustBeExternal'?: boolean;
|
|
2247
|
-
/**
|
|
2248
|
-
* If this is true and the requester and reviewer are the same, the request is automatically approved.
|
|
2249
|
-
* @type {boolean}
|
|
2250
|
-
* @memberof AccessRequestConfigV2026
|
|
2251
|
-
*/
|
|
2252
|
-
'autoApprovalEnabled'?: boolean;
|
|
2253
2247
|
/**
|
|
2254
2248
|
* If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state.
|
|
2255
2249
|
* @type {boolean}
|
|
@@ -2264,16 +2258,16 @@ export interface AccessRequestConfigV2026 {
|
|
|
2264
2258
|
'requestOnBehalfOfConfig'?: RequestOnBehalfOfConfigV2026;
|
|
2265
2259
|
/**
|
|
2266
2260
|
*
|
|
2267
|
-
* @type {
|
|
2261
|
+
* @type {EntitlementRequestConfigV2026}
|
|
2268
2262
|
* @memberof AccessRequestConfigV2026
|
|
2269
2263
|
*/
|
|
2270
|
-
'
|
|
2264
|
+
'entitlementRequestConfig'?: EntitlementRequestConfigV2026;
|
|
2271
2265
|
/**
|
|
2272
|
-
*
|
|
2273
|
-
* @type {
|
|
2266
|
+
* If this is true, requesters and requested-for users will be able to see the names of governance group members when a request is awaiting the group\'s approval. Up to the first 10 members of the group will be listed.
|
|
2267
|
+
* @type {boolean}
|
|
2274
2268
|
* @memberof AccessRequestConfigV2026
|
|
2275
2269
|
*/
|
|
2276
|
-
'
|
|
2270
|
+
'govGroupVisibilityEnabled'?: boolean;
|
|
2277
2271
|
}
|
|
2278
2272
|
/**
|
|
2279
2273
|
*
|
|
@@ -8419,37 +8413,6 @@ export interface ApprovalRejectRequestV2026 {
|
|
|
8419
8413
|
*/
|
|
8420
8414
|
'comment'?: string;
|
|
8421
8415
|
}
|
|
8422
|
-
/**
|
|
8423
|
-
* Configuration for approval reminder and escalation behavior. Important: Modifying this object will override the sp-approval service\'s reminderConfig and escalationConfig settings. Changes made here take precedence over any configuration set directly in the sp-approval service.
|
|
8424
|
-
* @export
|
|
8425
|
-
* @interface ApprovalReminderAndEscalationConfigV2026
|
|
8426
|
-
*/
|
|
8427
|
-
export interface ApprovalReminderAndEscalationConfigV2026 {
|
|
8428
|
-
/**
|
|
8429
|
-
* Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.
|
|
8430
|
-
* @type {number}
|
|
8431
|
-
* @memberof ApprovalReminderAndEscalationConfigV2026
|
|
8432
|
-
*/
|
|
8433
|
-
'daysUntilEscalation'?: number | null;
|
|
8434
|
-
/**
|
|
8435
|
-
* Number of days to wait between reminder notifications.
|
|
8436
|
-
* @type {number}
|
|
8437
|
-
* @memberof ApprovalReminderAndEscalationConfigV2026
|
|
8438
|
-
*/
|
|
8439
|
-
'daysBetweenReminders'?: number | null;
|
|
8440
|
-
/**
|
|
8441
|
-
* Maximum number of reminder notifications to send to the reviewer before approval escalation. The maximum allowed value is 20.
|
|
8442
|
-
* @type {number}
|
|
8443
|
-
* @memberof ApprovalReminderAndEscalationConfigV2026
|
|
8444
|
-
*/
|
|
8445
|
-
'maxReminders'?: number | null;
|
|
8446
|
-
/**
|
|
8447
|
-
*
|
|
8448
|
-
* @type {IdentityReferenceWithNameAndEmailV2026}
|
|
8449
|
-
* @memberof ApprovalReminderAndEscalationConfigV2026
|
|
8450
|
-
*/
|
|
8451
|
-
'fallbackApproverRef'?: IdentityReferenceWithNameAndEmailV2026 | null;
|
|
8452
|
-
}
|
|
8453
8416
|
/**
|
|
8454
8417
|
* Represents a requested target in an approval process, including details such as ID, name, reauthentication requirements, and removal date.
|
|
8455
8418
|
* @export
|
|
@@ -17674,19 +17637,6 @@ export declare const EmailStatusDtoV2026VerificationStatusV2026: {
|
|
|
17674
17637
|
readonly Na: "NA";
|
|
17675
17638
|
};
|
|
17676
17639
|
export type EmailStatusDtoV2026VerificationStatusV2026 = typeof EmailStatusDtoV2026VerificationStatusV2026[keyof typeof EmailStatusDtoV2026VerificationStatusV2026];
|
|
17677
|
-
/**
|
|
17678
|
-
* Additional data to classify the entitlement
|
|
17679
|
-
* @export
|
|
17680
|
-
* @interface EntitlementAccessModelMetadataV2026
|
|
17681
|
-
*/
|
|
17682
|
-
export interface EntitlementAccessModelMetadataV2026 {
|
|
17683
|
-
/**
|
|
17684
|
-
*
|
|
17685
|
-
* @type {Array<AccessModelMetadataV2026>}
|
|
17686
|
-
* @memberof EntitlementAccessModelMetadataV2026
|
|
17687
|
-
*/
|
|
17688
|
-
'attributes'?: Array<AccessModelMetadataV2026>;
|
|
17689
|
-
}
|
|
17690
17640
|
/**
|
|
17691
17641
|
* The maximum duration for which the access is permitted.
|
|
17692
17642
|
* @export
|
|
@@ -17928,194 +17878,6 @@ export interface EntitlementBulkUpdateRequestV2026 {
|
|
|
17928
17878
|
*/
|
|
17929
17879
|
'jsonPatch': Array<JsonPatchOperationV2026>;
|
|
17930
17880
|
}
|
|
17931
|
-
/**
|
|
17932
|
-
*
|
|
17933
|
-
* @export
|
|
17934
|
-
* @interface EntitlementDTOAllOfSourceV2026
|
|
17935
|
-
*/
|
|
17936
|
-
export interface EntitlementDTOAllOfSourceV2026 {
|
|
17937
|
-
/**
|
|
17938
|
-
* Object reference id
|
|
17939
|
-
* @type {string}
|
|
17940
|
-
* @memberof EntitlementDTOAllOfSourceV2026
|
|
17941
|
-
*/
|
|
17942
|
-
'id'?: string;
|
|
17943
|
-
/**
|
|
17944
|
-
* Object reference name
|
|
17945
|
-
* @type {string}
|
|
17946
|
-
* @memberof EntitlementDTOAllOfSourceV2026
|
|
17947
|
-
*/
|
|
17948
|
-
'value'?: string;
|
|
17949
|
-
/**
|
|
17950
|
-
* SOURCE (added because exists in Entitlement V3)
|
|
17951
|
-
* @type {string}
|
|
17952
|
-
* @memberof EntitlementDTOAllOfSourceV2026
|
|
17953
|
-
*/
|
|
17954
|
-
'type'?: string;
|
|
17955
|
-
}
|
|
17956
|
-
/**
|
|
17957
|
-
*
|
|
17958
|
-
* @export
|
|
17959
|
-
* @interface EntitlementDTOV2026
|
|
17960
|
-
*/
|
|
17961
|
-
export interface EntitlementDTOV2026 {
|
|
17962
|
-
/**
|
|
17963
|
-
* System-generated unique ID of the Object
|
|
17964
|
-
* @type {string}
|
|
17965
|
-
* @memberof EntitlementDTOV2026
|
|
17966
|
-
*/
|
|
17967
|
-
'id'?: string;
|
|
17968
|
-
/**
|
|
17969
|
-
* Name of the Object
|
|
17970
|
-
* @type {string}
|
|
17971
|
-
* @memberof EntitlementDTOV2026
|
|
17972
|
-
*/
|
|
17973
|
-
'name': string | null;
|
|
17974
|
-
/**
|
|
17975
|
-
* Creation date of the Object
|
|
17976
|
-
* @type {string}
|
|
17977
|
-
* @memberof EntitlementDTOV2026
|
|
17978
|
-
*/
|
|
17979
|
-
'created'?: string;
|
|
17980
|
-
/**
|
|
17981
|
-
* Last modification date of the Object
|
|
17982
|
-
* @type {string}
|
|
17983
|
-
* @memberof EntitlementDTOV2026
|
|
17984
|
-
*/
|
|
17985
|
-
'modified'?: string;
|
|
17986
|
-
/**
|
|
17987
|
-
* Name of the entitlement attribute
|
|
17988
|
-
* @type {string}
|
|
17989
|
-
* @memberof EntitlementDTOV2026
|
|
17990
|
-
*/
|
|
17991
|
-
'attribute'?: string;
|
|
17992
|
-
/**
|
|
17993
|
-
* Unique entitlement identifier within the database
|
|
17994
|
-
* @type {string}
|
|
17995
|
-
* @memberof EntitlementDTOV2026
|
|
17996
|
-
*/
|
|
17997
|
-
'uuid'?: string;
|
|
17998
|
-
/**
|
|
17999
|
-
* Raw value of the entitlement
|
|
18000
|
-
* @type {string}
|
|
18001
|
-
* @memberof EntitlementDTOV2026
|
|
18002
|
-
*/
|
|
18003
|
-
'value'?: string;
|
|
18004
|
-
/**
|
|
18005
|
-
* Entitlment description
|
|
18006
|
-
* @type {string}
|
|
18007
|
-
* @memberof EntitlementDTOV2026
|
|
18008
|
-
*/
|
|
18009
|
-
'description'?: string;
|
|
18010
|
-
/**
|
|
18011
|
-
* Schema objectType on the given application that maps to an Account Group
|
|
18012
|
-
* @type {string}
|
|
18013
|
-
* @memberof EntitlementDTOV2026
|
|
18014
|
-
*/
|
|
18015
|
-
'sourceSchemaObjectType'?: string;
|
|
18016
|
-
/**
|
|
18017
|
-
* Determines if this entitlement is privileged.
|
|
18018
|
-
* @type {boolean}
|
|
18019
|
-
* @memberof EntitlementDTOV2026
|
|
18020
|
-
*/
|
|
18021
|
-
'privileged'?: boolean;
|
|
18022
|
-
/**
|
|
18023
|
-
* True when this object is used to represent a group attribute, otherwise it represents an account attribute. For the time being, the property is always true.
|
|
18024
|
-
* @type {boolean}
|
|
18025
|
-
* @memberof EntitlementDTOV2026
|
|
18026
|
-
*/
|
|
18027
|
-
'isGroup'?: boolean;
|
|
18028
|
-
/**
|
|
18029
|
-
* Determines if this entitlement is governed in the cloud.
|
|
18030
|
-
* @type {boolean}
|
|
18031
|
-
* @memberof EntitlementDTOV2026
|
|
18032
|
-
*/
|
|
18033
|
-
'cloudGoverned'?: boolean;
|
|
18034
|
-
/**
|
|
18035
|
-
* Determines if this entitlement is requestable.
|
|
18036
|
-
* @type {boolean}
|
|
18037
|
-
* @memberof EntitlementDTOV2026
|
|
18038
|
-
*/
|
|
18039
|
-
'requestable'?: boolean;
|
|
18040
|
-
/**
|
|
18041
|
-
* Determines if this entitlement is cloud eligible.
|
|
18042
|
-
* @type {boolean}
|
|
18043
|
-
* @memberof EntitlementDTOV2026
|
|
18044
|
-
*/
|
|
18045
|
-
'cloudEligible'?: boolean;
|
|
18046
|
-
/**
|
|
18047
|
-
* Entitlement attributes
|
|
18048
|
-
* @type {object}
|
|
18049
|
-
* @memberof EntitlementDTOV2026
|
|
18050
|
-
*/
|
|
18051
|
-
'attributes'?: object;
|
|
18052
|
-
/**
|
|
18053
|
-
*
|
|
18054
|
-
* @type {EntitlementDTOAllOfSourceV2026}
|
|
18055
|
-
* @memberof EntitlementDTOV2026
|
|
18056
|
-
*/
|
|
18057
|
-
'source'?: EntitlementDTOAllOfSourceV2026;
|
|
18058
|
-
/**
|
|
18059
|
-
* Read-only calculated hash value of an entitlement
|
|
18060
|
-
* @type {string}
|
|
18061
|
-
* @memberof EntitlementDTOV2026
|
|
18062
|
-
*/
|
|
18063
|
-
'hash'?: string;
|
|
18064
|
-
/**
|
|
18065
|
-
*
|
|
18066
|
-
* @type {Array<PermissionDtoV2026>}
|
|
18067
|
-
* @memberof EntitlementDTOV2026
|
|
18068
|
-
*/
|
|
18069
|
-
'directPermissions'?: Array<PermissionDtoV2026>;
|
|
18070
|
-
/**
|
|
18071
|
-
* List of parent entitlements
|
|
18072
|
-
* @type {Array<string>}
|
|
18073
|
-
* @memberof EntitlementDTOV2026
|
|
18074
|
-
*/
|
|
18075
|
-
'inheritFrom'?: Array<string>;
|
|
18076
|
-
/**
|
|
18077
|
-
* List of entitlement segments
|
|
18078
|
-
* @type {Array<string>}
|
|
18079
|
-
* @memberof EntitlementDTOV2026
|
|
18080
|
-
*/
|
|
18081
|
-
'segments'?: Array<string>;
|
|
18082
|
-
/**
|
|
18083
|
-
* Last time the entitlement was refreshed
|
|
18084
|
-
* @type {string}
|
|
18085
|
-
* @memberof EntitlementDTOV2026
|
|
18086
|
-
*/
|
|
18087
|
-
'lastRefresh'?: string;
|
|
18088
|
-
/**
|
|
18089
|
-
* IDN service application
|
|
18090
|
-
* @type {string}
|
|
18091
|
-
* @memberof EntitlementDTOV2026
|
|
18092
|
-
*/
|
|
18093
|
-
'idnServiceApp'?: string;
|
|
18094
|
-
/**
|
|
18095
|
-
* Informs whether an entitlement is a priviliged one.
|
|
18096
|
-
* @type {string}
|
|
18097
|
-
* @memberof EntitlementDTOV2026
|
|
18098
|
-
*/
|
|
18099
|
-
'idnExceptional'?: string;
|
|
18100
|
-
/**
|
|
18101
|
-
* Indicates whether an entitlement was aggregated
|
|
18102
|
-
* @type {string}
|
|
18103
|
-
* @memberof EntitlementDTOV2026
|
|
18104
|
-
*/
|
|
18105
|
-
'entitlementitlementAggregated'?: string;
|
|
18106
|
-
/**
|
|
18107
|
-
* Segment status (GLOBAL/LOCAL)
|
|
18108
|
-
* @type {string}
|
|
18109
|
-
* @memberof EntitlementDTOV2026
|
|
18110
|
-
*/
|
|
18111
|
-
'segmentStatus'?: string;
|
|
18112
|
-
/**
|
|
18113
|
-
*
|
|
18114
|
-
* @type {OwnerReferenceDtoV2026}
|
|
18115
|
-
* @memberof EntitlementDTOV2026
|
|
18116
|
-
*/
|
|
18117
|
-
'owner'?: OwnerReferenceDtoV2026;
|
|
18118
|
-
}
|
|
18119
17881
|
/**
|
|
18120
17882
|
* Indicates whether the entitlement\'s display name and/or description have been manually updated.
|
|
18121
17883
|
* @export
|
|
@@ -18504,34 +18266,70 @@ export interface EntitlementDocumentsV2026 {
|
|
|
18504
18266
|
'_version'?: string;
|
|
18505
18267
|
}
|
|
18506
18268
|
/**
|
|
18507
|
-
*
|
|
18269
|
+
*
|
|
18508
18270
|
* @export
|
|
18509
|
-
* @interface
|
|
18271
|
+
* @interface EntitlementPrivilegeLevelV2026
|
|
18510
18272
|
*/
|
|
18511
|
-
export interface
|
|
18273
|
+
export interface EntitlementPrivilegeLevelV2026 {
|
|
18512
18274
|
/**
|
|
18513
|
-
*
|
|
18275
|
+
* Direct privilege level assigned to the entitlement
|
|
18514
18276
|
* @type {string}
|
|
18515
|
-
* @memberof
|
|
18277
|
+
* @memberof EntitlementPrivilegeLevelV2026
|
|
18516
18278
|
*/
|
|
18517
|
-
'
|
|
18279
|
+
'direct'?: EntitlementPrivilegeLevelV2026DirectV2026;
|
|
18518
18280
|
/**
|
|
18519
|
-
*
|
|
18281
|
+
* User or process that set the privilege level
|
|
18520
18282
|
* @type {string}
|
|
18521
|
-
* @memberof
|
|
18283
|
+
* @memberof EntitlementPrivilegeLevelV2026
|
|
18522
18284
|
*/
|
|
18523
|
-
'
|
|
18285
|
+
'setBy'?: string;
|
|
18524
18286
|
/**
|
|
18525
|
-
*
|
|
18287
|
+
* Method by which the privilege level was set
|
|
18526
18288
|
* @type {string}
|
|
18527
|
-
* @memberof
|
|
18289
|
+
* @memberof EntitlementPrivilegeLevelV2026
|
|
18528
18290
|
*/
|
|
18529
|
-
'
|
|
18291
|
+
'setByType'?: EntitlementPrivilegeLevelV2026SetByTypeV2026 | null;
|
|
18292
|
+
/**
|
|
18293
|
+
* Inherited privilege level on the entitlement, if any
|
|
18294
|
+
* @type {string}
|
|
18295
|
+
* @memberof EntitlementPrivilegeLevelV2026
|
|
18296
|
+
*/
|
|
18297
|
+
'inherited'?: EntitlementPrivilegeLevelV2026InheritedV2026 | null;
|
|
18298
|
+
/**
|
|
18299
|
+
* Effective privilege level assigned to the entitlement
|
|
18300
|
+
* @type {string}
|
|
18301
|
+
* @memberof EntitlementPrivilegeLevelV2026
|
|
18302
|
+
*/
|
|
18303
|
+
'effective'?: EntitlementPrivilegeLevelV2026EffectiveV2026;
|
|
18530
18304
|
}
|
|
18531
|
-
export declare const
|
|
18532
|
-
readonly
|
|
18305
|
+
export declare const EntitlementPrivilegeLevelV2026DirectV2026: {
|
|
18306
|
+
readonly High: "HIGH";
|
|
18307
|
+
readonly Low: "LOW";
|
|
18308
|
+
readonly Medium: "MEDIUM";
|
|
18309
|
+
readonly None: "NONE";
|
|
18310
|
+
};
|
|
18311
|
+
export type EntitlementPrivilegeLevelV2026DirectV2026 = typeof EntitlementPrivilegeLevelV2026DirectV2026[keyof typeof EntitlementPrivilegeLevelV2026DirectV2026];
|
|
18312
|
+
export declare const EntitlementPrivilegeLevelV2026SetByTypeV2026: {
|
|
18313
|
+
readonly Override: "OVERRIDE";
|
|
18314
|
+
readonly CustomCriteria: "CUSTOM_CRITERIA";
|
|
18315
|
+
readonly ConnectorCriteria: "CONNECTOR_CRITERIA";
|
|
18316
|
+
readonly SingleLevelCriteria: "SINGLE_LEVEL_CRITERIA";
|
|
18533
18317
|
};
|
|
18534
|
-
export type
|
|
18318
|
+
export type EntitlementPrivilegeLevelV2026SetByTypeV2026 = typeof EntitlementPrivilegeLevelV2026SetByTypeV2026[keyof typeof EntitlementPrivilegeLevelV2026SetByTypeV2026];
|
|
18319
|
+
export declare const EntitlementPrivilegeLevelV2026InheritedV2026: {
|
|
18320
|
+
readonly High: "HIGH";
|
|
18321
|
+
readonly Low: "LOW";
|
|
18322
|
+
readonly Medium: "MEDIUM";
|
|
18323
|
+
readonly None: "NONE";
|
|
18324
|
+
};
|
|
18325
|
+
export type EntitlementPrivilegeLevelV2026InheritedV2026 = typeof EntitlementPrivilegeLevelV2026InheritedV2026[keyof typeof EntitlementPrivilegeLevelV2026InheritedV2026];
|
|
18326
|
+
export declare const EntitlementPrivilegeLevelV2026EffectiveV2026: {
|
|
18327
|
+
readonly High: "HIGH";
|
|
18328
|
+
readonly Low: "LOW";
|
|
18329
|
+
readonly Medium: "MEDIUM";
|
|
18330
|
+
readonly None: "NONE";
|
|
18331
|
+
};
|
|
18332
|
+
export type EntitlementPrivilegeLevelV2026EffectiveV2026 = typeof EntitlementPrivilegeLevelV2026EffectiveV2026[keyof typeof EntitlementPrivilegeLevelV2026EffectiveV2026];
|
|
18535
18333
|
/**
|
|
18536
18334
|
* Entitlement including a specific set of access.
|
|
18537
18335
|
* @export
|
|
@@ -18772,10 +18570,10 @@ export interface EntitlementV2026 {
|
|
|
18772
18570
|
'requestable'?: boolean;
|
|
18773
18571
|
/**
|
|
18774
18572
|
*
|
|
18775
|
-
* @type {
|
|
18573
|
+
* @type {EntitlementV2OwnerV2026}
|
|
18776
18574
|
* @memberof EntitlementV2026
|
|
18777
18575
|
*/
|
|
18778
|
-
'owner'?:
|
|
18576
|
+
'owner'?: EntitlementV2OwnerV2026 | null;
|
|
18779
18577
|
/**
|
|
18780
18578
|
* List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP).
|
|
18781
18579
|
* @type {Array<AdditionalOwnerRefV2026>}
|
|
@@ -18792,10 +18590,10 @@ export interface EntitlementV2026 {
|
|
|
18792
18590
|
} | null;
|
|
18793
18591
|
/**
|
|
18794
18592
|
*
|
|
18795
|
-
* @type {
|
|
18593
|
+
* @type {EntitlementV2AccessModelMetadataV2026}
|
|
18796
18594
|
* @memberof EntitlementV2026
|
|
18797
18595
|
*/
|
|
18798
|
-
'accessModelMetadata'?:
|
|
18596
|
+
'accessModelMetadata'?: EntitlementV2AccessModelMetadataV2026;
|
|
18799
18597
|
/**
|
|
18800
18598
|
* Time when the entitlement was created
|
|
18801
18599
|
* @type {string}
|
|
@@ -18835,6 +18633,263 @@ export interface EntitlementV2026 {
|
|
|
18835
18633
|
*/
|
|
18836
18634
|
'directPermissions'?: Array<PermissionDtoV2026>;
|
|
18837
18635
|
}
|
|
18636
|
+
/**
|
|
18637
|
+
* Additional data to classify the entitlement
|
|
18638
|
+
* @export
|
|
18639
|
+
* @interface EntitlementV2AccessModelMetadataV2026
|
|
18640
|
+
*/
|
|
18641
|
+
export interface EntitlementV2AccessModelMetadataV2026 {
|
|
18642
|
+
/**
|
|
18643
|
+
*
|
|
18644
|
+
* @type {Array<AccessModelMetadataV2026>}
|
|
18645
|
+
* @memberof EntitlementV2AccessModelMetadataV2026
|
|
18646
|
+
*/
|
|
18647
|
+
'attributes'?: Array<AccessModelMetadataV2026>;
|
|
18648
|
+
}
|
|
18649
|
+
/**
|
|
18650
|
+
* The identity that owns the entitlement
|
|
18651
|
+
* @export
|
|
18652
|
+
* @interface EntitlementV2OwnerV2026
|
|
18653
|
+
*/
|
|
18654
|
+
export interface EntitlementV2OwnerV2026 {
|
|
18655
|
+
/**
|
|
18656
|
+
* The identity ID
|
|
18657
|
+
* @type {string}
|
|
18658
|
+
* @memberof EntitlementV2OwnerV2026
|
|
18659
|
+
*/
|
|
18660
|
+
'id'?: string;
|
|
18661
|
+
/**
|
|
18662
|
+
* The type of object
|
|
18663
|
+
* @type {string}
|
|
18664
|
+
* @memberof EntitlementV2OwnerV2026
|
|
18665
|
+
*/
|
|
18666
|
+
'type'?: EntitlementV2OwnerV2026TypeV2026;
|
|
18667
|
+
/**
|
|
18668
|
+
* The display name of the identity
|
|
18669
|
+
* @type {string}
|
|
18670
|
+
* @memberof EntitlementV2OwnerV2026
|
|
18671
|
+
*/
|
|
18672
|
+
'name'?: string;
|
|
18673
|
+
}
|
|
18674
|
+
export declare const EntitlementV2OwnerV2026TypeV2026: {
|
|
18675
|
+
readonly Identity: "IDENTITY";
|
|
18676
|
+
};
|
|
18677
|
+
export type EntitlementV2OwnerV2026TypeV2026 = typeof EntitlementV2OwnerV2026TypeV2026[keyof typeof EntitlementV2OwnerV2026TypeV2026];
|
|
18678
|
+
/**
|
|
18679
|
+
*
|
|
18680
|
+
* @export
|
|
18681
|
+
* @interface EntitlementV2PrivilegeLevelV2026
|
|
18682
|
+
*/
|
|
18683
|
+
export interface EntitlementV2PrivilegeLevelV2026 {
|
|
18684
|
+
/**
|
|
18685
|
+
* Direct privilege level assigned to the entitlement
|
|
18686
|
+
* @type {string}
|
|
18687
|
+
* @memberof EntitlementV2PrivilegeLevelV2026
|
|
18688
|
+
*/
|
|
18689
|
+
'direct'?: EntitlementV2PrivilegeLevelV2026DirectV2026;
|
|
18690
|
+
/**
|
|
18691
|
+
* User or process that set the privilege level
|
|
18692
|
+
* @type {string}
|
|
18693
|
+
* @memberof EntitlementV2PrivilegeLevelV2026
|
|
18694
|
+
*/
|
|
18695
|
+
'setBy'?: string;
|
|
18696
|
+
/**
|
|
18697
|
+
* Method by which the privilege level was set
|
|
18698
|
+
* @type {string}
|
|
18699
|
+
* @memberof EntitlementV2PrivilegeLevelV2026
|
|
18700
|
+
*/
|
|
18701
|
+
'setByType'?: EntitlementV2PrivilegeLevelV2026SetByTypeV2026 | null;
|
|
18702
|
+
/**
|
|
18703
|
+
* Inherited privilege level on the entitlement, if any
|
|
18704
|
+
* @type {string}
|
|
18705
|
+
* @memberof EntitlementV2PrivilegeLevelV2026
|
|
18706
|
+
*/
|
|
18707
|
+
'inherited'?: EntitlementV2PrivilegeLevelV2026InheritedV2026 | null;
|
|
18708
|
+
/**
|
|
18709
|
+
* Effective privilege level assigned to the entitlement
|
|
18710
|
+
* @type {string}
|
|
18711
|
+
* @memberof EntitlementV2PrivilegeLevelV2026
|
|
18712
|
+
*/
|
|
18713
|
+
'effective'?: EntitlementV2PrivilegeLevelV2026EffectiveV2026;
|
|
18714
|
+
}
|
|
18715
|
+
export declare const EntitlementV2PrivilegeLevelV2026DirectV2026: {
|
|
18716
|
+
readonly High: "HIGH";
|
|
18717
|
+
readonly Low: "LOW";
|
|
18718
|
+
readonly Medium: "MEDIUM";
|
|
18719
|
+
readonly None: "NONE";
|
|
18720
|
+
};
|
|
18721
|
+
export type EntitlementV2PrivilegeLevelV2026DirectV2026 = typeof EntitlementV2PrivilegeLevelV2026DirectV2026[keyof typeof EntitlementV2PrivilegeLevelV2026DirectV2026];
|
|
18722
|
+
export declare const EntitlementV2PrivilegeLevelV2026SetByTypeV2026: {
|
|
18723
|
+
readonly Override: "OVERRIDE";
|
|
18724
|
+
readonly CustomCriteria: "CUSTOM_CRITERIA";
|
|
18725
|
+
readonly ConnectorCriteria: "CONNECTOR_CRITERIA";
|
|
18726
|
+
readonly SingleLevelCriteria: "SINGLE_LEVEL_CRITERIA";
|
|
18727
|
+
};
|
|
18728
|
+
export type EntitlementV2PrivilegeLevelV2026SetByTypeV2026 = typeof EntitlementV2PrivilegeLevelV2026SetByTypeV2026[keyof typeof EntitlementV2PrivilegeLevelV2026SetByTypeV2026];
|
|
18729
|
+
export declare const EntitlementV2PrivilegeLevelV2026InheritedV2026: {
|
|
18730
|
+
readonly High: "HIGH";
|
|
18731
|
+
readonly Low: "LOW";
|
|
18732
|
+
readonly Medium: "MEDIUM";
|
|
18733
|
+
readonly None: "NONE";
|
|
18734
|
+
};
|
|
18735
|
+
export type EntitlementV2PrivilegeLevelV2026InheritedV2026 = typeof EntitlementV2PrivilegeLevelV2026InheritedV2026[keyof typeof EntitlementV2PrivilegeLevelV2026InheritedV2026];
|
|
18736
|
+
export declare const EntitlementV2PrivilegeLevelV2026EffectiveV2026: {
|
|
18737
|
+
readonly High: "HIGH";
|
|
18738
|
+
readonly Low: "LOW";
|
|
18739
|
+
readonly Medium: "MEDIUM";
|
|
18740
|
+
readonly None: "NONE";
|
|
18741
|
+
};
|
|
18742
|
+
export type EntitlementV2PrivilegeLevelV2026EffectiveV2026 = typeof EntitlementV2PrivilegeLevelV2026EffectiveV2026[keyof typeof EntitlementV2PrivilegeLevelV2026EffectiveV2026];
|
|
18743
|
+
/**
|
|
18744
|
+
*
|
|
18745
|
+
* @export
|
|
18746
|
+
* @interface EntitlementV2SourceV2026
|
|
18747
|
+
*/
|
|
18748
|
+
export interface EntitlementV2SourceV2026 {
|
|
18749
|
+
/**
|
|
18750
|
+
* The source ID
|
|
18751
|
+
* @type {string}
|
|
18752
|
+
* @memberof EntitlementV2SourceV2026
|
|
18753
|
+
*/
|
|
18754
|
+
'id'?: string;
|
|
18755
|
+
/**
|
|
18756
|
+
* The source type, will always be \"SOURCE\"
|
|
18757
|
+
* @type {string}
|
|
18758
|
+
* @memberof EntitlementV2SourceV2026
|
|
18759
|
+
*/
|
|
18760
|
+
'type'?: string;
|
|
18761
|
+
/**
|
|
18762
|
+
* The source name
|
|
18763
|
+
* @type {string}
|
|
18764
|
+
* @memberof EntitlementV2SourceV2026
|
|
18765
|
+
*/
|
|
18766
|
+
'name'?: string;
|
|
18767
|
+
}
|
|
18768
|
+
/**
|
|
18769
|
+
*
|
|
18770
|
+
* @export
|
|
18771
|
+
* @interface EntitlementV2V2026
|
|
18772
|
+
*/
|
|
18773
|
+
export interface EntitlementV2V2026 {
|
|
18774
|
+
/**
|
|
18775
|
+
* The entitlement id
|
|
18776
|
+
* @type {string}
|
|
18777
|
+
* @memberof EntitlementV2V2026
|
|
18778
|
+
*/
|
|
18779
|
+
'id'?: string;
|
|
18780
|
+
/**
|
|
18781
|
+
* The entitlement name
|
|
18782
|
+
* @type {string}
|
|
18783
|
+
* @memberof EntitlementV2V2026
|
|
18784
|
+
*/
|
|
18785
|
+
'name'?: string;
|
|
18786
|
+
/**
|
|
18787
|
+
* The entitlement attribute name
|
|
18788
|
+
* @type {string}
|
|
18789
|
+
* @memberof EntitlementV2V2026
|
|
18790
|
+
*/
|
|
18791
|
+
'attribute'?: string;
|
|
18792
|
+
/**
|
|
18793
|
+
* The value of the entitlement
|
|
18794
|
+
* @type {string}
|
|
18795
|
+
* @memberof EntitlementV2V2026
|
|
18796
|
+
*/
|
|
18797
|
+
'value'?: string;
|
|
18798
|
+
/**
|
|
18799
|
+
* The object type of the entitlement from the source schema
|
|
18800
|
+
* @type {string}
|
|
18801
|
+
* @memberof EntitlementV2V2026
|
|
18802
|
+
*/
|
|
18803
|
+
'sourceSchemaObjectType'?: string;
|
|
18804
|
+
/**
|
|
18805
|
+
* The description of the entitlement
|
|
18806
|
+
* @type {string}
|
|
18807
|
+
* @memberof EntitlementV2V2026
|
|
18808
|
+
*/
|
|
18809
|
+
'description'?: string | null;
|
|
18810
|
+
/**
|
|
18811
|
+
*
|
|
18812
|
+
* @type {EntitlementV2PrivilegeLevelV2026}
|
|
18813
|
+
* @memberof EntitlementV2V2026
|
|
18814
|
+
*/
|
|
18815
|
+
'privilegeLevel'?: EntitlementV2PrivilegeLevelV2026;
|
|
18816
|
+
/**
|
|
18817
|
+
* List of tags assigned to the entitlement
|
|
18818
|
+
* @type {Array<string>}
|
|
18819
|
+
* @memberof EntitlementV2V2026
|
|
18820
|
+
*/
|
|
18821
|
+
'tags'?: Array<string> | null;
|
|
18822
|
+
/**
|
|
18823
|
+
* True if the entitlement is cloud governed
|
|
18824
|
+
* @type {boolean}
|
|
18825
|
+
* @memberof EntitlementV2V2026
|
|
18826
|
+
*/
|
|
18827
|
+
'cloudGoverned'?: boolean;
|
|
18828
|
+
/**
|
|
18829
|
+
* True if the entitlement is able to be directly requested
|
|
18830
|
+
* @type {boolean}
|
|
18831
|
+
* @memberof EntitlementV2V2026
|
|
18832
|
+
*/
|
|
18833
|
+
'requestable'?: boolean;
|
|
18834
|
+
/**
|
|
18835
|
+
*
|
|
18836
|
+
* @type {EntitlementV2OwnerV2026}
|
|
18837
|
+
* @memberof EntitlementV2V2026
|
|
18838
|
+
*/
|
|
18839
|
+
'owner'?: EntitlementV2OwnerV2026 | null;
|
|
18840
|
+
/**
|
|
18841
|
+
* 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.
|
|
18842
|
+
* @type {{ [key: string]: any; }}
|
|
18843
|
+
* @memberof EntitlementV2V2026
|
|
18844
|
+
*/
|
|
18845
|
+
'manuallyUpdatedFields'?: {
|
|
18846
|
+
[key: string]: any;
|
|
18847
|
+
} | null;
|
|
18848
|
+
/**
|
|
18849
|
+
*
|
|
18850
|
+
* @type {EntitlementV2AccessModelMetadataV2026}
|
|
18851
|
+
* @memberof EntitlementV2V2026
|
|
18852
|
+
*/
|
|
18853
|
+
'accessModelMetadata'?: EntitlementV2AccessModelMetadataV2026;
|
|
18854
|
+
/**
|
|
18855
|
+
* Time when the entitlement was created
|
|
18856
|
+
* @type {string}
|
|
18857
|
+
* @memberof EntitlementV2V2026
|
|
18858
|
+
*/
|
|
18859
|
+
'created'?: string;
|
|
18860
|
+
/**
|
|
18861
|
+
* Time when the entitlement was last modified
|
|
18862
|
+
* @type {string}
|
|
18863
|
+
* @memberof EntitlementV2V2026
|
|
18864
|
+
*/
|
|
18865
|
+
'modified'?: string;
|
|
18866
|
+
/**
|
|
18867
|
+
*
|
|
18868
|
+
* @type {EntitlementV2SourceV2026}
|
|
18869
|
+
* @memberof EntitlementV2V2026
|
|
18870
|
+
*/
|
|
18871
|
+
'source'?: EntitlementV2SourceV2026;
|
|
18872
|
+
/**
|
|
18873
|
+
* A map of free-form key-value pairs from the source system
|
|
18874
|
+
* @type {{ [key: string]: any; }}
|
|
18875
|
+
* @memberof EntitlementV2V2026
|
|
18876
|
+
*/
|
|
18877
|
+
'attributes'?: {
|
|
18878
|
+
[key: string]: any;
|
|
18879
|
+
};
|
|
18880
|
+
/**
|
|
18881
|
+
* List of IDs of segments, if any, to which this Entitlement is assigned.
|
|
18882
|
+
* @type {Array<string>}
|
|
18883
|
+
* @memberof EntitlementV2V2026
|
|
18884
|
+
*/
|
|
18885
|
+
'segments'?: Array<string> | null;
|
|
18886
|
+
/**
|
|
18887
|
+
*
|
|
18888
|
+
* @type {Array<PermissionDtoV2026>}
|
|
18889
|
+
* @memberof EntitlementV2V2026
|
|
18890
|
+
*/
|
|
18891
|
+
'directPermissions'?: Array<PermissionDtoV2026>;
|
|
18892
|
+
}
|
|
18838
18893
|
/**
|
|
18839
18894
|
*
|
|
18840
18895
|
* @export
|
|
@@ -27889,11 +27944,11 @@ export interface MachineIdentityRequestV2026 {
|
|
|
27889
27944
|
*/
|
|
27890
27945
|
'modified'?: string;
|
|
27891
27946
|
/**
|
|
27892
|
-
* The
|
|
27947
|
+
* The native identity associated to the machine identity directly aggregated from a source
|
|
27893
27948
|
* @type {string}
|
|
27894
27949
|
* @memberof MachineIdentityRequestV2026
|
|
27895
27950
|
*/
|
|
27896
|
-
'
|
|
27951
|
+
'nativeIdentity': string;
|
|
27897
27952
|
/**
|
|
27898
27953
|
* Description of machine identity
|
|
27899
27954
|
* @type {string}
|
|
@@ -27930,12 +27985,6 @@ export interface MachineIdentityRequestV2026 {
|
|
|
27930
27985
|
* @memberof MachineIdentityRequestV2026
|
|
27931
27986
|
*/
|
|
27932
27987
|
'uuid'?: string;
|
|
27933
|
-
/**
|
|
27934
|
-
* The native identity associated to the machine identity directly aggregated from a source
|
|
27935
|
-
* @type {string}
|
|
27936
|
-
* @memberof MachineIdentityRequestV2026
|
|
27937
|
-
*/
|
|
27938
|
-
'nativeIdentity'?: string;
|
|
27939
27988
|
/**
|
|
27940
27989
|
* The user entitlements associated to the machine identity
|
|
27941
27990
|
* @type {Array<MachineIdentityRequestUserEntitlementsV2026>}
|
|
@@ -28005,11 +28054,11 @@ export interface MachineIdentityResponseV2026 {
|
|
|
28005
28054
|
*/
|
|
28006
28055
|
'modified'?: string;
|
|
28007
28056
|
/**
|
|
28008
|
-
* The
|
|
28057
|
+
* The native identity associated to the machine identity directly aggregated from a source
|
|
28009
28058
|
* @type {string}
|
|
28010
28059
|
* @memberof MachineIdentityResponseV2026
|
|
28011
28060
|
*/
|
|
28012
|
-
'
|
|
28061
|
+
'nativeIdentity': string;
|
|
28013
28062
|
/**
|
|
28014
28063
|
* Description of machine identity
|
|
28015
28064
|
* @type {string}
|
|
@@ -28046,12 +28095,6 @@ export interface MachineIdentityResponseV2026 {
|
|
|
28046
28095
|
* @memberof MachineIdentityResponseV2026
|
|
28047
28096
|
*/
|
|
28048
28097
|
'uuid'?: string;
|
|
28049
|
-
/**
|
|
28050
|
-
* The native identity associated to the machine identity directly aggregated from a source
|
|
28051
|
-
* @type {string}
|
|
28052
|
-
* @memberof MachineIdentityResponseV2026
|
|
28053
|
-
*/
|
|
28054
|
-
'nativeIdentity'?: string;
|
|
28055
28098
|
/**
|
|
28056
28099
|
* Indicates if the machine identity has been manually edited
|
|
28057
28100
|
* @type {boolean}
|
|
@@ -28517,11 +28560,11 @@ export interface MachineIdentityV2026 {
|
|
|
28517
28560
|
*/
|
|
28518
28561
|
'modified'?: string;
|
|
28519
28562
|
/**
|
|
28520
|
-
* The
|
|
28563
|
+
* The native identity associated to the machine identity directly aggregated from a source
|
|
28521
28564
|
* @type {string}
|
|
28522
28565
|
* @memberof MachineIdentityV2026
|
|
28523
28566
|
*/
|
|
28524
|
-
'
|
|
28567
|
+
'nativeIdentity': string;
|
|
28525
28568
|
/**
|
|
28526
28569
|
* Description of machine identity
|
|
28527
28570
|
* @type {string}
|
|
@@ -28558,12 +28601,6 @@ export interface MachineIdentityV2026 {
|
|
|
28558
28601
|
* @memberof MachineIdentityV2026
|
|
28559
28602
|
*/
|
|
28560
28603
|
'uuid'?: string;
|
|
28561
|
-
/**
|
|
28562
|
-
* The native identity associated to the machine identity directly aggregated from a source
|
|
28563
|
-
* @type {string}
|
|
28564
|
-
* @memberof MachineIdentityV2026
|
|
28565
|
-
*/
|
|
28566
|
-
'nativeIdentity'?: string;
|
|
28567
28604
|
}
|
|
28568
28605
|
/**
|
|
28569
28606
|
* MAIL FROM attributes for a domain / identity
|
|
@@ -33031,35 +33068,6 @@ export declare const OwnerDtoV2026TypeV2026: {
|
|
|
33031
33068
|
readonly Identity: "IDENTITY";
|
|
33032
33069
|
};
|
|
33033
33070
|
export type OwnerDtoV2026TypeV2026 = typeof OwnerDtoV2026TypeV2026[keyof typeof OwnerDtoV2026TypeV2026];
|
|
33034
|
-
/**
|
|
33035
|
-
* Simplified DTO for the owner object of the entitlement
|
|
33036
|
-
* @export
|
|
33037
|
-
* @interface OwnerReferenceDtoV2026
|
|
33038
|
-
*/
|
|
33039
|
-
export interface OwnerReferenceDtoV2026 {
|
|
33040
|
-
/**
|
|
33041
|
-
* The owner id for the entitlement
|
|
33042
|
-
* @type {string}
|
|
33043
|
-
* @memberof OwnerReferenceDtoV2026
|
|
33044
|
-
*/
|
|
33045
|
-
'id'?: string;
|
|
33046
|
-
/**
|
|
33047
|
-
* The owner name for the entitlement
|
|
33048
|
-
* @type {string}
|
|
33049
|
-
* @memberof OwnerReferenceDtoV2026
|
|
33050
|
-
*/
|
|
33051
|
-
'name'?: string;
|
|
33052
|
-
/**
|
|
33053
|
-
* The type of the owner. Initially only type IDENTITY is supported
|
|
33054
|
-
* @type {string}
|
|
33055
|
-
* @memberof OwnerReferenceDtoV2026
|
|
33056
|
-
*/
|
|
33057
|
-
'type'?: OwnerReferenceDtoV2026TypeV2026;
|
|
33058
|
-
}
|
|
33059
|
-
export declare const OwnerReferenceDtoV2026TypeV2026: {
|
|
33060
|
-
readonly Identity: "IDENTITY";
|
|
33061
|
-
};
|
|
33062
|
-
export type OwnerReferenceDtoV2026TypeV2026 = typeof OwnerReferenceDtoV2026TypeV2026[keyof typeof OwnerReferenceDtoV2026TypeV2026];
|
|
33063
33071
|
/**
|
|
33064
33072
|
* The owner of this object.
|
|
33065
33073
|
* @export
|
|
@@ -54219,7 +54227,6 @@ export declare const AccessRequestsV2026ApiAxiosParamCreator: (configuration?: C
|
|
|
54219
54227
|
* This endpoint returns the current access-request configuration.
|
|
54220
54228
|
* @summary Get access request configuration
|
|
54221
54229
|
* @param {*} [axiosOptions] Override http request option.
|
|
54222
|
-
* @deprecated
|
|
54223
54230
|
* @throws {RequiredError}
|
|
54224
54231
|
*/
|
|
54225
54232
|
getAccessRequestConfig: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -54281,7 +54288,6 @@ export declare const AccessRequestsV2026ApiAxiosParamCreator: (configuration?: C
|
|
|
54281
54288
|
* @summary Update access request configuration
|
|
54282
54289
|
* @param {AccessRequestConfigV2026} accessRequestConfigV2026
|
|
54283
54290
|
* @param {*} [axiosOptions] Override http request option.
|
|
54284
|
-
* @deprecated
|
|
54285
54291
|
* @throws {RequiredError}
|
|
54286
54292
|
*/
|
|
54287
54293
|
setAccessRequestConfig: (accessRequestConfigV2026: AccessRequestConfigV2026, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -54335,7 +54341,6 @@ export declare const AccessRequestsV2026ApiFp: (configuration?: Configuration) =
|
|
|
54335
54341
|
* This endpoint returns the current access-request configuration.
|
|
54336
54342
|
* @summary Get access request configuration
|
|
54337
54343
|
* @param {*} [axiosOptions] Override http request option.
|
|
54338
|
-
* @deprecated
|
|
54339
54344
|
* @throws {RequiredError}
|
|
54340
54345
|
*/
|
|
54341
54346
|
getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestConfigV2026>>;
|
|
@@ -54397,7 +54402,6 @@ export declare const AccessRequestsV2026ApiFp: (configuration?: Configuration) =
|
|
|
54397
54402
|
* @summary Update access request configuration
|
|
54398
54403
|
* @param {AccessRequestConfigV2026} accessRequestConfigV2026
|
|
54399
54404
|
* @param {*} [axiosOptions] Override http request option.
|
|
54400
|
-
* @deprecated
|
|
54401
54405
|
* @throws {RequiredError}
|
|
54402
54406
|
*/
|
|
54403
54407
|
setAccessRequestConfig(accessRequestConfigV2026: AccessRequestConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestConfigV2026>>;
|
|
@@ -54451,7 +54455,6 @@ export declare const AccessRequestsV2026ApiFactory: (configuration?: Configurati
|
|
|
54451
54455
|
* This endpoint returns the current access-request configuration.
|
|
54452
54456
|
* @summary Get access request configuration
|
|
54453
54457
|
* @param {*} [axiosOptions] Override http request option.
|
|
54454
|
-
* @deprecated
|
|
54455
54458
|
* @throws {RequiredError}
|
|
54456
54459
|
*/
|
|
54457
54460
|
getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<AccessRequestConfigV2026>;
|
|
@@ -54492,7 +54495,6 @@ export declare const AccessRequestsV2026ApiFactory: (configuration?: Configurati
|
|
|
54492
54495
|
* @summary Update access request configuration
|
|
54493
54496
|
* @param {AccessRequestsV2026ApiSetAccessRequestConfigRequest} requestParameters Request parameters.
|
|
54494
54497
|
* @param {*} [axiosOptions] Override http request option.
|
|
54495
|
-
* @deprecated
|
|
54496
54498
|
* @throws {RequiredError}
|
|
54497
54499
|
*/
|
|
54498
54500
|
setAccessRequestConfig(requestParameters: AccessRequestsV2026ApiSetAccessRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<AccessRequestConfigV2026>;
|
|
@@ -54809,7 +54811,6 @@ export declare class AccessRequestsV2026Api extends BaseAPI {
|
|
|
54809
54811
|
* This endpoint returns the current access-request configuration.
|
|
54810
54812
|
* @summary Get access request configuration
|
|
54811
54813
|
* @param {*} [axiosOptions] Override http request option.
|
|
54812
|
-
* @deprecated
|
|
54813
54814
|
* @throws {RequiredError}
|
|
54814
54815
|
* @memberof AccessRequestsV2026Api
|
|
54815
54816
|
*/
|
|
@@ -54855,7 +54856,6 @@ export declare class AccessRequestsV2026Api extends BaseAPI {
|
|
|
54855
54856
|
* @summary Update access request configuration
|
|
54856
54857
|
* @param {AccessRequestsV2026ApiSetAccessRequestConfigRequest} requestParameters Request parameters.
|
|
54857
54858
|
* @param {*} [axiosOptions] Override http request option.
|
|
54858
|
-
* @deprecated
|
|
54859
54859
|
* @throws {RequiredError}
|
|
54860
54860
|
* @memberof AccessRequestsV2026Api
|
|
54861
54861
|
*/
|
|
@@ -68475,14 +68475,6 @@ export declare const EntitlementsV2026ApiAxiosParamCreator: (configuration?: Con
|
|
|
68475
68475
|
* @throws {RequiredError}
|
|
68476
68476
|
*/
|
|
68477
68477
|
createAccessModelMetadataForEntitlement: (id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68478
|
-
/**
|
|
68479
|
-
* This internal endpoint creates an entitlement using the given entitlement payload
|
|
68480
|
-
* @summary Creates an entitlement
|
|
68481
|
-
* @param {EntitlementDTOV2026} entitlementDTOV2026
|
|
68482
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
68483
|
-
* @throws {RequiredError}
|
|
68484
|
-
*/
|
|
68485
|
-
createEntitlement: (entitlementDTOV2026: EntitlementDTOV2026, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68486
68478
|
/**
|
|
68487
68479
|
* Remove single Access Model Metadata from an entitlement.
|
|
68488
68480
|
* @summary Remove metadata from an entitlement.
|
|
@@ -68493,6 +68485,14 @@ export declare const EntitlementsV2026ApiAxiosParamCreator: (configuration?: Con
|
|
|
68493
68485
|
* @throws {RequiredError}
|
|
68494
68486
|
*/
|
|
68495
68487
|
deleteAccessModelMetadataFromEntitlement: (id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68488
|
+
/**
|
|
68489
|
+
* This API returns an entitlement by its ID.
|
|
68490
|
+
* @summary Get an entitlement
|
|
68491
|
+
* @param {string} id The entitlement ID
|
|
68492
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
68493
|
+
* @throws {RequiredError}
|
|
68494
|
+
*/
|
|
68495
|
+
getEntitlement: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68496
68496
|
/**
|
|
68497
68497
|
* This API returns the entitlement request config for a specified entitlement.
|
|
68498
68498
|
* @summary Get entitlement request config
|
|
@@ -68540,21 +68540,21 @@ export declare const EntitlementsV2026ApiAxiosParamCreator: (configuration?: Con
|
|
|
68540
68540
|
*/
|
|
68541
68541
|
listEntitlementParents: (id: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68542
68542
|
/**
|
|
68543
|
-
* This API returns a list of entitlements.
|
|
68543
|
+
* This API returns a list of entitlements. Any authenticated token can call this API.
|
|
68544
68544
|
* @summary Gets a list of entitlements.
|
|
68545
|
-
* @param {string} [
|
|
68546
|
-
* @param {string} [
|
|
68547
|
-
* @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
|
|
68545
|
+
* @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID.
|
|
68546
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.
|
|
68548
68547
|
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.
|
|
68549
68548
|
* @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.
|
|
68550
68549
|
* @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.
|
|
68551
68550
|
* @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.
|
|
68551
|
+
* @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.
|
|
68552
68552
|
* @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, name, created, modified, type, attribute, value, source.id, requestable**
|
|
68553
|
-
* @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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in*
|
|
68553
|
+
* @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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
|
|
68554
68554
|
* @param {*} [axiosOptions] Override http request option.
|
|
68555
68555
|
* @throws {RequiredError}
|
|
68556
68556
|
*/
|
|
68557
|
-
listEntitlements: (
|
|
68557
|
+
listEntitlements: (segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68558
68558
|
/**
|
|
68559
68559
|
* This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404.
|
|
68560
68560
|
* @summary Get entitlements for an account
|
|
@@ -68568,6 +68568,15 @@ export declare const EntitlementsV2026ApiAxiosParamCreator: (configuration?: Con
|
|
|
68568
68568
|
* @throws {RequiredError}
|
|
68569
68569
|
*/
|
|
68570
68570
|
listEntitlementsByAccount: (accountId: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68571
|
+
/**
|
|
68572
|
+
* This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
|
|
68573
|
+
* @summary Patch an entitlement
|
|
68574
|
+
* @param {string} id ID of the entitlement to patch
|
|
68575
|
+
* @param {Array<JsonPatchOperationV2026>} [jsonPatchOperationV2026]
|
|
68576
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
68577
|
+
* @throws {RequiredError}
|
|
68578
|
+
*/
|
|
68579
|
+
patchEntitlement: (id: string, jsonPatchOperationV2026?: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68571
68580
|
/**
|
|
68572
68581
|
* This API replaces the entitlement request config for a specified entitlement.
|
|
68573
68582
|
* @summary Replace entitlement request config
|
|
@@ -68609,14 +68618,6 @@ export declare const EntitlementsV2026ApiFp: (configuration?: Configuration) =>
|
|
|
68609
68618
|
* @throws {RequiredError}
|
|
68610
68619
|
*/
|
|
68611
68620
|
createAccessModelMetadataForEntitlement(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementV2026>>;
|
|
68612
|
-
/**
|
|
68613
|
-
* This internal endpoint creates an entitlement using the given entitlement payload
|
|
68614
|
-
* @summary Creates an entitlement
|
|
68615
|
-
* @param {EntitlementDTOV2026} entitlementDTOV2026
|
|
68616
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
68617
|
-
* @throws {RequiredError}
|
|
68618
|
-
*/
|
|
68619
|
-
createEntitlement(entitlementDTOV2026: EntitlementDTOV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementDTOV2026>>>;
|
|
68620
68621
|
/**
|
|
68621
68622
|
* Remove single Access Model Metadata from an entitlement.
|
|
68622
68623
|
* @summary Remove metadata from an entitlement.
|
|
@@ -68627,6 +68628,14 @@ export declare const EntitlementsV2026ApiFp: (configuration?: Configuration) =>
|
|
|
68627
68628
|
* @throws {RequiredError}
|
|
68628
68629
|
*/
|
|
68629
68630
|
deleteAccessModelMetadataFromEntitlement(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
68631
|
+
/**
|
|
68632
|
+
* This API returns an entitlement by its ID.
|
|
68633
|
+
* @summary Get an entitlement
|
|
68634
|
+
* @param {string} id The entitlement ID
|
|
68635
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
68636
|
+
* @throws {RequiredError}
|
|
68637
|
+
*/
|
|
68638
|
+
getEntitlement(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementV2V2026>>;
|
|
68630
68639
|
/**
|
|
68631
68640
|
* This API returns the entitlement request config for a specified entitlement.
|
|
68632
68641
|
* @summary Get entitlement request config
|
|
@@ -68658,7 +68667,7 @@ export declare const EntitlementsV2026ApiFp: (configuration?: Configuration) =>
|
|
|
68658
68667
|
* @param {*} [axiosOptions] Override http request option.
|
|
68659
68668
|
* @throws {RequiredError}
|
|
68660
68669
|
*/
|
|
68661
|
-
listEntitlementChildren(id: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
68670
|
+
listEntitlementChildren(id: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2V2026>>>;
|
|
68662
68671
|
/**
|
|
68663
68672
|
* This API returns a list of all parent entitlements of a given entitlement.
|
|
68664
68673
|
* @summary List of entitlements parents
|
|
@@ -68672,23 +68681,23 @@ export declare const EntitlementsV2026ApiFp: (configuration?: Configuration) =>
|
|
|
68672
68681
|
* @param {*} [axiosOptions] Override http request option.
|
|
68673
68682
|
* @throws {RequiredError}
|
|
68674
68683
|
*/
|
|
68675
|
-
listEntitlementParents(id: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
68684
|
+
listEntitlementParents(id: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2V2026>>>;
|
|
68676
68685
|
/**
|
|
68677
|
-
* This API returns a list of entitlements.
|
|
68686
|
+
* This API returns a list of entitlements. Any authenticated token can call this API.
|
|
68678
68687
|
* @summary Gets a list of entitlements.
|
|
68679
|
-
* @param {string} [
|
|
68680
|
-
* @param {string} [
|
|
68681
|
-
* @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
|
|
68688
|
+
* @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID.
|
|
68689
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.
|
|
68682
68690
|
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.
|
|
68683
68691
|
* @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.
|
|
68684
68692
|
* @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.
|
|
68685
68693
|
* @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.
|
|
68694
|
+
* @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.
|
|
68686
68695
|
* @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, name, created, modified, type, attribute, value, source.id, requestable**
|
|
68687
|
-
* @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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in*
|
|
68696
|
+
* @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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
|
|
68688
68697
|
* @param {*} [axiosOptions] Override http request option.
|
|
68689
68698
|
* @throws {RequiredError}
|
|
68690
68699
|
*/
|
|
68691
|
-
listEntitlements(
|
|
68700
|
+
listEntitlements(segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2V2026>>>;
|
|
68692
68701
|
/**
|
|
68693
68702
|
* This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404.
|
|
68694
68703
|
* @summary Get entitlements for an account
|
|
@@ -68701,7 +68710,16 @@ export declare const EntitlementsV2026ApiFp: (configuration?: Configuration) =>
|
|
|
68701
68710
|
* @param {*} [axiosOptions] Override http request option.
|
|
68702
68711
|
* @throws {RequiredError}
|
|
68703
68712
|
*/
|
|
68704
|
-
listEntitlementsByAccount(accountId: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
68713
|
+
listEntitlementsByAccount(accountId: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2V2026>>>;
|
|
68714
|
+
/**
|
|
68715
|
+
* This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
|
|
68716
|
+
* @summary Patch an entitlement
|
|
68717
|
+
* @param {string} id ID of the entitlement to patch
|
|
68718
|
+
* @param {Array<JsonPatchOperationV2026>} [jsonPatchOperationV2026]
|
|
68719
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
68720
|
+
* @throws {RequiredError}
|
|
68721
|
+
*/
|
|
68722
|
+
patchEntitlement(id: string, jsonPatchOperationV2026?: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementV2V2026>>;
|
|
68705
68723
|
/**
|
|
68706
68724
|
* This API replaces the entitlement request config for a specified entitlement.
|
|
68707
68725
|
* @summary Replace entitlement request config
|
|
@@ -68741,14 +68759,6 @@ export declare const EntitlementsV2026ApiFactory: (configuration?: Configuration
|
|
|
68741
68759
|
* @throws {RequiredError}
|
|
68742
68760
|
*/
|
|
68743
68761
|
createAccessModelMetadataForEntitlement(requestParameters: EntitlementsV2026ApiCreateAccessModelMetadataForEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<EntitlementV2026>;
|
|
68744
|
-
/**
|
|
68745
|
-
* This internal endpoint creates an entitlement using the given entitlement payload
|
|
68746
|
-
* @summary Creates an entitlement
|
|
68747
|
-
* @param {EntitlementsV2026ApiCreateEntitlementRequest} requestParameters Request parameters.
|
|
68748
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
68749
|
-
* @throws {RequiredError}
|
|
68750
|
-
*/
|
|
68751
|
-
createEntitlement(requestParameters: EntitlementsV2026ApiCreateEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementDTOV2026>>;
|
|
68752
68762
|
/**
|
|
68753
68763
|
* Remove single Access Model Metadata from an entitlement.
|
|
68754
68764
|
* @summary Remove metadata from an entitlement.
|
|
@@ -68757,6 +68767,14 @@ export declare const EntitlementsV2026ApiFactory: (configuration?: Configuration
|
|
|
68757
68767
|
* @throws {RequiredError}
|
|
68758
68768
|
*/
|
|
68759
68769
|
deleteAccessModelMetadataFromEntitlement(requestParameters: EntitlementsV2026ApiDeleteAccessModelMetadataFromEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
68770
|
+
/**
|
|
68771
|
+
* This API returns an entitlement by its ID.
|
|
68772
|
+
* @summary Get an entitlement
|
|
68773
|
+
* @param {EntitlementsV2026ApiGetEntitlementRequest} requestParameters Request parameters.
|
|
68774
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
68775
|
+
* @throws {RequiredError}
|
|
68776
|
+
*/
|
|
68777
|
+
getEntitlement(requestParameters: EntitlementsV2026ApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<EntitlementV2V2026>;
|
|
68760
68778
|
/**
|
|
68761
68779
|
* This API returns the entitlement request config for a specified entitlement.
|
|
68762
68780
|
* @summary Get entitlement request config
|
|
@@ -68781,7 +68799,7 @@ export declare const EntitlementsV2026ApiFactory: (configuration?: Configuration
|
|
|
68781
68799
|
* @param {*} [axiosOptions] Override http request option.
|
|
68782
68800
|
* @throws {RequiredError}
|
|
68783
68801
|
*/
|
|
68784
|
-
listEntitlementChildren(requestParameters: EntitlementsV2026ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
68802
|
+
listEntitlementChildren(requestParameters: EntitlementsV2026ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementV2V2026>>;
|
|
68785
68803
|
/**
|
|
68786
68804
|
* This API returns a list of all parent entitlements of a given entitlement.
|
|
68787
68805
|
* @summary List of entitlements parents
|
|
@@ -68789,15 +68807,15 @@ export declare const EntitlementsV2026ApiFactory: (configuration?: Configuration
|
|
|
68789
68807
|
* @param {*} [axiosOptions] Override http request option.
|
|
68790
68808
|
* @throws {RequiredError}
|
|
68791
68809
|
*/
|
|
68792
|
-
listEntitlementParents(requestParameters: EntitlementsV2026ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
68810
|
+
listEntitlementParents(requestParameters: EntitlementsV2026ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementV2V2026>>;
|
|
68793
68811
|
/**
|
|
68794
|
-
* This API returns a list of entitlements.
|
|
68812
|
+
* This API returns a list of entitlements. Any authenticated token can call this API.
|
|
68795
68813
|
* @summary Gets a list of entitlements.
|
|
68796
68814
|
* @param {EntitlementsV2026ApiListEntitlementsRequest} requestParameters Request parameters.
|
|
68797
68815
|
* @param {*} [axiosOptions] Override http request option.
|
|
68798
68816
|
* @throws {RequiredError}
|
|
68799
68817
|
*/
|
|
68800
|
-
listEntitlements(requestParameters?: EntitlementsV2026ApiListEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
68818
|
+
listEntitlements(requestParameters?: EntitlementsV2026ApiListEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementV2V2026>>;
|
|
68801
68819
|
/**
|
|
68802
68820
|
* This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404.
|
|
68803
68821
|
* @summary Get entitlements for an account
|
|
@@ -68805,7 +68823,15 @@ export declare const EntitlementsV2026ApiFactory: (configuration?: Configuration
|
|
|
68805
68823
|
* @param {*} [axiosOptions] Override http request option.
|
|
68806
68824
|
* @throws {RequiredError}
|
|
68807
68825
|
*/
|
|
68808
|
-
listEntitlementsByAccount(requestParameters: EntitlementsV2026ApiListEntitlementsByAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
68826
|
+
listEntitlementsByAccount(requestParameters: EntitlementsV2026ApiListEntitlementsByAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementV2V2026>>;
|
|
68827
|
+
/**
|
|
68828
|
+
* This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
|
|
68829
|
+
* @summary Patch an entitlement
|
|
68830
|
+
* @param {EntitlementsV2026ApiPatchEntitlementRequest} requestParameters Request parameters.
|
|
68831
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
68832
|
+
* @throws {RequiredError}
|
|
68833
|
+
*/
|
|
68834
|
+
patchEntitlement(requestParameters: EntitlementsV2026ApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<EntitlementV2V2026>;
|
|
68809
68835
|
/**
|
|
68810
68836
|
* This API replaces the entitlement request config for a specified entitlement.
|
|
68811
68837
|
* @summary Replace entitlement request config
|
|
@@ -68856,19 +68882,6 @@ export interface EntitlementsV2026ApiCreateAccessModelMetadataForEntitlementRequ
|
|
|
68856
68882
|
*/
|
|
68857
68883
|
readonly attributeValue: string;
|
|
68858
68884
|
}
|
|
68859
|
-
/**
|
|
68860
|
-
* Request parameters for createEntitlement operation in EntitlementsV2026Api.
|
|
68861
|
-
* @export
|
|
68862
|
-
* @interface EntitlementsV2026ApiCreateEntitlementRequest
|
|
68863
|
-
*/
|
|
68864
|
-
export interface EntitlementsV2026ApiCreateEntitlementRequest {
|
|
68865
|
-
/**
|
|
68866
|
-
*
|
|
68867
|
-
* @type {EntitlementDTOV2026}
|
|
68868
|
-
* @memberof EntitlementsV2026ApiCreateEntitlement
|
|
68869
|
-
*/
|
|
68870
|
-
readonly entitlementDTOV2026: EntitlementDTOV2026;
|
|
68871
|
-
}
|
|
68872
68885
|
/**
|
|
68873
68886
|
* Request parameters for deleteAccessModelMetadataFromEntitlement operation in EntitlementsV2026Api.
|
|
68874
68887
|
* @export
|
|
@@ -68894,6 +68907,19 @@ export interface EntitlementsV2026ApiDeleteAccessModelMetadataFromEntitlementReq
|
|
|
68894
68907
|
*/
|
|
68895
68908
|
readonly attributeValue: string;
|
|
68896
68909
|
}
|
|
68910
|
+
/**
|
|
68911
|
+
* Request parameters for getEntitlement operation in EntitlementsV2026Api.
|
|
68912
|
+
* @export
|
|
68913
|
+
* @interface EntitlementsV2026ApiGetEntitlementRequest
|
|
68914
|
+
*/
|
|
68915
|
+
export interface EntitlementsV2026ApiGetEntitlementRequest {
|
|
68916
|
+
/**
|
|
68917
|
+
* The entitlement ID
|
|
68918
|
+
* @type {string}
|
|
68919
|
+
* @memberof EntitlementsV2026ApiGetEntitlement
|
|
68920
|
+
*/
|
|
68921
|
+
readonly id: string;
|
|
68922
|
+
}
|
|
68897
68923
|
/**
|
|
68898
68924
|
* Request parameters for getEntitlementRequestConfig operation in EntitlementsV2026Api.
|
|
68899
68925
|
* @export
|
|
@@ -69031,19 +69057,13 @@ export interface EntitlementsV2026ApiListEntitlementParentsRequest {
|
|
|
69031
69057
|
*/
|
|
69032
69058
|
export interface EntitlementsV2026ApiListEntitlementsRequest {
|
|
69033
69059
|
/**
|
|
69034
|
-
*
|
|
69035
|
-
* @type {string}
|
|
69036
|
-
* @memberof EntitlementsV2026ApiListEntitlements
|
|
69037
|
-
*/
|
|
69038
|
-
readonly accountId?: string;
|
|
69039
|
-
/**
|
|
69040
|
-
* If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity.
|
|
69060
|
+
* If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID.
|
|
69041
69061
|
* @type {string}
|
|
69042
69062
|
* @memberof EntitlementsV2026ApiListEntitlements
|
|
69043
69063
|
*/
|
|
69044
69064
|
readonly segmentedForIdentity?: string;
|
|
69045
69065
|
/**
|
|
69046
|
-
* If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.
|
|
69066
|
+
* If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.
|
|
69047
69067
|
* @type {string}
|
|
69048
69068
|
* @memberof EntitlementsV2026ApiListEntitlements
|
|
69049
69069
|
*/
|
|
@@ -69072,6 +69092,12 @@ export interface EntitlementsV2026ApiListEntitlementsRequest {
|
|
|
69072
69092
|
* @memberof EntitlementsV2026ApiListEntitlements
|
|
69073
69093
|
*/
|
|
69074
69094
|
readonly count?: boolean;
|
|
69095
|
+
/**
|
|
69096
|
+
* 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.
|
|
69097
|
+
* @type {string}
|
|
69098
|
+
* @memberof EntitlementsV2026ApiListEntitlements
|
|
69099
|
+
*/
|
|
69100
|
+
readonly searchAfter?: string;
|
|
69075
69101
|
/**
|
|
69076
69102
|
* 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, name, created, modified, type, attribute, value, source.id, requestable**
|
|
69077
69103
|
* @type {string}
|
|
@@ -69079,7 +69105,7 @@ export interface EntitlementsV2026ApiListEntitlementsRequest {
|
|
|
69079
69105
|
*/
|
|
69080
69106
|
readonly sorters?: string;
|
|
69081
69107
|
/**
|
|
69082
|
-
* 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in*
|
|
69108
|
+
* 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
|
|
69083
69109
|
* @type {string}
|
|
69084
69110
|
* @memberof EntitlementsV2026ApiListEntitlements
|
|
69085
69111
|
*/
|
|
@@ -69128,6 +69154,25 @@ export interface EntitlementsV2026ApiListEntitlementsByAccountRequest {
|
|
|
69128
69154
|
*/
|
|
69129
69155
|
readonly sorters?: string;
|
|
69130
69156
|
}
|
|
69157
|
+
/**
|
|
69158
|
+
* Request parameters for patchEntitlement operation in EntitlementsV2026Api.
|
|
69159
|
+
* @export
|
|
69160
|
+
* @interface EntitlementsV2026ApiPatchEntitlementRequest
|
|
69161
|
+
*/
|
|
69162
|
+
export interface EntitlementsV2026ApiPatchEntitlementRequest {
|
|
69163
|
+
/**
|
|
69164
|
+
* ID of the entitlement to patch
|
|
69165
|
+
* @type {string}
|
|
69166
|
+
* @memberof EntitlementsV2026ApiPatchEntitlement
|
|
69167
|
+
*/
|
|
69168
|
+
readonly id: string;
|
|
69169
|
+
/**
|
|
69170
|
+
*
|
|
69171
|
+
* @type {Array<JsonPatchOperationV2026>}
|
|
69172
|
+
* @memberof EntitlementsV2026ApiPatchEntitlement
|
|
69173
|
+
*/
|
|
69174
|
+
readonly jsonPatchOperationV2026?: Array<JsonPatchOperationV2026>;
|
|
69175
|
+
}
|
|
69131
69176
|
/**
|
|
69132
69177
|
* Request parameters for putEntitlementRequestConfig operation in EntitlementsV2026Api.
|
|
69133
69178
|
* @export
|
|
@@ -69190,23 +69235,23 @@ export declare class EntitlementsV2026Api extends BaseAPI {
|
|
|
69190
69235
|
*/
|
|
69191
69236
|
createAccessModelMetadataForEntitlement(requestParameters: EntitlementsV2026ApiCreateAccessModelMetadataForEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2026, any>>;
|
|
69192
69237
|
/**
|
|
69193
|
-
*
|
|
69194
|
-
* @summary
|
|
69195
|
-
* @param {
|
|
69238
|
+
* Remove single Access Model Metadata from an entitlement.
|
|
69239
|
+
* @summary Remove metadata from an entitlement.
|
|
69240
|
+
* @param {EntitlementsV2026ApiDeleteAccessModelMetadataFromEntitlementRequest} requestParameters Request parameters.
|
|
69196
69241
|
* @param {*} [axiosOptions] Override http request option.
|
|
69197
69242
|
* @throws {RequiredError}
|
|
69198
69243
|
* @memberof EntitlementsV2026Api
|
|
69199
69244
|
*/
|
|
69200
|
-
|
|
69245
|
+
deleteAccessModelMetadataFromEntitlement(requestParameters: EntitlementsV2026ApiDeleteAccessModelMetadataFromEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
69201
69246
|
/**
|
|
69202
|
-
*
|
|
69203
|
-
* @summary
|
|
69204
|
-
* @param {
|
|
69247
|
+
* This API returns an entitlement by its ID.
|
|
69248
|
+
* @summary Get an entitlement
|
|
69249
|
+
* @param {EntitlementsV2026ApiGetEntitlementRequest} requestParameters Request parameters.
|
|
69205
69250
|
* @param {*} [axiosOptions] Override http request option.
|
|
69206
69251
|
* @throws {RequiredError}
|
|
69207
69252
|
* @memberof EntitlementsV2026Api
|
|
69208
69253
|
*/
|
|
69209
|
-
|
|
69254
|
+
getEntitlement(requestParameters: EntitlementsV2026ApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2V2026, any>>;
|
|
69210
69255
|
/**
|
|
69211
69256
|
* This API returns the entitlement request config for a specified entitlement.
|
|
69212
69257
|
* @summary Get entitlement request config
|
|
@@ -69234,7 +69279,7 @@ export declare class EntitlementsV2026Api extends BaseAPI {
|
|
|
69234
69279
|
* @throws {RequiredError}
|
|
69235
69280
|
* @memberof EntitlementsV2026Api
|
|
69236
69281
|
*/
|
|
69237
|
-
listEntitlementChildren(requestParameters: EntitlementsV2026ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
69282
|
+
listEntitlementChildren(requestParameters: EntitlementsV2026ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2V2026[], any>>;
|
|
69238
69283
|
/**
|
|
69239
69284
|
* This API returns a list of all parent entitlements of a given entitlement.
|
|
69240
69285
|
* @summary List of entitlements parents
|
|
@@ -69243,16 +69288,16 @@ export declare class EntitlementsV2026Api extends BaseAPI {
|
|
|
69243
69288
|
* @throws {RequiredError}
|
|
69244
69289
|
* @memberof EntitlementsV2026Api
|
|
69245
69290
|
*/
|
|
69246
|
-
listEntitlementParents(requestParameters: EntitlementsV2026ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
69291
|
+
listEntitlementParents(requestParameters: EntitlementsV2026ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2V2026[], any>>;
|
|
69247
69292
|
/**
|
|
69248
|
-
* This API returns a list of entitlements.
|
|
69293
|
+
* This API returns a list of entitlements. Any authenticated token can call this API.
|
|
69249
69294
|
* @summary Gets a list of entitlements.
|
|
69250
69295
|
* @param {EntitlementsV2026ApiListEntitlementsRequest} requestParameters Request parameters.
|
|
69251
69296
|
* @param {*} [axiosOptions] Override http request option.
|
|
69252
69297
|
* @throws {RequiredError}
|
|
69253
69298
|
* @memberof EntitlementsV2026Api
|
|
69254
69299
|
*/
|
|
69255
|
-
listEntitlements(requestParameters?: EntitlementsV2026ApiListEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
69300
|
+
listEntitlements(requestParameters?: EntitlementsV2026ApiListEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2V2026[], any>>;
|
|
69256
69301
|
/**
|
|
69257
69302
|
* This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404.
|
|
69258
69303
|
* @summary Get entitlements for an account
|
|
@@ -69261,7 +69306,16 @@ export declare class EntitlementsV2026Api extends BaseAPI {
|
|
|
69261
69306
|
* @throws {RequiredError}
|
|
69262
69307
|
* @memberof EntitlementsV2026Api
|
|
69263
69308
|
*/
|
|
69264
|
-
listEntitlementsByAccount(requestParameters: EntitlementsV2026ApiListEntitlementsByAccountRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
69309
|
+
listEntitlementsByAccount(requestParameters: EntitlementsV2026ApiListEntitlementsByAccountRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2V2026[], any>>;
|
|
69310
|
+
/**
|
|
69311
|
+
* This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
|
|
69312
|
+
* @summary Patch an entitlement
|
|
69313
|
+
* @param {EntitlementsV2026ApiPatchEntitlementRequest} requestParameters Request parameters.
|
|
69314
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
69315
|
+
* @throws {RequiredError}
|
|
69316
|
+
* @memberof EntitlementsV2026Api
|
|
69317
|
+
*/
|
|
69318
|
+
patchEntitlement(requestParameters: EntitlementsV2026ApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2V2026, any>>;
|
|
69265
69319
|
/**
|
|
69266
69320
|
* This API replaces the entitlement request config for a specified entitlement.
|
|
69267
69321
|
* @summary Replace entitlement request config
|
|
@@ -79286,8 +79340,8 @@ export declare const MachineIdentitiesV2026ApiAxiosParamCreator: (configuration?
|
|
|
79286
79340
|
/**
|
|
79287
79341
|
* This API returns a list of machine identities.
|
|
79288
79342
|
* @summary List machine identities
|
|
79289
|
-
* @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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **
|
|
79290
|
-
* @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: **
|
|
79343
|
+
* @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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw*
|
|
79344
|
+
* @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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified**
|
|
79291
79345
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
79292
79346
|
* @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.
|
|
79293
79347
|
* @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.
|
|
@@ -79364,8 +79418,8 @@ export declare const MachineIdentitiesV2026ApiFp: (configuration?: Configuration
|
|
|
79364
79418
|
/**
|
|
79365
79419
|
* This API returns a list of machine identities.
|
|
79366
79420
|
* @summary List machine identities
|
|
79367
|
-
* @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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **
|
|
79368
|
-
* @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: **
|
|
79421
|
+
* @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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw*
|
|
79422
|
+
* @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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified**
|
|
79369
79423
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
79370
79424
|
* @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.
|
|
79371
79425
|
* @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.
|
|
@@ -79533,13 +79587,13 @@ export interface MachineIdentitiesV2026ApiGetMachineIdentityRequest {
|
|
|
79533
79587
|
*/
|
|
79534
79588
|
export interface MachineIdentitiesV2026ApiListMachineIdentitiesRequest {
|
|
79535
79589
|
/**
|
|
79536
|
-
* 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **
|
|
79590
|
+
* 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw*
|
|
79537
79591
|
* @type {string}
|
|
79538
79592
|
* @memberof MachineIdentitiesV2026ApiListMachineIdentities
|
|
79539
79593
|
*/
|
|
79540
79594
|
readonly filters?: string;
|
|
79541
79595
|
/**
|
|
79542
|
-
* 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: **
|
|
79596
|
+
* 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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified**
|
|
79543
79597
|
* @type {string}
|
|
79544
79598
|
* @memberof MachineIdentitiesV2026ApiListMachineIdentities
|
|
79545
79599
|
*/
|
|
@@ -98056,140 +98110,82 @@ export declare class TagsV2026Api extends BaseAPI {
|
|
|
98056
98110
|
* @export
|
|
98057
98111
|
*/
|
|
98058
98112
|
export declare const TaskManagementV2026ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
98059
|
-
/**
|
|
98060
|
-
* This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2025/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks.
|
|
98061
|
-
* @summary Retrieve pending task list headers
|
|
98062
|
-
* @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.
|
|
98063
|
-
* @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.
|
|
98064
|
-
* @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.
|
|
98065
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
98066
|
-
* @deprecated
|
|
98067
|
-
* @throws {RequiredError}
|
|
98068
|
-
*/
|
|
98069
|
-
getPendingTaskHeaders: (offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98070
|
-
/**
|
|
98071
|
-
* This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2025/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
98072
|
-
* @summary Retrieve pending task status list
|
|
98073
|
-
* @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.
|
|
98074
|
-
* @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.
|
|
98075
|
-
* @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.
|
|
98076
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
98077
|
-
* @deprecated
|
|
98078
|
-
* @throws {RequiredError}
|
|
98079
|
-
*/
|
|
98080
|
-
getPendingTasks: (offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98081
98113
|
/**
|
|
98082
98114
|
* Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
98083
98115
|
* @summary Get task status by id
|
|
98084
98116
|
* @param {string} id Task ID.
|
|
98117
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98085
98118
|
* @param {*} [axiosOptions] Override http request option.
|
|
98086
98119
|
* @throws {RequiredError}
|
|
98087
98120
|
*/
|
|
98088
|
-
getTaskStatus: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98121
|
+
getTaskStatus: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98089
98122
|
/**
|
|
98090
|
-
* Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks,
|
|
98123
|
+
* Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field.
|
|
98091
98124
|
* @summary Retrieve task status list
|
|
98092
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98093
98125
|
* @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.
|
|
98094
98126
|
* @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.
|
|
98095
98127
|
* @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.
|
|
98096
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION
|
|
98128
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION
|
|
98097
98129
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created**
|
|
98130
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98098
98131
|
* @param {*} [axiosOptions] Override http request option.
|
|
98099
98132
|
* @throws {RequiredError}
|
|
98100
98133
|
*/
|
|
98101
|
-
getTaskStatusList: (
|
|
98134
|
+
getTaskStatusList: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98102
98135
|
/**
|
|
98103
98136
|
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
98104
98137
|
* @summary Update task status by id
|
|
98105
98138
|
* @param {string} id Task ID.
|
|
98106
98139
|
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
98140
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98107
98141
|
* @param {*} [axiosOptions] Override http request option.
|
|
98108
98142
|
* @throws {RequiredError}
|
|
98109
98143
|
*/
|
|
98110
|
-
updateTaskStatus: (id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98144
|
+
updateTaskStatus: (id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98111
98145
|
};
|
|
98112
98146
|
/**
|
|
98113
98147
|
* TaskManagementV2026Api - functional programming interface
|
|
98114
98148
|
* @export
|
|
98115
98149
|
*/
|
|
98116
98150
|
export declare const TaskManagementV2026ApiFp: (configuration?: Configuration) => {
|
|
98117
|
-
/**
|
|
98118
|
-
* This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2025/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks.
|
|
98119
|
-
* @summary Retrieve pending task list headers
|
|
98120
|
-
* @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.
|
|
98121
|
-
* @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.
|
|
98122
|
-
* @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.
|
|
98123
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
98124
|
-
* @deprecated
|
|
98125
|
-
* @throws {RequiredError}
|
|
98126
|
-
*/
|
|
98127
|
-
getPendingTaskHeaders(offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
98128
|
-
/**
|
|
98129
|
-
* This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2025/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
98130
|
-
* @summary Retrieve pending task status list
|
|
98131
|
-
* @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.
|
|
98132
|
-
* @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.
|
|
98133
|
-
* @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.
|
|
98134
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
98135
|
-
* @deprecated
|
|
98136
|
-
* @throws {RequiredError}
|
|
98137
|
-
*/
|
|
98138
|
-
getPendingTasks(offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskStatusV2026>>>;
|
|
98139
98151
|
/**
|
|
98140
98152
|
* Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
98141
98153
|
* @summary Get task status by id
|
|
98142
98154
|
* @param {string} id Task ID.
|
|
98155
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98143
98156
|
* @param {*} [axiosOptions] Override http request option.
|
|
98144
98157
|
* @throws {RequiredError}
|
|
98145
98158
|
*/
|
|
98146
|
-
getTaskStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2026>>;
|
|
98159
|
+
getTaskStatus(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2026>>;
|
|
98147
98160
|
/**
|
|
98148
|
-
* Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks,
|
|
98161
|
+
* Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field.
|
|
98149
98162
|
* @summary Retrieve task status list
|
|
98150
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98151
98163
|
* @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.
|
|
98152
98164
|
* @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.
|
|
98153
98165
|
* @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.
|
|
98154
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION
|
|
98166
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION
|
|
98155
98167
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created**
|
|
98168
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98156
98169
|
* @param {*} [axiosOptions] Override http request option.
|
|
98157
98170
|
* @throws {RequiredError}
|
|
98158
98171
|
*/
|
|
98159
|
-
getTaskStatusList(
|
|
98172
|
+
getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskStatusV2026>>>;
|
|
98160
98173
|
/**
|
|
98161
98174
|
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
98162
98175
|
* @summary Update task status by id
|
|
98163
98176
|
* @param {string} id Task ID.
|
|
98164
98177
|
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
98178
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98165
98179
|
* @param {*} [axiosOptions] Override http request option.
|
|
98166
98180
|
* @throws {RequiredError}
|
|
98167
98181
|
*/
|
|
98168
|
-
updateTaskStatus(id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2026>>;
|
|
98182
|
+
updateTaskStatus(id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2026>>;
|
|
98169
98183
|
};
|
|
98170
98184
|
/**
|
|
98171
98185
|
* TaskManagementV2026Api - factory interface
|
|
98172
98186
|
* @export
|
|
98173
98187
|
*/
|
|
98174
98188
|
export declare const TaskManagementV2026ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
98175
|
-
/**
|
|
98176
|
-
* This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2025/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks.
|
|
98177
|
-
* @summary Retrieve pending task list headers
|
|
98178
|
-
* @param {TaskManagementV2026ApiGetPendingTaskHeadersRequest} requestParameters Request parameters.
|
|
98179
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
98180
|
-
* @deprecated
|
|
98181
|
-
* @throws {RequiredError}
|
|
98182
|
-
*/
|
|
98183
|
-
getPendingTaskHeaders(requestParameters?: TaskManagementV2026ApiGetPendingTaskHeadersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
98184
|
-
/**
|
|
98185
|
-
* This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2025/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
98186
|
-
* @summary Retrieve pending task status list
|
|
98187
|
-
* @param {TaskManagementV2026ApiGetPendingTasksRequest} requestParameters Request parameters.
|
|
98188
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
98189
|
-
* @deprecated
|
|
98190
|
-
* @throws {RequiredError}
|
|
98191
|
-
*/
|
|
98192
|
-
getPendingTasks(requestParameters?: TaskManagementV2026ApiGetPendingTasksRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<TaskStatusV2026>>;
|
|
98193
98189
|
/**
|
|
98194
98190
|
* Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
98195
98191
|
* @summary Get task status by id
|
|
@@ -98199,7 +98195,7 @@ export declare const TaskManagementV2026ApiFactory: (configuration?: Configurati
|
|
|
98199
98195
|
*/
|
|
98200
98196
|
getTaskStatus(requestParameters: TaskManagementV2026ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TaskStatusV2026>;
|
|
98201
98197
|
/**
|
|
98202
|
-
* Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks,
|
|
98198
|
+
* Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field.
|
|
98203
98199
|
* @summary Retrieve task status list
|
|
98204
98200
|
* @param {TaskManagementV2026ApiGetTaskStatusListRequest} requestParameters Request parameters.
|
|
98205
98201
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -98215,56 +98211,6 @@ export declare const TaskManagementV2026ApiFactory: (configuration?: Configurati
|
|
|
98215
98211
|
*/
|
|
98216
98212
|
updateTaskStatus(requestParameters: TaskManagementV2026ApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TaskStatusV2026>;
|
|
98217
98213
|
};
|
|
98218
|
-
/**
|
|
98219
|
-
* Request parameters for getPendingTaskHeaders operation in TaskManagementV2026Api.
|
|
98220
|
-
* @export
|
|
98221
|
-
* @interface TaskManagementV2026ApiGetPendingTaskHeadersRequest
|
|
98222
|
-
*/
|
|
98223
|
-
export interface TaskManagementV2026ApiGetPendingTaskHeadersRequest {
|
|
98224
|
-
/**
|
|
98225
|
-
* 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.
|
|
98226
|
-
* @type {number}
|
|
98227
|
-
* @memberof TaskManagementV2026ApiGetPendingTaskHeaders
|
|
98228
|
-
*/
|
|
98229
|
-
readonly offset?: number;
|
|
98230
|
-
/**
|
|
98231
|
-
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
98232
|
-
* @type {number}
|
|
98233
|
-
* @memberof TaskManagementV2026ApiGetPendingTaskHeaders
|
|
98234
|
-
*/
|
|
98235
|
-
readonly limit?: number;
|
|
98236
|
-
/**
|
|
98237
|
-
* 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.
|
|
98238
|
-
* @type {boolean}
|
|
98239
|
-
* @memberof TaskManagementV2026ApiGetPendingTaskHeaders
|
|
98240
|
-
*/
|
|
98241
|
-
readonly count?: boolean;
|
|
98242
|
-
}
|
|
98243
|
-
/**
|
|
98244
|
-
* Request parameters for getPendingTasks operation in TaskManagementV2026Api.
|
|
98245
|
-
* @export
|
|
98246
|
-
* @interface TaskManagementV2026ApiGetPendingTasksRequest
|
|
98247
|
-
*/
|
|
98248
|
-
export interface TaskManagementV2026ApiGetPendingTasksRequest {
|
|
98249
|
-
/**
|
|
98250
|
-
* 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.
|
|
98251
|
-
* @type {number}
|
|
98252
|
-
* @memberof TaskManagementV2026ApiGetPendingTasks
|
|
98253
|
-
*/
|
|
98254
|
-
readonly offset?: number;
|
|
98255
|
-
/**
|
|
98256
|
-
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
98257
|
-
* @type {number}
|
|
98258
|
-
* @memberof TaskManagementV2026ApiGetPendingTasks
|
|
98259
|
-
*/
|
|
98260
|
-
readonly limit?: number;
|
|
98261
|
-
/**
|
|
98262
|
-
* 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.
|
|
98263
|
-
* @type {boolean}
|
|
98264
|
-
* @memberof TaskManagementV2026ApiGetPendingTasks
|
|
98265
|
-
*/
|
|
98266
|
-
readonly count?: boolean;
|
|
98267
|
-
}
|
|
98268
98214
|
/**
|
|
98269
98215
|
* Request parameters for getTaskStatus operation in TaskManagementV2026Api.
|
|
98270
98216
|
* @export
|
|
@@ -98277,6 +98223,12 @@ export interface TaskManagementV2026ApiGetTaskStatusRequest {
|
|
|
98277
98223
|
* @memberof TaskManagementV2026ApiGetTaskStatus
|
|
98278
98224
|
*/
|
|
98279
98225
|
readonly id: string;
|
|
98226
|
+
/**
|
|
98227
|
+
* Use this header to enable this experimental API.
|
|
98228
|
+
* @type {string}
|
|
98229
|
+
* @memberof TaskManagementV2026ApiGetTaskStatus
|
|
98230
|
+
*/
|
|
98231
|
+
readonly xSailPointExperimental?: string;
|
|
98280
98232
|
}
|
|
98281
98233
|
/**
|
|
98282
98234
|
* Request parameters for getTaskStatusList operation in TaskManagementV2026Api.
|
|
@@ -98284,12 +98236,6 @@ export interface TaskManagementV2026ApiGetTaskStatusRequest {
|
|
|
98284
98236
|
* @interface TaskManagementV2026ApiGetTaskStatusListRequest
|
|
98285
98237
|
*/
|
|
98286
98238
|
export interface TaskManagementV2026ApiGetTaskStatusListRequest {
|
|
98287
|
-
/**
|
|
98288
|
-
* Use this header to enable this experimental API.
|
|
98289
|
-
* @type {string}
|
|
98290
|
-
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
98291
|
-
*/
|
|
98292
|
-
readonly xSailPointExperimental?: string;
|
|
98293
98239
|
/**
|
|
98294
98240
|
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
98295
98241
|
* @type {number}
|
|
@@ -98309,7 +98255,7 @@ export interface TaskManagementV2026ApiGetTaskStatusListRequest {
|
|
|
98309
98255
|
*/
|
|
98310
98256
|
readonly count?: boolean;
|
|
98311
98257
|
/**
|
|
98312
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION
|
|
98258
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION
|
|
98313
98259
|
* @type {string}
|
|
98314
98260
|
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
98315
98261
|
*/
|
|
@@ -98320,6 +98266,12 @@ export interface TaskManagementV2026ApiGetTaskStatusListRequest {
|
|
|
98320
98266
|
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
98321
98267
|
*/
|
|
98322
98268
|
readonly sorters?: string;
|
|
98269
|
+
/**
|
|
98270
|
+
* Use this header to enable this experimental API.
|
|
98271
|
+
* @type {string}
|
|
98272
|
+
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
98273
|
+
*/
|
|
98274
|
+
readonly xSailPointExperimental?: string;
|
|
98323
98275
|
}
|
|
98324
98276
|
/**
|
|
98325
98277
|
* Request parameters for updateTaskStatus operation in TaskManagementV2026Api.
|
|
@@ -98339,6 +98291,12 @@ export interface TaskManagementV2026ApiUpdateTaskStatusRequest {
|
|
|
98339
98291
|
* @memberof TaskManagementV2026ApiUpdateTaskStatus
|
|
98340
98292
|
*/
|
|
98341
98293
|
readonly jsonPatchOperationV2026: Array<JsonPatchOperationV2026>;
|
|
98294
|
+
/**
|
|
98295
|
+
* Use this header to enable this experimental API.
|
|
98296
|
+
* @type {string}
|
|
98297
|
+
* @memberof TaskManagementV2026ApiUpdateTaskStatus
|
|
98298
|
+
*/
|
|
98299
|
+
readonly xSailPointExperimental?: string;
|
|
98342
98300
|
}
|
|
98343
98301
|
/**
|
|
98344
98302
|
* TaskManagementV2026Api - object-oriented interface
|
|
@@ -98347,26 +98305,6 @@ export interface TaskManagementV2026ApiUpdateTaskStatusRequest {
|
|
|
98347
98305
|
* @extends {BaseAPI}
|
|
98348
98306
|
*/
|
|
98349
98307
|
export declare class TaskManagementV2026Api extends BaseAPI {
|
|
98350
|
-
/**
|
|
98351
|
-
* This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2025/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks.
|
|
98352
|
-
* @summary Retrieve pending task list headers
|
|
98353
|
-
* @param {TaskManagementV2026ApiGetPendingTaskHeadersRequest} requestParameters Request parameters.
|
|
98354
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
98355
|
-
* @deprecated
|
|
98356
|
-
* @throws {RequiredError}
|
|
98357
|
-
* @memberof TaskManagementV2026Api
|
|
98358
|
-
*/
|
|
98359
|
-
getPendingTaskHeaders(requestParameters?: TaskManagementV2026ApiGetPendingTaskHeadersRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
98360
|
-
/**
|
|
98361
|
-
* This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2025/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
98362
|
-
* @summary Retrieve pending task status list
|
|
98363
|
-
* @param {TaskManagementV2026ApiGetPendingTasksRequest} requestParameters Request parameters.
|
|
98364
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
98365
|
-
* @deprecated
|
|
98366
|
-
* @throws {RequiredError}
|
|
98367
|
-
* @memberof TaskManagementV2026Api
|
|
98368
|
-
*/
|
|
98369
|
-
getPendingTasks(requestParameters?: TaskManagementV2026ApiGetPendingTasksRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskStatusV2026[], any>>;
|
|
98370
98308
|
/**
|
|
98371
98309
|
* Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
98372
98310
|
* @summary Get task status by id
|
|
@@ -98377,7 +98315,7 @@ export declare class TaskManagementV2026Api extends BaseAPI {
|
|
|
98377
98315
|
*/
|
|
98378
98316
|
getTaskStatus(requestParameters: TaskManagementV2026ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskStatusV2026, any>>;
|
|
98379
98317
|
/**
|
|
98380
|
-
* Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks,
|
|
98318
|
+
* Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field.
|
|
98381
98319
|
* @summary Retrieve task status list
|
|
98382
98320
|
* @param {TaskManagementV2026ApiGetTaskStatusListRequest} requestParameters Request parameters.
|
|
98383
98321
|
* @param {*} [axiosOptions] Override http request option.
|