sailpoint-api-client 1.4.12 → 1.4.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/beta/README.md +2 -2
- package/beta/api.ts +493 -221
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +369 -170
- package/dist/beta/api.js +313 -202
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/v2024/api.d.ts +2201 -493
- package/dist/v2024/api.js +1806 -640
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v3/api.d.ts +392 -372
- package/dist/v3/api.js +280 -500
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +1 -1
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/api.ts +2953 -615
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +425 -520
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/beta/api.d.ts
CHANGED
|
@@ -1012,13 +1012,13 @@ export interface AccessProfileDetailsBeta {
|
|
|
1012
1012
|
*/
|
|
1013
1013
|
'segments'?: Array<string>;
|
|
1014
1014
|
/**
|
|
1015
|
-
* Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup
|
|
1015
|
+
* Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId>
|
|
1016
1016
|
* @type {string}
|
|
1017
1017
|
* @memberof AccessProfileDetailsBeta
|
|
1018
1018
|
*/
|
|
1019
1019
|
'approvalSchemes'?: string;
|
|
1020
1020
|
/**
|
|
1021
|
-
* Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup
|
|
1021
|
+
* Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId>
|
|
1022
1022
|
* @type {string}
|
|
1023
1023
|
* @memberof AccessProfileDetailsBeta
|
|
1024
1024
|
*/
|
|
@@ -1243,6 +1243,12 @@ export interface AccessRequestConfigBeta {
|
|
|
1243
1243
|
* @memberof AccessRequestConfigBeta
|
|
1244
1244
|
*/
|
|
1245
1245
|
'autoApprovalEnabled'?: boolean;
|
|
1246
|
+
/**
|
|
1247
|
+
* If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state.
|
|
1248
|
+
* @type {boolean}
|
|
1249
|
+
* @memberof AccessRequestConfigBeta
|
|
1250
|
+
*/
|
|
1251
|
+
'reauthorizationEnabled'?: boolean;
|
|
1246
1252
|
/**
|
|
1247
1253
|
*
|
|
1248
1254
|
* @type {RequestOnBehalfOfConfigBeta}
|
|
@@ -2040,28 +2046,78 @@ export type AccessRequestRecommendationItemTypeBeta = typeof AccessRequestRecomm
|
|
|
2040
2046
|
/**
|
|
2041
2047
|
*
|
|
2042
2048
|
* @export
|
|
2043
|
-
* @interface
|
|
2049
|
+
* @interface AccessRequestResponse1Beta
|
|
2044
2050
|
*/
|
|
2045
|
-
export interface
|
|
2051
|
+
export interface AccessRequestResponse1Beta {
|
|
2046
2052
|
/**
|
|
2047
2053
|
* the requester Id
|
|
2048
2054
|
* @type {string}
|
|
2049
|
-
* @memberof
|
|
2055
|
+
* @memberof AccessRequestResponse1Beta
|
|
2050
2056
|
*/
|
|
2051
2057
|
'requesterId'?: string;
|
|
2052
2058
|
/**
|
|
2053
2059
|
* the requesterName
|
|
2054
2060
|
* @type {string}
|
|
2055
|
-
* @memberof
|
|
2061
|
+
* @memberof AccessRequestResponse1Beta
|
|
2056
2062
|
*/
|
|
2057
2063
|
'requesterName'?: string;
|
|
2058
2064
|
/**
|
|
2059
2065
|
*
|
|
2060
2066
|
* @type {Array<AccessRequestItemResponseBeta>}
|
|
2061
|
-
* @memberof
|
|
2067
|
+
* @memberof AccessRequestResponse1Beta
|
|
2062
2068
|
*/
|
|
2063
2069
|
'items'?: Array<AccessRequestItemResponseBeta>;
|
|
2064
2070
|
}
|
|
2071
|
+
/**
|
|
2072
|
+
*
|
|
2073
|
+
* @export
|
|
2074
|
+
* @interface AccessRequestResponseBeta
|
|
2075
|
+
*/
|
|
2076
|
+
export interface AccessRequestResponseBeta {
|
|
2077
|
+
/**
|
|
2078
|
+
* A list of new access request tracking data mapped to the values requested.
|
|
2079
|
+
* @type {Array<AccessRequestTrackingBeta>}
|
|
2080
|
+
* @memberof AccessRequestResponseBeta
|
|
2081
|
+
*/
|
|
2082
|
+
'newRequests'?: Array<AccessRequestTrackingBeta>;
|
|
2083
|
+
/**
|
|
2084
|
+
* A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item.
|
|
2085
|
+
* @type {Array<AccessRequestTrackingBeta>}
|
|
2086
|
+
* @memberof AccessRequestResponseBeta
|
|
2087
|
+
*/
|
|
2088
|
+
'existingRequests'?: Array<AccessRequestTrackingBeta>;
|
|
2089
|
+
}
|
|
2090
|
+
/**
|
|
2091
|
+
*
|
|
2092
|
+
* @export
|
|
2093
|
+
* @interface AccessRequestTrackingBeta
|
|
2094
|
+
*/
|
|
2095
|
+
export interface AccessRequestTrackingBeta {
|
|
2096
|
+
/**
|
|
2097
|
+
* The identity id in which the access request is for.
|
|
2098
|
+
* @type {string}
|
|
2099
|
+
* @memberof AccessRequestTrackingBeta
|
|
2100
|
+
*/
|
|
2101
|
+
'requestedFor'?: string;
|
|
2102
|
+
/**
|
|
2103
|
+
* The details of the item requested.
|
|
2104
|
+
* @type {Array<RequestedItemDetailsBeta>}
|
|
2105
|
+
* @memberof AccessRequestTrackingBeta
|
|
2106
|
+
*/
|
|
2107
|
+
'requestedItemsDetails'?: Array<RequestedItemDetailsBeta>;
|
|
2108
|
+
/**
|
|
2109
|
+
* a hash representation of the access requested, useful for longer term tracking client side.
|
|
2110
|
+
* @type {string}
|
|
2111
|
+
* @memberof AccessRequestTrackingBeta
|
|
2112
|
+
*/
|
|
2113
|
+
'attributesHash'?: string;
|
|
2114
|
+
/**
|
|
2115
|
+
* a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids.
|
|
2116
|
+
* @type {Array<string>}
|
|
2117
|
+
* @memberof AccessRequestTrackingBeta
|
|
2118
|
+
*/
|
|
2119
|
+
'accessRequestIds'?: Array<string>;
|
|
2120
|
+
}
|
|
2065
2121
|
/**
|
|
2066
2122
|
* Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.
|
|
2067
2123
|
* @export
|
|
@@ -2081,10 +2137,10 @@ export type AccessRequestTypeBeta = typeof AccessRequestTypeBeta[keyof typeof Ac
|
|
|
2081
2137
|
export interface AccessRequestedBeta {
|
|
2082
2138
|
/**
|
|
2083
2139
|
*
|
|
2084
|
-
* @type {
|
|
2140
|
+
* @type {AccessRequestResponse1Beta}
|
|
2085
2141
|
* @memberof AccessRequestedBeta
|
|
2086
2142
|
*/
|
|
2087
|
-
'accessRequest'?:
|
|
2143
|
+
'accessRequest'?: AccessRequestResponse1Beta;
|
|
2088
2144
|
/**
|
|
2089
2145
|
* the identity id
|
|
2090
2146
|
* @type {string}
|
|
@@ -4361,6 +4417,12 @@ export type ApprovalStatusBeta = typeof ApprovalStatusBeta[keyof typeof Approval
|
|
|
4361
4417
|
* @interface ApprovalStatusDtoBeta
|
|
4362
4418
|
*/
|
|
4363
4419
|
export interface ApprovalStatusDtoBeta {
|
|
4420
|
+
/**
|
|
4421
|
+
* Unique identifier for the approval.
|
|
4422
|
+
* @type {string}
|
|
4423
|
+
* @memberof ApprovalStatusDtoBeta
|
|
4424
|
+
*/
|
|
4425
|
+
'approvalId'?: string | null;
|
|
4364
4426
|
/**
|
|
4365
4427
|
* True if the request for this item was forwarded from one owner to another.
|
|
4366
4428
|
* @type {boolean}
|
|
@@ -8852,7 +8914,7 @@ export interface CustomPasswordInstructionBeta {
|
|
|
8852
8914
|
*/
|
|
8853
8915
|
'pageId'?: CustomPasswordInstructionBetaPageIdEnum;
|
|
8854
8916
|
/**
|
|
8855
|
-
* The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like
|
|
8917
|
+
* The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `<A HREF=\\\"URL\\\">...</A>` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: `<a href=\\\"URL\" target=\\\"_blank\\\" >link</a>`. This will open a new tab when the link is clicked. Notice we\'re only supporting _blank as the redirection target.
|
|
8856
8918
|
* @type {string}
|
|
8857
8919
|
* @memberof CustomPasswordInstructionBeta
|
|
8858
8920
|
*/
|
|
@@ -8898,7 +8960,7 @@ export interface DateCompareBeta {
|
|
|
8898
8960
|
*/
|
|
8899
8961
|
'secondDate': DateCompareSecondDateBeta;
|
|
8900
8962
|
/**
|
|
8901
|
-
* This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: firstDate < secondDate | | LTE | Less than or equal to: firstDate <= secondDate | | GT | Strictly greater than: firstDate > secondDate | | GTE | Greater than or equal to: firstDate >= secondDate |
|
|
8963
|
+
* This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` |
|
|
8902
8964
|
* @type {string}
|
|
8903
8965
|
* @memberof DateCompareBeta
|
|
8904
8966
|
*/
|
|
@@ -9685,7 +9747,7 @@ export interface EntitlementRequestConfig1Beta {
|
|
|
9685
9747
|
*/
|
|
9686
9748
|
'deniedCommentsRequired'?: boolean;
|
|
9687
9749
|
/**
|
|
9688
|
-
* Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"workgroup:{id}
|
|
9750
|
+
* Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"`workgroup:{id}`\". You can use multiple governance groups (workgroups).
|
|
9689
9751
|
* @type {string}
|
|
9690
9752
|
* @memberof EntitlementRequestConfig1Beta
|
|
9691
9753
|
*/
|
|
@@ -12034,10 +12096,10 @@ export interface GetHistoricalIdentityEvents200ResponseInnerBeta {
|
|
|
12034
12096
|
'changes'?: Array<AttributeChangeBeta>;
|
|
12035
12097
|
/**
|
|
12036
12098
|
*
|
|
12037
|
-
* @type {
|
|
12099
|
+
* @type {AccessRequestResponse1Beta}
|
|
12038
12100
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerBeta
|
|
12039
12101
|
*/
|
|
12040
|
-
'accessRequest'?:
|
|
12102
|
+
'accessRequest'?: AccessRequestResponse1Beta;
|
|
12041
12103
|
/**
|
|
12042
12104
|
* the id of the certification item
|
|
12043
12105
|
* @type {string}
|
|
@@ -22366,6 +22428,31 @@ export declare const RequestableObjectTypeBeta: {
|
|
|
22366
22428
|
readonly Entitlement: "ENTITLEMENT";
|
|
22367
22429
|
};
|
|
22368
22430
|
export type RequestableObjectTypeBeta = typeof RequestableObjectTypeBeta[keyof typeof RequestableObjectTypeBeta];
|
|
22431
|
+
/**
|
|
22432
|
+
*
|
|
22433
|
+
* @export
|
|
22434
|
+
* @interface RequestedItemDetailsBeta
|
|
22435
|
+
*/
|
|
22436
|
+
export interface RequestedItemDetailsBeta {
|
|
22437
|
+
/**
|
|
22438
|
+
* The type of access item requested.
|
|
22439
|
+
* @type {string}
|
|
22440
|
+
* @memberof RequestedItemDetailsBeta
|
|
22441
|
+
*/
|
|
22442
|
+
'type'?: RequestedItemDetailsBetaTypeEnum;
|
|
22443
|
+
/**
|
|
22444
|
+
* The id of the access item requested.
|
|
22445
|
+
* @type {string}
|
|
22446
|
+
* @memberof RequestedItemDetailsBeta
|
|
22447
|
+
*/
|
|
22448
|
+
'id'?: string;
|
|
22449
|
+
}
|
|
22450
|
+
export declare const RequestedItemDetailsBetaTypeEnum: {
|
|
22451
|
+
readonly AccessProfile: "ACCESS_PROFILE";
|
|
22452
|
+
readonly Entitlement: "ENTITLEMENT";
|
|
22453
|
+
readonly Role: "ROLE";
|
|
22454
|
+
};
|
|
22455
|
+
export type RequestedItemDetailsBetaTypeEnum = typeof RequestedItemDetailsBetaTypeEnum[keyof typeof RequestedItemDetailsBetaTypeEnum];
|
|
22369
22456
|
/**
|
|
22370
22457
|
*
|
|
22371
22458
|
* @export
|
|
@@ -22408,6 +22495,12 @@ export interface RequestedItemStatusBeta {
|
|
|
22408
22495
|
* @memberof RequestedItemStatusBeta
|
|
22409
22496
|
*/
|
|
22410
22497
|
'approvalDetails'?: Array<ApprovalStatusDtoBeta>;
|
|
22498
|
+
/**
|
|
22499
|
+
* List of approval IDs associated with the request.
|
|
22500
|
+
* @type {Array<string>}
|
|
22501
|
+
* @memberof RequestedItemStatusBeta
|
|
22502
|
+
*/
|
|
22503
|
+
'approvalIds'?: Array<string> | null;
|
|
22411
22504
|
/**
|
|
22412
22505
|
* Manual work items created for provisioning the item.
|
|
22413
22506
|
* @type {Array<ManualWorkItemDetailsBeta>}
|
|
@@ -29933,10 +30026,10 @@ export interface TaskStatusMessageBeta {
|
|
|
29933
30026
|
'key': string;
|
|
29934
30027
|
/**
|
|
29935
30028
|
* Message parameters for internationalization
|
|
29936
|
-
* @type {Array<
|
|
30029
|
+
* @type {Array<TaskStatusMessageParametersInnerBeta>}
|
|
29937
30030
|
* @memberof TaskStatusMessageBeta
|
|
29938
30031
|
*/
|
|
29939
|
-
'parameters': Array<
|
|
30032
|
+
'parameters': Array<TaskStatusMessageParametersInnerBeta> | null;
|
|
29940
30033
|
}
|
|
29941
30034
|
export declare const TaskStatusMessageBetaTypeEnum: {
|
|
29942
30035
|
readonly Info: "INFO";
|
|
@@ -29944,6 +30037,13 @@ export declare const TaskStatusMessageBetaTypeEnum: {
|
|
|
29944
30037
|
readonly Error: "ERROR";
|
|
29945
30038
|
};
|
|
29946
30039
|
export type TaskStatusMessageBetaTypeEnum = typeof TaskStatusMessageBetaTypeEnum[keyof typeof TaskStatusMessageBetaTypeEnum];
|
|
30040
|
+
/**
|
|
30041
|
+
*
|
|
30042
|
+
* @export
|
|
30043
|
+
* @interface TaskStatusMessageParametersInnerBeta
|
|
30044
|
+
*/
|
|
30045
|
+
export interface TaskStatusMessageParametersInnerBeta {
|
|
30046
|
+
}
|
|
29947
30047
|
/**
|
|
29948
30048
|
*
|
|
29949
30049
|
* @export
|
|
@@ -34477,7 +34577,7 @@ export declare const AccessRequestsBetaApiAxiosParamCreator: (configuration?: Co
|
|
|
34477
34577
|
* @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored.
|
|
34478
34578
|
* @param {number} [limit] Max number of results to return.
|
|
34479
34579
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
34480
|
-
* @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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
34580
|
+
* @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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
34481
34581
|
* @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, modified, accountActivityItemId, name**
|
|
34482
34582
|
* @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
34483
34583
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34521,7 +34621,7 @@ export declare const AccessRequestsBetaApiFp: (configuration?: Configuration) =>
|
|
|
34521
34621
|
* @param {*} [axiosOptions] Override http request option.
|
|
34522
34622
|
* @throws {RequiredError}
|
|
34523
34623
|
*/
|
|
34524
|
-
createAccessRequest(accessRequestBeta: AccessRequestBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
34624
|
+
createAccessRequest(accessRequestBeta: AccessRequestBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestResponseBeta>>;
|
|
34525
34625
|
/**
|
|
34526
34626
|
* This endpoint returns the current access-request configuration.
|
|
34527
34627
|
* @summary Get Access Request Configuration
|
|
@@ -34539,7 +34639,7 @@ export declare const AccessRequestsBetaApiFp: (configuration?: Configuration) =>
|
|
|
34539
34639
|
* @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored.
|
|
34540
34640
|
* @param {number} [limit] Max number of results to return.
|
|
34541
34641
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
34542
|
-
* @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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
34642
|
+
* @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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
34543
34643
|
* @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, modified, accountActivityItemId, name**
|
|
34544
34644
|
* @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
34545
34645
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34583,7 +34683,7 @@ export declare const AccessRequestsBetaApiFactory: (configuration?: Configuratio
|
|
|
34583
34683
|
* @param {*} [axiosOptions] Override http request option.
|
|
34584
34684
|
* @throws {RequiredError}
|
|
34585
34685
|
*/
|
|
34586
|
-
createAccessRequest(accessRequestBeta: AccessRequestBeta, axiosOptions?: any): AxiosPromise<
|
|
34686
|
+
createAccessRequest(accessRequestBeta: AccessRequestBeta, axiosOptions?: any): AxiosPromise<AccessRequestResponseBeta>;
|
|
34587
34687
|
/**
|
|
34588
34688
|
* This endpoint returns the current access-request configuration.
|
|
34589
34689
|
* @summary Get Access Request Configuration
|
|
@@ -34601,7 +34701,7 @@ export declare const AccessRequestsBetaApiFactory: (configuration?: Configuratio
|
|
|
34601
34701
|
* @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored.
|
|
34602
34702
|
* @param {number} [limit] Max number of results to return.
|
|
34603
34703
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
34604
|
-
* @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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
34704
|
+
* @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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
34605
34705
|
* @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, modified, accountActivityItemId, name**
|
|
34606
34706
|
* @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
34607
34707
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34705,7 +34805,7 @@ export interface AccessRequestsBetaApiListAccessRequestStatusRequest {
|
|
|
34705
34805
|
*/
|
|
34706
34806
|
readonly offset?: number;
|
|
34707
34807
|
/**
|
|
34708
|
-
* 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
34808
|
+
* 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
34709
34809
|
* @type {string}
|
|
34710
34810
|
* @memberof AccessRequestsBetaApiListAccessRequestStatus
|
|
34711
34811
|
*/
|
|
@@ -34769,7 +34869,7 @@ export declare class AccessRequestsBetaApi extends BaseAPI {
|
|
|
34769
34869
|
* @throws {RequiredError}
|
|
34770
34870
|
* @memberof AccessRequestsBetaApi
|
|
34771
34871
|
*/
|
|
34772
|
-
createAccessRequest(requestParameters: AccessRequestsBetaApiCreateAccessRequestRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
34872
|
+
createAccessRequest(requestParameters: AccessRequestsBetaApiCreateAccessRequestRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessRequestResponseBeta, any>>;
|
|
34773
34873
|
/**
|
|
34774
34874
|
* This endpoint returns the current access-request configuration.
|
|
34775
34875
|
* @summary Get Access Request Configuration
|
|
@@ -35173,7 +35273,7 @@ export declare class AccountUsagesBetaApi extends BaseAPI {
|
|
|
35173
35273
|
*/
|
|
35174
35274
|
export declare const AccountsBetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
35175
35275
|
/**
|
|
35176
|
-
*
|
|
35276
|
+
* Submits an account creation task - the API then returns the task ID. The `sourceId` where this account will be created must be included in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account.
|
|
35177
35277
|
* @summary Create Account
|
|
35178
35278
|
* @param {AccountAttributesCreateBeta} accountAttributesCreateBeta
|
|
35179
35279
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35266,9 +35366,9 @@ export declare const AccountsBetaApiAxiosParamCreator: (configuration?: Configur
|
|
|
35266
35366
|
*/
|
|
35267
35367
|
getAccountEntitlements: (id: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35268
35368
|
/**
|
|
35269
|
-
*
|
|
35369
|
+
* List accounts.
|
|
35270
35370
|
* @summary Accounts List
|
|
35271
|
-
* @param {'SLIM' | 'FULL'} [detailLevel]
|
|
35371
|
+
* @param {'SLIM' | 'FULL'} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior.
|
|
35272
35372
|
* @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.
|
|
35273
35373
|
* @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.
|
|
35274
35374
|
* @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.
|
|
@@ -35320,7 +35420,7 @@ export declare const AccountsBetaApiAxiosParamCreator: (configuration?: Configur
|
|
|
35320
35420
|
*/
|
|
35321
35421
|
export declare const AccountsBetaApiFp: (configuration?: Configuration) => {
|
|
35322
35422
|
/**
|
|
35323
|
-
*
|
|
35423
|
+
* Submits an account creation task - the API then returns the task ID. The `sourceId` where this account will be created must be included in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account.
|
|
35324
35424
|
* @summary Create Account
|
|
35325
35425
|
* @param {AccountAttributesCreateBeta} accountAttributesCreateBeta
|
|
35326
35426
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35413,9 +35513,9 @@ export declare const AccountsBetaApiFp: (configuration?: Configuration) => {
|
|
|
35413
35513
|
*/
|
|
35414
35514
|
getAccountEntitlements(id: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementBeta>>>;
|
|
35415
35515
|
/**
|
|
35416
|
-
*
|
|
35516
|
+
* List accounts.
|
|
35417
35517
|
* @summary Accounts List
|
|
35418
|
-
* @param {'SLIM' | 'FULL'} [detailLevel]
|
|
35518
|
+
* @param {'SLIM' | 'FULL'} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior.
|
|
35419
35519
|
* @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.
|
|
35420
35520
|
* @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.
|
|
35421
35521
|
* @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.
|
|
@@ -35467,7 +35567,7 @@ export declare const AccountsBetaApiFp: (configuration?: Configuration) => {
|
|
|
35467
35567
|
*/
|
|
35468
35568
|
export declare const AccountsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
35469
35569
|
/**
|
|
35470
|
-
*
|
|
35570
|
+
* Submits an account creation task - the API then returns the task ID. The `sourceId` where this account will be created must be included in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account.
|
|
35471
35571
|
* @summary Create Account
|
|
35472
35572
|
* @param {AccountAttributesCreateBeta} accountAttributesCreateBeta
|
|
35473
35573
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35560,9 +35660,9 @@ export declare const AccountsBetaApiFactory: (configuration?: Configuration, bas
|
|
|
35560
35660
|
*/
|
|
35561
35661
|
getAccountEntitlements(id: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: any): AxiosPromise<Array<EntitlementBeta>>;
|
|
35562
35662
|
/**
|
|
35563
|
-
*
|
|
35663
|
+
* List accounts.
|
|
35564
35664
|
* @summary Accounts List
|
|
35565
|
-
* @param {'SLIM' | 'FULL'} [detailLevel]
|
|
35665
|
+
* @param {'SLIM' | 'FULL'} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior.
|
|
35566
35666
|
* @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.
|
|
35567
35667
|
* @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.
|
|
35568
35668
|
* @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.
|
|
@@ -35788,7 +35888,7 @@ export interface AccountsBetaApiGetAccountEntitlementsRequest {
|
|
|
35788
35888
|
*/
|
|
35789
35889
|
export interface AccountsBetaApiListAccountsRequest {
|
|
35790
35890
|
/**
|
|
35791
|
-
*
|
|
35891
|
+
* This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior.
|
|
35792
35892
|
* @type {'SLIM' | 'FULL'}
|
|
35793
35893
|
* @memberof AccountsBetaApiListAccounts
|
|
35794
35894
|
*/
|
|
@@ -35902,7 +36002,7 @@ export interface AccountsBetaApiUpdateAccountRequest {
|
|
|
35902
36002
|
*/
|
|
35903
36003
|
export declare class AccountsBetaApi extends BaseAPI {
|
|
35904
36004
|
/**
|
|
35905
|
-
*
|
|
36005
|
+
* Submits an account creation task - the API then returns the task ID. The `sourceId` where this account will be created must be included in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account.
|
|
35906
36006
|
* @summary Create Account
|
|
35907
36007
|
* @param {AccountsBetaApiCreateAccountRequest} requestParameters Request parameters.
|
|
35908
36008
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -36001,7 +36101,7 @@ export declare class AccountsBetaApi extends BaseAPI {
|
|
|
36001
36101
|
*/
|
|
36002
36102
|
getAccountEntitlements(requestParameters: AccountsBetaApiGetAccountEntitlementsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementBeta[], any>>;
|
|
36003
36103
|
/**
|
|
36004
|
-
*
|
|
36104
|
+
* List accounts.
|
|
36005
36105
|
* @summary Accounts List
|
|
36006
36106
|
* @param {AccountsBetaApiListAccountsRequest} requestParameters Request parameters.
|
|
36007
36107
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -36510,74 +36610,81 @@ export declare const AppsBetaApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
36510
36610
|
* @summary List access profiles for the specified source app
|
|
36511
36611
|
* @param {string} id ID of the source app
|
|
36512
36612
|
* @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.
|
|
36613
|
+
* @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.
|
|
36513
36614
|
* @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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
|
|
36514
36615
|
* @param {*} [axiosOptions] Override http request option.
|
|
36515
36616
|
* @throws {RequiredError}
|
|
36516
36617
|
*/
|
|
36517
|
-
listAccessProfilesForSourceApp: (id: string, limit?: number, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36618
|
+
listAccessProfilesForSourceApp: (id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36518
36619
|
/**
|
|
36519
36620
|
* This API returns the list of all source apps for the org. A token with ORG_ADMIN authority is required to call this API.
|
|
36520
36621
|
* @summary List all source apps
|
|
36521
36622
|
* @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.
|
|
36522
36623
|
* @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.
|
|
36624
|
+
* @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.
|
|
36523
36625
|
* @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, owner.id, accountSource.id**
|
|
36524
36626
|
* @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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq*
|
|
36525
36627
|
* @param {*} [axiosOptions] Override http request option.
|
|
36526
36628
|
* @throws {RequiredError}
|
|
36527
36629
|
*/
|
|
36528
|
-
listAllSourceApp: (limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36630
|
+
listAllSourceApp: (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36529
36631
|
/**
|
|
36530
36632
|
* This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter.
|
|
36531
36633
|
* @summary List all user apps
|
|
36532
36634
|
* @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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq*
|
|
36533
36635
|
* @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.
|
|
36534
36636
|
* @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.
|
|
36637
|
+
* @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.
|
|
36535
36638
|
* @param {*} [axiosOptions] Override http request option.
|
|
36536
36639
|
* @throws {RequiredError}
|
|
36537
36640
|
*/
|
|
36538
|
-
listAllUserApps: (filters: string, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36641
|
+
listAllUserApps: (filters: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36539
36642
|
/**
|
|
36540
36643
|
* This API returns the list of source apps assigned for logged in user.
|
|
36541
36644
|
* @summary List assigned source apps
|
|
36542
36645
|
* @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.
|
|
36543
36646
|
* @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.
|
|
36647
|
+
* @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.
|
|
36544
36648
|
* @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, accountSource.id**
|
|
36545
36649
|
* @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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in*
|
|
36546
36650
|
* @param {*} [axiosOptions] Override http request option.
|
|
36547
36651
|
* @throws {RequiredError}
|
|
36548
36652
|
*/
|
|
36549
|
-
listAssignedSourceApp: (limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36653
|
+
listAssignedSourceApp: (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36550
36654
|
/**
|
|
36551
36655
|
* This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user.
|
|
36552
36656
|
* @summary List available accounts for user app
|
|
36553
36657
|
* @param {string} id ID of the user app
|
|
36554
36658
|
* @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.
|
|
36555
36659
|
* @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.
|
|
36660
|
+
* @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.
|
|
36556
36661
|
* @param {*} [axiosOptions] Override http request option.
|
|
36557
36662
|
* @throws {RequiredError}
|
|
36558
36663
|
*/
|
|
36559
|
-
listAvailableAccountsForUserApp: (id: string, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36664
|
+
listAvailableAccountsForUserApp: (id: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36560
36665
|
/**
|
|
36561
36666
|
* This API returns the list of source apps available for access request.
|
|
36562
36667
|
* @summary List available source apps
|
|
36563
36668
|
* @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.
|
|
36564
36669
|
* @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.
|
|
36670
|
+
* @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.
|
|
36565
36671
|
* @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, owner.id, accountSource.id**
|
|
36566
36672
|
* @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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in*
|
|
36567
36673
|
* @param {*} [axiosOptions] Override http request option.
|
|
36568
36674
|
* @throws {RequiredError}
|
|
36569
36675
|
*/
|
|
36570
|
-
listAvailableSourceApps: (limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36676
|
+
listAvailableSourceApps: (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36571
36677
|
/**
|
|
36572
36678
|
* This API returns the list of user apps assigned to logged in user
|
|
36573
36679
|
* @summary List owned user apps
|
|
36574
36680
|
* @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.
|
|
36575
36681
|
* @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.
|
|
36682
|
+
* @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.
|
|
36576
36683
|
* @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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq*
|
|
36577
36684
|
* @param {*} [axiosOptions] Override http request option.
|
|
36578
36685
|
* @throws {RequiredError}
|
|
36579
36686
|
*/
|
|
36580
|
-
listOwnedUserApps: (limit?: number, count?: boolean, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36687
|
+
listOwnedUserApps: (limit?: number, count?: boolean, offset?: number, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36581
36688
|
/**
|
|
36582
36689
|
* This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null.
|
|
36583
36690
|
* @summary Patch source app by ID
|
|
@@ -36649,74 +36756,81 @@ export declare const AppsBetaApiFp: (configuration?: Configuration) => {
|
|
|
36649
36756
|
* @summary List access profiles for the specified source app
|
|
36650
36757
|
* @param {string} id ID of the source app
|
|
36651
36758
|
* @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.
|
|
36759
|
+
* @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.
|
|
36652
36760
|
* @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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
|
|
36653
36761
|
* @param {*} [axiosOptions] Override http request option.
|
|
36654
36762
|
* @throws {RequiredError}
|
|
36655
36763
|
*/
|
|
36656
|
-
listAccessProfilesForSourceApp(id: string, limit?: number, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccessProfileDetailsBeta>>>;
|
|
36764
|
+
listAccessProfilesForSourceApp(id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccessProfileDetailsBeta>>>;
|
|
36657
36765
|
/**
|
|
36658
36766
|
* This API returns the list of all source apps for the org. A token with ORG_ADMIN authority is required to call this API.
|
|
36659
36767
|
* @summary List all source apps
|
|
36660
36768
|
* @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.
|
|
36661
36769
|
* @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.
|
|
36770
|
+
* @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.
|
|
36662
36771
|
* @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, owner.id, accountSource.id**
|
|
36663
36772
|
* @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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq*
|
|
36664
36773
|
* @param {*} [axiosOptions] Override http request option.
|
|
36665
36774
|
* @throws {RequiredError}
|
|
36666
36775
|
*/
|
|
36667
|
-
listAllSourceApp(limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SourceAppBeta>>>;
|
|
36776
|
+
listAllSourceApp(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SourceAppBeta>>>;
|
|
36668
36777
|
/**
|
|
36669
36778
|
* This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter.
|
|
36670
36779
|
* @summary List all user apps
|
|
36671
36780
|
* @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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq*
|
|
36672
36781
|
* @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.
|
|
36673
36782
|
* @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.
|
|
36783
|
+
* @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.
|
|
36674
36784
|
* @param {*} [axiosOptions] Override http request option.
|
|
36675
36785
|
* @throws {RequiredError}
|
|
36676
36786
|
*/
|
|
36677
|
-
listAllUserApps(filters: string, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserAppBeta>>>;
|
|
36787
|
+
listAllUserApps(filters: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserAppBeta>>>;
|
|
36678
36788
|
/**
|
|
36679
36789
|
* This API returns the list of source apps assigned for logged in user.
|
|
36680
36790
|
* @summary List assigned source apps
|
|
36681
36791
|
* @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.
|
|
36682
36792
|
* @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.
|
|
36793
|
+
* @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.
|
|
36683
36794
|
* @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, accountSource.id**
|
|
36684
36795
|
* @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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in*
|
|
36685
36796
|
* @param {*} [axiosOptions] Override http request option.
|
|
36686
36797
|
* @throws {RequiredError}
|
|
36687
36798
|
*/
|
|
36688
|
-
listAssignedSourceApp(limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SourceAppBeta>>>;
|
|
36799
|
+
listAssignedSourceApp(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SourceAppBeta>>>;
|
|
36689
36800
|
/**
|
|
36690
36801
|
* This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user.
|
|
36691
36802
|
* @summary List available accounts for user app
|
|
36692
36803
|
* @param {string} id ID of the user app
|
|
36693
36804
|
* @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.
|
|
36694
36805
|
* @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.
|
|
36806
|
+
* @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.
|
|
36695
36807
|
* @param {*} [axiosOptions] Override http request option.
|
|
36696
36808
|
* @throws {RequiredError}
|
|
36697
36809
|
*/
|
|
36698
|
-
listAvailableAccountsForUserApp(id: string, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AppAccountDetailsBeta>>>;
|
|
36810
|
+
listAvailableAccountsForUserApp(id: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AppAccountDetailsBeta>>>;
|
|
36699
36811
|
/**
|
|
36700
36812
|
* This API returns the list of source apps available for access request.
|
|
36701
36813
|
* @summary List available source apps
|
|
36702
36814
|
* @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.
|
|
36703
36815
|
* @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.
|
|
36816
|
+
* @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.
|
|
36704
36817
|
* @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, owner.id, accountSource.id**
|
|
36705
36818
|
* @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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in*
|
|
36706
36819
|
* @param {*} [axiosOptions] Override http request option.
|
|
36707
36820
|
* @throws {RequiredError}
|
|
36708
36821
|
*/
|
|
36709
|
-
listAvailableSourceApps(limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SourceAppBeta>>>;
|
|
36822
|
+
listAvailableSourceApps(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SourceAppBeta>>>;
|
|
36710
36823
|
/**
|
|
36711
36824
|
* This API returns the list of user apps assigned to logged in user
|
|
36712
36825
|
* @summary List owned user apps
|
|
36713
36826
|
* @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.
|
|
36714
36827
|
* @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.
|
|
36828
|
+
* @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.
|
|
36715
36829
|
* @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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq*
|
|
36716
36830
|
* @param {*} [axiosOptions] Override http request option.
|
|
36717
36831
|
* @throws {RequiredError}
|
|
36718
36832
|
*/
|
|
36719
|
-
listOwnedUserApps(limit?: number, count?: boolean, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserAppBeta>>>;
|
|
36833
|
+
listOwnedUserApps(limit?: number, count?: boolean, offset?: number, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserAppBeta>>>;
|
|
36720
36834
|
/**
|
|
36721
36835
|
* This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null.
|
|
36722
36836
|
* @summary Patch source app by ID
|
|
@@ -36788,74 +36902,81 @@ export declare const AppsBetaApiFactory: (configuration?: Configuration, basePat
|
|
|
36788
36902
|
* @summary List access profiles for the specified source app
|
|
36789
36903
|
* @param {string} id ID of the source app
|
|
36790
36904
|
* @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.
|
|
36905
|
+
* @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.
|
|
36791
36906
|
* @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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
|
|
36792
36907
|
* @param {*} [axiosOptions] Override http request option.
|
|
36793
36908
|
* @throws {RequiredError}
|
|
36794
36909
|
*/
|
|
36795
|
-
listAccessProfilesForSourceApp(id: string, limit?: number, filters?: string, axiosOptions?: any): AxiosPromise<Array<AccessProfileDetailsBeta>>;
|
|
36910
|
+
listAccessProfilesForSourceApp(id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: any): AxiosPromise<Array<AccessProfileDetailsBeta>>;
|
|
36796
36911
|
/**
|
|
36797
36912
|
* This API returns the list of all source apps for the org. A token with ORG_ADMIN authority is required to call this API.
|
|
36798
36913
|
* @summary List all source apps
|
|
36799
36914
|
* @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.
|
|
36800
36915
|
* @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.
|
|
36916
|
+
* @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.
|
|
36801
36917
|
* @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, owner.id, accountSource.id**
|
|
36802
36918
|
* @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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq*
|
|
36803
36919
|
* @param {*} [axiosOptions] Override http request option.
|
|
36804
36920
|
* @throws {RequiredError}
|
|
36805
36921
|
*/
|
|
36806
|
-
listAllSourceApp(limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<SourceAppBeta>>;
|
|
36922
|
+
listAllSourceApp(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<SourceAppBeta>>;
|
|
36807
36923
|
/**
|
|
36808
36924
|
* This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter.
|
|
36809
36925
|
* @summary List all user apps
|
|
36810
36926
|
* @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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq*
|
|
36811
36927
|
* @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.
|
|
36812
36928
|
* @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.
|
|
36929
|
+
* @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.
|
|
36813
36930
|
* @param {*} [axiosOptions] Override http request option.
|
|
36814
36931
|
* @throws {RequiredError}
|
|
36815
36932
|
*/
|
|
36816
|
-
listAllUserApps(filters: string, limit?: number, count?: boolean, axiosOptions?: any): AxiosPromise<Array<UserAppBeta>>;
|
|
36933
|
+
listAllUserApps(filters: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: any): AxiosPromise<Array<UserAppBeta>>;
|
|
36817
36934
|
/**
|
|
36818
36935
|
* This API returns the list of source apps assigned for logged in user.
|
|
36819
36936
|
* @summary List assigned source apps
|
|
36820
36937
|
* @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.
|
|
36821
36938
|
* @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.
|
|
36939
|
+
* @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.
|
|
36822
36940
|
* @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, accountSource.id**
|
|
36823
36941
|
* @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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in*
|
|
36824
36942
|
* @param {*} [axiosOptions] Override http request option.
|
|
36825
36943
|
* @throws {RequiredError}
|
|
36826
36944
|
*/
|
|
36827
|
-
listAssignedSourceApp(limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<SourceAppBeta>>;
|
|
36945
|
+
listAssignedSourceApp(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<SourceAppBeta>>;
|
|
36828
36946
|
/**
|
|
36829
36947
|
* This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user.
|
|
36830
36948
|
* @summary List available accounts for user app
|
|
36831
36949
|
* @param {string} id ID of the user app
|
|
36832
36950
|
* @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.
|
|
36833
36951
|
* @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.
|
|
36952
|
+
* @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.
|
|
36834
36953
|
* @param {*} [axiosOptions] Override http request option.
|
|
36835
36954
|
* @throws {RequiredError}
|
|
36836
36955
|
*/
|
|
36837
|
-
listAvailableAccountsForUserApp(id: string, limit?: number, count?: boolean, axiosOptions?: any): AxiosPromise<Array<AppAccountDetailsBeta>>;
|
|
36956
|
+
listAvailableAccountsForUserApp(id: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: any): AxiosPromise<Array<AppAccountDetailsBeta>>;
|
|
36838
36957
|
/**
|
|
36839
36958
|
* This API returns the list of source apps available for access request.
|
|
36840
36959
|
* @summary List available source apps
|
|
36841
36960
|
* @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.
|
|
36842
36961
|
* @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.
|
|
36962
|
+
* @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.
|
|
36843
36963
|
* @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, owner.id, accountSource.id**
|
|
36844
36964
|
* @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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in*
|
|
36845
36965
|
* @param {*} [axiosOptions] Override http request option.
|
|
36846
36966
|
* @throws {RequiredError}
|
|
36847
36967
|
*/
|
|
36848
|
-
listAvailableSourceApps(limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<SourceAppBeta>>;
|
|
36968
|
+
listAvailableSourceApps(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<SourceAppBeta>>;
|
|
36849
36969
|
/**
|
|
36850
36970
|
* This API returns the list of user apps assigned to logged in user
|
|
36851
36971
|
* @summary List owned user apps
|
|
36852
36972
|
* @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.
|
|
36853
36973
|
* @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.
|
|
36974
|
+
* @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.
|
|
36854
36975
|
* @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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq*
|
|
36855
36976
|
* @param {*} [axiosOptions] Override http request option.
|
|
36856
36977
|
* @throws {RequiredError}
|
|
36857
36978
|
*/
|
|
36858
|
-
listOwnedUserApps(limit?: number, count?: boolean, filters?: string, axiosOptions?: any): AxiosPromise<Array<UserAppBeta>>;
|
|
36979
|
+
listOwnedUserApps(limit?: number, count?: boolean, offset?: number, filters?: string, axiosOptions?: any): AxiosPromise<Array<UserAppBeta>>;
|
|
36859
36980
|
/**
|
|
36860
36981
|
* This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null.
|
|
36861
36982
|
* @summary Patch source app by ID
|
|
@@ -36965,6 +37086,12 @@ export interface AppsBetaApiListAccessProfilesForSourceAppRequest {
|
|
|
36965
37086
|
* @memberof AppsBetaApiListAccessProfilesForSourceApp
|
|
36966
37087
|
*/
|
|
36967
37088
|
readonly limit?: number;
|
|
37089
|
+
/**
|
|
37090
|
+
* 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.
|
|
37091
|
+
* @type {number}
|
|
37092
|
+
* @memberof AppsBetaApiListAccessProfilesForSourceApp
|
|
37093
|
+
*/
|
|
37094
|
+
readonly offset?: number;
|
|
36968
37095
|
/**
|
|
36969
37096
|
* 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
|
|
36970
37097
|
* @type {string}
|
|
@@ -36990,6 +37117,12 @@ export interface AppsBetaApiListAllSourceAppRequest {
|
|
|
36990
37117
|
* @memberof AppsBetaApiListAllSourceApp
|
|
36991
37118
|
*/
|
|
36992
37119
|
readonly count?: boolean;
|
|
37120
|
+
/**
|
|
37121
|
+
* 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.
|
|
37122
|
+
* @type {number}
|
|
37123
|
+
* @memberof AppsBetaApiListAllSourceApp
|
|
37124
|
+
*/
|
|
37125
|
+
readonly offset?: number;
|
|
36993
37126
|
/**
|
|
36994
37127
|
* 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, owner.id, accountSource.id**
|
|
36995
37128
|
* @type {string}
|
|
@@ -37027,6 +37160,12 @@ export interface AppsBetaApiListAllUserAppsRequest {
|
|
|
37027
37160
|
* @memberof AppsBetaApiListAllUserApps
|
|
37028
37161
|
*/
|
|
37029
37162
|
readonly count?: boolean;
|
|
37163
|
+
/**
|
|
37164
|
+
* 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.
|
|
37165
|
+
* @type {number}
|
|
37166
|
+
* @memberof AppsBetaApiListAllUserApps
|
|
37167
|
+
*/
|
|
37168
|
+
readonly offset?: number;
|
|
37030
37169
|
}
|
|
37031
37170
|
/**
|
|
37032
37171
|
* Request parameters for listAssignedSourceApp operation in AppsBetaApi.
|
|
@@ -37046,6 +37185,12 @@ export interface AppsBetaApiListAssignedSourceAppRequest {
|
|
|
37046
37185
|
* @memberof AppsBetaApiListAssignedSourceApp
|
|
37047
37186
|
*/
|
|
37048
37187
|
readonly count?: boolean;
|
|
37188
|
+
/**
|
|
37189
|
+
* 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.
|
|
37190
|
+
* @type {number}
|
|
37191
|
+
* @memberof AppsBetaApiListAssignedSourceApp
|
|
37192
|
+
*/
|
|
37193
|
+
readonly offset?: number;
|
|
37049
37194
|
/**
|
|
37050
37195
|
* 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, accountSource.id**
|
|
37051
37196
|
* @type {string}
|
|
@@ -37083,6 +37228,12 @@ export interface AppsBetaApiListAvailableAccountsForUserAppRequest {
|
|
|
37083
37228
|
* @memberof AppsBetaApiListAvailableAccountsForUserApp
|
|
37084
37229
|
*/
|
|
37085
37230
|
readonly count?: boolean;
|
|
37231
|
+
/**
|
|
37232
|
+
* 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.
|
|
37233
|
+
* @type {number}
|
|
37234
|
+
* @memberof AppsBetaApiListAvailableAccountsForUserApp
|
|
37235
|
+
*/
|
|
37236
|
+
readonly offset?: number;
|
|
37086
37237
|
}
|
|
37087
37238
|
/**
|
|
37088
37239
|
* Request parameters for listAvailableSourceApps operation in AppsBetaApi.
|
|
@@ -37102,6 +37253,12 @@ export interface AppsBetaApiListAvailableSourceAppsRequest {
|
|
|
37102
37253
|
* @memberof AppsBetaApiListAvailableSourceApps
|
|
37103
37254
|
*/
|
|
37104
37255
|
readonly count?: boolean;
|
|
37256
|
+
/**
|
|
37257
|
+
* 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.
|
|
37258
|
+
* @type {number}
|
|
37259
|
+
* @memberof AppsBetaApiListAvailableSourceApps
|
|
37260
|
+
*/
|
|
37261
|
+
readonly offset?: number;
|
|
37105
37262
|
/**
|
|
37106
37263
|
* 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, owner.id, accountSource.id**
|
|
37107
37264
|
* @type {string}
|
|
@@ -37133,6 +37290,12 @@ export interface AppsBetaApiListOwnedUserAppsRequest {
|
|
|
37133
37290
|
* @memberof AppsBetaApiListOwnedUserApps
|
|
37134
37291
|
*/
|
|
37135
37292
|
readonly count?: boolean;
|
|
37293
|
+
/**
|
|
37294
|
+
* 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.
|
|
37295
|
+
* @type {number}
|
|
37296
|
+
* @memberof AppsBetaApiListOwnedUserApps
|
|
37297
|
+
*/
|
|
37298
|
+
readonly offset?: number;
|
|
37136
37299
|
/**
|
|
37137
37300
|
* 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq*
|
|
37138
37301
|
* @type {string}
|
|
@@ -39393,8 +39556,8 @@ export declare class ConnectorRuleManagementBetaApi extends BaseAPI {
|
|
|
39393
39556
|
*/
|
|
39394
39557
|
export declare const ConnectorsBetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
39395
39558
|
/**
|
|
39396
|
-
* Fetches list of connectors that have \'RELEASED\' status using filtering and pagination.
|
|
39397
|
-
* @summary
|
|
39559
|
+
* Fetches list of connectors that have \'RELEASED\' status using filtering and pagination.
|
|
39560
|
+
* @summary Get Connector List
|
|
39398
39561
|
* @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: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca*
|
|
39399
39562
|
* @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.
|
|
39400
39563
|
* @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.
|
|
@@ -39411,8 +39574,8 @@ export declare const ConnectorsBetaApiAxiosParamCreator: (configuration?: Config
|
|
|
39411
39574
|
*/
|
|
39412
39575
|
export declare const ConnectorsBetaApiFp: (configuration?: Configuration) => {
|
|
39413
39576
|
/**
|
|
39414
|
-
* Fetches list of connectors that have \'RELEASED\' status using filtering and pagination.
|
|
39415
|
-
* @summary
|
|
39577
|
+
* Fetches list of connectors that have \'RELEASED\' status using filtering and pagination.
|
|
39578
|
+
* @summary Get Connector List
|
|
39416
39579
|
* @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: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca*
|
|
39417
39580
|
* @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.
|
|
39418
39581
|
* @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.
|
|
@@ -39429,8 +39592,8 @@ export declare const ConnectorsBetaApiFp: (configuration?: Configuration) => {
|
|
|
39429
39592
|
*/
|
|
39430
39593
|
export declare const ConnectorsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
39431
39594
|
/**
|
|
39432
|
-
* Fetches list of connectors that have \'RELEASED\' status using filtering and pagination.
|
|
39433
|
-
* @summary
|
|
39595
|
+
* Fetches list of connectors that have \'RELEASED\' status using filtering and pagination.
|
|
39596
|
+
* @summary Get Connector List
|
|
39434
39597
|
* @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: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca*
|
|
39435
39598
|
* @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.
|
|
39436
39599
|
* @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.
|
|
@@ -39486,8 +39649,8 @@ export interface ConnectorsBetaApiGetConnectorListRequest {
|
|
|
39486
39649
|
*/
|
|
39487
39650
|
export declare class ConnectorsBetaApi extends BaseAPI {
|
|
39488
39651
|
/**
|
|
39489
|
-
* Fetches list of connectors that have \'RELEASED\' status using filtering and pagination.
|
|
39490
|
-
* @summary
|
|
39652
|
+
* Fetches list of connectors that have \'RELEASED\' status using filtering and pagination.
|
|
39653
|
+
* @summary Get Connector List
|
|
39491
39654
|
* @param {ConnectorsBetaApiGetConnectorListRequest} requestParameters Request parameters.
|
|
39492
39655
|
* @param {*} [axiosOptions] Override http request option.
|
|
39493
39656
|
* @throws {RequiredError}
|
|
@@ -40842,7 +41005,7 @@ export declare const EntitlementsBetaApiAxiosParamCreator: (configuration?: Conf
|
|
|
40842
41005
|
*/
|
|
40843
41006
|
putEntitlementRequestConfig: (id: string, entitlementRequestConfigBeta: EntitlementRequestConfigBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40844
41007
|
/**
|
|
40845
|
-
*
|
|
41008
|
+
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`.
|
|
40846
41009
|
* @summary Reset Source Entitlements
|
|
40847
41010
|
* @param {string} id ID of source for the entitlement reset
|
|
40848
41011
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -40850,7 +41013,7 @@ export declare const EntitlementsBetaApiAxiosParamCreator: (configuration?: Conf
|
|
|
40850
41013
|
*/
|
|
40851
41014
|
resetSourceEntitlements: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40852
41015
|
/**
|
|
40853
|
-
* This API applies an update to every entitlement of the list.
|
|
41016
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
40854
41017
|
* @summary Bulk update an entitlement list
|
|
40855
41018
|
* @param {EntitlementBulkUpdateRequestBeta} entitlementBulkUpdateRequestBeta
|
|
40856
41019
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -40970,7 +41133,7 @@ export declare const EntitlementsBetaApiFp: (configuration?: Configuration) => {
|
|
|
40970
41133
|
*/
|
|
40971
41134
|
putEntitlementRequestConfig(id: string, entitlementRequestConfigBeta: EntitlementRequestConfigBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementRequestConfigBeta>>;
|
|
40972
41135
|
/**
|
|
40973
|
-
*
|
|
41136
|
+
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`.
|
|
40974
41137
|
* @summary Reset Source Entitlements
|
|
40975
41138
|
* @param {string} id ID of source for the entitlement reset
|
|
40976
41139
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -40978,7 +41141,7 @@ export declare const EntitlementsBetaApiFp: (configuration?: Configuration) => {
|
|
|
40978
41141
|
*/
|
|
40979
41142
|
resetSourceEntitlements(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementSourceResetBaseReferenceDtoBeta>>;
|
|
40980
41143
|
/**
|
|
40981
|
-
* This API applies an update to every entitlement of the list.
|
|
41144
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
40982
41145
|
* @summary Bulk update an entitlement list
|
|
40983
41146
|
* @param {EntitlementBulkUpdateRequestBeta} entitlementBulkUpdateRequestBeta
|
|
40984
41147
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -41098,7 +41261,7 @@ export declare const EntitlementsBetaApiFactory: (configuration?: Configuration,
|
|
|
41098
41261
|
*/
|
|
41099
41262
|
putEntitlementRequestConfig(id: string, entitlementRequestConfigBeta: EntitlementRequestConfigBeta, axiosOptions?: any): AxiosPromise<EntitlementRequestConfigBeta>;
|
|
41100
41263
|
/**
|
|
41101
|
-
*
|
|
41264
|
+
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`.
|
|
41102
41265
|
* @summary Reset Source Entitlements
|
|
41103
41266
|
* @param {string} id ID of source for the entitlement reset
|
|
41104
41267
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -41106,7 +41269,7 @@ export declare const EntitlementsBetaApiFactory: (configuration?: Configuration,
|
|
|
41106
41269
|
*/
|
|
41107
41270
|
resetSourceEntitlements(id: string, axiosOptions?: any): AxiosPromise<EntitlementSourceResetBaseReferenceDtoBeta>;
|
|
41108
41271
|
/**
|
|
41109
|
-
* This API applies an update to every entitlement of the list.
|
|
41272
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
41110
41273
|
* @summary Bulk update an entitlement list
|
|
41111
41274
|
* @param {EntitlementBulkUpdateRequestBeta} entitlementBulkUpdateRequestBeta
|
|
41112
41275
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -41519,7 +41682,7 @@ export declare class EntitlementsBetaApi extends BaseAPI {
|
|
|
41519
41682
|
*/
|
|
41520
41683
|
putEntitlementRequestConfig(requestParameters: EntitlementsBetaApiPutEntitlementRequestConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementRequestConfigBeta, any>>;
|
|
41521
41684
|
/**
|
|
41522
|
-
*
|
|
41685
|
+
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`.
|
|
41523
41686
|
* @summary Reset Source Entitlements
|
|
41524
41687
|
* @param {EntitlementsBetaApiResetSourceEntitlementsRequest} requestParameters Request parameters.
|
|
41525
41688
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -41528,7 +41691,7 @@ export declare class EntitlementsBetaApi extends BaseAPI {
|
|
|
41528
41691
|
*/
|
|
41529
41692
|
resetSourceEntitlements(requestParameters: EntitlementsBetaApiResetSourceEntitlementsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementSourceResetBaseReferenceDtoBeta, any>>;
|
|
41530
41693
|
/**
|
|
41531
|
-
* This API applies an update to every entitlement of the list.
|
|
41694
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
41532
41695
|
* @summary Bulk update an entitlement list
|
|
41533
41696
|
* @param {EntitlementsBetaApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters.
|
|
41534
41697
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -45883,15 +46046,16 @@ export declare const IdentitiesBetaApiAxiosParamCreator: (configuration?: Config
|
|
|
45883
46046
|
*/
|
|
45884
46047
|
resetIdentity: (identityId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45885
46048
|
/**
|
|
45886
|
-
* This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours.
|
|
46049
|
+
* This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours.
|
|
45887
46050
|
* @summary Send password reset email
|
|
46051
|
+
* @param {string} id Identity ID
|
|
45888
46052
|
* @param {SendAccountVerificationRequestBeta} sendAccountVerificationRequestBeta
|
|
45889
46053
|
* @param {*} [axiosOptions] Override http request option.
|
|
45890
46054
|
* @throws {RequiredError}
|
|
45891
46055
|
*/
|
|
45892
|
-
sendIdentityVerificationAccountToken: (sendAccountVerificationRequestBeta: SendAccountVerificationRequestBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46056
|
+
sendIdentityVerificationAccountToken: (id: string, sendAccountVerificationRequestBeta: SendAccountVerificationRequestBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45893
46057
|
/**
|
|
45894
|
-
* This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status)
|
|
46058
|
+
* This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status).
|
|
45895
46059
|
* @summary Invite identities to register
|
|
45896
46060
|
* @param {InviteIdentitiesRequestBeta} inviteIdentitiesRequestBeta
|
|
45897
46061
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -45985,15 +46149,16 @@ export declare const IdentitiesBetaApiFp: (configuration?: Configuration) => {
|
|
|
45985
46149
|
*/
|
|
45986
46150
|
resetIdentity(identityId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
45987
46151
|
/**
|
|
45988
|
-
* This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours.
|
|
46152
|
+
* This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours.
|
|
45989
46153
|
* @summary Send password reset email
|
|
46154
|
+
* @param {string} id Identity ID
|
|
45990
46155
|
* @param {SendAccountVerificationRequestBeta} sendAccountVerificationRequestBeta
|
|
45991
46156
|
* @param {*} [axiosOptions] Override http request option.
|
|
45992
46157
|
* @throws {RequiredError}
|
|
45993
46158
|
*/
|
|
45994
|
-
sendIdentityVerificationAccountToken(sendAccountVerificationRequestBeta: SendAccountVerificationRequestBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
46159
|
+
sendIdentityVerificationAccountToken(id: string, sendAccountVerificationRequestBeta: SendAccountVerificationRequestBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
45995
46160
|
/**
|
|
45996
|
-
* This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status)
|
|
46161
|
+
* This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status).
|
|
45997
46162
|
* @summary Invite identities to register
|
|
45998
46163
|
* @param {InviteIdentitiesRequestBeta} inviteIdentitiesRequestBeta
|
|
45999
46164
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -46087,15 +46252,16 @@ export declare const IdentitiesBetaApiFactory: (configuration?: Configuration, b
|
|
|
46087
46252
|
*/
|
|
46088
46253
|
resetIdentity(identityId: string, axiosOptions?: any): AxiosPromise<void>;
|
|
46089
46254
|
/**
|
|
46090
|
-
* This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours.
|
|
46255
|
+
* This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours.
|
|
46091
46256
|
* @summary Send password reset email
|
|
46257
|
+
* @param {string} id Identity ID
|
|
46092
46258
|
* @param {SendAccountVerificationRequestBeta} sendAccountVerificationRequestBeta
|
|
46093
46259
|
* @param {*} [axiosOptions] Override http request option.
|
|
46094
46260
|
* @throws {RequiredError}
|
|
46095
46261
|
*/
|
|
46096
|
-
sendIdentityVerificationAccountToken(sendAccountVerificationRequestBeta: SendAccountVerificationRequestBeta, axiosOptions?: any): AxiosPromise<void>;
|
|
46262
|
+
sendIdentityVerificationAccountToken(id: string, sendAccountVerificationRequestBeta: SendAccountVerificationRequestBeta, axiosOptions?: any): AxiosPromise<void>;
|
|
46097
46263
|
/**
|
|
46098
|
-
* This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status)
|
|
46264
|
+
* This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status).
|
|
46099
46265
|
* @summary Invite identities to register
|
|
46100
46266
|
* @param {InviteIdentitiesRequestBeta} inviteIdentitiesRequestBeta
|
|
46101
46267
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -46264,6 +46430,12 @@ export interface IdentitiesBetaApiResetIdentityRequest {
|
|
|
46264
46430
|
* @interface IdentitiesBetaApiSendIdentityVerificationAccountTokenRequest
|
|
46265
46431
|
*/
|
|
46266
46432
|
export interface IdentitiesBetaApiSendIdentityVerificationAccountTokenRequest {
|
|
46433
|
+
/**
|
|
46434
|
+
* Identity ID
|
|
46435
|
+
* @type {string}
|
|
46436
|
+
* @memberof IdentitiesBetaApiSendIdentityVerificationAccountToken
|
|
46437
|
+
*/
|
|
46438
|
+
readonly id: string;
|
|
46267
46439
|
/**
|
|
46268
46440
|
*
|
|
46269
46441
|
* @type {SendAccountVerificationRequestBeta}
|
|
@@ -46381,7 +46553,7 @@ export declare class IdentitiesBetaApi extends BaseAPI {
|
|
|
46381
46553
|
*/
|
|
46382
46554
|
resetIdentity(requestParameters: IdentitiesBetaApiResetIdentityRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
46383
46555
|
/**
|
|
46384
|
-
* This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours.
|
|
46556
|
+
* This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours.
|
|
46385
46557
|
* @summary Send password reset email
|
|
46386
46558
|
* @param {IdentitiesBetaApiSendIdentityVerificationAccountTokenRequest} requestParameters Request parameters.
|
|
46387
46559
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -46390,7 +46562,7 @@ export declare class IdentitiesBetaApi extends BaseAPI {
|
|
|
46390
46562
|
*/
|
|
46391
46563
|
sendIdentityVerificationAccountToken(requestParameters: IdentitiesBetaApiSendIdentityVerificationAccountTokenRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
46392
46564
|
/**
|
|
46393
|
-
* This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status)
|
|
46565
|
+
* This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status).
|
|
46394
46566
|
* @summary Invite identities to register
|
|
46395
46567
|
* @param {IdentitiesBetaApiStartIdentitiesInviteRequest} requestParameters Request parameters.
|
|
46396
46568
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -46855,17 +47027,20 @@ export declare const IdentityHistoryBetaApiAxiosParamCreator: (configuration?: C
|
|
|
46855
47027
|
*/
|
|
46856
47028
|
listHistoricalIdentities: (startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46857
47029
|
/**
|
|
46858
|
-
* This method retrieves a list of access item for the identity filtered by the access item type
|
|
46859
|
-
* @summary
|
|
47030
|
+
* This method retrieves a list of access item for the identity filtered by the access item type
|
|
47031
|
+
* @summary List Access Items by Identity
|
|
46860
47032
|
* @param {string} id The identity id
|
|
46861
47033
|
* @param {string} [type] The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role**
|
|
46862
47034
|
* @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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq*
|
|
46863
47035
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount**
|
|
46864
47036
|
* @param {string} [query] This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description**
|
|
47037
|
+
* @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.
|
|
47038
|
+
* @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.
|
|
47039
|
+
* @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.
|
|
46865
47040
|
* @param {*} [axiosOptions] Override http request option.
|
|
46866
47041
|
* @throws {RequiredError}
|
|
46867
47042
|
*/
|
|
46868
|
-
listIdentityAccessItems: (id: string, type?: string, filters?: string, sorters?: string, query?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47043
|
+
listIdentityAccessItems: (id: string, type?: string, filters?: string, sorters?: string, query?: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46869
47044
|
/**
|
|
46870
47045
|
* Use this API to get a list of identity access items at a specified date, filtered by item type.
|
|
46871
47046
|
* @summary Get Identity Access Items Snapshot
|
|
@@ -46990,17 +47165,20 @@ export declare const IdentityHistoryBetaApiFp: (configuration?: Configuration) =
|
|
|
46990
47165
|
*/
|
|
46991
47166
|
listHistoricalIdentities(startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IdentityListItemBeta>>>;
|
|
46992
47167
|
/**
|
|
46993
|
-
* This method retrieves a list of access item for the identity filtered by the access item type
|
|
46994
|
-
* @summary
|
|
47168
|
+
* This method retrieves a list of access item for the identity filtered by the access item type
|
|
47169
|
+
* @summary List Access Items by Identity
|
|
46995
47170
|
* @param {string} id The identity id
|
|
46996
47171
|
* @param {string} [type] The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role**
|
|
46997
47172
|
* @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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq*
|
|
46998
47173
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount**
|
|
46999
47174
|
* @param {string} [query] This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description**
|
|
47175
|
+
* @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.
|
|
47176
|
+
* @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.
|
|
47177
|
+
* @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.
|
|
47000
47178
|
* @param {*} [axiosOptions] Override http request option.
|
|
47001
47179
|
* @throws {RequiredError}
|
|
47002
47180
|
*/
|
|
47003
|
-
listIdentityAccessItems(id: string, type?: string, filters?: string, sorters?: string, query?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListIdentityAccessItems200ResponseInnerBeta>>>;
|
|
47181
|
+
listIdentityAccessItems(id: string, type?: string, filters?: string, sorters?: string, query?: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListIdentityAccessItems200ResponseInnerBeta>>>;
|
|
47004
47182
|
/**
|
|
47005
47183
|
* Use this API to get a list of identity access items at a specified date, filtered by item type.
|
|
47006
47184
|
* @summary Get Identity Access Items Snapshot
|
|
@@ -47125,17 +47303,20 @@ export declare const IdentityHistoryBetaApiFactory: (configuration?: Configurati
|
|
|
47125
47303
|
*/
|
|
47126
47304
|
listHistoricalIdentities(startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, axiosOptions?: any): AxiosPromise<Array<IdentityListItemBeta>>;
|
|
47127
47305
|
/**
|
|
47128
|
-
* This method retrieves a list of access item for the identity filtered by the access item type
|
|
47129
|
-
* @summary
|
|
47306
|
+
* This method retrieves a list of access item for the identity filtered by the access item type
|
|
47307
|
+
* @summary List Access Items by Identity
|
|
47130
47308
|
* @param {string} id The identity id
|
|
47131
47309
|
* @param {string} [type] The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role**
|
|
47132
47310
|
* @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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq*
|
|
47133
47311
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount**
|
|
47134
47312
|
* @param {string} [query] This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description**
|
|
47313
|
+
* @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.
|
|
47314
|
+
* @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.
|
|
47315
|
+
* @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.
|
|
47135
47316
|
* @param {*} [axiosOptions] Override http request option.
|
|
47136
47317
|
* @throws {RequiredError}
|
|
47137
47318
|
*/
|
|
47138
|
-
listIdentityAccessItems(id: string, type?: string, filters?: string, sorters?: string, query?: string, axiosOptions?: any): AxiosPromise<Array<ListIdentityAccessItems200ResponseInnerBeta>>;
|
|
47319
|
+
listIdentityAccessItems(id: string, type?: string, filters?: string, sorters?: string, query?: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: any): AxiosPromise<Array<ListIdentityAccessItems200ResponseInnerBeta>>;
|
|
47139
47320
|
/**
|
|
47140
47321
|
* Use this API to get a list of identity access items at a specified date, filtered by item type.
|
|
47141
47322
|
* @summary Get Identity Access Items Snapshot
|
|
@@ -47480,6 +47661,24 @@ export interface IdentityHistoryBetaApiListIdentityAccessItemsRequest {
|
|
|
47480
47661
|
* @memberof IdentityHistoryBetaApiListIdentityAccessItems
|
|
47481
47662
|
*/
|
|
47482
47663
|
readonly query?: string;
|
|
47664
|
+
/**
|
|
47665
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
47666
|
+
* @type {number}
|
|
47667
|
+
* @memberof IdentityHistoryBetaApiListIdentityAccessItems
|
|
47668
|
+
*/
|
|
47669
|
+
readonly limit?: number;
|
|
47670
|
+
/**
|
|
47671
|
+
* 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.
|
|
47672
|
+
* @type {boolean}
|
|
47673
|
+
* @memberof IdentityHistoryBetaApiListIdentityAccessItems
|
|
47674
|
+
*/
|
|
47675
|
+
readonly count?: boolean;
|
|
47676
|
+
/**
|
|
47677
|
+
* 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.
|
|
47678
|
+
* @type {number}
|
|
47679
|
+
* @memberof IdentityHistoryBetaApiListIdentityAccessItems
|
|
47680
|
+
*/
|
|
47681
|
+
readonly offset?: number;
|
|
47483
47682
|
}
|
|
47484
47683
|
/**
|
|
47485
47684
|
* Request parameters for listIdentitySnapshotAccessItems operation in IdentityHistoryBetaApi.
|
|
@@ -47629,8 +47828,8 @@ export declare class IdentityHistoryBetaApi extends BaseAPI {
|
|
|
47629
47828
|
*/
|
|
47630
47829
|
listHistoricalIdentities(requestParameters?: IdentityHistoryBetaApiListHistoricalIdentitiesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityListItemBeta[], any>>;
|
|
47631
47830
|
/**
|
|
47632
|
-
* This method retrieves a list of access item for the identity filtered by the access item type
|
|
47633
|
-
* @summary
|
|
47831
|
+
* This method retrieves a list of access item for the identity filtered by the access item type
|
|
47832
|
+
* @summary List Access Items by Identity
|
|
47634
47833
|
* @param {IdentityHistoryBetaApiListIdentityAccessItemsRequest} requestParameters Request parameters.
|
|
47635
47834
|
* @param {*} [axiosOptions] Override http request option.
|
|
47636
47835
|
* @throws {RequiredError}
|
|
@@ -55578,7 +55777,7 @@ export declare const RolesBetaApiAxiosParamCreator: (configuration?: Configurati
|
|
|
55578
55777
|
*/
|
|
55579
55778
|
listRoles: (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55580
55779
|
/**
|
|
55581
|
-
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
55780
|
+
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
55582
55781
|
* @summary Patch a specified Role
|
|
55583
55782
|
* @param {string} id ID of the Role to patch
|
|
55584
55783
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta
|
|
@@ -55666,7 +55865,7 @@ export declare const RolesBetaApiFp: (configuration?: Configuration) => {
|
|
|
55666
55865
|
*/
|
|
55667
55866
|
listRoles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RoleBeta>>>;
|
|
55668
55867
|
/**
|
|
55669
|
-
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
55868
|
+
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
55670
55869
|
* @summary Patch a specified Role
|
|
55671
55870
|
* @param {string} id ID of the Role to patch
|
|
55672
55871
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta
|
|
@@ -55754,7 +55953,7 @@ export declare const RolesBetaApiFactory: (configuration?: Configuration, basePa
|
|
|
55754
55953
|
*/
|
|
55755
55954
|
listRoles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: any): AxiosPromise<Array<RoleBeta>>;
|
|
55756
55955
|
/**
|
|
55757
|
-
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
55956
|
+
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
55758
55957
|
* @summary Patch a specified Role
|
|
55759
55958
|
* @param {string} id ID of the Role to patch
|
|
55760
55959
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta
|
|
@@ -56046,7 +56245,7 @@ export declare class RolesBetaApi extends BaseAPI {
|
|
|
56046
56245
|
*/
|
|
56047
56246
|
listRoles(requestParameters?: RolesBetaApiListRolesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleBeta[], any>>;
|
|
56048
56247
|
/**
|
|
56049
|
-
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
56248
|
+
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
56050
56249
|
* @summary Patch a specified Role
|
|
56051
56250
|
* @param {RolesBetaApiPatchRoleRequest} requestParameters Request parameters.
|
|
56052
56251
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57417,7 +57616,7 @@ export declare const SPConfigBetaApiAxiosParamCreator: (configuration?: Configur
|
|
|
57417
57616
|
*/
|
|
57418
57617
|
getSpConfigImport: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57419
57618
|
/**
|
|
57420
|
-
* This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
|
57619
|
+
* This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
|
57421
57620
|
* @summary Get import job status
|
|
57422
57621
|
* @param {string} id The ID of the import job whose status will be returned.
|
|
57423
57622
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57425,7 +57624,7 @@ export declare const SPConfigBetaApiAxiosParamCreator: (configuration?: Configur
|
|
|
57425
57624
|
*/
|
|
57426
57625
|
getSpConfigImportStatus: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57427
57626
|
/**
|
|
57428
|
-
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the
|
|
57627
|
+
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
|
57429
57628
|
* @summary Initiates configuration objects import job
|
|
57430
57629
|
* @param {any} data JSON file containing the objects to be imported.
|
|
57431
57630
|
* @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.
|
|
@@ -57480,7 +57679,7 @@ export declare const SPConfigBetaApiFp: (configuration?: Configuration) => {
|
|
|
57480
57679
|
*/
|
|
57481
57680
|
getSpConfigImport(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SpConfigImportResultsBeta>>;
|
|
57482
57681
|
/**
|
|
57483
|
-
* This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
|
57682
|
+
* This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
|
57484
57683
|
* @summary Get import job status
|
|
57485
57684
|
* @param {string} id The ID of the import job whose status will be returned.
|
|
57486
57685
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57488,7 +57687,7 @@ export declare const SPConfigBetaApiFp: (configuration?: Configuration) => {
|
|
|
57488
57687
|
*/
|
|
57489
57688
|
getSpConfigImportStatus(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SpConfigImportJobStatusBeta>>;
|
|
57490
57689
|
/**
|
|
57491
|
-
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the
|
|
57690
|
+
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
|
57492
57691
|
* @summary Initiates configuration objects import job
|
|
57493
57692
|
* @param {any} data JSON file containing the objects to be imported.
|
|
57494
57693
|
* @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.
|
|
@@ -57543,7 +57742,7 @@ export declare const SPConfigBetaApiFactory: (configuration?: Configuration, bas
|
|
|
57543
57742
|
*/
|
|
57544
57743
|
getSpConfigImport(id: string, axiosOptions?: any): AxiosPromise<SpConfigImportResultsBeta>;
|
|
57545
57744
|
/**
|
|
57546
|
-
* This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
|
57745
|
+
* This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
|
57547
57746
|
* @summary Get import job status
|
|
57548
57747
|
* @param {string} id The ID of the import job whose status will be returned.
|
|
57549
57748
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57551,7 +57750,7 @@ export declare const SPConfigBetaApiFactory: (configuration?: Configuration, bas
|
|
|
57551
57750
|
*/
|
|
57552
57751
|
getSpConfigImportStatus(id: string, axiosOptions?: any): AxiosPromise<SpConfigImportJobStatusBeta>;
|
|
57553
57752
|
/**
|
|
57554
|
-
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the
|
|
57753
|
+
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
|
57555
57754
|
* @summary Initiates configuration objects import job
|
|
57556
57755
|
* @param {any} data JSON file containing the objects to be imported.
|
|
57557
57756
|
* @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.
|
|
@@ -57702,7 +57901,7 @@ export declare class SPConfigBetaApi extends BaseAPI {
|
|
|
57702
57901
|
*/
|
|
57703
57902
|
getSpConfigImport(requestParameters: SPConfigBetaApiGetSpConfigImportRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SpConfigImportResultsBeta, any>>;
|
|
57704
57903
|
/**
|
|
57705
|
-
* This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
|
57904
|
+
* This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
|
57706
57905
|
* @summary Get import job status
|
|
57707
57906
|
* @param {SPConfigBetaApiGetSpConfigImportStatusRequest} requestParameters Request parameters.
|
|
57708
57907
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57711,7 +57910,7 @@ export declare class SPConfigBetaApi extends BaseAPI {
|
|
|
57711
57910
|
*/
|
|
57712
57911
|
getSpConfigImportStatus(requestParameters: SPConfigBetaApiGetSpConfigImportStatusRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SpConfigImportJobStatusBeta, any>>;
|
|
57713
57912
|
/**
|
|
57714
|
-
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the
|
|
57913
|
+
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
|
57715
57914
|
* @summary Initiates configuration objects import job
|
|
57716
57915
|
* @param {SPConfigBetaApiImportSpConfigRequest} requestParameters Request parameters.
|
|
57717
57916
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -58994,7 +59193,7 @@ export declare const SourcesBetaApiAxiosParamCreator: (configuration?: Configura
|
|
|
58994
59193
|
*/
|
|
58995
59194
|
deleteSourceSchema: (sourceId: string, schemaId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58996
59195
|
/**
|
|
58997
|
-
* This API returns the existing correlation configuration for a source specified by the given ID.
|
|
59196
|
+
* This API returns the existing correlation configuration for a source specified by the given ID.
|
|
58998
59197
|
* @summary Get Source Correlation Configuration
|
|
58999
59198
|
* @param {string} id The source id
|
|
59000
59199
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -59182,7 +59381,7 @@ export declare const SourcesBetaApiAxiosParamCreator: (configuration?: Configura
|
|
|
59182
59381
|
*/
|
|
59183
59382
|
pingCluster: (sourceId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59184
59383
|
/**
|
|
59185
|
-
* Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body.
|
|
59384
|
+
* Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body.
|
|
59186
59385
|
* @summary Update Source Correlation Configuration
|
|
59187
59386
|
* @param {string} id The source id
|
|
59188
59387
|
* @param {CorrelationConfigBeta} correlationConfigBeta
|
|
@@ -59383,7 +59582,7 @@ export declare const SourcesBetaApiFp: (configuration?: Configuration) => {
|
|
|
59383
59582
|
*/
|
|
59384
59583
|
deleteSourceSchema(sourceId: string, schemaId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
59385
59584
|
/**
|
|
59386
|
-
* This API returns the existing correlation configuration for a source specified by the given ID.
|
|
59585
|
+
* This API returns the existing correlation configuration for a source specified by the given ID.
|
|
59387
59586
|
* @summary Get Source Correlation Configuration
|
|
59388
59587
|
* @param {string} id The source id
|
|
59389
59588
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -59571,7 +59770,7 @@ export declare const SourcesBetaApiFp: (configuration?: Configuration) => {
|
|
|
59571
59770
|
*/
|
|
59572
59771
|
pingCluster(sourceId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StatusResponseBeta>>;
|
|
59573
59772
|
/**
|
|
59574
|
-
* Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body.
|
|
59773
|
+
* Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body.
|
|
59575
59774
|
* @summary Update Source Correlation Configuration
|
|
59576
59775
|
* @param {string} id The source id
|
|
59577
59776
|
* @param {CorrelationConfigBeta} correlationConfigBeta
|
|
@@ -59772,7 +59971,7 @@ export declare const SourcesBetaApiFactory: (configuration?: Configuration, base
|
|
|
59772
59971
|
*/
|
|
59773
59972
|
deleteSourceSchema(sourceId: string, schemaId: string, axiosOptions?: any): AxiosPromise<void>;
|
|
59774
59973
|
/**
|
|
59775
|
-
* This API returns the existing correlation configuration for a source specified by the given ID.
|
|
59974
|
+
* This API returns the existing correlation configuration for a source specified by the given ID.
|
|
59776
59975
|
* @summary Get Source Correlation Configuration
|
|
59777
59976
|
* @param {string} id The source id
|
|
59778
59977
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -59960,7 +60159,7 @@ export declare const SourcesBetaApiFactory: (configuration?: Configuration, base
|
|
|
59960
60159
|
*/
|
|
59961
60160
|
pingCluster(sourceId: string, axiosOptions?: any): AxiosPromise<StatusResponseBeta>;
|
|
59962
60161
|
/**
|
|
59963
|
-
* Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body.
|
|
60162
|
+
* Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body.
|
|
59964
60163
|
* @summary Update Source Correlation Configuration
|
|
59965
60164
|
* @param {string} id The source id
|
|
59966
60165
|
* @param {CorrelationConfigBeta} correlationConfigBeta
|
|
@@ -60952,7 +61151,7 @@ export declare class SourcesBetaApi extends BaseAPI {
|
|
|
60952
61151
|
*/
|
|
60953
61152
|
deleteSourceSchema(requestParameters: SourcesBetaApiDeleteSourceSchemaRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
60954
61153
|
/**
|
|
60955
|
-
* This API returns the existing correlation configuration for a source specified by the given ID.
|
|
61154
|
+
* This API returns the existing correlation configuration for a source specified by the given ID.
|
|
60956
61155
|
* @summary Get Source Correlation Configuration
|
|
60957
61156
|
* @param {SourcesBetaApiGetCorrelationConfigRequest} requestParameters Request parameters.
|
|
60958
61157
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61140,7 +61339,7 @@ export declare class SourcesBetaApi extends BaseAPI {
|
|
|
61140
61339
|
*/
|
|
61141
61340
|
pingCluster(requestParameters: SourcesBetaApiPingClusterRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StatusResponseBeta, any>>;
|
|
61142
61341
|
/**
|
|
61143
|
-
* Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body.
|
|
61342
|
+
* Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body.
|
|
61144
61343
|
* @summary Update Source Correlation Configuration
|
|
61145
61344
|
* @param {SourcesBetaApiPutCorrelationConfigRequest} requestParameters Request parameters.
|
|
61146
61345
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61272,7 +61471,7 @@ export declare class SourcesBetaApi extends BaseAPI {
|
|
|
61272
61471
|
*/
|
|
61273
61472
|
export declare const SuggestedEntitlementDescriptionBetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
61274
61473
|
/**
|
|
61275
|
-
* Submit Sed Batch Stats Request.
|
|
61474
|
+
* Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.
|
|
61276
61475
|
* @summary Submit Sed Batch Stats Request
|
|
61277
61476
|
* @param {string} batchId Batch Id
|
|
61278
61477
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61340,7 +61539,7 @@ export declare const SuggestedEntitlementDescriptionBetaApiAxiosParamCreator: (c
|
|
|
61340
61539
|
*/
|
|
61341
61540
|
export declare const SuggestedEntitlementDescriptionBetaApiFp: (configuration?: Configuration) => {
|
|
61342
61541
|
/**
|
|
61343
|
-
* Submit Sed Batch Stats Request.
|
|
61542
|
+
* Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.
|
|
61344
61543
|
* @summary Submit Sed Batch Stats Request
|
|
61345
61544
|
* @param {string} batchId Batch Id
|
|
61346
61545
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61408,7 +61607,7 @@ export declare const SuggestedEntitlementDescriptionBetaApiFp: (configuration?:
|
|
|
61408
61607
|
*/
|
|
61409
61608
|
export declare const SuggestedEntitlementDescriptionBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
61410
61609
|
/**
|
|
61411
|
-
* Submit Sed Batch Stats Request.
|
|
61610
|
+
* Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.
|
|
61412
61611
|
* @summary Submit Sed Batch Stats Request
|
|
61413
61612
|
* @param {string} batchId Batch Id
|
|
61414
61613
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61598,7 +61797,7 @@ export interface SuggestedEntitlementDescriptionBetaApiSubmitSedBatchRequestRequ
|
|
|
61598
61797
|
*/
|
|
61599
61798
|
export declare class SuggestedEntitlementDescriptionBetaApi extends BaseAPI {
|
|
61600
61799
|
/**
|
|
61601
|
-
* Submit Sed Batch Stats Request.
|
|
61800
|
+
* Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.
|
|
61602
61801
|
* @summary Submit Sed Batch Stats Request
|
|
61603
61802
|
* @param {SuggestedEntitlementDescriptionBetaApiGetSedBatchStatsRequest} requestParameters Request parameters.
|
|
61604
61803
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61666,10 +61865,10 @@ export declare class SuggestedEntitlementDescriptionBetaApi extends BaseAPI {
|
|
|
61666
61865
|
*/
|
|
61667
61866
|
export declare const TaggedObjectsBetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
61668
61867
|
/**
|
|
61669
|
-
*
|
|
61670
|
-
* @summary Delete
|
|
61671
|
-
* @param {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} type The type of
|
|
61672
|
-
* @param {string} id The ID of the object
|
|
61868
|
+
* Delete all tags from a tagged object.
|
|
61869
|
+
* @summary Delete Object Tags
|
|
61870
|
+
* @param {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} type The type of object to delete tags from.
|
|
61871
|
+
* @param {string} id The ID of the object to delete tags from.
|
|
61673
61872
|
* @param {*} [axiosOptions] Override http request option.
|
|
61674
61873
|
* @throws {RequiredError}
|
|
61675
61874
|
*/
|
|
@@ -61747,10 +61946,10 @@ export declare const TaggedObjectsBetaApiAxiosParamCreator: (configuration?: Con
|
|
|
61747
61946
|
*/
|
|
61748
61947
|
export declare const TaggedObjectsBetaApiFp: (configuration?: Configuration) => {
|
|
61749
61948
|
/**
|
|
61750
|
-
*
|
|
61751
|
-
* @summary Delete
|
|
61752
|
-
* @param {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} type The type of
|
|
61753
|
-
* @param {string} id The ID of the object
|
|
61949
|
+
* Delete all tags from a tagged object.
|
|
61950
|
+
* @summary Delete Object Tags
|
|
61951
|
+
* @param {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} type The type of object to delete tags from.
|
|
61952
|
+
* @param {string} id The ID of the object to delete tags from.
|
|
61754
61953
|
* @param {*} [axiosOptions] Override http request option.
|
|
61755
61954
|
* @throws {RequiredError}
|
|
61756
61955
|
*/
|
|
@@ -61828,10 +62027,10 @@ export declare const TaggedObjectsBetaApiFp: (configuration?: Configuration) =>
|
|
|
61828
62027
|
*/
|
|
61829
62028
|
export declare const TaggedObjectsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
61830
62029
|
/**
|
|
61831
|
-
*
|
|
61832
|
-
* @summary Delete
|
|
61833
|
-
* @param {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} type The type of
|
|
61834
|
-
* @param {string} id The ID of the object
|
|
62030
|
+
* Delete all tags from a tagged object.
|
|
62031
|
+
* @summary Delete Object Tags
|
|
62032
|
+
* @param {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} type The type of object to delete tags from.
|
|
62033
|
+
* @param {string} id The ID of the object to delete tags from.
|
|
61835
62034
|
* @param {*} [axiosOptions] Override http request option.
|
|
61836
62035
|
* @throws {RequiredError}
|
|
61837
62036
|
*/
|
|
@@ -61910,13 +62109,13 @@ export declare const TaggedObjectsBetaApiFactory: (configuration?: Configuration
|
|
|
61910
62109
|
*/
|
|
61911
62110
|
export interface TaggedObjectsBetaApiDeleteTaggedObjectRequest {
|
|
61912
62111
|
/**
|
|
61913
|
-
* The type of
|
|
62112
|
+
* The type of object to delete tags from.
|
|
61914
62113
|
* @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'}
|
|
61915
62114
|
* @memberof TaggedObjectsBetaApiDeleteTaggedObject
|
|
61916
62115
|
*/
|
|
61917
62116
|
readonly type: 'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE';
|
|
61918
62117
|
/**
|
|
61919
|
-
* The ID of the object
|
|
62118
|
+
* The ID of the object to delete tags from.
|
|
61920
62119
|
* @type {string}
|
|
61921
62120
|
* @memberof TaggedObjectsBetaApiDeleteTaggedObject
|
|
61922
62121
|
*/
|
|
@@ -62081,8 +62280,8 @@ export interface TaggedObjectsBetaApiSetTagsToManyObjectsRequest {
|
|
|
62081
62280
|
*/
|
|
62082
62281
|
export declare class TaggedObjectsBetaApi extends BaseAPI {
|
|
62083
62282
|
/**
|
|
62084
|
-
*
|
|
62085
|
-
* @summary Delete
|
|
62283
|
+
* Delete all tags from a tagged object.
|
|
62284
|
+
* @summary Delete Object Tags
|
|
62086
62285
|
* @param {TaggedObjectsBetaApiDeleteTaggedObjectRequest} requestParameters Request parameters.
|
|
62087
62286
|
* @param {*} [axiosOptions] Override http request option.
|
|
62088
62287
|
* @throws {RequiredError}
|
|
@@ -62405,8 +62604,8 @@ export declare class TagsBetaApi extends BaseAPI {
|
|
|
62405
62604
|
*/
|
|
62406
62605
|
export declare const TaskManagementBetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
62407
62606
|
/**
|
|
62408
|
-
*
|
|
62409
|
-
* @summary Retrieve
|
|
62607
|
+
* Responds with headers only for list of task statuses for pending tasks.
|
|
62608
|
+
* @summary Retrieve Pending Task List Headers
|
|
62410
62609
|
* @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.
|
|
62411
62610
|
* @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.
|
|
62412
62611
|
* @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.
|
|
@@ -62415,8 +62614,8 @@ export declare const TaskManagementBetaApiAxiosParamCreator: (configuration?: Co
|
|
|
62415
62614
|
*/
|
|
62416
62615
|
getPendingTaskHeaders: (offset?: number, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
62417
62616
|
/**
|
|
62418
|
-
* Retrieve a list of
|
|
62419
|
-
* @summary Retrieve
|
|
62617
|
+
* 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.
|
|
62618
|
+
* @summary Retrieve Pending Task Status List
|
|
62420
62619
|
* @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.
|
|
62421
62620
|
* @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.
|
|
62422
62621
|
* @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.
|
|
@@ -62425,16 +62624,16 @@ export declare const TaskManagementBetaApiAxiosParamCreator: (configuration?: Co
|
|
|
62425
62624
|
*/
|
|
62426
62625
|
getPendingTasks: (offset?: number, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
62427
62626
|
/**
|
|
62428
|
-
* Get
|
|
62429
|
-
* @summary Get
|
|
62627
|
+
* 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.
|
|
62628
|
+
* @summary Get Task Status by ID
|
|
62430
62629
|
* @param {string} id Task ID.
|
|
62431
62630
|
* @param {*} [axiosOptions] Override http request option.
|
|
62432
62631
|
* @throws {RequiredError}
|
|
62433
62632
|
*/
|
|
62434
62633
|
getTaskStatus: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
62435
62634
|
/**
|
|
62436
|
-
* Use this endpoint to get a list of **completed** tasks. To get a list of
|
|
62437
|
-
* @summary Retrieve
|
|
62635
|
+
* Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint.
|
|
62636
|
+
* @summary Retrieve Task Status List
|
|
62438
62637
|
* @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.
|
|
62439
62638
|
* @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.
|
|
62440
62639
|
* @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.
|
|
@@ -62446,7 +62645,7 @@ export declare const TaskManagementBetaApiAxiosParamCreator: (configuration?: Co
|
|
|
62446
62645
|
getTaskStatusList: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
62447
62646
|
/**
|
|
62448
62647
|
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
62449
|
-
* @summary Update
|
|
62648
|
+
* @summary Update Task Status by ID
|
|
62450
62649
|
* @param {string} id Task ID.
|
|
62451
62650
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta The JSONPatch payload used to update the object.
|
|
62452
62651
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -62460,8 +62659,8 @@ export declare const TaskManagementBetaApiAxiosParamCreator: (configuration?: Co
|
|
|
62460
62659
|
*/
|
|
62461
62660
|
export declare const TaskManagementBetaApiFp: (configuration?: Configuration) => {
|
|
62462
62661
|
/**
|
|
62463
|
-
*
|
|
62464
|
-
* @summary Retrieve
|
|
62662
|
+
* Responds with headers only for list of task statuses for pending tasks.
|
|
62663
|
+
* @summary Retrieve Pending Task List Headers
|
|
62465
62664
|
* @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.
|
|
62466
62665
|
* @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.
|
|
62467
62666
|
* @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.
|
|
@@ -62470,8 +62669,8 @@ export declare const TaskManagementBetaApiFp: (configuration?: Configuration) =>
|
|
|
62470
62669
|
*/
|
|
62471
62670
|
getPendingTaskHeaders(offset?: number, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
62472
62671
|
/**
|
|
62473
|
-
* Retrieve a list of
|
|
62474
|
-
* @summary Retrieve
|
|
62672
|
+
* 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.
|
|
62673
|
+
* @summary Retrieve Pending Task Status List
|
|
62475
62674
|
* @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.
|
|
62476
62675
|
* @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.
|
|
62477
62676
|
* @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.
|
|
@@ -62480,16 +62679,16 @@ export declare const TaskManagementBetaApiFp: (configuration?: Configuration) =>
|
|
|
62480
62679
|
*/
|
|
62481
62680
|
getPendingTasks(offset?: number, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskStatusBeta>>>;
|
|
62482
62681
|
/**
|
|
62483
|
-
* Get
|
|
62484
|
-
* @summary Get
|
|
62682
|
+
* 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.
|
|
62683
|
+
* @summary Get Task Status by ID
|
|
62485
62684
|
* @param {string} id Task ID.
|
|
62486
62685
|
* @param {*} [axiosOptions] Override http request option.
|
|
62487
62686
|
* @throws {RequiredError}
|
|
62488
62687
|
*/
|
|
62489
62688
|
getTaskStatus(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusBeta>>;
|
|
62490
62689
|
/**
|
|
62491
|
-
* Use this endpoint to get a list of **completed** tasks. To get a list of
|
|
62492
|
-
* @summary Retrieve
|
|
62690
|
+
* Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint.
|
|
62691
|
+
* @summary Retrieve Task Status List
|
|
62493
62692
|
* @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.
|
|
62494
62693
|
* @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.
|
|
62495
62694
|
* @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.
|
|
@@ -62501,7 +62700,7 @@ export declare const TaskManagementBetaApiFp: (configuration?: Configuration) =>
|
|
|
62501
62700
|
getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskStatusBeta>>>;
|
|
62502
62701
|
/**
|
|
62503
62702
|
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
62504
|
-
* @summary Update
|
|
62703
|
+
* @summary Update Task Status by ID
|
|
62505
62704
|
* @param {string} id Task ID.
|
|
62506
62705
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta The JSONPatch payload used to update the object.
|
|
62507
62706
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -62515,8 +62714,8 @@ export declare const TaskManagementBetaApiFp: (configuration?: Configuration) =>
|
|
|
62515
62714
|
*/
|
|
62516
62715
|
export declare const TaskManagementBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
62517
62716
|
/**
|
|
62518
|
-
*
|
|
62519
|
-
* @summary Retrieve
|
|
62717
|
+
* Responds with headers only for list of task statuses for pending tasks.
|
|
62718
|
+
* @summary Retrieve Pending Task List Headers
|
|
62520
62719
|
* @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.
|
|
62521
62720
|
* @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.
|
|
62522
62721
|
* @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.
|
|
@@ -62525,8 +62724,8 @@ export declare const TaskManagementBetaApiFactory: (configuration?: Configuratio
|
|
|
62525
62724
|
*/
|
|
62526
62725
|
getPendingTaskHeaders(offset?: number, limit?: number, count?: boolean, axiosOptions?: any): AxiosPromise<void>;
|
|
62527
62726
|
/**
|
|
62528
|
-
* Retrieve a list of
|
|
62529
|
-
* @summary Retrieve
|
|
62727
|
+
* 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.
|
|
62728
|
+
* @summary Retrieve Pending Task Status List
|
|
62530
62729
|
* @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.
|
|
62531
62730
|
* @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.
|
|
62532
62731
|
* @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.
|
|
@@ -62535,16 +62734,16 @@ export declare const TaskManagementBetaApiFactory: (configuration?: Configuratio
|
|
|
62535
62734
|
*/
|
|
62536
62735
|
getPendingTasks(offset?: number, limit?: number, count?: boolean, axiosOptions?: any): AxiosPromise<Array<TaskStatusBeta>>;
|
|
62537
62736
|
/**
|
|
62538
|
-
* Get
|
|
62539
|
-
* @summary Get
|
|
62737
|
+
* 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.
|
|
62738
|
+
* @summary Get Task Status by ID
|
|
62540
62739
|
* @param {string} id Task ID.
|
|
62541
62740
|
* @param {*} [axiosOptions] Override http request option.
|
|
62542
62741
|
* @throws {RequiredError}
|
|
62543
62742
|
*/
|
|
62544
62743
|
getTaskStatus(id: string, axiosOptions?: any): AxiosPromise<TaskStatusBeta>;
|
|
62545
62744
|
/**
|
|
62546
|
-
* Use this endpoint to get a list of **completed** tasks. To get a list of
|
|
62547
|
-
* @summary Retrieve
|
|
62745
|
+
* Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint.
|
|
62746
|
+
* @summary Retrieve Task Status List
|
|
62548
62747
|
* @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.
|
|
62549
62748
|
* @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.
|
|
62550
62749
|
* @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.
|
|
@@ -62556,7 +62755,7 @@ export declare const TaskManagementBetaApiFactory: (configuration?: Configuratio
|
|
|
62556
62755
|
getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<TaskStatusBeta>>;
|
|
62557
62756
|
/**
|
|
62558
62757
|
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
62559
|
-
* @summary Update
|
|
62758
|
+
* @summary Update Task Status by ID
|
|
62560
62759
|
* @param {string} id Task ID.
|
|
62561
62760
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta The JSONPatch payload used to update the object.
|
|
62562
62761
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -62691,8 +62890,8 @@ export interface TaskManagementBetaApiUpdateTaskStatusRequest {
|
|
|
62691
62890
|
*/
|
|
62692
62891
|
export declare class TaskManagementBetaApi extends BaseAPI {
|
|
62693
62892
|
/**
|
|
62694
|
-
*
|
|
62695
|
-
* @summary Retrieve
|
|
62893
|
+
* Responds with headers only for list of task statuses for pending tasks.
|
|
62894
|
+
* @summary Retrieve Pending Task List Headers
|
|
62696
62895
|
* @param {TaskManagementBetaApiGetPendingTaskHeadersRequest} requestParameters Request parameters.
|
|
62697
62896
|
* @param {*} [axiosOptions] Override http request option.
|
|
62698
62897
|
* @throws {RequiredError}
|
|
@@ -62700,8 +62899,8 @@ export declare class TaskManagementBetaApi extends BaseAPI {
|
|
|
62700
62899
|
*/
|
|
62701
62900
|
getPendingTaskHeaders(requestParameters?: TaskManagementBetaApiGetPendingTaskHeadersRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
62702
62901
|
/**
|
|
62703
|
-
* Retrieve a list of
|
|
62704
|
-
* @summary Retrieve
|
|
62902
|
+
* 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.
|
|
62903
|
+
* @summary Retrieve Pending Task Status List
|
|
62705
62904
|
* @param {TaskManagementBetaApiGetPendingTasksRequest} requestParameters Request parameters.
|
|
62706
62905
|
* @param {*} [axiosOptions] Override http request option.
|
|
62707
62906
|
* @throws {RequiredError}
|
|
@@ -62709,8 +62908,8 @@ export declare class TaskManagementBetaApi extends BaseAPI {
|
|
|
62709
62908
|
*/
|
|
62710
62909
|
getPendingTasks(requestParameters?: TaskManagementBetaApiGetPendingTasksRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskStatusBeta[], any>>;
|
|
62711
62910
|
/**
|
|
62712
|
-
* Get
|
|
62713
|
-
* @summary Get
|
|
62911
|
+
* 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.
|
|
62912
|
+
* @summary Get Task Status by ID
|
|
62714
62913
|
* @param {TaskManagementBetaApiGetTaskStatusRequest} requestParameters Request parameters.
|
|
62715
62914
|
* @param {*} [axiosOptions] Override http request option.
|
|
62716
62915
|
* @throws {RequiredError}
|
|
@@ -62718,8 +62917,8 @@ export declare class TaskManagementBetaApi extends BaseAPI {
|
|
|
62718
62917
|
*/
|
|
62719
62918
|
getTaskStatus(requestParameters: TaskManagementBetaApiGetTaskStatusRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskStatusBeta, any>>;
|
|
62720
62919
|
/**
|
|
62721
|
-
* Use this endpoint to get a list of **completed** tasks. To get a list of
|
|
62722
|
-
* @summary Retrieve
|
|
62920
|
+
* Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint.
|
|
62921
|
+
* @summary Retrieve Task Status List
|
|
62723
62922
|
* @param {TaskManagementBetaApiGetTaskStatusListRequest} requestParameters Request parameters.
|
|
62724
62923
|
* @param {*} [axiosOptions] Override http request option.
|
|
62725
62924
|
* @throws {RequiredError}
|
|
@@ -62728,7 +62927,7 @@ export declare class TaskManagementBetaApi extends BaseAPI {
|
|
|
62728
62927
|
getTaskStatusList(requestParameters?: TaskManagementBetaApiGetTaskStatusListRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskStatusBeta[], any>>;
|
|
62729
62928
|
/**
|
|
62730
62929
|
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
62731
|
-
* @summary Update
|
|
62930
|
+
* @summary Update Task Status by ID
|
|
62732
62931
|
* @param {TaskManagementBetaApiUpdateTaskStatusRequest} requestParameters Request parameters.
|
|
62733
62932
|
* @param {*} [axiosOptions] Override http request option.
|
|
62734
62933
|
* @throws {RequiredError}
|