sailpoint-api-client 1.8.17 → 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/v2025/api.ts
CHANGED
|
@@ -7495,24 +7495,6 @@ export type ApprovalConfigTimeoutConfigV2025TimeoutResultV2025 = typeof Approval
|
|
|
7495
7495
|
* @interface ApprovalConfigV2025
|
|
7496
7496
|
*/
|
|
7497
7497
|
export interface ApprovalConfigV2025 {
|
|
7498
|
-
/**
|
|
7499
|
-
* Tenant ID of the approval configuration.
|
|
7500
|
-
* @type {string}
|
|
7501
|
-
* @memberof ApprovalConfigV2025
|
|
7502
|
-
*/
|
|
7503
|
-
'tenantId'?: string;
|
|
7504
|
-
/**
|
|
7505
|
-
* 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
|
|
7506
|
-
* @type {string}
|
|
7507
|
-
* @memberof ApprovalConfigV2025
|
|
7508
|
-
*/
|
|
7509
|
-
'id'?: string;
|
|
7510
|
-
/**
|
|
7511
|
-
* 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
|
|
7512
|
-
* @type {string}
|
|
7513
|
-
* @memberof ApprovalConfigV2025
|
|
7514
|
-
*/
|
|
7515
|
-
'scope'?: string;
|
|
7516
7498
|
/**
|
|
7517
7499
|
*
|
|
7518
7500
|
* @type {ApprovalConfigReminderConfigV2025}
|
|
@@ -7555,6 +7537,18 @@ export interface ApprovalConfigV2025 {
|
|
|
7555
7537
|
* @memberof ApprovalConfigV2025
|
|
7556
7538
|
*/
|
|
7557
7539
|
'fallbackApprover'?: ApprovalIdentityV2025;
|
|
7540
|
+
/**
|
|
7541
|
+
* Specifies how to treat the identity type \"MANAGER_OF\" when the requestee is a machine identity.
|
|
7542
|
+
* @type {string}
|
|
7543
|
+
* @memberof ApprovalConfigV2025
|
|
7544
|
+
*/
|
|
7545
|
+
'machineIdentityManagerAssignment'?: ApprovalConfigV2025MachineIdentityManagerAssignmentV2025;
|
|
7546
|
+
/**
|
|
7547
|
+
* When true, all approvals will be created with the status \"PASSED\".
|
|
7548
|
+
* @type {boolean}
|
|
7549
|
+
* @memberof ApprovalConfigV2025
|
|
7550
|
+
*/
|
|
7551
|
+
'circumventApprovalProcess'?: boolean;
|
|
7558
7552
|
/**
|
|
7559
7553
|
* 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.
|
|
7560
7554
|
* @type {string}
|
|
@@ -7571,6 +7565,17 @@ export const ApprovalConfigV2025RequiresCommentV2025 = {
|
|
|
7571
7565
|
} as const;
|
|
7572
7566
|
|
|
7573
7567
|
export type ApprovalConfigV2025RequiresCommentV2025 = typeof ApprovalConfigV2025RequiresCommentV2025[keyof typeof ApprovalConfigV2025RequiresCommentV2025];
|
|
7568
|
+
export const ApprovalConfigV2025MachineIdentityManagerAssignmentV2025 = {
|
|
7569
|
+
ManagerOfRequester: 'MANAGER_OF_REQUESTER',
|
|
7570
|
+
MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER',
|
|
7571
|
+
ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER',
|
|
7572
|
+
RequestedTargetOwner: 'REQUESTED_TARGET_OWNER',
|
|
7573
|
+
ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER',
|
|
7574
|
+
AccountOwner: 'ACCOUNT_OWNER',
|
|
7575
|
+
ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER'
|
|
7576
|
+
} as const;
|
|
7577
|
+
|
|
7578
|
+
export type ApprovalConfigV2025MachineIdentityManagerAssignmentV2025 = typeof ApprovalConfigV2025MachineIdentityManagerAssignmentV2025[keyof typeof ApprovalConfigV2025MachineIdentityManagerAssignmentV2025];
|
|
7574
7579
|
export const ApprovalConfigV2025AutoApproveV2025 = {
|
|
7575
7580
|
Off: 'OFF',
|
|
7576
7581
|
Direct: 'DIRECT',
|
|
@@ -60619,9 +60624,9 @@ export type GetDiscoveredApplicationsDetailV2025 = typeof GetDiscoveredApplicati
|
|
|
60619
60624
|
export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
60620
60625
|
return {
|
|
60621
60626
|
/**
|
|
60622
|
-
*
|
|
60627
|
+
* 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.
|
|
60623
60628
|
* @summary Post Approvals Approve
|
|
60624
|
-
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve
|
|
60629
|
+
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve.
|
|
60625
60630
|
* @param {ApprovalApproveRequestV2025} [approvalApproveRequestV2025]
|
|
60626
60631
|
* @param {*} [axiosOptions] Override http request option.
|
|
60627
60632
|
* @throws {RequiredError}
|
|
@@ -60709,7 +60714,7 @@ export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
60709
60714
|
};
|
|
60710
60715
|
},
|
|
60711
60716
|
/**
|
|
60712
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
60717
|
+
* 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
|
|
60713
60718
|
* @summary Post Bulk Cancel Approvals
|
|
60714
60719
|
* @param {BulkCancelRequestDTOV2025} bulkCancelRequestDTOV2025
|
|
60715
60720
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -60755,8 +60760,8 @@ export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
60755
60760
|
/**
|
|
60756
60761
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
60757
60762
|
* @summary Delete Approval Configuration
|
|
60758
|
-
* @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
|
|
60759
|
-
* @param {DeleteApprovalConfigRequestScopeV2025} 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
|
|
60763
|
+
* @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
|
|
60764
|
+
* @param {DeleteApprovalConfigRequestScopeV2025} 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
|
|
60760
60765
|
* @param {*} [axiosOptions] Override http request option.
|
|
60761
60766
|
* @throws {RequiredError}
|
|
60762
60767
|
*/
|
|
@@ -60799,7 +60804,7 @@ export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
60799
60804
|
};
|
|
60800
60805
|
},
|
|
60801
60806
|
/**
|
|
60802
|
-
*
|
|
60807
|
+
* 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\"
|
|
60803
60808
|
* @summary Get an approval
|
|
60804
60809
|
* @param {string} id ID of the approval that is to be returned
|
|
60805
60810
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -60841,7 +60846,7 @@ export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
60841
60846
|
};
|
|
60842
60847
|
},
|
|
60843
60848
|
/**
|
|
60844
|
-
*
|
|
60849
|
+
* 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.
|
|
60845
60850
|
* @summary Get approvals
|
|
60846
60851
|
* @param {boolean} [mine] Returns the list of approvals for the current caller. Defaults to false if admin, true otherwise.
|
|
60847
60852
|
* @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.
|
|
@@ -60851,6 +60856,7 @@ export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
60851
60856
|
* @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.
|
|
60852
60857
|
* @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments.
|
|
60853
60858
|
* @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers.
|
|
60859
|
+
* @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history.
|
|
60854
60860
|
* @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch information.
|
|
60855
60861
|
* @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*
|
|
60856
60862
|
* @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.
|
|
@@ -60858,7 +60864,7 @@ export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
60858
60864
|
* @param {*} [axiosOptions] Override http request option.
|
|
60859
60865
|
* @throws {RequiredError}
|
|
60860
60866
|
*/
|
|
60861
|
-
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> => {
|
|
60867
|
+
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> => {
|
|
60862
60868
|
const localVarPath = `/generic-approvals`;
|
|
60863
60869
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
60864
60870
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -60911,6 +60917,10 @@ export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
60911
60917
|
localVarQueryParameter['include-approvers'] = includeApprovers;
|
|
60912
60918
|
}
|
|
60913
60919
|
|
|
60920
|
+
if (includeReassignmentHistory !== undefined) {
|
|
60921
|
+
localVarQueryParameter['include-reassignment-history'] = includeReassignmentHistory;
|
|
60922
|
+
}
|
|
60923
|
+
|
|
60914
60924
|
if (includeBatchInfo !== undefined) {
|
|
60915
60925
|
localVarQueryParameter['include-batch-info'] = includeBatchInfo;
|
|
60916
60926
|
}
|
|
@@ -60941,7 +60951,7 @@ export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
60941
60951
|
/**
|
|
60942
60952
|
* Retrieves a singular approval configuration that matches the given ID
|
|
60943
60953
|
* @summary Get Approval Config
|
|
60944
|
-
* @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)]
|
|
60954
|
+
* @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)]
|
|
60945
60955
|
* @param {*} [axiosOptions] Override http request option.
|
|
60946
60956
|
* @throws {RequiredError}
|
|
60947
60957
|
*/
|
|
@@ -61027,8 +61037,8 @@ export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
61027
61037
|
/**
|
|
61028
61038
|
* 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\'
|
|
61029
61039
|
* @summary Put Approval Config
|
|
61030
|
-
* @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
|
|
61031
|
-
* @param {PutApprovalsConfigScopeV2025} 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
|
|
61040
|
+
* @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
|
|
61041
|
+
* @param {PutApprovalsConfigScopeV2025} 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
|
|
61032
61042
|
* @param {ApprovalConfigV2025} approvalConfigV2025
|
|
61033
61043
|
* @param {*} [axiosOptions] Override http request option.
|
|
61034
61044
|
* @throws {RequiredError}
|
|
@@ -61077,7 +61087,7 @@ export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
61077
61087
|
};
|
|
61078
61088
|
},
|
|
61079
61089
|
/**
|
|
61080
|
-
*
|
|
61090
|
+
* 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.
|
|
61081
61091
|
* @summary Post Approvals Reject
|
|
61082
61092
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject.
|
|
61083
61093
|
* @param {ApprovalRejectRequestV2025} [approvalRejectRequestV2025]
|
|
@@ -61167,7 +61177,7 @@ export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
61167
61177
|
};
|
|
61168
61178
|
},
|
|
61169
61179
|
/**
|
|
61170
|
-
*
|
|
61180
|
+
* 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.
|
|
61171
61181
|
* @summary Post Approvals Attributes
|
|
61172
61182
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
|
|
61173
61183
|
* @param {ApprovalAttributesRequestV2025} approvalAttributesRequestV2025
|
|
@@ -61215,7 +61225,7 @@ export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
61215
61225
|
};
|
|
61216
61226
|
},
|
|
61217
61227
|
/**
|
|
61218
|
-
*
|
|
61228
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
61219
61229
|
* @summary Post Approvals Comments
|
|
61220
61230
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to.
|
|
61221
61231
|
* @param {ApprovalCommentsRequestV2025} approvalCommentsRequestV2025
|
|
@@ -61263,7 +61273,7 @@ export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Conf
|
|
|
61263
61273
|
};
|
|
61264
61274
|
},
|
|
61265
61275
|
/**
|
|
61266
|
-
*
|
|
61276
|
+
* 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.
|
|
61267
61277
|
* @summary Post Approvals Reassign
|
|
61268
61278
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign.
|
|
61269
61279
|
* @param {ApprovalReassignRequestV2025} approvalReassignRequestV2025
|
|
@@ -61321,9 +61331,9 @@ export const ApprovalsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
61321
61331
|
const localVarAxiosParamCreator = ApprovalsV2025ApiAxiosParamCreator(configuration)
|
|
61322
61332
|
return {
|
|
61323
61333
|
/**
|
|
61324
|
-
*
|
|
61334
|
+
* 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.
|
|
61325
61335
|
* @summary Post Approvals Approve
|
|
61326
|
-
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve
|
|
61336
|
+
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve.
|
|
61327
61337
|
* @param {ApprovalApproveRequestV2025} [approvalApproveRequestV2025]
|
|
61328
61338
|
* @param {*} [axiosOptions] Override http request option.
|
|
61329
61339
|
* @throws {RequiredError}
|
|
@@ -61348,7 +61358,7 @@ export const ApprovalsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
61348
61358
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
61349
61359
|
},
|
|
61350
61360
|
/**
|
|
61351
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
61361
|
+
* 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
|
|
61352
61362
|
* @summary Post Bulk Cancel Approvals
|
|
61353
61363
|
* @param {BulkCancelRequestDTOV2025} bulkCancelRequestDTOV2025
|
|
61354
61364
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61363,8 +61373,8 @@ export const ApprovalsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
61363
61373
|
/**
|
|
61364
61374
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
61365
61375
|
* @summary Delete Approval Configuration
|
|
61366
|
-
* @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
|
|
61367
|
-
* @param {DeleteApprovalConfigRequestScopeV2025} 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
|
|
61376
|
+
* @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
|
|
61377
|
+
* @param {DeleteApprovalConfigRequestScopeV2025} 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
|
|
61368
61378
|
* @param {*} [axiosOptions] Override http request option.
|
|
61369
61379
|
* @throws {RequiredError}
|
|
61370
61380
|
*/
|
|
@@ -61375,7 +61385,7 @@ export const ApprovalsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
61375
61385
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
61376
61386
|
},
|
|
61377
61387
|
/**
|
|
61378
|
-
*
|
|
61388
|
+
* 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\"
|
|
61379
61389
|
* @summary Get an approval
|
|
61380
61390
|
* @param {string} id ID of the approval that is to be returned
|
|
61381
61391
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61388,7 +61398,7 @@ export const ApprovalsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
61388
61398
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
61389
61399
|
},
|
|
61390
61400
|
/**
|
|
61391
|
-
*
|
|
61401
|
+
* 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.
|
|
61392
61402
|
* @summary Get approvals
|
|
61393
61403
|
* @param {boolean} [mine] Returns the list of approvals for the current caller. Defaults to false if admin, true otherwise.
|
|
61394
61404
|
* @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.
|
|
@@ -61398,6 +61408,7 @@ export const ApprovalsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
61398
61408
|
* @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.
|
|
61399
61409
|
* @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments.
|
|
61400
61410
|
* @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers.
|
|
61411
|
+
* @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history.
|
|
61401
61412
|
* @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch information.
|
|
61402
61413
|
* @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*
|
|
61403
61414
|
* @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.
|
|
@@ -61405,8 +61416,8 @@ export const ApprovalsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
61405
61416
|
* @param {*} [axiosOptions] Override http request option.
|
|
61406
61417
|
* @throws {RequiredError}
|
|
61407
61418
|
*/
|
|
61408
|
-
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<ApprovalV2025>>> {
|
|
61409
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getApprovals(mine, requesterId, requesteeId, approverId, count, countOnly, includeComments, includeApprovers, includeBatchInfo, filters, limit, offset, axiosOptions);
|
|
61419
|
+
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<ApprovalV2025>>> {
|
|
61420
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getApprovals(mine, requesterId, requesteeId, approverId, count, countOnly, includeComments, includeApprovers, includeReassignmentHistory, includeBatchInfo, filters, limit, offset, axiosOptions);
|
|
61410
61421
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
61411
61422
|
const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.getApprovals']?.[localVarOperationServerIndex]?.url;
|
|
61412
61423
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -61414,7 +61425,7 @@ export const ApprovalsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
61414
61425
|
/**
|
|
61415
61426
|
* Retrieves a singular approval configuration that matches the given ID
|
|
61416
61427
|
* @summary Get Approval Config
|
|
61417
|
-
* @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)]
|
|
61428
|
+
* @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)]
|
|
61418
61429
|
* @param {*} [axiosOptions] Override http request option.
|
|
61419
61430
|
* @throws {RequiredError}
|
|
61420
61431
|
*/
|
|
@@ -61440,8 +61451,8 @@ export const ApprovalsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
61440
61451
|
/**
|
|
61441
61452
|
* 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\'
|
|
61442
61453
|
* @summary Put Approval Config
|
|
61443
|
-
* @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
|
|
61444
|
-
* @param {PutApprovalsConfigScopeV2025} 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
|
|
61454
|
+
* @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
|
|
61455
|
+
* @param {PutApprovalsConfigScopeV2025} 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
|
|
61445
61456
|
* @param {ApprovalConfigV2025} approvalConfigV2025
|
|
61446
61457
|
* @param {*} [axiosOptions] Override http request option.
|
|
61447
61458
|
* @throws {RequiredError}
|
|
@@ -61453,7 +61464,7 @@ export const ApprovalsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
61453
61464
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
61454
61465
|
},
|
|
61455
61466
|
/**
|
|
61456
|
-
*
|
|
61467
|
+
* 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.
|
|
61457
61468
|
* @summary Post Approvals Reject
|
|
61458
61469
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject.
|
|
61459
61470
|
* @param {ApprovalRejectRequestV2025} [approvalRejectRequestV2025]
|
|
@@ -61480,7 +61491,7 @@ export const ApprovalsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
61480
61491
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
61481
61492
|
},
|
|
61482
61493
|
/**
|
|
61483
|
-
*
|
|
61494
|
+
* 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.
|
|
61484
61495
|
* @summary Post Approvals Attributes
|
|
61485
61496
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
|
|
61486
61497
|
* @param {ApprovalAttributesRequestV2025} approvalAttributesRequestV2025
|
|
@@ -61494,7 +61505,7 @@ export const ApprovalsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
61494
61505
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
61495
61506
|
},
|
|
61496
61507
|
/**
|
|
61497
|
-
*
|
|
61508
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
61498
61509
|
* @summary Post Approvals Comments
|
|
61499
61510
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to.
|
|
61500
61511
|
* @param {ApprovalCommentsRequestV2025} approvalCommentsRequestV2025
|
|
@@ -61508,7 +61519,7 @@ export const ApprovalsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
61508
61519
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
61509
61520
|
},
|
|
61510
61521
|
/**
|
|
61511
|
-
*
|
|
61522
|
+
* 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.
|
|
61512
61523
|
* @summary Post Approvals Reassign
|
|
61513
61524
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign.
|
|
61514
61525
|
* @param {ApprovalReassignRequestV2025} approvalReassignRequestV2025
|
|
@@ -61532,7 +61543,7 @@ export const ApprovalsV2025ApiFactory = function (configuration?: Configuration,
|
|
|
61532
61543
|
const localVarFp = ApprovalsV2025ApiFp(configuration)
|
|
61533
61544
|
return {
|
|
61534
61545
|
/**
|
|
61535
|
-
*
|
|
61546
|
+
* 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.
|
|
61536
61547
|
* @summary Post Approvals Approve
|
|
61537
61548
|
* @param {ApprovalsV2025ApiApproveApprovalRequest} requestParameters Request parameters.
|
|
61538
61549
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61552,7 +61563,7 @@ export const ApprovalsV2025ApiFactory = function (configuration?: Configuration,
|
|
|
61552
61563
|
return localVarFp.approveApprovalInBulk(requestParameters.bulkApproveRequestDTOV2025, axiosOptions).then((request) => request(axios, basePath));
|
|
61553
61564
|
},
|
|
61554
61565
|
/**
|
|
61555
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
61566
|
+
* 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
|
|
61556
61567
|
* @summary Post Bulk Cancel Approvals
|
|
61557
61568
|
* @param {ApprovalsV2025ApiCancelApprovalRequest} requestParameters Request parameters.
|
|
61558
61569
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61572,7 +61583,7 @@ export const ApprovalsV2025ApiFactory = function (configuration?: Configuration,
|
|
|
61572
61583
|
return localVarFp.deleteApprovalConfigRequest(requestParameters.id, requestParameters.scope, axiosOptions).then((request) => request(axios, basePath));
|
|
61573
61584
|
},
|
|
61574
61585
|
/**
|
|
61575
|
-
*
|
|
61586
|
+
* 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\"
|
|
61576
61587
|
* @summary Get an approval
|
|
61577
61588
|
* @param {ApprovalsV2025ApiGetApprovalRequest} requestParameters Request parameters.
|
|
61578
61589
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61582,14 +61593,14 @@ export const ApprovalsV2025ApiFactory = function (configuration?: Configuration,
|
|
|
61582
61593
|
return localVarFp.getApproval(requestParameters.id, axiosOptions).then((request) => request(axios, basePath));
|
|
61583
61594
|
},
|
|
61584
61595
|
/**
|
|
61585
|
-
*
|
|
61596
|
+
* 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.
|
|
61586
61597
|
* @summary Get approvals
|
|
61587
61598
|
* @param {ApprovalsV2025ApiGetApprovalsRequest} requestParameters Request parameters.
|
|
61588
61599
|
* @param {*} [axiosOptions] Override http request option.
|
|
61589
61600
|
* @throws {RequiredError}
|
|
61590
61601
|
*/
|
|
61591
61602
|
getApprovals(requestParameters: ApprovalsV2025ApiGetApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<ApprovalV2025>> {
|
|
61592
|
-
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));
|
|
61603
|
+
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));
|
|
61593
61604
|
},
|
|
61594
61605
|
/**
|
|
61595
61606
|
* Retrieves a singular approval configuration that matches the given ID
|
|
@@ -61622,7 +61633,7 @@ export const ApprovalsV2025ApiFactory = function (configuration?: Configuration,
|
|
|
61622
61633
|
return localVarFp.putApprovalsConfig(requestParameters.id, requestParameters.scope, requestParameters.approvalConfigV2025, axiosOptions).then((request) => request(axios, basePath));
|
|
61623
61634
|
},
|
|
61624
61635
|
/**
|
|
61625
|
-
*
|
|
61636
|
+
* 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.
|
|
61626
61637
|
* @summary Post Approvals Reject
|
|
61627
61638
|
* @param {ApprovalsV2025ApiRejectApprovalRequest} requestParameters Request parameters.
|
|
61628
61639
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61642,7 +61653,7 @@ export const ApprovalsV2025ApiFactory = function (configuration?: Configuration,
|
|
|
61642
61653
|
return localVarFp.rejectApprovalInBulk(requestParameters.bulkRejectRequestDTOV2025, axiosOptions).then((request) => request(axios, basePath));
|
|
61643
61654
|
},
|
|
61644
61655
|
/**
|
|
61645
|
-
*
|
|
61656
|
+
* 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.
|
|
61646
61657
|
* @summary Post Approvals Attributes
|
|
61647
61658
|
* @param {ApprovalsV2025ApiUpdateApprovalsAttributesRequest} requestParameters Request parameters.
|
|
61648
61659
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61652,7 +61663,7 @@ export const ApprovalsV2025ApiFactory = function (configuration?: Configuration,
|
|
|
61652
61663
|
return localVarFp.updateApprovalsAttributes(requestParameters.id, requestParameters.approvalAttributesRequestV2025, axiosOptions).then((request) => request(axios, basePath));
|
|
61653
61664
|
},
|
|
61654
61665
|
/**
|
|
61655
|
-
*
|
|
61666
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
61656
61667
|
* @summary Post Approvals Comments
|
|
61657
61668
|
* @param {ApprovalsV2025ApiUpdateApprovalsCommentsRequest} requestParameters Request parameters.
|
|
61658
61669
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61662,7 +61673,7 @@ export const ApprovalsV2025ApiFactory = function (configuration?: Configuration,
|
|
|
61662
61673
|
return localVarFp.updateApprovalsComments(requestParameters.id, requestParameters.approvalCommentsRequestV2025, axiosOptions).then((request) => request(axios, basePath));
|
|
61663
61674
|
},
|
|
61664
61675
|
/**
|
|
61665
|
-
*
|
|
61676
|
+
* 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.
|
|
61666
61677
|
* @summary Post Approvals Reassign
|
|
61667
61678
|
* @param {ApprovalsV2025ApiUpdateApprovalsReassignRequest} requestParameters Request parameters.
|
|
61668
61679
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61681,7 +61692,7 @@ export const ApprovalsV2025ApiFactory = function (configuration?: Configuration,
|
|
|
61681
61692
|
*/
|
|
61682
61693
|
export interface ApprovalsV2025ApiApproveApprovalRequest {
|
|
61683
61694
|
/**
|
|
61684
|
-
* Approval ID that correlates to an existing approval request that a user wants to approve
|
|
61695
|
+
* Approval ID that correlates to an existing approval request that a user wants to approve.
|
|
61685
61696
|
* @type {string}
|
|
61686
61697
|
* @memberof ApprovalsV2025ApiApproveApproval
|
|
61687
61698
|
*/
|
|
@@ -61730,14 +61741,14 @@ export interface ApprovalsV2025ApiCancelApprovalRequest {
|
|
|
61730
61741
|
*/
|
|
61731
61742
|
export interface ApprovalsV2025ApiDeleteApprovalConfigRequestRequest {
|
|
61732
61743
|
/**
|
|
61733
|
-
* 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
|
|
61744
|
+
* 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
|
|
61734
61745
|
* @type {string}
|
|
61735
61746
|
* @memberof ApprovalsV2025ApiDeleteApprovalConfigRequest
|
|
61736
61747
|
*/
|
|
61737
61748
|
readonly id: string
|
|
61738
61749
|
|
|
61739
61750
|
/**
|
|
61740
|
-
* 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
|
|
61751
|
+
* 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
|
|
61741
61752
|
* @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'}
|
|
61742
61753
|
* @memberof ApprovalsV2025ApiDeleteApprovalConfigRequest
|
|
61743
61754
|
*/
|
|
@@ -61820,6 +61831,13 @@ export interface ApprovalsV2025ApiGetApprovalsRequest {
|
|
|
61820
61831
|
*/
|
|
61821
61832
|
readonly includeApprovers?: boolean
|
|
61822
61833
|
|
|
61834
|
+
/**
|
|
61835
|
+
* If set to true in the query, the approval requests returned will include reassignment history.
|
|
61836
|
+
* @type {boolean}
|
|
61837
|
+
* @memberof ApprovalsV2025ApiGetApprovals
|
|
61838
|
+
*/
|
|
61839
|
+
readonly includeReassignmentHistory?: boolean
|
|
61840
|
+
|
|
61823
61841
|
/**
|
|
61824
61842
|
* If set to true in the query, the approval requests returned will include batch information.
|
|
61825
61843
|
* @type {boolean}
|
|
@@ -61856,7 +61874,7 @@ export interface ApprovalsV2025ApiGetApprovalsRequest {
|
|
|
61856
61874
|
*/
|
|
61857
61875
|
export interface ApprovalsV2025ApiGetApprovalsConfigRequest {
|
|
61858
61876
|
/**
|
|
61859
|
-
* 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)]
|
|
61877
|
+
* 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)]
|
|
61860
61878
|
* @type {string}
|
|
61861
61879
|
* @memberof ApprovalsV2025ApiGetApprovalsConfig
|
|
61862
61880
|
*/
|
|
@@ -61884,14 +61902,14 @@ export interface ApprovalsV2025ApiMoveApprovalRequest {
|
|
|
61884
61902
|
*/
|
|
61885
61903
|
export interface ApprovalsV2025ApiPutApprovalsConfigRequest {
|
|
61886
61904
|
/**
|
|
61887
|
-
* 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
|
|
61905
|
+
* 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
|
|
61888
61906
|
* @type {string}
|
|
61889
61907
|
* @memberof ApprovalsV2025ApiPutApprovalsConfig
|
|
61890
61908
|
*/
|
|
61891
61909
|
readonly id: string
|
|
61892
61910
|
|
|
61893
61911
|
/**
|
|
61894
|
-
* 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
|
|
61912
|
+
* 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
|
|
61895
61913
|
* @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'}
|
|
61896
61914
|
* @memberof ApprovalsV2025ApiPutApprovalsConfig
|
|
61897
61915
|
*/
|
|
@@ -62011,7 +62029,7 @@ export interface ApprovalsV2025ApiUpdateApprovalsReassignRequest {
|
|
|
62011
62029
|
*/
|
|
62012
62030
|
export class ApprovalsV2025Api extends BaseAPI {
|
|
62013
62031
|
/**
|
|
62014
|
-
*
|
|
62032
|
+
* 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.
|
|
62015
62033
|
* @summary Post Approvals Approve
|
|
62016
62034
|
* @param {ApprovalsV2025ApiApproveApprovalRequest} requestParameters Request parameters.
|
|
62017
62035
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -62035,7 +62053,7 @@ export class ApprovalsV2025Api extends BaseAPI {
|
|
|
62035
62053
|
}
|
|
62036
62054
|
|
|
62037
62055
|
/**
|
|
62038
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
62056
|
+
* 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
|
|
62039
62057
|
* @summary Post Bulk Cancel Approvals
|
|
62040
62058
|
* @param {ApprovalsV2025ApiCancelApprovalRequest} requestParameters Request parameters.
|
|
62041
62059
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -62059,7 +62077,7 @@ export class ApprovalsV2025Api extends BaseAPI {
|
|
|
62059
62077
|
}
|
|
62060
62078
|
|
|
62061
62079
|
/**
|
|
62062
|
-
*
|
|
62080
|
+
* 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\"
|
|
62063
62081
|
* @summary Get an approval
|
|
62064
62082
|
* @param {ApprovalsV2025ApiGetApprovalRequest} requestParameters Request parameters.
|
|
62065
62083
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -62071,7 +62089,7 @@ export class ApprovalsV2025Api extends BaseAPI {
|
|
|
62071
62089
|
}
|
|
62072
62090
|
|
|
62073
62091
|
/**
|
|
62074
|
-
*
|
|
62092
|
+
* 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.
|
|
62075
62093
|
* @summary Get approvals
|
|
62076
62094
|
* @param {ApprovalsV2025ApiGetApprovalsRequest} requestParameters Request parameters.
|
|
62077
62095
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -62079,7 +62097,7 @@ export class ApprovalsV2025Api extends BaseAPI {
|
|
|
62079
62097
|
* @memberof ApprovalsV2025Api
|
|
62080
62098
|
*/
|
|
62081
62099
|
public getApprovals(requestParameters: ApprovalsV2025ApiGetApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
|
|
62082
|
-
return ApprovalsV2025ApiFp(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));
|
|
62100
|
+
return ApprovalsV2025ApiFp(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));
|
|
62083
62101
|
}
|
|
62084
62102
|
|
|
62085
62103
|
/**
|
|
@@ -62119,7 +62137,7 @@ export class ApprovalsV2025Api extends BaseAPI {
|
|
|
62119
62137
|
}
|
|
62120
62138
|
|
|
62121
62139
|
/**
|
|
62122
|
-
*
|
|
62140
|
+
* 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.
|
|
62123
62141
|
* @summary Post Approvals Reject
|
|
62124
62142
|
* @param {ApprovalsV2025ApiRejectApprovalRequest} requestParameters Request parameters.
|
|
62125
62143
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -62143,7 +62161,7 @@ export class ApprovalsV2025Api extends BaseAPI {
|
|
|
62143
62161
|
}
|
|
62144
62162
|
|
|
62145
62163
|
/**
|
|
62146
|
-
*
|
|
62164
|
+
* 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.
|
|
62147
62165
|
* @summary Post Approvals Attributes
|
|
62148
62166
|
* @param {ApprovalsV2025ApiUpdateApprovalsAttributesRequest} requestParameters Request parameters.
|
|
62149
62167
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -62155,7 +62173,7 @@ export class ApprovalsV2025Api extends BaseAPI {
|
|
|
62155
62173
|
}
|
|
62156
62174
|
|
|
62157
62175
|
/**
|
|
62158
|
-
*
|
|
62176
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
62159
62177
|
* @summary Post Approvals Comments
|
|
62160
62178
|
* @param {ApprovalsV2025ApiUpdateApprovalsCommentsRequest} requestParameters Request parameters.
|
|
62161
62179
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -62167,7 +62185,7 @@ export class ApprovalsV2025Api extends BaseAPI {
|
|
|
62167
62185
|
}
|
|
62168
62186
|
|
|
62169
62187
|
/**
|
|
62170
|
-
*
|
|
62188
|
+
* 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.
|
|
62171
62189
|
* @summary Post Approvals Reassign
|
|
62172
62190
|
* @param {ApprovalsV2025ApiUpdateApprovalsReassignRequest} requestParameters Request parameters.
|
|
62173
62191
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -75950,11 +75968,13 @@ export const CustomFormsV2025ApiAxiosParamCreator = function (configuration?: Co
|
|
|
75950
75968
|
/**
|
|
75951
75969
|
* Returns a list of form instances for the tenant. Optionally filter by form definition ID.
|
|
75952
75970
|
* @summary List form instances by tenant.
|
|
75971
|
+
* @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.
|
|
75972
|
+
* @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.
|
|
75953
75973
|
* @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*
|
|
75954
75974
|
* @param {*} [axiosOptions] Override http request option.
|
|
75955
75975
|
* @throws {RequiredError}
|
|
75956
75976
|
*/
|
|
75957
|
-
searchFormInstancesByTenant: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
75977
|
+
searchFormInstancesByTenant: async (offset?: number, limit?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
75958
75978
|
const localVarPath = `/form-instances`;
|
|
75959
75979
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
75960
75980
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -75975,6 +75995,14 @@ export const CustomFormsV2025ApiAxiosParamCreator = function (configuration?: Co
|
|
|
75975
75995
|
// oauth required
|
|
75976
75996
|
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
75977
75997
|
|
|
75998
|
+
if (offset !== undefined) {
|
|
75999
|
+
localVarQueryParameter['offset'] = offset;
|
|
76000
|
+
}
|
|
76001
|
+
|
|
76002
|
+
if (limit !== undefined) {
|
|
76003
|
+
localVarQueryParameter['limit'] = limit;
|
|
76004
|
+
}
|
|
76005
|
+
|
|
75978
76006
|
if (filters !== undefined) {
|
|
75979
76007
|
localVarQueryParameter['filters'] = filters;
|
|
75980
76008
|
}
|
|
@@ -76312,12 +76340,14 @@ export const CustomFormsV2025ApiFp = function(configuration?: Configuration) {
|
|
|
76312
76340
|
/**
|
|
76313
76341
|
* Returns a list of form instances for the tenant. Optionally filter by form definition ID.
|
|
76314
76342
|
* @summary List form instances by tenant.
|
|
76343
|
+
* @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.
|
|
76344
|
+
* @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.
|
|
76315
76345
|
* @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*
|
|
76316
76346
|
* @param {*} [axiosOptions] Override http request option.
|
|
76317
76347
|
* @throws {RequiredError}
|
|
76318
76348
|
*/
|
|
76319
|
-
async searchFormInstancesByTenant(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListFormInstancesByTenantResponseV2025>>> {
|
|
76320
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormInstancesByTenant(filters, axiosOptions);
|
|
76349
|
+
async searchFormInstancesByTenant(offset?: number, limit?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListFormInstancesByTenantResponseV2025>>> {
|
|
76350
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormInstancesByTenant(offset, limit, filters, axiosOptions);
|
|
76321
76351
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
76322
76352
|
const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.searchFormInstancesByTenant']?.[localVarOperationServerIndex]?.url;
|
|
76323
76353
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -76519,7 +76549,7 @@ export const CustomFormsV2025ApiFactory = function (configuration?: Configuratio
|
|
|
76519
76549
|
* @throws {RequiredError}
|
|
76520
76550
|
*/
|
|
76521
76551
|
searchFormInstancesByTenant(requestParameters: CustomFormsV2025ApiSearchFormInstancesByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<ListFormInstancesByTenantResponseV2025>> {
|
|
76522
|
-
return localVarFp.searchFormInstancesByTenant(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath));
|
|
76552
|
+
return localVarFp.searchFormInstancesByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath));
|
|
76523
76553
|
},
|
|
76524
76554
|
/**
|
|
76525
76555
|
* No parameters required.
|
|
@@ -76864,6 +76894,20 @@ export interface CustomFormsV2025ApiSearchFormElementDataByElementIDRequest {
|
|
|
76864
76894
|
* @interface CustomFormsV2025ApiSearchFormInstancesByTenantRequest
|
|
76865
76895
|
*/
|
|
76866
76896
|
export interface CustomFormsV2025ApiSearchFormInstancesByTenantRequest {
|
|
76897
|
+
/**
|
|
76898
|
+
* 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.
|
|
76899
|
+
* @type {number}
|
|
76900
|
+
* @memberof CustomFormsV2025ApiSearchFormInstancesByTenant
|
|
76901
|
+
*/
|
|
76902
|
+
readonly offset?: number
|
|
76903
|
+
|
|
76904
|
+
/**
|
|
76905
|
+
* 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.
|
|
76906
|
+
* @type {number}
|
|
76907
|
+
* @memberof CustomFormsV2025ApiSearchFormInstancesByTenant
|
|
76908
|
+
*/
|
|
76909
|
+
readonly limit?: number
|
|
76910
|
+
|
|
76867
76911
|
/**
|
|
76868
76912
|
* 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*
|
|
76869
76913
|
* @type {string}
|
|
@@ -77110,7 +77154,7 @@ export class CustomFormsV2025Api extends BaseAPI {
|
|
|
77110
77154
|
* @memberof CustomFormsV2025Api
|
|
77111
77155
|
*/
|
|
77112
77156
|
public searchFormInstancesByTenant(requestParameters: CustomFormsV2025ApiSearchFormInstancesByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
|
|
77113
|
-
return CustomFormsV2025ApiFp(this.configuration).searchFormInstancesByTenant(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
77157
|
+
return CustomFormsV2025ApiFp(this.configuration).searchFormInstancesByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
77114
77158
|
}
|
|
77115
77159
|
|
|
77116
77160
|
/**
|