sailpoint-api-client 1.8.16 → 1.8.18
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 +42 -7
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +29 -4
- package/dist/beta/api.js +21 -7
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +2 -2
- package/dist/nerm/common.js +2 -2
- package/dist/nermv2025/common.js +2 -2
- package/dist/v2024/api.d.ts +18 -2
- package/dist/v2024/api.js +15 -5
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +2 -2
- package/dist/v2025/api.d.ts +100 -72
- package/dist/v2025/api.js +97 -73
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +2 -2
- package/dist/v2026/api.d.ts +174 -103
- package/dist/v2026/api.js +215 -113
- package/dist/v2026/api.js.map +1 -1
- package/dist/v2026/common.js +2 -2
- package/dist/v3/common.js +2 -2
- package/nerm/README.md +2 -2
- package/nerm/common.ts +2 -2
- package/nerm/package.json +1 -1
- package/nermv2025/README.md +2 -2
- package/nermv2025/common.ts +2 -2
- package/nermv2025/package.json +1 -1
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/api.ts +31 -5
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +122 -78
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v2026/README.md +2 -2
- package/v2026/api.ts +254 -142
- package/v2026/common.ts +2 -2
- package/v2026/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/v2026/api.ts
CHANGED
|
@@ -7840,6 +7840,19 @@ export interface ApprovalBatchV2026 {
|
|
|
7840
7840
|
*/
|
|
7841
7841
|
'batchSize'?: number;
|
|
7842
7842
|
}
|
|
7843
|
+
/**
|
|
7844
|
+
* Request body for cancelling a single approval request.
|
|
7845
|
+
* @export
|
|
7846
|
+
* @interface ApprovalCancelRequestV2026
|
|
7847
|
+
*/
|
|
7848
|
+
export interface ApprovalCancelRequestV2026 {
|
|
7849
|
+
/**
|
|
7850
|
+
* Optional comment associated with the cancel request.
|
|
7851
|
+
* @type {string}
|
|
7852
|
+
* @memberof ApprovalCancelRequestV2026
|
|
7853
|
+
*/
|
|
7854
|
+
'comment'?: string;
|
|
7855
|
+
}
|
|
7843
7856
|
/**
|
|
7844
7857
|
* Comments Object
|
|
7845
7858
|
* @export
|
|
@@ -8137,24 +8150,6 @@ export type ApprovalConfigTimeoutConfigV2026TimeoutResultV2026 = typeof Approval
|
|
|
8137
8150
|
* @interface ApprovalConfigV2026
|
|
8138
8151
|
*/
|
|
8139
8152
|
export interface ApprovalConfigV2026 {
|
|
8140
|
-
/**
|
|
8141
|
-
* Tenant ID of the approval configuration.
|
|
8142
|
-
* @type {string}
|
|
8143
|
-
* @memberof ApprovalConfigV2026
|
|
8144
|
-
*/
|
|
8145
|
-
'tenantId'?: string;
|
|
8146
|
-
/**
|
|
8147
|
-
* The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
8148
|
-
* @type {string}
|
|
8149
|
-
* @memberof ApprovalConfigV2026
|
|
8150
|
-
*/
|
|
8151
|
-
'id'?: string;
|
|
8152
|
-
/**
|
|
8153
|
-
* The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
8154
|
-
* @type {string}
|
|
8155
|
-
* @memberof ApprovalConfigV2026
|
|
8156
|
-
*/
|
|
8157
|
-
'scope'?: string;
|
|
8158
8153
|
/**
|
|
8159
8154
|
*
|
|
8160
8155
|
* @type {ApprovalConfigReminderConfigV2026}
|
|
@@ -8197,6 +8192,18 @@ export interface ApprovalConfigV2026 {
|
|
|
8197
8192
|
* @memberof ApprovalConfigV2026
|
|
8198
8193
|
*/
|
|
8199
8194
|
'fallbackApprover'?: ApprovalIdentityV2026;
|
|
8195
|
+
/**
|
|
8196
|
+
* Specifies how to treat the identity type \"MANAGER_OF\" when the requestee is a machine identity.
|
|
8197
|
+
* @type {string}
|
|
8198
|
+
* @memberof ApprovalConfigV2026
|
|
8199
|
+
*/
|
|
8200
|
+
'machineIdentityManagerAssignment'?: ApprovalConfigV2026MachineIdentityManagerAssignmentV2026;
|
|
8201
|
+
/**
|
|
8202
|
+
* When true, all approvals will be created with the status \"PASSED\".
|
|
8203
|
+
* @type {boolean}
|
|
8204
|
+
* @memberof ApprovalConfigV2026
|
|
8205
|
+
*/
|
|
8206
|
+
'circumventApprovalProcess'?: boolean;
|
|
8200
8207
|
/**
|
|
8201
8208
|
* OFF will prevent the approval request from being assigned to the requester or requestee by assigning it to their manager instead. DIRECT will cause approval requests to be auto-approved when assigned directly and only to the requester. INDIRECT will auto-approve when the requester appears anywhere in the list of approvers, including in a governance group. This field will only be effective if requestedTarget.reauthRequired is set to false, otherwise the approval will have to be manually approved.
|
|
8202
8209
|
* @type {string}
|
|
@@ -8213,6 +8220,17 @@ export const ApprovalConfigV2026RequiresCommentV2026 = {
|
|
|
8213
8220
|
} as const;
|
|
8214
8221
|
|
|
8215
8222
|
export type ApprovalConfigV2026RequiresCommentV2026 = typeof ApprovalConfigV2026RequiresCommentV2026[keyof typeof ApprovalConfigV2026RequiresCommentV2026];
|
|
8223
|
+
export const ApprovalConfigV2026MachineIdentityManagerAssignmentV2026 = {
|
|
8224
|
+
ManagerOfRequester: 'MANAGER_OF_REQUESTER',
|
|
8225
|
+
MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER',
|
|
8226
|
+
ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER',
|
|
8227
|
+
RequestedTargetOwner: 'REQUESTED_TARGET_OWNER',
|
|
8228
|
+
ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER',
|
|
8229
|
+
AccountOwner: 'ACCOUNT_OWNER',
|
|
8230
|
+
ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER'
|
|
8231
|
+
} as const;
|
|
8232
|
+
|
|
8233
|
+
export type ApprovalConfigV2026MachineIdentityManagerAssignmentV2026 = typeof ApprovalConfigV2026MachineIdentityManagerAssignmentV2026[keyof typeof ApprovalConfigV2026MachineIdentityManagerAssignmentV2026];
|
|
8216
8234
|
export const ApprovalConfigV2026AutoApproveV2026 = {
|
|
8217
8235
|
Off: 'OFF',
|
|
8218
8236
|
Direct: 'DIRECT',
|
|
@@ -29646,7 +29664,7 @@ export interface MachineIdentityV2026 {
|
|
|
29646
29664
|
*/
|
|
29647
29665
|
export interface MachineSubtypeApprovalConfigV2026 {
|
|
29648
29666
|
/**
|
|
29649
|
-
* Comma separated string of approvers. Following are the options for approver types: manager, sourceOwner, accountOwner, workgroup:
|
|
29667
|
+
* Comma separated string of approvers. Following are the options for approver types: manager, sourceOwner, accountOwner, workgroup:[workgroupId] (Governance group). Approval request will be assigned based on the order of the approvers passed. Multiple workgroups(governance groups) can be selected as an approver. >**Note:** accountOwner approver type is only for machine account delete approval settings.
|
|
29650
29668
|
* @type {string}
|
|
29651
29669
|
* @memberof MachineSubtypeApprovalConfigV2026
|
|
29652
29670
|
*/
|
|
@@ -62300,9 +62318,9 @@ export type GetDiscoveredApplicationsDetailV2026 = typeof GetDiscoveredApplicati
|
|
|
62300
62318
|
export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
62301
62319
|
return {
|
|
62302
62320
|
/**
|
|
62303
|
-
*
|
|
62321
|
+
* Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user.
|
|
62304
62322
|
* @summary Post Approvals Approve
|
|
62305
|
-
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve
|
|
62323
|
+
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve.
|
|
62306
62324
|
* @param {ApprovalApproveRequestV2026} [approvalApproveRequestV2026]
|
|
62307
62325
|
* @param {*} [axiosOptions] Override http request option.
|
|
62308
62326
|
* @throws {RequiredError}
|
|
@@ -62390,7 +62408,7 @@ export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62390
62408
|
};
|
|
62391
62409
|
},
|
|
62392
62410
|
/**
|
|
62393
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
62411
|
+
* Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel
|
|
62394
62412
|
* @summary Post Bulk Cancel Approvals
|
|
62395
62413
|
* @param {BulkCancelRequestDTOV2026} bulkCancelRequestDTOV2026
|
|
62396
62414
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -62433,11 +62451,57 @@ export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62433
62451
|
axiosOptions: localVarRequestOptions,
|
|
62434
62452
|
};
|
|
62435
62453
|
},
|
|
62454
|
+
/**
|
|
62455
|
+
* Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel
|
|
62456
|
+
* @summary Post Approval Cancel
|
|
62457
|
+
* @param {string} id ID of the approval request to cancel.
|
|
62458
|
+
* @param {ApprovalCancelRequestV2026} [approvalCancelRequestV2026]
|
|
62459
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
62460
|
+
* @throws {RequiredError}
|
|
62461
|
+
*/
|
|
62462
|
+
cancelApprovalById: async (id: string, approvalCancelRequestV2026?: ApprovalCancelRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
62463
|
+
// verify required parameter 'id' is not null or undefined
|
|
62464
|
+
assertParamExists('cancelApprovalById', 'id', id)
|
|
62465
|
+
const localVarPath = `/generic-approvals/{id}/cancel`
|
|
62466
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
62467
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
62468
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
62469
|
+
let baseOptions;
|
|
62470
|
+
if (configuration) {
|
|
62471
|
+
baseOptions = configuration.baseOptions;
|
|
62472
|
+
}
|
|
62473
|
+
|
|
62474
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions};
|
|
62475
|
+
const localVarHeaderParameter = {} as any;
|
|
62476
|
+
const localVarQueryParameter = {} as any;
|
|
62477
|
+
|
|
62478
|
+
// authentication userAuth required
|
|
62479
|
+
// oauth required
|
|
62480
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
62481
|
+
|
|
62482
|
+
// authentication userAuth required
|
|
62483
|
+
// oauth required
|
|
62484
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
62485
|
+
|
|
62486
|
+
|
|
62487
|
+
|
|
62488
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
62489
|
+
|
|
62490
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
62491
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
62492
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
62493
|
+
localVarRequestOptions.data = serializeDataIfNeeded(approvalCancelRequestV2026, localVarRequestOptions, configuration)
|
|
62494
|
+
|
|
62495
|
+
return {
|
|
62496
|
+
url: toPathString(localVarUrlObj),
|
|
62497
|
+
axiosOptions: localVarRequestOptions,
|
|
62498
|
+
};
|
|
62499
|
+
},
|
|
62436
62500
|
/**
|
|
62437
62501
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
62438
62502
|
* @summary Delete Approval Configuration
|
|
62439
|
-
* @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
62440
|
-
* @param {DeleteApprovalConfigRequestScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
62503
|
+
* @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
62504
|
+
* @param {DeleteApprovalConfigRequestScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
62441
62505
|
* @param {*} [axiosOptions] Override http request option.
|
|
62442
62506
|
* @throws {RequiredError}
|
|
62443
62507
|
*/
|
|
@@ -62480,7 +62544,7 @@ export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62480
62544
|
};
|
|
62481
62545
|
},
|
|
62482
62546
|
/**
|
|
62483
|
-
*
|
|
62547
|
+
* Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"
|
|
62484
62548
|
* @summary Get an approval
|
|
62485
62549
|
* @param {string} id ID of the approval that is to be returned
|
|
62486
62550
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -62522,7 +62586,7 @@ export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62522
62586
|
};
|
|
62523
62587
|
},
|
|
62524
62588
|
/**
|
|
62525
|
-
*
|
|
62589
|
+
* Gets a list of approvals. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" Absence of all query parameters for non admins will will default to mine=true. Admin will default to mine=false. Absence of all query parameters for admins will return all approvals in the org.
|
|
62526
62590
|
* @summary Get approvals
|
|
62527
62591
|
* @param {boolean} [mine] Returns the list of approvals for the current caller. Defaults to false if admin, true otherwise.
|
|
62528
62592
|
* @param {string} [requesterId] Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin.
|
|
@@ -62532,6 +62596,7 @@ export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62532
62596
|
* @param {boolean} [countOnly] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects.
|
|
62533
62597
|
* @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments.
|
|
62534
62598
|
* @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers.
|
|
62599
|
+
* @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history.
|
|
62535
62600
|
* @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch information.
|
|
62536
62601
|
* @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: **status**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **approvalId**: *eq, ne, in, co, sw* **tenantId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le*
|
|
62537
62602
|
* @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.
|
|
@@ -62539,7 +62604,7 @@ export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62539
62604
|
* @param {*} [axiosOptions] Override http request option.
|
|
62540
62605
|
* @throws {RequiredError}
|
|
62541
62606
|
*/
|
|
62542
|
-
getApprovals: async (mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
62607
|
+
getApprovals: async (mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeReassignmentHistory?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
62543
62608
|
const localVarPath = `/generic-approvals`;
|
|
62544
62609
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
62545
62610
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -62592,6 +62657,10 @@ export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62592
62657
|
localVarQueryParameter['include-approvers'] = includeApprovers;
|
|
62593
62658
|
}
|
|
62594
62659
|
|
|
62660
|
+
if (includeReassignmentHistory !== undefined) {
|
|
62661
|
+
localVarQueryParameter['include-reassignment-history'] = includeReassignmentHistory;
|
|
62662
|
+
}
|
|
62663
|
+
|
|
62595
62664
|
if (includeBatchInfo !== undefined) {
|
|
62596
62665
|
localVarQueryParameter['include-batch-info'] = includeBatchInfo;
|
|
62597
62666
|
}
|
|
@@ -62622,7 +62691,7 @@ export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62622
62691
|
/**
|
|
62623
62692
|
* Retrieves a singular approval configuration that matches the given ID
|
|
62624
62693
|
* @summary Get Approval Config
|
|
62625
|
-
* @param {string} id The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", (tenantID)]
|
|
62694
|
+
* @param {string} id The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)]
|
|
62626
62695
|
* @param {*} [axiosOptions] Override http request option.
|
|
62627
62696
|
* @throws {RequiredError}
|
|
62628
62697
|
*/
|
|
@@ -62708,8 +62777,8 @@ export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62708
62777
|
/**
|
|
62709
62778
|
* Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\'
|
|
62710
62779
|
* @summary Put Approval Config
|
|
62711
|
-
* @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
62712
|
-
* @param {PutApprovalsConfigScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
62780
|
+
* @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
62781
|
+
* @param {PutApprovalsConfigScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
62713
62782
|
* @param {ApprovalConfigV2026} approvalConfigV2026
|
|
62714
62783
|
* @param {*} [axiosOptions] Override http request option.
|
|
62715
62784
|
* @throws {RequiredError}
|
|
@@ -62758,7 +62827,7 @@ export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62758
62827
|
};
|
|
62759
62828
|
},
|
|
62760
62829
|
/**
|
|
62761
|
-
*
|
|
62830
|
+
* Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved.
|
|
62762
62831
|
* @summary Post Approvals Reject
|
|
62763
62832
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject.
|
|
62764
62833
|
* @param {ApprovalRejectRequestV2026} [approvalRejectRequestV2026]
|
|
@@ -62848,7 +62917,7 @@ export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62848
62917
|
};
|
|
62849
62918
|
},
|
|
62850
62919
|
/**
|
|
62851
|
-
*
|
|
62920
|
+
* Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs.
|
|
62852
62921
|
* @summary Post Approvals Attributes
|
|
62853
62922
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
|
|
62854
62923
|
* @param {ApprovalAttributesRequestV2026} approvalAttributesRequestV2026
|
|
@@ -62896,7 +62965,7 @@ export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62896
62965
|
};
|
|
62897
62966
|
},
|
|
62898
62967
|
/**
|
|
62899
|
-
*
|
|
62968
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
62900
62969
|
* @summary Post Approvals Comments
|
|
62901
62970
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to.
|
|
62902
62971
|
* @param {ApprovalCommentsRequestV2026} approvalCommentsRequestV2026
|
|
@@ -62944,7 +63013,7 @@ export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62944
63013
|
};
|
|
62945
63014
|
},
|
|
62946
63015
|
/**
|
|
62947
|
-
*
|
|
63016
|
+
* Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs.
|
|
62948
63017
|
* @summary Post Approvals Reassign
|
|
62949
63018
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign.
|
|
62950
63019
|
* @param {ApprovalReassignRequestV2026} approvalReassignRequestV2026
|
|
@@ -63002,9 +63071,9 @@ export const ApprovalsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
63002
63071
|
const localVarAxiosParamCreator = ApprovalsV2026ApiAxiosParamCreator(configuration)
|
|
63003
63072
|
return {
|
|
63004
63073
|
/**
|
|
63005
|
-
*
|
|
63074
|
+
* Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user.
|
|
63006
63075
|
* @summary Post Approvals Approve
|
|
63007
|
-
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve
|
|
63076
|
+
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve.
|
|
63008
63077
|
* @param {ApprovalApproveRequestV2026} [approvalApproveRequestV2026]
|
|
63009
63078
|
* @param {*} [axiosOptions] Override http request option.
|
|
63010
63079
|
* @throws {RequiredError}
|
|
@@ -63029,7 +63098,7 @@ export const ApprovalsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
63029
63098
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
63030
63099
|
},
|
|
63031
63100
|
/**
|
|
63032
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
63101
|
+
* Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel
|
|
63033
63102
|
* @summary Post Bulk Cancel Approvals
|
|
63034
63103
|
* @param {BulkCancelRequestDTOV2026} bulkCancelRequestDTOV2026
|
|
63035
63104
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63041,11 +63110,25 @@ export const ApprovalsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
63041
63110
|
const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.cancelApproval']?.[localVarOperationServerIndex]?.url;
|
|
63042
63111
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
63043
63112
|
},
|
|
63113
|
+
/**
|
|
63114
|
+
* Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel
|
|
63115
|
+
* @summary Post Approval Cancel
|
|
63116
|
+
* @param {string} id ID of the approval request to cancel.
|
|
63117
|
+
* @param {ApprovalCancelRequestV2026} [approvalCancelRequestV2026]
|
|
63118
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
63119
|
+
* @throws {RequiredError}
|
|
63120
|
+
*/
|
|
63121
|
+
async cancelApprovalById(id: string, approvalCancelRequestV2026?: ApprovalCancelRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
63122
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.cancelApprovalById(id, approvalCancelRequestV2026, axiosOptions);
|
|
63123
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
63124
|
+
const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.cancelApprovalById']?.[localVarOperationServerIndex]?.url;
|
|
63125
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
63126
|
+
},
|
|
63044
63127
|
/**
|
|
63045
63128
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
63046
63129
|
* @summary Delete Approval Configuration
|
|
63047
|
-
* @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63048
|
-
* @param {DeleteApprovalConfigRequestScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63130
|
+
* @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63131
|
+
* @param {DeleteApprovalConfigRequestScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63049
63132
|
* @param {*} [axiosOptions] Override http request option.
|
|
63050
63133
|
* @throws {RequiredError}
|
|
63051
63134
|
*/
|
|
@@ -63056,7 +63139,7 @@ export const ApprovalsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
63056
63139
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
63057
63140
|
},
|
|
63058
63141
|
/**
|
|
63059
|
-
*
|
|
63142
|
+
* Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"
|
|
63060
63143
|
* @summary Get an approval
|
|
63061
63144
|
* @param {string} id ID of the approval that is to be returned
|
|
63062
63145
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63069,7 +63152,7 @@ export const ApprovalsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
63069
63152
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
63070
63153
|
},
|
|
63071
63154
|
/**
|
|
63072
|
-
*
|
|
63155
|
+
* Gets a list of approvals. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" Absence of all query parameters for non admins will will default to mine=true. Admin will default to mine=false. Absence of all query parameters for admins will return all approvals in the org.
|
|
63073
63156
|
* @summary Get approvals
|
|
63074
63157
|
* @param {boolean} [mine] Returns the list of approvals for the current caller. Defaults to false if admin, true otherwise.
|
|
63075
63158
|
* @param {string} [requesterId] Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin.
|
|
@@ -63079,6 +63162,7 @@ export const ApprovalsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
63079
63162
|
* @param {boolean} [countOnly] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects.
|
|
63080
63163
|
* @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments.
|
|
63081
63164
|
* @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers.
|
|
63165
|
+
* @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history.
|
|
63082
63166
|
* @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch information.
|
|
63083
63167
|
* @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: **status**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **approvalId**: *eq, ne, in, co, sw* **tenantId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le*
|
|
63084
63168
|
* @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.
|
|
@@ -63086,8 +63170,8 @@ export const ApprovalsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
63086
63170
|
* @param {*} [axiosOptions] Override http request option.
|
|
63087
63171
|
* @throws {RequiredError}
|
|
63088
63172
|
*/
|
|
63089
|
-
async getApprovals(mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApprovalV2026>>> {
|
|
63090
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getApprovals(mine, requesterId, requesteeId, approverId, count, countOnly, includeComments, includeApprovers, includeBatchInfo, filters, limit, offset, axiosOptions);
|
|
63173
|
+
async getApprovals(mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeReassignmentHistory?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApprovalV2026>>> {
|
|
63174
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getApprovals(mine, requesterId, requesteeId, approverId, count, countOnly, includeComments, includeApprovers, includeReassignmentHistory, includeBatchInfo, filters, limit, offset, axiosOptions);
|
|
63091
63175
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
63092
63176
|
const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.getApprovals']?.[localVarOperationServerIndex]?.url;
|
|
63093
63177
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -63095,7 +63179,7 @@ export const ApprovalsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
63095
63179
|
/**
|
|
63096
63180
|
* Retrieves a singular approval configuration that matches the given ID
|
|
63097
63181
|
* @summary Get Approval Config
|
|
63098
|
-
* @param {string} id The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", (tenantID)]
|
|
63182
|
+
* @param {string} id The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)]
|
|
63099
63183
|
* @param {*} [axiosOptions] Override http request option.
|
|
63100
63184
|
* @throws {RequiredError}
|
|
63101
63185
|
*/
|
|
@@ -63121,8 +63205,8 @@ export const ApprovalsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
63121
63205
|
/**
|
|
63122
63206
|
* Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\'
|
|
63123
63207
|
* @summary Put Approval Config
|
|
63124
|
-
* @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63125
|
-
* @param {PutApprovalsConfigScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63208
|
+
* @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63209
|
+
* @param {PutApprovalsConfigScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63126
63210
|
* @param {ApprovalConfigV2026} approvalConfigV2026
|
|
63127
63211
|
* @param {*} [axiosOptions] Override http request option.
|
|
63128
63212
|
* @throws {RequiredError}
|
|
@@ -63134,7 +63218,7 @@ export const ApprovalsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
63134
63218
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
63135
63219
|
},
|
|
63136
63220
|
/**
|
|
63137
|
-
*
|
|
63221
|
+
* Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved.
|
|
63138
63222
|
* @summary Post Approvals Reject
|
|
63139
63223
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject.
|
|
63140
63224
|
* @param {ApprovalRejectRequestV2026} [approvalRejectRequestV2026]
|
|
@@ -63161,7 +63245,7 @@ export const ApprovalsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
63161
63245
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
63162
63246
|
},
|
|
63163
63247
|
/**
|
|
63164
|
-
*
|
|
63248
|
+
* Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs.
|
|
63165
63249
|
* @summary Post Approvals Attributes
|
|
63166
63250
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
|
|
63167
63251
|
* @param {ApprovalAttributesRequestV2026} approvalAttributesRequestV2026
|
|
@@ -63175,7 +63259,7 @@ export const ApprovalsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
63175
63259
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
63176
63260
|
},
|
|
63177
63261
|
/**
|
|
63178
|
-
*
|
|
63262
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
63179
63263
|
* @summary Post Approvals Comments
|
|
63180
63264
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to.
|
|
63181
63265
|
* @param {ApprovalCommentsRequestV2026} approvalCommentsRequestV2026
|
|
@@ -63189,7 +63273,7 @@ export const ApprovalsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
63189
63273
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
63190
63274
|
},
|
|
63191
63275
|
/**
|
|
63192
|
-
*
|
|
63276
|
+
* Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs.
|
|
63193
63277
|
* @summary Post Approvals Reassign
|
|
63194
63278
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign.
|
|
63195
63279
|
* @param {ApprovalReassignRequestV2026} approvalReassignRequestV2026
|
|
@@ -63213,7 +63297,7 @@ export const ApprovalsV2026ApiFactory = function (configuration?: Configuration,
|
|
|
63213
63297
|
const localVarFp = ApprovalsV2026ApiFp(configuration)
|
|
63214
63298
|
return {
|
|
63215
63299
|
/**
|
|
63216
|
-
*
|
|
63300
|
+
* Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user.
|
|
63217
63301
|
* @summary Post Approvals Approve
|
|
63218
63302
|
* @param {ApprovalsV2026ApiApproveApprovalRequest} requestParameters Request parameters.
|
|
63219
63303
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63233,7 +63317,7 @@ export const ApprovalsV2026ApiFactory = function (configuration?: Configuration,
|
|
|
63233
63317
|
return localVarFp.approveApprovalInBulk(requestParameters.bulkApproveRequestDTOV2026, axiosOptions).then((request) => request(axios, basePath));
|
|
63234
63318
|
},
|
|
63235
63319
|
/**
|
|
63236
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
63320
|
+
* Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel
|
|
63237
63321
|
* @summary Post Bulk Cancel Approvals
|
|
63238
63322
|
* @param {ApprovalsV2026ApiCancelApprovalRequest} requestParameters Request parameters.
|
|
63239
63323
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63242,6 +63326,16 @@ export const ApprovalsV2026ApiFactory = function (configuration?: Configuration,
|
|
|
63242
63326
|
cancelApproval(requestParameters: ApprovalsV2026ApiCancelApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object> {
|
|
63243
63327
|
return localVarFp.cancelApproval(requestParameters.bulkCancelRequestDTOV2026, axiosOptions).then((request) => request(axios, basePath));
|
|
63244
63328
|
},
|
|
63329
|
+
/**
|
|
63330
|
+
* Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel
|
|
63331
|
+
* @summary Post Approval Cancel
|
|
63332
|
+
* @param {ApprovalsV2026ApiCancelApprovalByIdRequest} requestParameters Request parameters.
|
|
63333
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
63334
|
+
* @throws {RequiredError}
|
|
63335
|
+
*/
|
|
63336
|
+
cancelApprovalById(requestParameters: ApprovalsV2026ApiCancelApprovalByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
63337
|
+
return localVarFp.cancelApprovalById(requestParameters.id, requestParameters.approvalCancelRequestV2026, axiosOptions).then((request) => request(axios, basePath));
|
|
63338
|
+
},
|
|
63245
63339
|
/**
|
|
63246
63340
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
63247
63341
|
* @summary Delete Approval Configuration
|
|
@@ -63253,7 +63347,7 @@ export const ApprovalsV2026ApiFactory = function (configuration?: Configuration,
|
|
|
63253
63347
|
return localVarFp.deleteApprovalConfigRequest(requestParameters.id, requestParameters.scope, axiosOptions).then((request) => request(axios, basePath));
|
|
63254
63348
|
},
|
|
63255
63349
|
/**
|
|
63256
|
-
*
|
|
63350
|
+
* Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"
|
|
63257
63351
|
* @summary Get an approval
|
|
63258
63352
|
* @param {ApprovalsV2026ApiGetApprovalRequest} requestParameters Request parameters.
|
|
63259
63353
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63263,14 +63357,14 @@ export const ApprovalsV2026ApiFactory = function (configuration?: Configuration,
|
|
|
63263
63357
|
return localVarFp.getApproval(requestParameters.id, axiosOptions).then((request) => request(axios, basePath));
|
|
63264
63358
|
},
|
|
63265
63359
|
/**
|
|
63266
|
-
*
|
|
63360
|
+
* Gets a list of approvals. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" Absence of all query parameters for non admins will will default to mine=true. Admin will default to mine=false. Absence of all query parameters for admins will return all approvals in the org.
|
|
63267
63361
|
* @summary Get approvals
|
|
63268
63362
|
* @param {ApprovalsV2026ApiGetApprovalsRequest} requestParameters Request parameters.
|
|
63269
63363
|
* @param {*} [axiosOptions] Override http request option.
|
|
63270
63364
|
* @throws {RequiredError}
|
|
63271
63365
|
*/
|
|
63272
63366
|
getApprovals(requestParameters: ApprovalsV2026ApiGetApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<ApprovalV2026>> {
|
|
63273
|
-
return localVarFp.getApprovals(requestParameters.mine, requestParameters.requesterId, requestParameters.requesteeId, requestParameters.approverId, requestParameters.count, requestParameters.countOnly, requestParameters.includeComments, requestParameters.includeApprovers, requestParameters.includeBatchInfo, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath));
|
|
63367
|
+
return localVarFp.getApprovals(requestParameters.mine, requestParameters.requesterId, requestParameters.requesteeId, requestParameters.approverId, requestParameters.count, requestParameters.countOnly, requestParameters.includeComments, requestParameters.includeApprovers, requestParameters.includeReassignmentHistory, requestParameters.includeBatchInfo, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath));
|
|
63274
63368
|
},
|
|
63275
63369
|
/**
|
|
63276
63370
|
* Retrieves a singular approval configuration that matches the given ID
|
|
@@ -63303,7 +63397,7 @@ export const ApprovalsV2026ApiFactory = function (configuration?: Configuration,
|
|
|
63303
63397
|
return localVarFp.putApprovalsConfig(requestParameters.id, requestParameters.scope, requestParameters.approvalConfigV2026, axiosOptions).then((request) => request(axios, basePath));
|
|
63304
63398
|
},
|
|
63305
63399
|
/**
|
|
63306
|
-
*
|
|
63400
|
+
* Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved.
|
|
63307
63401
|
* @summary Post Approvals Reject
|
|
63308
63402
|
* @param {ApprovalsV2026ApiRejectApprovalRequest} requestParameters Request parameters.
|
|
63309
63403
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63323,7 +63417,7 @@ export const ApprovalsV2026ApiFactory = function (configuration?: Configuration,
|
|
|
63323
63417
|
return localVarFp.rejectApprovalInBulk(requestParameters.bulkRejectRequestDTOV2026, axiosOptions).then((request) => request(axios, basePath));
|
|
63324
63418
|
},
|
|
63325
63419
|
/**
|
|
63326
|
-
*
|
|
63420
|
+
* Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs.
|
|
63327
63421
|
* @summary Post Approvals Attributes
|
|
63328
63422
|
* @param {ApprovalsV2026ApiUpdateApprovalsAttributesRequest} requestParameters Request parameters.
|
|
63329
63423
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63333,7 +63427,7 @@ export const ApprovalsV2026ApiFactory = function (configuration?: Configuration,
|
|
|
63333
63427
|
return localVarFp.updateApprovalsAttributes(requestParameters.id, requestParameters.approvalAttributesRequestV2026, axiosOptions).then((request) => request(axios, basePath));
|
|
63334
63428
|
},
|
|
63335
63429
|
/**
|
|
63336
|
-
*
|
|
63430
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
63337
63431
|
* @summary Post Approvals Comments
|
|
63338
63432
|
* @param {ApprovalsV2026ApiUpdateApprovalsCommentsRequest} requestParameters Request parameters.
|
|
63339
63433
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63343,7 +63437,7 @@ export const ApprovalsV2026ApiFactory = function (configuration?: Configuration,
|
|
|
63343
63437
|
return localVarFp.updateApprovalsComments(requestParameters.id, requestParameters.approvalCommentsRequestV2026, axiosOptions).then((request) => request(axios, basePath));
|
|
63344
63438
|
},
|
|
63345
63439
|
/**
|
|
63346
|
-
*
|
|
63440
|
+
* Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs.
|
|
63347
63441
|
* @summary Post Approvals Reassign
|
|
63348
63442
|
* @param {ApprovalsV2026ApiUpdateApprovalsReassignRequest} requestParameters Request parameters.
|
|
63349
63443
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63362,7 +63456,7 @@ export const ApprovalsV2026ApiFactory = function (configuration?: Configuration,
|
|
|
63362
63456
|
*/
|
|
63363
63457
|
export interface ApprovalsV2026ApiApproveApprovalRequest {
|
|
63364
63458
|
/**
|
|
63365
|
-
* Approval ID that correlates to an existing approval request that a user wants to approve
|
|
63459
|
+
* Approval ID that correlates to an existing approval request that a user wants to approve.
|
|
63366
63460
|
* @type {string}
|
|
63367
63461
|
* @memberof ApprovalsV2026ApiApproveApproval
|
|
63368
63462
|
*/
|
|
@@ -63404,6 +63498,27 @@ export interface ApprovalsV2026ApiCancelApprovalRequest {
|
|
|
63404
63498
|
readonly bulkCancelRequestDTOV2026: BulkCancelRequestDTOV2026
|
|
63405
63499
|
}
|
|
63406
63500
|
|
|
63501
|
+
/**
|
|
63502
|
+
* Request parameters for cancelApprovalById operation in ApprovalsV2026Api.
|
|
63503
|
+
* @export
|
|
63504
|
+
* @interface ApprovalsV2026ApiCancelApprovalByIdRequest
|
|
63505
|
+
*/
|
|
63506
|
+
export interface ApprovalsV2026ApiCancelApprovalByIdRequest {
|
|
63507
|
+
/**
|
|
63508
|
+
* ID of the approval request to cancel.
|
|
63509
|
+
* @type {string}
|
|
63510
|
+
* @memberof ApprovalsV2026ApiCancelApprovalById
|
|
63511
|
+
*/
|
|
63512
|
+
readonly id: string
|
|
63513
|
+
|
|
63514
|
+
/**
|
|
63515
|
+
*
|
|
63516
|
+
* @type {ApprovalCancelRequestV2026}
|
|
63517
|
+
* @memberof ApprovalsV2026ApiCancelApprovalById
|
|
63518
|
+
*/
|
|
63519
|
+
readonly approvalCancelRequestV2026?: ApprovalCancelRequestV2026
|
|
63520
|
+
}
|
|
63521
|
+
|
|
63407
63522
|
/**
|
|
63408
63523
|
* Request parameters for deleteApprovalConfigRequest operation in ApprovalsV2026Api.
|
|
63409
63524
|
* @export
|
|
@@ -63411,14 +63526,14 @@ export interface ApprovalsV2026ApiCancelApprovalRequest {
|
|
|
63411
63526
|
*/
|
|
63412
63527
|
export interface ApprovalsV2026ApiDeleteApprovalConfigRequestRequest {
|
|
63413
63528
|
/**
|
|
63414
|
-
* The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63529
|
+
* The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63415
63530
|
* @type {string}
|
|
63416
63531
|
* @memberof ApprovalsV2026ApiDeleteApprovalConfigRequest
|
|
63417
63532
|
*/
|
|
63418
63533
|
readonly id: string
|
|
63419
63534
|
|
|
63420
63535
|
/**
|
|
63421
|
-
* The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63536
|
+
* The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63422
63537
|
* @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'}
|
|
63423
63538
|
* @memberof ApprovalsV2026ApiDeleteApprovalConfigRequest
|
|
63424
63539
|
*/
|
|
@@ -63501,6 +63616,13 @@ export interface ApprovalsV2026ApiGetApprovalsRequest {
|
|
|
63501
63616
|
*/
|
|
63502
63617
|
readonly includeApprovers?: boolean
|
|
63503
63618
|
|
|
63619
|
+
/**
|
|
63620
|
+
* If set to true in the query, the approval requests returned will include reassignment history.
|
|
63621
|
+
* @type {boolean}
|
|
63622
|
+
* @memberof ApprovalsV2026ApiGetApprovals
|
|
63623
|
+
*/
|
|
63624
|
+
readonly includeReassignmentHistory?: boolean
|
|
63625
|
+
|
|
63504
63626
|
/**
|
|
63505
63627
|
* If set to true in the query, the approval requests returned will include batch information.
|
|
63506
63628
|
* @type {boolean}
|
|
@@ -63537,7 +63659,7 @@ export interface ApprovalsV2026ApiGetApprovalsRequest {
|
|
|
63537
63659
|
*/
|
|
63538
63660
|
export interface ApprovalsV2026ApiGetApprovalsConfigRequest {
|
|
63539
63661
|
/**
|
|
63540
|
-
* The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", (tenantID)]
|
|
63662
|
+
* The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)]
|
|
63541
63663
|
* @type {string}
|
|
63542
63664
|
* @memberof ApprovalsV2026ApiGetApprovalsConfig
|
|
63543
63665
|
*/
|
|
@@ -63565,14 +63687,14 @@ export interface ApprovalsV2026ApiMoveApprovalRequest {
|
|
|
63565
63687
|
*/
|
|
63566
63688
|
export interface ApprovalsV2026ApiPutApprovalsConfigRequest {
|
|
63567
63689
|
/**
|
|
63568
|
-
* The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63690
|
+
* The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63569
63691
|
* @type {string}
|
|
63570
63692
|
* @memberof ApprovalsV2026ApiPutApprovalsConfig
|
|
63571
63693
|
*/
|
|
63572
63694
|
readonly id: string
|
|
63573
63695
|
|
|
63574
63696
|
/**
|
|
63575
|
-
* The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63697
|
+
* The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
63576
63698
|
* @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'}
|
|
63577
63699
|
* @memberof ApprovalsV2026ApiPutApprovalsConfig
|
|
63578
63700
|
*/
|
|
@@ -63692,7 +63814,7 @@ export interface ApprovalsV2026ApiUpdateApprovalsReassignRequest {
|
|
|
63692
63814
|
*/
|
|
63693
63815
|
export class ApprovalsV2026Api extends BaseAPI {
|
|
63694
63816
|
/**
|
|
63695
|
-
*
|
|
63817
|
+
* Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user.
|
|
63696
63818
|
* @summary Post Approvals Approve
|
|
63697
63819
|
* @param {ApprovalsV2026ApiApproveApprovalRequest} requestParameters Request parameters.
|
|
63698
63820
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63716,7 +63838,7 @@ export class ApprovalsV2026Api extends BaseAPI {
|
|
|
63716
63838
|
}
|
|
63717
63839
|
|
|
63718
63840
|
/**
|
|
63719
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
63841
|
+
* Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel
|
|
63720
63842
|
* @summary Post Bulk Cancel Approvals
|
|
63721
63843
|
* @param {ApprovalsV2026ApiCancelApprovalRequest} requestParameters Request parameters.
|
|
63722
63844
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63727,6 +63849,18 @@ export class ApprovalsV2026Api extends BaseAPI {
|
|
|
63727
63849
|
return ApprovalsV2026ApiFp(this.configuration).cancelApproval(requestParameters.bulkCancelRequestDTOV2026, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
63728
63850
|
}
|
|
63729
63851
|
|
|
63852
|
+
/**
|
|
63853
|
+
* Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel
|
|
63854
|
+
* @summary Post Approval Cancel
|
|
63855
|
+
* @param {ApprovalsV2026ApiCancelApprovalByIdRequest} requestParameters Request parameters.
|
|
63856
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
63857
|
+
* @throws {RequiredError}
|
|
63858
|
+
* @memberof ApprovalsV2026Api
|
|
63859
|
+
*/
|
|
63860
|
+
public cancelApprovalById(requestParameters: ApprovalsV2026ApiCancelApprovalByIdRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
63861
|
+
return ApprovalsV2026ApiFp(this.configuration).cancelApprovalById(requestParameters.id, requestParameters.approvalCancelRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
63862
|
+
}
|
|
63863
|
+
|
|
63730
63864
|
/**
|
|
63731
63865
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
63732
63866
|
* @summary Delete Approval Configuration
|
|
@@ -63740,7 +63874,7 @@ export class ApprovalsV2026Api extends BaseAPI {
|
|
|
63740
63874
|
}
|
|
63741
63875
|
|
|
63742
63876
|
/**
|
|
63743
|
-
*
|
|
63877
|
+
* Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"
|
|
63744
63878
|
* @summary Get an approval
|
|
63745
63879
|
* @param {ApprovalsV2026ApiGetApprovalRequest} requestParameters Request parameters.
|
|
63746
63880
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63752,7 +63886,7 @@ export class ApprovalsV2026Api extends BaseAPI {
|
|
|
63752
63886
|
}
|
|
63753
63887
|
|
|
63754
63888
|
/**
|
|
63755
|
-
*
|
|
63889
|
+
* Gets a list of approvals. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" Absence of all query parameters for non admins will will default to mine=true. Admin will default to mine=false. Absence of all query parameters for admins will return all approvals in the org.
|
|
63756
63890
|
* @summary Get approvals
|
|
63757
63891
|
* @param {ApprovalsV2026ApiGetApprovalsRequest} requestParameters Request parameters.
|
|
63758
63892
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63760,7 +63894,7 @@ export class ApprovalsV2026Api extends BaseAPI {
|
|
|
63760
63894
|
* @memberof ApprovalsV2026Api
|
|
63761
63895
|
*/
|
|
63762
63896
|
public getApprovals(requestParameters: ApprovalsV2026ApiGetApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
|
|
63763
|
-
return ApprovalsV2026ApiFp(this.configuration).getApprovals(requestParameters.mine, requestParameters.requesterId, requestParameters.requesteeId, requestParameters.approverId, requestParameters.count, requestParameters.countOnly, requestParameters.includeComments, requestParameters.includeApprovers, requestParameters.includeBatchInfo, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
63897
|
+
return ApprovalsV2026ApiFp(this.configuration).getApprovals(requestParameters.mine, requestParameters.requesterId, requestParameters.requesteeId, requestParameters.approverId, requestParameters.count, requestParameters.countOnly, requestParameters.includeComments, requestParameters.includeApprovers, requestParameters.includeReassignmentHistory, requestParameters.includeBatchInfo, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
63764
63898
|
}
|
|
63765
63899
|
|
|
63766
63900
|
/**
|
|
@@ -63800,7 +63934,7 @@ export class ApprovalsV2026Api extends BaseAPI {
|
|
|
63800
63934
|
}
|
|
63801
63935
|
|
|
63802
63936
|
/**
|
|
63803
|
-
*
|
|
63937
|
+
* Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved.
|
|
63804
63938
|
* @summary Post Approvals Reject
|
|
63805
63939
|
* @param {ApprovalsV2026ApiRejectApprovalRequest} requestParameters Request parameters.
|
|
63806
63940
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63824,7 +63958,7 @@ export class ApprovalsV2026Api extends BaseAPI {
|
|
|
63824
63958
|
}
|
|
63825
63959
|
|
|
63826
63960
|
/**
|
|
63827
|
-
*
|
|
63961
|
+
* Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs.
|
|
63828
63962
|
* @summary Post Approvals Attributes
|
|
63829
63963
|
* @param {ApprovalsV2026ApiUpdateApprovalsAttributesRequest} requestParameters Request parameters.
|
|
63830
63964
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63836,7 +63970,7 @@ export class ApprovalsV2026Api extends BaseAPI {
|
|
|
63836
63970
|
}
|
|
63837
63971
|
|
|
63838
63972
|
/**
|
|
63839
|
-
*
|
|
63973
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
63840
63974
|
* @summary Post Approvals Comments
|
|
63841
63975
|
* @param {ApprovalsV2026ApiUpdateApprovalsCommentsRequest} requestParameters Request parameters.
|
|
63842
63976
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63848,7 +63982,7 @@ export class ApprovalsV2026Api extends BaseAPI {
|
|
|
63848
63982
|
}
|
|
63849
63983
|
|
|
63850
63984
|
/**
|
|
63851
|
-
*
|
|
63985
|
+
* Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs.
|
|
63852
63986
|
* @summary Post Approvals Reassign
|
|
63853
63987
|
* @param {ApprovalsV2026ApiUpdateApprovalsReassignRequest} requestParameters Request parameters.
|
|
63854
63988
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -77631,11 +77765,13 @@ export const CustomFormsV2026ApiAxiosParamCreator = function (configuration?: Co
|
|
|
77631
77765
|
/**
|
|
77632
77766
|
* Returns a list of form instances for the tenant. Optionally filter by form definition ID.
|
|
77633
77767
|
* @summary List form instances by tenant.
|
|
77768
|
+
* @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0.
|
|
77769
|
+
* @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used.
|
|
77634
77770
|
* @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: **formDefinitionId**: *eq*
|
|
77635
77771
|
* @param {*} [axiosOptions] Override http request option.
|
|
77636
77772
|
* @throws {RequiredError}
|
|
77637
77773
|
*/
|
|
77638
|
-
searchFormInstancesByTenant: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
77774
|
+
searchFormInstancesByTenant: async (offset?: number, limit?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
77639
77775
|
const localVarPath = `/form-instances`;
|
|
77640
77776
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
77641
77777
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -77656,6 +77792,14 @@ export const CustomFormsV2026ApiAxiosParamCreator = function (configuration?: Co
|
|
|
77656
77792
|
// oauth required
|
|
77657
77793
|
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
77658
77794
|
|
|
77795
|
+
if (offset !== undefined) {
|
|
77796
|
+
localVarQueryParameter['offset'] = offset;
|
|
77797
|
+
}
|
|
77798
|
+
|
|
77799
|
+
if (limit !== undefined) {
|
|
77800
|
+
localVarQueryParameter['limit'] = limit;
|
|
77801
|
+
}
|
|
77802
|
+
|
|
77659
77803
|
if (filters !== undefined) {
|
|
77660
77804
|
localVarQueryParameter['filters'] = filters;
|
|
77661
77805
|
}
|
|
@@ -77993,12 +78137,14 @@ export const CustomFormsV2026ApiFp = function(configuration?: Configuration) {
|
|
|
77993
78137
|
/**
|
|
77994
78138
|
* Returns a list of form instances for the tenant. Optionally filter by form definition ID.
|
|
77995
78139
|
* @summary List form instances by tenant.
|
|
78140
|
+
* @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0.
|
|
78141
|
+
* @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used.
|
|
77996
78142
|
* @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: **formDefinitionId**: *eq*
|
|
77997
78143
|
* @param {*} [axiosOptions] Override http request option.
|
|
77998
78144
|
* @throws {RequiredError}
|
|
77999
78145
|
*/
|
|
78000
|
-
async searchFormInstancesByTenant(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListFormInstancesByTenantResponseV2026>>> {
|
|
78001
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormInstancesByTenant(filters, axiosOptions);
|
|
78146
|
+
async searchFormInstancesByTenant(offset?: number, limit?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListFormInstancesByTenantResponseV2026>>> {
|
|
78147
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormInstancesByTenant(offset, limit, filters, axiosOptions);
|
|
78002
78148
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
78003
78149
|
const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.searchFormInstancesByTenant']?.[localVarOperationServerIndex]?.url;
|
|
78004
78150
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -78200,7 +78346,7 @@ export const CustomFormsV2026ApiFactory = function (configuration?: Configuratio
|
|
|
78200
78346
|
* @throws {RequiredError}
|
|
78201
78347
|
*/
|
|
78202
78348
|
searchFormInstancesByTenant(requestParameters: CustomFormsV2026ApiSearchFormInstancesByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<ListFormInstancesByTenantResponseV2026>> {
|
|
78203
|
-
return localVarFp.searchFormInstancesByTenant(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath));
|
|
78349
|
+
return localVarFp.searchFormInstancesByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath));
|
|
78204
78350
|
},
|
|
78205
78351
|
/**
|
|
78206
78352
|
* No parameters required.
|
|
@@ -78545,6 +78691,20 @@ export interface CustomFormsV2026ApiSearchFormElementDataByElementIDRequest {
|
|
|
78545
78691
|
* @interface CustomFormsV2026ApiSearchFormInstancesByTenantRequest
|
|
78546
78692
|
*/
|
|
78547
78693
|
export interface CustomFormsV2026ApiSearchFormInstancesByTenantRequest {
|
|
78694
|
+
/**
|
|
78695
|
+
* Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0.
|
|
78696
|
+
* @type {number}
|
|
78697
|
+
* @memberof CustomFormsV2026ApiSearchFormInstancesByTenant
|
|
78698
|
+
*/
|
|
78699
|
+
readonly offset?: number
|
|
78700
|
+
|
|
78701
|
+
/**
|
|
78702
|
+
* Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used.
|
|
78703
|
+
* @type {number}
|
|
78704
|
+
* @memberof CustomFormsV2026ApiSearchFormInstancesByTenant
|
|
78705
|
+
*/
|
|
78706
|
+
readonly limit?: number
|
|
78707
|
+
|
|
78548
78708
|
/**
|
|
78549
78709
|
* 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: **formDefinitionId**: *eq*
|
|
78550
78710
|
* @type {string}
|
|
@@ -78791,7 +78951,7 @@ export class CustomFormsV2026Api extends BaseAPI {
|
|
|
78791
78951
|
* @memberof CustomFormsV2026Api
|
|
78792
78952
|
*/
|
|
78793
78953
|
public searchFormInstancesByTenant(requestParameters: CustomFormsV2026ApiSearchFormInstancesByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
|
|
78794
|
-
return CustomFormsV2026ApiFp(this.configuration).searchFormInstancesByTenant(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
78954
|
+
return CustomFormsV2026ApiFp(this.configuration).searchFormInstancesByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
78795
78955
|
}
|
|
78796
78956
|
|
|
78797
78957
|
/**
|
|
@@ -143388,17 +143548,12 @@ export const TaskManagementV2026ApiAxiosParamCreator = function (configuration?:
|
|
|
143388
143548
|
* 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.
|
|
143389
143549
|
* @summary Get task status by id
|
|
143390
143550
|
* @param {string} id Task ID.
|
|
143391
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
143392
143551
|
* @param {*} [axiosOptions] Override http request option.
|
|
143393
143552
|
* @throws {RequiredError}
|
|
143394
143553
|
*/
|
|
143395
|
-
getTaskStatus: async (id: string,
|
|
143554
|
+
getTaskStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
143396
143555
|
// verify required parameter 'id' is not null or undefined
|
|
143397
143556
|
assertParamExists('getTaskStatus', 'id', id)
|
|
143398
|
-
if (xSailPointExperimental === undefined) {
|
|
143399
|
-
xSailPointExperimental = 'true';
|
|
143400
|
-
}
|
|
143401
|
-
|
|
143402
143557
|
const localVarPath = `/task-status/{id}`
|
|
143403
143558
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
143404
143559
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -143426,9 +143581,6 @@ export const TaskManagementV2026ApiAxiosParamCreator = function (configuration?:
|
|
|
143426
143581
|
|
|
143427
143582
|
|
|
143428
143583
|
|
|
143429
|
-
if (xSailPointExperimental != null) {
|
|
143430
|
-
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
143431
|
-
}
|
|
143432
143584
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
143433
143585
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
143434
143586
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
@@ -143446,15 +143598,10 @@ export const TaskManagementV2026ApiAxiosParamCreator = function (configuration?:
|
|
|
143446
143598
|
* @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.
|
|
143447
143599
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION
|
|
143448
143600
|
* @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**
|
|
143449
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
143450
143601
|
* @param {*} [axiosOptions] Override http request option.
|
|
143451
143602
|
* @throws {RequiredError}
|
|
143452
143603
|
*/
|
|
143453
|
-
getTaskStatusList: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string,
|
|
143454
|
-
if (xSailPointExperimental === undefined) {
|
|
143455
|
-
xSailPointExperimental = 'true';
|
|
143456
|
-
}
|
|
143457
|
-
|
|
143604
|
+
getTaskStatusList: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
143458
143605
|
const localVarPath = `/task-status`;
|
|
143459
143606
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
143460
143607
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -143501,9 +143648,6 @@ export const TaskManagementV2026ApiAxiosParamCreator = function (configuration?:
|
|
|
143501
143648
|
|
|
143502
143649
|
|
|
143503
143650
|
|
|
143504
|
-
if (xSailPointExperimental != null) {
|
|
143505
|
-
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
143506
|
-
}
|
|
143507
143651
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
143508
143652
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
143509
143653
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
@@ -143518,19 +143662,14 @@ export const TaskManagementV2026ApiAxiosParamCreator = function (configuration?:
|
|
|
143518
143662
|
* @summary Update task status by id
|
|
143519
143663
|
* @param {string} id Task ID.
|
|
143520
143664
|
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
143521
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
143522
143665
|
* @param {*} [axiosOptions] Override http request option.
|
|
143523
143666
|
* @throws {RequiredError}
|
|
143524
143667
|
*/
|
|
143525
|
-
updateTaskStatus: async (id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>,
|
|
143668
|
+
updateTaskStatus: async (id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
143526
143669
|
// verify required parameter 'id' is not null or undefined
|
|
143527
143670
|
assertParamExists('updateTaskStatus', 'id', id)
|
|
143528
143671
|
// verify required parameter 'jsonPatchOperationV2026' is not null or undefined
|
|
143529
143672
|
assertParamExists('updateTaskStatus', 'jsonPatchOperationV2026', jsonPatchOperationV2026)
|
|
143530
|
-
if (xSailPointExperimental === undefined) {
|
|
143531
|
-
xSailPointExperimental = 'true';
|
|
143532
|
-
}
|
|
143533
|
-
|
|
143534
143673
|
const localVarPath = `/task-status/{id}`
|
|
143535
143674
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
143536
143675
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -143556,9 +143695,6 @@ export const TaskManagementV2026ApiAxiosParamCreator = function (configuration?:
|
|
|
143556
143695
|
|
|
143557
143696
|
localVarHeaderParameter['Content-Type'] = 'application/json-patch+json';
|
|
143558
143697
|
|
|
143559
|
-
if (xSailPointExperimental != null) {
|
|
143560
|
-
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
143561
|
-
}
|
|
143562
143698
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
143563
143699
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
143564
143700
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
@@ -143583,12 +143719,11 @@ export const TaskManagementV2026ApiFp = function(configuration?: Configuration)
|
|
|
143583
143719
|
* 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.
|
|
143584
143720
|
* @summary Get task status by id
|
|
143585
143721
|
* @param {string} id Task ID.
|
|
143586
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
143587
143722
|
* @param {*} [axiosOptions] Override http request option.
|
|
143588
143723
|
* @throws {RequiredError}
|
|
143589
143724
|
*/
|
|
143590
|
-
async getTaskStatus(id: string,
|
|
143591
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatus(id,
|
|
143725
|
+
async getTaskStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2026>> {
|
|
143726
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatus(id, axiosOptions);
|
|
143592
143727
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
143593
143728
|
const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.getTaskStatus']?.[localVarOperationServerIndex]?.url;
|
|
143594
143729
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -143601,12 +143736,11 @@ export const TaskManagementV2026ApiFp = function(configuration?: Configuration)
|
|
|
143601
143736
|
* @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.
|
|
143602
143737
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION
|
|
143603
143738
|
* @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**
|
|
143604
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
143605
143739
|
* @param {*} [axiosOptions] Override http request option.
|
|
143606
143740
|
* @throws {RequiredError}
|
|
143607
143741
|
*/
|
|
143608
|
-
async getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string,
|
|
143609
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatusList(limit, offset, count, filters, sorters,
|
|
143742
|
+
async getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskStatusV2026>>> {
|
|
143743
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatusList(limit, offset, count, filters, sorters, axiosOptions);
|
|
143610
143744
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
143611
143745
|
const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.getTaskStatusList']?.[localVarOperationServerIndex]?.url;
|
|
143612
143746
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -143616,12 +143750,11 @@ export const TaskManagementV2026ApiFp = function(configuration?: Configuration)
|
|
|
143616
143750
|
* @summary Update task status by id
|
|
143617
143751
|
* @param {string} id Task ID.
|
|
143618
143752
|
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
143619
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
143620
143753
|
* @param {*} [axiosOptions] Override http request option.
|
|
143621
143754
|
* @throws {RequiredError}
|
|
143622
143755
|
*/
|
|
143623
|
-
async updateTaskStatus(id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>,
|
|
143624
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateTaskStatus(id, jsonPatchOperationV2026,
|
|
143756
|
+
async updateTaskStatus(id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2026>> {
|
|
143757
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateTaskStatus(id, jsonPatchOperationV2026, axiosOptions);
|
|
143625
143758
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
143626
143759
|
const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.updateTaskStatus']?.[localVarOperationServerIndex]?.url;
|
|
143627
143760
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -143644,7 +143777,7 @@ export const TaskManagementV2026ApiFactory = function (configuration?: Configura
|
|
|
143644
143777
|
* @throws {RequiredError}
|
|
143645
143778
|
*/
|
|
143646
143779
|
getTaskStatus(requestParameters: TaskManagementV2026ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TaskStatusV2026> {
|
|
143647
|
-
return localVarFp.getTaskStatus(requestParameters.id,
|
|
143780
|
+
return localVarFp.getTaskStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath));
|
|
143648
143781
|
},
|
|
143649
143782
|
/**
|
|
143650
143783
|
* Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field.
|
|
@@ -143654,7 +143787,7 @@ export const TaskManagementV2026ApiFactory = function (configuration?: Configura
|
|
|
143654
143787
|
* @throws {RequiredError}
|
|
143655
143788
|
*/
|
|
143656
143789
|
getTaskStatusList(requestParameters: TaskManagementV2026ApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<TaskStatusV2026>> {
|
|
143657
|
-
return localVarFp.getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters,
|
|
143790
|
+
return localVarFp.getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath));
|
|
143658
143791
|
},
|
|
143659
143792
|
/**
|
|
143660
143793
|
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
@@ -143664,7 +143797,7 @@ export const TaskManagementV2026ApiFactory = function (configuration?: Configura
|
|
|
143664
143797
|
* @throws {RequiredError}
|
|
143665
143798
|
*/
|
|
143666
143799
|
updateTaskStatus(requestParameters: TaskManagementV2026ApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TaskStatusV2026> {
|
|
143667
|
-
return localVarFp.updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2026,
|
|
143800
|
+
return localVarFp.updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath));
|
|
143668
143801
|
},
|
|
143669
143802
|
};
|
|
143670
143803
|
};
|
|
@@ -143681,13 +143814,6 @@ export interface TaskManagementV2026ApiGetTaskStatusRequest {
|
|
|
143681
143814
|
* @memberof TaskManagementV2026ApiGetTaskStatus
|
|
143682
143815
|
*/
|
|
143683
143816
|
readonly id: string
|
|
143684
|
-
|
|
143685
|
-
/**
|
|
143686
|
-
* Use this header to enable this experimental API.
|
|
143687
|
-
* @type {string}
|
|
143688
|
-
* @memberof TaskManagementV2026ApiGetTaskStatus
|
|
143689
|
-
*/
|
|
143690
|
-
readonly xSailPointExperimental?: string
|
|
143691
143817
|
}
|
|
143692
143818
|
|
|
143693
143819
|
/**
|
|
@@ -143730,13 +143856,6 @@ export interface TaskManagementV2026ApiGetTaskStatusListRequest {
|
|
|
143730
143856
|
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
143731
143857
|
*/
|
|
143732
143858
|
readonly sorters?: string
|
|
143733
|
-
|
|
143734
|
-
/**
|
|
143735
|
-
* Use this header to enable this experimental API.
|
|
143736
|
-
* @type {string}
|
|
143737
|
-
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
143738
|
-
*/
|
|
143739
|
-
readonly xSailPointExperimental?: string
|
|
143740
143859
|
}
|
|
143741
143860
|
|
|
143742
143861
|
/**
|
|
@@ -143758,13 +143877,6 @@ export interface TaskManagementV2026ApiUpdateTaskStatusRequest {
|
|
|
143758
143877
|
* @memberof TaskManagementV2026ApiUpdateTaskStatus
|
|
143759
143878
|
*/
|
|
143760
143879
|
readonly jsonPatchOperationV2026: Array<JsonPatchOperationV2026>
|
|
143761
|
-
|
|
143762
|
-
/**
|
|
143763
|
-
* Use this header to enable this experimental API.
|
|
143764
|
-
* @type {string}
|
|
143765
|
-
* @memberof TaskManagementV2026ApiUpdateTaskStatus
|
|
143766
|
-
*/
|
|
143767
|
-
readonly xSailPointExperimental?: string
|
|
143768
143880
|
}
|
|
143769
143881
|
|
|
143770
143882
|
/**
|
|
@@ -143783,7 +143895,7 @@ export class TaskManagementV2026Api extends BaseAPI {
|
|
|
143783
143895
|
* @memberof TaskManagementV2026Api
|
|
143784
143896
|
*/
|
|
143785
143897
|
public getTaskStatus(requestParameters: TaskManagementV2026ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
143786
|
-
return TaskManagementV2026ApiFp(this.configuration).getTaskStatus(requestParameters.id,
|
|
143898
|
+
return TaskManagementV2026ApiFp(this.configuration).getTaskStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
143787
143899
|
}
|
|
143788
143900
|
|
|
143789
143901
|
/**
|
|
@@ -143795,7 +143907,7 @@ export class TaskManagementV2026Api extends BaseAPI {
|
|
|
143795
143907
|
* @memberof TaskManagementV2026Api
|
|
143796
143908
|
*/
|
|
143797
143909
|
public getTaskStatusList(requestParameters: TaskManagementV2026ApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
|
|
143798
|
-
return TaskManagementV2026ApiFp(this.configuration).getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters,
|
|
143910
|
+
return TaskManagementV2026ApiFp(this.configuration).getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
143799
143911
|
}
|
|
143800
143912
|
|
|
143801
143913
|
/**
|
|
@@ -143807,7 +143919,7 @@ export class TaskManagementV2026Api extends BaseAPI {
|
|
|
143807
143919
|
* @memberof TaskManagementV2026Api
|
|
143808
143920
|
*/
|
|
143809
143921
|
public updateTaskStatus(requestParameters: TaskManagementV2026ApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
143810
|
-
return TaskManagementV2026ApiFp(this.configuration).updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2026,
|
|
143922
|
+
return TaskManagementV2026ApiFp(this.configuration).updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
143811
143923
|
}
|
|
143812
143924
|
}
|
|
143813
143925
|
|