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/dist/v2024/common.js
CHANGED
|
@@ -250,12 +250,12 @@ var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configu
|
|
|
250
250
|
if (axios === void 0) { axios = globalAxios; }
|
|
251
251
|
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
252
252
|
(0, axios_retry_1.default)(axios, configuration.retriesConfig);
|
|
253
|
-
var userAgent = "SailPoint-SDK-TypeScript/1.8.
|
|
253
|
+
var userAgent = "SailPoint-SDK-TypeScript/1.8.18";
|
|
254
254
|
if ((configuration === null || configuration === void 0 ? void 0 : configuration.consumerIdentifier) && (configuration === null || configuration === void 0 ? void 0 : configuration.consumerVersion)) {
|
|
255
255
|
userAgent += " (".concat(configuration.consumerIdentifier, "/").concat(configuration.consumerVersion, ")");
|
|
256
256
|
}
|
|
257
257
|
userAgent += " (".concat(process.platform, "; ").concat(process.arch, ") Node/").concat(process.versions.node, " (openapi-generator/7.12.0)");
|
|
258
|
-
var headers = __assign(__assign(__assign({}, axiosArgs.axiosOptions.headers), { 'X-SailPoint-SDK': 'typescript-1.8.
|
|
258
|
+
var headers = __assign(__assign(__assign({}, axiosArgs.axiosOptions.headers), { 'X-SailPoint-SDK': 'typescript-1.8.18' }), { 'User-Agent': userAgent });
|
|
259
259
|
if (!configuration.experimental && ("X-SailPoint-Experimental" in headers)) {
|
|
260
260
|
throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.");
|
|
261
261
|
}
|
package/dist/v2025/api.d.ts
CHANGED
|
@@ -7257,24 +7257,6 @@ export type ApprovalConfigTimeoutConfigV2025TimeoutResultV2025 = typeof Approval
|
|
|
7257
7257
|
* @interface ApprovalConfigV2025
|
|
7258
7258
|
*/
|
|
7259
7259
|
export interface ApprovalConfigV2025 {
|
|
7260
|
-
/**
|
|
7261
|
-
* Tenant ID of the approval configuration.
|
|
7262
|
-
* @type {string}
|
|
7263
|
-
* @memberof ApprovalConfigV2025
|
|
7264
|
-
*/
|
|
7265
|
-
'tenantId'?: string;
|
|
7266
|
-
/**
|
|
7267
|
-
* 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
|
|
7268
|
-
* @type {string}
|
|
7269
|
-
* @memberof ApprovalConfigV2025
|
|
7270
|
-
*/
|
|
7271
|
-
'id'?: string;
|
|
7272
|
-
/**
|
|
7273
|
-
* 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
|
|
7274
|
-
* @type {string}
|
|
7275
|
-
* @memberof ApprovalConfigV2025
|
|
7276
|
-
*/
|
|
7277
|
-
'scope'?: string;
|
|
7278
7260
|
/**
|
|
7279
7261
|
*
|
|
7280
7262
|
* @type {ApprovalConfigReminderConfigV2025}
|
|
@@ -7317,6 +7299,18 @@ export interface ApprovalConfigV2025 {
|
|
|
7317
7299
|
* @memberof ApprovalConfigV2025
|
|
7318
7300
|
*/
|
|
7319
7301
|
'fallbackApprover'?: ApprovalIdentityV2025;
|
|
7302
|
+
/**
|
|
7303
|
+
* Specifies how to treat the identity type \"MANAGER_OF\" when the requestee is a machine identity.
|
|
7304
|
+
* @type {string}
|
|
7305
|
+
* @memberof ApprovalConfigV2025
|
|
7306
|
+
*/
|
|
7307
|
+
'machineIdentityManagerAssignment'?: ApprovalConfigV2025MachineIdentityManagerAssignmentV2025;
|
|
7308
|
+
/**
|
|
7309
|
+
* When true, all approvals will be created with the status \"PASSED\".
|
|
7310
|
+
* @type {boolean}
|
|
7311
|
+
* @memberof ApprovalConfigV2025
|
|
7312
|
+
*/
|
|
7313
|
+
'circumventApprovalProcess'?: boolean;
|
|
7320
7314
|
/**
|
|
7321
7315
|
* 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.
|
|
7322
7316
|
* @type {string}
|
|
@@ -7331,6 +7325,16 @@ export declare const ApprovalConfigV2025RequiresCommentV2025: {
|
|
|
7331
7325
|
readonly Off: "OFF";
|
|
7332
7326
|
};
|
|
7333
7327
|
export type ApprovalConfigV2025RequiresCommentV2025 = typeof ApprovalConfigV2025RequiresCommentV2025[keyof typeof ApprovalConfigV2025RequiresCommentV2025];
|
|
7328
|
+
export declare const ApprovalConfigV2025MachineIdentityManagerAssignmentV2025: {
|
|
7329
|
+
readonly ManagerOfRequester: "MANAGER_OF_REQUESTER";
|
|
7330
|
+
readonly MachineIdentityOwner: "MACHINE_IDENTITY_OWNER";
|
|
7331
|
+
readonly ManagerOfMachineIdentityOwner: "MANAGER_OF_MACHINE_IDENTITY_OWNER";
|
|
7332
|
+
readonly RequestedTargetOwner: "REQUESTED_TARGET_OWNER";
|
|
7333
|
+
readonly ManagerOfRequestedTargetOwner: "MANAGER_OF_REQUESTED_TARGET_OWNER";
|
|
7334
|
+
readonly AccountOwner: "ACCOUNT_OWNER";
|
|
7335
|
+
readonly ManagerOfAccountOwner: "MANAGER_OF_ACCOUNT_OWNER";
|
|
7336
|
+
};
|
|
7337
|
+
export type ApprovalConfigV2025MachineIdentityManagerAssignmentV2025 = typeof ApprovalConfigV2025MachineIdentityManagerAssignmentV2025[keyof typeof ApprovalConfigV2025MachineIdentityManagerAssignmentV2025];
|
|
7334
7338
|
export declare const ApprovalConfigV2025AutoApproveV2025: {
|
|
7335
7339
|
readonly Off: "OFF";
|
|
7336
7340
|
readonly Direct: "DIRECT";
|
|
@@ -55443,9 +55447,9 @@ export type GetDiscoveredApplicationsDetailV2025 = typeof GetDiscoveredApplicati
|
|
|
55443
55447
|
*/
|
|
55444
55448
|
export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
55445
55449
|
/**
|
|
55446
|
-
*
|
|
55450
|
+
* 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.
|
|
55447
55451
|
* @summary Post Approvals Approve
|
|
55448
|
-
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve
|
|
55452
|
+
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve.
|
|
55449
55453
|
* @param {ApprovalApproveRequestV2025} [approvalApproveRequestV2025]
|
|
55450
55454
|
* @param {*} [axiosOptions] Override http request option.
|
|
55451
55455
|
* @throws {RequiredError}
|
|
@@ -55460,7 +55464,7 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
55460
55464
|
*/
|
|
55461
55465
|
approveApprovalInBulk: (bulkApproveRequestDTOV2025: BulkApproveRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55462
55466
|
/**
|
|
55463
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
55467
|
+
* 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
|
|
55464
55468
|
* @summary Post Bulk Cancel Approvals
|
|
55465
55469
|
* @param {BulkCancelRequestDTOV2025} bulkCancelRequestDTOV2025
|
|
55466
55470
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -55470,14 +55474,14 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
55470
55474
|
/**
|
|
55471
55475
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
55472
55476
|
* @summary Delete Approval Configuration
|
|
55473
|
-
* @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
|
|
55474
|
-
* @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
|
|
55477
|
+
* @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
|
|
55478
|
+
* @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
|
|
55475
55479
|
* @param {*} [axiosOptions] Override http request option.
|
|
55476
55480
|
* @throws {RequiredError}
|
|
55477
55481
|
*/
|
|
55478
55482
|
deleteApprovalConfigRequest: (id: string, scope: DeleteApprovalConfigRequestScopeV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55479
55483
|
/**
|
|
55480
|
-
*
|
|
55484
|
+
* 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\"
|
|
55481
55485
|
* @summary Get an approval
|
|
55482
55486
|
* @param {string} id ID of the approval that is to be returned
|
|
55483
55487
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -55485,7 +55489,7 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
55485
55489
|
*/
|
|
55486
55490
|
getApproval: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55487
55491
|
/**
|
|
55488
|
-
*
|
|
55492
|
+
* 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.
|
|
55489
55493
|
* @summary Get approvals
|
|
55490
55494
|
* @param {boolean} [mine] Returns the list of approvals for the current caller. Defaults to false if admin, true otherwise.
|
|
55491
55495
|
* @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.
|
|
@@ -55495,6 +55499,7 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
55495
55499
|
* @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.
|
|
55496
55500
|
* @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments.
|
|
55497
55501
|
* @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers.
|
|
55502
|
+
* @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history.
|
|
55498
55503
|
* @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch information.
|
|
55499
55504
|
* @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*
|
|
55500
55505
|
* @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.
|
|
@@ -55502,11 +55507,11 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
55502
55507
|
* @param {*} [axiosOptions] Override http request option.
|
|
55503
55508
|
* @throws {RequiredError}
|
|
55504
55509
|
*/
|
|
55505
|
-
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<RequestArgs>;
|
|
55510
|
+
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<RequestArgs>;
|
|
55506
55511
|
/**
|
|
55507
55512
|
* Retrieves a singular approval configuration that matches the given ID
|
|
55508
55513
|
* @summary Get Approval Config
|
|
55509
|
-
* @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)]
|
|
55514
|
+
* @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)]
|
|
55510
55515
|
* @param {*} [axiosOptions] Override http request option.
|
|
55511
55516
|
* @throws {RequiredError}
|
|
55512
55517
|
*/
|
|
@@ -55522,15 +55527,15 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
55522
55527
|
/**
|
|
55523
55528
|
* 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\'
|
|
55524
55529
|
* @summary Put Approval Config
|
|
55525
|
-
* @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
|
|
55526
|
-
* @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
|
|
55530
|
+
* @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
|
|
55531
|
+
* @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
|
|
55527
55532
|
* @param {ApprovalConfigV2025} approvalConfigV2025
|
|
55528
55533
|
* @param {*} [axiosOptions] Override http request option.
|
|
55529
55534
|
* @throws {RequiredError}
|
|
55530
55535
|
*/
|
|
55531
55536
|
putApprovalsConfig: (id: string, scope: PutApprovalsConfigScopeV2025, approvalConfigV2025: ApprovalConfigV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55532
55537
|
/**
|
|
55533
|
-
*
|
|
55538
|
+
* 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.
|
|
55534
55539
|
* @summary Post Approvals Reject
|
|
55535
55540
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject.
|
|
55536
55541
|
* @param {ApprovalRejectRequestV2025} [approvalRejectRequestV2025]
|
|
@@ -55547,7 +55552,7 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
55547
55552
|
*/
|
|
55548
55553
|
rejectApprovalInBulk: (bulkRejectRequestDTOV2025: BulkRejectRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55549
55554
|
/**
|
|
55550
|
-
*
|
|
55555
|
+
* 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.
|
|
55551
55556
|
* @summary Post Approvals Attributes
|
|
55552
55557
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
|
|
55553
55558
|
* @param {ApprovalAttributesRequestV2025} approvalAttributesRequestV2025
|
|
@@ -55556,7 +55561,7 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
55556
55561
|
*/
|
|
55557
55562
|
updateApprovalsAttributes: (id: string, approvalAttributesRequestV2025: ApprovalAttributesRequestV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55558
55563
|
/**
|
|
55559
|
-
*
|
|
55564
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
55560
55565
|
* @summary Post Approvals Comments
|
|
55561
55566
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to.
|
|
55562
55567
|
* @param {ApprovalCommentsRequestV2025} approvalCommentsRequestV2025
|
|
@@ -55565,7 +55570,7 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
55565
55570
|
*/
|
|
55566
55571
|
updateApprovalsComments: (id: string, approvalCommentsRequestV2025: ApprovalCommentsRequestV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55567
55572
|
/**
|
|
55568
|
-
*
|
|
55573
|
+
* 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.
|
|
55569
55574
|
* @summary Post Approvals Reassign
|
|
55570
55575
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign.
|
|
55571
55576
|
* @param {ApprovalReassignRequestV2025} approvalReassignRequestV2025
|
|
@@ -55580,9 +55585,9 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
55580
55585
|
*/
|
|
55581
55586
|
export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
55582
55587
|
/**
|
|
55583
|
-
*
|
|
55588
|
+
* 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.
|
|
55584
55589
|
* @summary Post Approvals Approve
|
|
55585
|
-
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve
|
|
55590
|
+
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve.
|
|
55586
55591
|
* @param {ApprovalApproveRequestV2025} [approvalApproveRequestV2025]
|
|
55587
55592
|
* @param {*} [axiosOptions] Override http request option.
|
|
55588
55593
|
* @throws {RequiredError}
|
|
@@ -55597,7 +55602,7 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
55597
55602
|
*/
|
|
55598
55603
|
approveApprovalInBulk(bulkApproveRequestDTOV2025: BulkApproveRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
55599
55604
|
/**
|
|
55600
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
55605
|
+
* 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
|
|
55601
55606
|
* @summary Post Bulk Cancel Approvals
|
|
55602
55607
|
* @param {BulkCancelRequestDTOV2025} bulkCancelRequestDTOV2025
|
|
55603
55608
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -55607,14 +55612,14 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
55607
55612
|
/**
|
|
55608
55613
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
55609
55614
|
* @summary Delete Approval Configuration
|
|
55610
|
-
* @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
|
|
55611
|
-
* @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
|
|
55615
|
+
* @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
|
|
55616
|
+
* @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
|
|
55612
55617
|
* @param {*} [axiosOptions] Override http request option.
|
|
55613
55618
|
* @throws {RequiredError}
|
|
55614
55619
|
*/
|
|
55615
55620
|
deleteApprovalConfigRequest(id: string, scope: DeleteApprovalConfigRequestScopeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
55616
55621
|
/**
|
|
55617
|
-
*
|
|
55622
|
+
* 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\"
|
|
55618
55623
|
* @summary Get an approval
|
|
55619
55624
|
* @param {string} id ID of the approval that is to be returned
|
|
55620
55625
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -55622,7 +55627,7 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
55622
55627
|
*/
|
|
55623
55628
|
getApproval(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalV2025>>;
|
|
55624
55629
|
/**
|
|
55625
|
-
*
|
|
55630
|
+
* 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.
|
|
55626
55631
|
* @summary Get approvals
|
|
55627
55632
|
* @param {boolean} [mine] Returns the list of approvals for the current caller. Defaults to false if admin, true otherwise.
|
|
55628
55633
|
* @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.
|
|
@@ -55632,6 +55637,7 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
55632
55637
|
* @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.
|
|
55633
55638
|
* @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments.
|
|
55634
55639
|
* @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers.
|
|
55640
|
+
* @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history.
|
|
55635
55641
|
* @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch information.
|
|
55636
55642
|
* @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*
|
|
55637
55643
|
* @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.
|
|
@@ -55639,11 +55645,11 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
55639
55645
|
* @param {*} [axiosOptions] Override http request option.
|
|
55640
55646
|
* @throws {RequiredError}
|
|
55641
55647
|
*/
|
|
55642
|
-
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>>>;
|
|
55648
|
+
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>>>;
|
|
55643
55649
|
/**
|
|
55644
55650
|
* Retrieves a singular approval configuration that matches the given ID
|
|
55645
55651
|
* @summary Get Approval Config
|
|
55646
|
-
* @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)]
|
|
55652
|
+
* @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)]
|
|
55647
55653
|
* @param {*} [axiosOptions] Override http request option.
|
|
55648
55654
|
* @throws {RequiredError}
|
|
55649
55655
|
*/
|
|
@@ -55659,15 +55665,15 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
55659
55665
|
/**
|
|
55660
55666
|
* 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\'
|
|
55661
55667
|
* @summary Put Approval Config
|
|
55662
|
-
* @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
|
|
55663
|
-
* @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
|
|
55668
|
+
* @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
|
|
55669
|
+
* @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
|
|
55664
55670
|
* @param {ApprovalConfigV2025} approvalConfigV2025
|
|
55665
55671
|
* @param {*} [axiosOptions] Override http request option.
|
|
55666
55672
|
* @throws {RequiredError}
|
|
55667
55673
|
*/
|
|
55668
55674
|
putApprovalsConfig(id: string, scope: PutApprovalsConfigScopeV2025, approvalConfigV2025: ApprovalConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalConfigV2025>>;
|
|
55669
55675
|
/**
|
|
55670
|
-
*
|
|
55676
|
+
* 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.
|
|
55671
55677
|
* @summary Post Approvals Reject
|
|
55672
55678
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject.
|
|
55673
55679
|
* @param {ApprovalRejectRequestV2025} [approvalRejectRequestV2025]
|
|
@@ -55684,7 +55690,7 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
55684
55690
|
*/
|
|
55685
55691
|
rejectApprovalInBulk(bulkRejectRequestDTOV2025: BulkRejectRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
55686
55692
|
/**
|
|
55687
|
-
*
|
|
55693
|
+
* 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.
|
|
55688
55694
|
* @summary Post Approvals Attributes
|
|
55689
55695
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
|
|
55690
55696
|
* @param {ApprovalAttributesRequestV2025} approvalAttributesRequestV2025
|
|
@@ -55693,7 +55699,7 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
55693
55699
|
*/
|
|
55694
55700
|
updateApprovalsAttributes(id: string, approvalAttributesRequestV2025: ApprovalAttributesRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalV2025>>;
|
|
55695
55701
|
/**
|
|
55696
|
-
*
|
|
55702
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
55697
55703
|
* @summary Post Approvals Comments
|
|
55698
55704
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to.
|
|
55699
55705
|
* @param {ApprovalCommentsRequestV2025} approvalCommentsRequestV2025
|
|
@@ -55702,7 +55708,7 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
55702
55708
|
*/
|
|
55703
55709
|
updateApprovalsComments(id: string, approvalCommentsRequestV2025: ApprovalCommentsRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalV2025>>;
|
|
55704
55710
|
/**
|
|
55705
|
-
*
|
|
55711
|
+
* 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.
|
|
55706
55712
|
* @summary Post Approvals Reassign
|
|
55707
55713
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign.
|
|
55708
55714
|
* @param {ApprovalReassignRequestV2025} approvalReassignRequestV2025
|
|
@@ -55717,7 +55723,7 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
55717
55723
|
*/
|
|
55718
55724
|
export declare const ApprovalsV2025ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
55719
55725
|
/**
|
|
55720
|
-
*
|
|
55726
|
+
* 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.
|
|
55721
55727
|
* @summary Post Approvals Approve
|
|
55722
55728
|
* @param {ApprovalsV2025ApiApproveApprovalRequest} requestParameters Request parameters.
|
|
55723
55729
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -55733,7 +55739,7 @@ export declare const ApprovalsV2025ApiFactory: (configuration?: Configuration, b
|
|
|
55733
55739
|
*/
|
|
55734
55740
|
approveApprovalInBulk(requestParameters: ApprovalsV2025ApiApproveApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
55735
55741
|
/**
|
|
55736
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
55742
|
+
* 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
|
|
55737
55743
|
* @summary Post Bulk Cancel Approvals
|
|
55738
55744
|
* @param {ApprovalsV2025ApiCancelApprovalRequest} requestParameters Request parameters.
|
|
55739
55745
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -55749,7 +55755,7 @@ export declare const ApprovalsV2025ApiFactory: (configuration?: Configuration, b
|
|
|
55749
55755
|
*/
|
|
55750
55756
|
deleteApprovalConfigRequest(requestParameters: ApprovalsV2025ApiDeleteApprovalConfigRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
55751
55757
|
/**
|
|
55752
|
-
*
|
|
55758
|
+
* 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\"
|
|
55753
55759
|
* @summary Get an approval
|
|
55754
55760
|
* @param {ApprovalsV2025ApiGetApprovalRequest} requestParameters Request parameters.
|
|
55755
55761
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -55757,7 +55763,7 @@ export declare const ApprovalsV2025ApiFactory: (configuration?: Configuration, b
|
|
|
55757
55763
|
*/
|
|
55758
55764
|
getApproval(requestParameters: ApprovalsV2025ApiGetApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ApprovalV2025>;
|
|
55759
55765
|
/**
|
|
55760
|
-
*
|
|
55766
|
+
* 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.
|
|
55761
55767
|
* @summary Get approvals
|
|
55762
55768
|
* @param {ApprovalsV2025ApiGetApprovalsRequest} requestParameters Request parameters.
|
|
55763
55769
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -55789,7 +55795,7 @@ export declare const ApprovalsV2025ApiFactory: (configuration?: Configuration, b
|
|
|
55789
55795
|
*/
|
|
55790
55796
|
putApprovalsConfig(requestParameters: ApprovalsV2025ApiPutApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ApprovalConfigV2025>;
|
|
55791
55797
|
/**
|
|
55792
|
-
*
|
|
55798
|
+
* 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.
|
|
55793
55799
|
* @summary Post Approvals Reject
|
|
55794
55800
|
* @param {ApprovalsV2025ApiRejectApprovalRequest} requestParameters Request parameters.
|
|
55795
55801
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -55805,7 +55811,7 @@ export declare const ApprovalsV2025ApiFactory: (configuration?: Configuration, b
|
|
|
55805
55811
|
*/
|
|
55806
55812
|
rejectApprovalInBulk(requestParameters: ApprovalsV2025ApiRejectApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
55807
55813
|
/**
|
|
55808
|
-
*
|
|
55814
|
+
* 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.
|
|
55809
55815
|
* @summary Post Approvals Attributes
|
|
55810
55816
|
* @param {ApprovalsV2025ApiUpdateApprovalsAttributesRequest} requestParameters Request parameters.
|
|
55811
55817
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -55813,7 +55819,7 @@ export declare const ApprovalsV2025ApiFactory: (configuration?: Configuration, b
|
|
|
55813
55819
|
*/
|
|
55814
55820
|
updateApprovalsAttributes(requestParameters: ApprovalsV2025ApiUpdateApprovalsAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ApprovalV2025>;
|
|
55815
55821
|
/**
|
|
55816
|
-
*
|
|
55822
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
55817
55823
|
* @summary Post Approvals Comments
|
|
55818
55824
|
* @param {ApprovalsV2025ApiUpdateApprovalsCommentsRequest} requestParameters Request parameters.
|
|
55819
55825
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -55821,7 +55827,7 @@ export declare const ApprovalsV2025ApiFactory: (configuration?: Configuration, b
|
|
|
55821
55827
|
*/
|
|
55822
55828
|
updateApprovalsComments(requestParameters: ApprovalsV2025ApiUpdateApprovalsCommentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ApprovalV2025>;
|
|
55823
55829
|
/**
|
|
55824
|
-
*
|
|
55830
|
+
* 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.
|
|
55825
55831
|
* @summary Post Approvals Reassign
|
|
55826
55832
|
* @param {ApprovalsV2025ApiUpdateApprovalsReassignRequest} requestParameters Request parameters.
|
|
55827
55833
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -55836,7 +55842,7 @@ export declare const ApprovalsV2025ApiFactory: (configuration?: Configuration, b
|
|
|
55836
55842
|
*/
|
|
55837
55843
|
export interface ApprovalsV2025ApiApproveApprovalRequest {
|
|
55838
55844
|
/**
|
|
55839
|
-
* Approval ID that correlates to an existing approval request that a user wants to approve
|
|
55845
|
+
* Approval ID that correlates to an existing approval request that a user wants to approve.
|
|
55840
55846
|
* @type {string}
|
|
55841
55847
|
* @memberof ApprovalsV2025ApiApproveApproval
|
|
55842
55848
|
*/
|
|
@@ -55881,13 +55887,13 @@ export interface ApprovalsV2025ApiCancelApprovalRequest {
|
|
|
55881
55887
|
*/
|
|
55882
55888
|
export interface ApprovalsV2025ApiDeleteApprovalConfigRequestRequest {
|
|
55883
55889
|
/**
|
|
55884
|
-
* 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
|
|
55890
|
+
* 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
|
|
55885
55891
|
* @type {string}
|
|
55886
55892
|
* @memberof ApprovalsV2025ApiDeleteApprovalConfigRequest
|
|
55887
55893
|
*/
|
|
55888
55894
|
readonly id: string;
|
|
55889
55895
|
/**
|
|
55890
|
-
* 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
|
|
55896
|
+
* 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
|
|
55891
55897
|
* @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'}
|
|
55892
55898
|
* @memberof ApprovalsV2025ApiDeleteApprovalConfigRequest
|
|
55893
55899
|
*/
|
|
@@ -55960,6 +55966,12 @@ export interface ApprovalsV2025ApiGetApprovalsRequest {
|
|
|
55960
55966
|
* @memberof ApprovalsV2025ApiGetApprovals
|
|
55961
55967
|
*/
|
|
55962
55968
|
readonly includeApprovers?: boolean;
|
|
55969
|
+
/**
|
|
55970
|
+
* If set to true in the query, the approval requests returned will include reassignment history.
|
|
55971
|
+
* @type {boolean}
|
|
55972
|
+
* @memberof ApprovalsV2025ApiGetApprovals
|
|
55973
|
+
*/
|
|
55974
|
+
readonly includeReassignmentHistory?: boolean;
|
|
55963
55975
|
/**
|
|
55964
55976
|
* If set to true in the query, the approval requests returned will include batch information.
|
|
55965
55977
|
* @type {boolean}
|
|
@@ -55992,7 +56004,7 @@ export interface ApprovalsV2025ApiGetApprovalsRequest {
|
|
|
55992
56004
|
*/
|
|
55993
56005
|
export interface ApprovalsV2025ApiGetApprovalsConfigRequest {
|
|
55994
56006
|
/**
|
|
55995
|
-
* 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)]
|
|
56007
|
+
* 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)]
|
|
55996
56008
|
* @type {string}
|
|
55997
56009
|
* @memberof ApprovalsV2025ApiGetApprovalsConfig
|
|
55998
56010
|
*/
|
|
@@ -56018,13 +56030,13 @@ export interface ApprovalsV2025ApiMoveApprovalRequest {
|
|
|
56018
56030
|
*/
|
|
56019
56031
|
export interface ApprovalsV2025ApiPutApprovalsConfigRequest {
|
|
56020
56032
|
/**
|
|
56021
|
-
* 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
|
|
56033
|
+
* 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
|
|
56022
56034
|
* @type {string}
|
|
56023
56035
|
* @memberof ApprovalsV2025ApiPutApprovalsConfig
|
|
56024
56036
|
*/
|
|
56025
56037
|
readonly id: string;
|
|
56026
56038
|
/**
|
|
56027
|
-
* 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
|
|
56039
|
+
* 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
|
|
56028
56040
|
* @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'}
|
|
56029
56041
|
* @memberof ApprovalsV2025ApiPutApprovalsConfig
|
|
56030
56042
|
*/
|
|
@@ -56133,7 +56145,7 @@ export interface ApprovalsV2025ApiUpdateApprovalsReassignRequest {
|
|
|
56133
56145
|
*/
|
|
56134
56146
|
export declare class ApprovalsV2025Api extends BaseAPI {
|
|
56135
56147
|
/**
|
|
56136
|
-
*
|
|
56148
|
+
* 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.
|
|
56137
56149
|
* @summary Post Approvals Approve
|
|
56138
56150
|
* @param {ApprovalsV2025ApiApproveApprovalRequest} requestParameters Request parameters.
|
|
56139
56151
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56151,7 +56163,7 @@ export declare class ApprovalsV2025Api extends BaseAPI {
|
|
|
56151
56163
|
*/
|
|
56152
56164
|
approveApprovalInBulk(requestParameters: ApprovalsV2025ApiApproveApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
56153
56165
|
/**
|
|
56154
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
56166
|
+
* 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
|
|
56155
56167
|
* @summary Post Bulk Cancel Approvals
|
|
56156
56168
|
* @param {ApprovalsV2025ApiCancelApprovalRequest} requestParameters Request parameters.
|
|
56157
56169
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56169,7 +56181,7 @@ export declare class ApprovalsV2025Api extends BaseAPI {
|
|
|
56169
56181
|
*/
|
|
56170
56182
|
deleteApprovalConfigRequest(requestParameters: ApprovalsV2025ApiDeleteApprovalConfigRequestRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
56171
56183
|
/**
|
|
56172
|
-
*
|
|
56184
|
+
* 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\"
|
|
56173
56185
|
* @summary Get an approval
|
|
56174
56186
|
* @param {ApprovalsV2025ApiGetApprovalRequest} requestParameters Request parameters.
|
|
56175
56187
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56178,7 +56190,7 @@ export declare class ApprovalsV2025Api extends BaseAPI {
|
|
|
56178
56190
|
*/
|
|
56179
56191
|
getApproval(requestParameters: ApprovalsV2025ApiGetApprovalRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalV2025, any>>;
|
|
56180
56192
|
/**
|
|
56181
|
-
*
|
|
56193
|
+
* 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.
|
|
56182
56194
|
* @summary Get approvals
|
|
56183
56195
|
* @param {ApprovalsV2025ApiGetApprovalsRequest} requestParameters Request parameters.
|
|
56184
56196
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56214,7 +56226,7 @@ export declare class ApprovalsV2025Api extends BaseAPI {
|
|
|
56214
56226
|
*/
|
|
56215
56227
|
putApprovalsConfig(requestParameters: ApprovalsV2025ApiPutApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalConfigV2025, any>>;
|
|
56216
56228
|
/**
|
|
56217
|
-
*
|
|
56229
|
+
* 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.
|
|
56218
56230
|
* @summary Post Approvals Reject
|
|
56219
56231
|
* @param {ApprovalsV2025ApiRejectApprovalRequest} requestParameters Request parameters.
|
|
56220
56232
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56232,7 +56244,7 @@ export declare class ApprovalsV2025Api extends BaseAPI {
|
|
|
56232
56244
|
*/
|
|
56233
56245
|
rejectApprovalInBulk(requestParameters: ApprovalsV2025ApiRejectApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
56234
56246
|
/**
|
|
56235
|
-
*
|
|
56247
|
+
* 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.
|
|
56236
56248
|
* @summary Post Approvals Attributes
|
|
56237
56249
|
* @param {ApprovalsV2025ApiUpdateApprovalsAttributesRequest} requestParameters Request parameters.
|
|
56238
56250
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56241,7 +56253,7 @@ export declare class ApprovalsV2025Api extends BaseAPI {
|
|
|
56241
56253
|
*/
|
|
56242
56254
|
updateApprovalsAttributes(requestParameters: ApprovalsV2025ApiUpdateApprovalsAttributesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalV2025, any>>;
|
|
56243
56255
|
/**
|
|
56244
|
-
*
|
|
56256
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
56245
56257
|
* @summary Post Approvals Comments
|
|
56246
56258
|
* @param {ApprovalsV2025ApiUpdateApprovalsCommentsRequest} requestParameters Request parameters.
|
|
56247
56259
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56250,7 +56262,7 @@ export declare class ApprovalsV2025Api extends BaseAPI {
|
|
|
56250
56262
|
*/
|
|
56251
56263
|
updateApprovalsComments(requestParameters: ApprovalsV2025ApiUpdateApprovalsCommentsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalV2025, any>>;
|
|
56252
56264
|
/**
|
|
56253
|
-
*
|
|
56265
|
+
* 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.
|
|
56254
56266
|
* @summary Post Approvals Reassign
|
|
56255
56267
|
* @param {ApprovalsV2025ApiUpdateApprovalsReassignRequest} requestParameters Request parameters.
|
|
56256
56268
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -63229,11 +63241,13 @@ export declare const CustomFormsV2025ApiAxiosParamCreator: (configuration?: Conf
|
|
|
63229
63241
|
/**
|
|
63230
63242
|
* Returns a list of form instances for the tenant. Optionally filter by form definition ID.
|
|
63231
63243
|
* @summary List form instances by tenant.
|
|
63244
|
+
* @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.
|
|
63245
|
+
* @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.
|
|
63232
63246
|
* @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*
|
|
63233
63247
|
* @param {*} [axiosOptions] Override http request option.
|
|
63234
63248
|
* @throws {RequiredError}
|
|
63235
63249
|
*/
|
|
63236
|
-
searchFormInstancesByTenant: (filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63250
|
+
searchFormInstancesByTenant: (offset?: number, limit?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63237
63251
|
/**
|
|
63238
63252
|
* No parameters required.
|
|
63239
63253
|
* @summary List predefined select options.
|
|
@@ -63401,11 +63415,13 @@ export declare const CustomFormsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
63401
63415
|
/**
|
|
63402
63416
|
* Returns a list of form instances for the tenant. Optionally filter by form definition ID.
|
|
63403
63417
|
* @summary List form instances by tenant.
|
|
63418
|
+
* @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.
|
|
63419
|
+
* @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.
|
|
63404
63420
|
* @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*
|
|
63405
63421
|
* @param {*} [axiosOptions] Override http request option.
|
|
63406
63422
|
* @throws {RequiredError}
|
|
63407
63423
|
*/
|
|
63408
|
-
searchFormInstancesByTenant(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListFormInstancesByTenantResponseV2025>>>;
|
|
63424
|
+
searchFormInstancesByTenant(offset?: number, limit?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListFormInstancesByTenantResponseV2025>>>;
|
|
63409
63425
|
/**
|
|
63410
63426
|
* No parameters required.
|
|
63411
63427
|
* @summary List predefined select options.
|
|
@@ -63870,6 +63886,18 @@ export interface CustomFormsV2025ApiSearchFormElementDataByElementIDRequest {
|
|
|
63870
63886
|
* @interface CustomFormsV2025ApiSearchFormInstancesByTenantRequest
|
|
63871
63887
|
*/
|
|
63872
63888
|
export interface CustomFormsV2025ApiSearchFormInstancesByTenantRequest {
|
|
63889
|
+
/**
|
|
63890
|
+
* 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.
|
|
63891
|
+
* @type {number}
|
|
63892
|
+
* @memberof CustomFormsV2025ApiSearchFormInstancesByTenant
|
|
63893
|
+
*/
|
|
63894
|
+
readonly offset?: number;
|
|
63895
|
+
/**
|
|
63896
|
+
* 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.
|
|
63897
|
+
* @type {number}
|
|
63898
|
+
* @memberof CustomFormsV2025ApiSearchFormInstancesByTenant
|
|
63899
|
+
*/
|
|
63900
|
+
readonly limit?: number;
|
|
63873
63901
|
/**
|
|
63874
63902
|
* 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*
|
|
63875
63903
|
* @type {string}
|