sailpoint-api-client 1.8.17 → 1.8.19
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/v2026/api.d.ts
CHANGED
|
@@ -7589,6 +7589,19 @@ export interface ApprovalBatchV2026 {
|
|
|
7589
7589
|
*/
|
|
7590
7590
|
'batchSize'?: number;
|
|
7591
7591
|
}
|
|
7592
|
+
/**
|
|
7593
|
+
* Request body for cancelling a single approval request.
|
|
7594
|
+
* @export
|
|
7595
|
+
* @interface ApprovalCancelRequestV2026
|
|
7596
|
+
*/
|
|
7597
|
+
export interface ApprovalCancelRequestV2026 {
|
|
7598
|
+
/**
|
|
7599
|
+
* Optional comment associated with the cancel request.
|
|
7600
|
+
* @type {string}
|
|
7601
|
+
* @memberof ApprovalCancelRequestV2026
|
|
7602
|
+
*/
|
|
7603
|
+
'comment'?: string;
|
|
7604
|
+
}
|
|
7592
7605
|
/**
|
|
7593
7606
|
* Comments Object
|
|
7594
7607
|
* @export
|
|
@@ -7880,24 +7893,6 @@ export type ApprovalConfigTimeoutConfigV2026TimeoutResultV2026 = typeof Approval
|
|
|
7880
7893
|
* @interface ApprovalConfigV2026
|
|
7881
7894
|
*/
|
|
7882
7895
|
export interface ApprovalConfigV2026 {
|
|
7883
|
-
/**
|
|
7884
|
-
* Tenant ID of the approval configuration.
|
|
7885
|
-
* @type {string}
|
|
7886
|
-
* @memberof ApprovalConfigV2026
|
|
7887
|
-
*/
|
|
7888
|
-
'tenantId'?: string;
|
|
7889
|
-
/**
|
|
7890
|
-
* 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
|
|
7891
|
-
* @type {string}
|
|
7892
|
-
* @memberof ApprovalConfigV2026
|
|
7893
|
-
*/
|
|
7894
|
-
'id'?: string;
|
|
7895
|
-
/**
|
|
7896
|
-
* 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
|
|
7897
|
-
* @type {string}
|
|
7898
|
-
* @memberof ApprovalConfigV2026
|
|
7899
|
-
*/
|
|
7900
|
-
'scope'?: string;
|
|
7901
7896
|
/**
|
|
7902
7897
|
*
|
|
7903
7898
|
* @type {ApprovalConfigReminderConfigV2026}
|
|
@@ -7940,6 +7935,18 @@ export interface ApprovalConfigV2026 {
|
|
|
7940
7935
|
* @memberof ApprovalConfigV2026
|
|
7941
7936
|
*/
|
|
7942
7937
|
'fallbackApprover'?: ApprovalIdentityV2026;
|
|
7938
|
+
/**
|
|
7939
|
+
* Specifies how to treat the identity type \"MANAGER_OF\" when the requestee is a machine identity.
|
|
7940
|
+
* @type {string}
|
|
7941
|
+
* @memberof ApprovalConfigV2026
|
|
7942
|
+
*/
|
|
7943
|
+
'machineIdentityManagerAssignment'?: ApprovalConfigV2026MachineIdentityManagerAssignmentV2026;
|
|
7944
|
+
/**
|
|
7945
|
+
* When true, all approvals will be created with the status \"PASSED\".
|
|
7946
|
+
* @type {boolean}
|
|
7947
|
+
* @memberof ApprovalConfigV2026
|
|
7948
|
+
*/
|
|
7949
|
+
'circumventApprovalProcess'?: boolean;
|
|
7943
7950
|
/**
|
|
7944
7951
|
* 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.
|
|
7945
7952
|
* @type {string}
|
|
@@ -7954,6 +7961,16 @@ export declare const ApprovalConfigV2026RequiresCommentV2026: {
|
|
|
7954
7961
|
readonly Off: "OFF";
|
|
7955
7962
|
};
|
|
7956
7963
|
export type ApprovalConfigV2026RequiresCommentV2026 = typeof ApprovalConfigV2026RequiresCommentV2026[keyof typeof ApprovalConfigV2026RequiresCommentV2026];
|
|
7964
|
+
export declare const ApprovalConfigV2026MachineIdentityManagerAssignmentV2026: {
|
|
7965
|
+
readonly ManagerOfRequester: "MANAGER_OF_REQUESTER";
|
|
7966
|
+
readonly MachineIdentityOwner: "MACHINE_IDENTITY_OWNER";
|
|
7967
|
+
readonly ManagerOfMachineIdentityOwner: "MANAGER_OF_MACHINE_IDENTITY_OWNER";
|
|
7968
|
+
readonly RequestedTargetOwner: "REQUESTED_TARGET_OWNER";
|
|
7969
|
+
readonly ManagerOfRequestedTargetOwner: "MANAGER_OF_REQUESTED_TARGET_OWNER";
|
|
7970
|
+
readonly AccountOwner: "ACCOUNT_OWNER";
|
|
7971
|
+
readonly ManagerOfAccountOwner: "MANAGER_OF_ACCOUNT_OWNER";
|
|
7972
|
+
};
|
|
7973
|
+
export type ApprovalConfigV2026MachineIdentityManagerAssignmentV2026 = typeof ApprovalConfigV2026MachineIdentityManagerAssignmentV2026[keyof typeof ApprovalConfigV2026MachineIdentityManagerAssignmentV2026];
|
|
7957
7974
|
export declare const ApprovalConfigV2026AutoApproveV2026: {
|
|
7958
7975
|
readonly Off: "OFF";
|
|
7959
7976
|
readonly Direct: "DIRECT";
|
|
@@ -28825,7 +28842,7 @@ export interface MachineIdentityV2026 {
|
|
|
28825
28842
|
*/
|
|
28826
28843
|
export interface MachineSubtypeApprovalConfigV2026 {
|
|
28827
28844
|
/**
|
|
28828
|
-
* Comma separated string of approvers. Following are the options for approver types: manager, sourceOwner, accountOwner, workgroup:
|
|
28845
|
+
* Comma separated string of approvers. Following are the options for approver types: manager, sourceOwner, accountOwner, workgroup:[workgroupId] (Governance group). Approval request will be assigned based on the order of the approvers passed. Multiple workgroups(governance groups) can be selected as an approver. >**Note:** accountOwner approver type is only for machine account delete approval settings.
|
|
28829
28846
|
* @type {string}
|
|
28830
28847
|
* @memberof MachineSubtypeApprovalConfigV2026
|
|
28831
28848
|
*/
|
|
@@ -56957,9 +56974,9 @@ export type GetDiscoveredApplicationsDetailV2026 = typeof GetDiscoveredApplicati
|
|
|
56957
56974
|
*/
|
|
56958
56975
|
export declare const ApprovalsV2026ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
56959
56976
|
/**
|
|
56960
|
-
*
|
|
56977
|
+
* 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.
|
|
56961
56978
|
* @summary Post Approvals Approve
|
|
56962
|
-
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve
|
|
56979
|
+
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve.
|
|
56963
56980
|
* @param {ApprovalApproveRequestV2026} [approvalApproveRequestV2026]
|
|
56964
56981
|
* @param {*} [axiosOptions] Override http request option.
|
|
56965
56982
|
* @throws {RequiredError}
|
|
@@ -56974,24 +56991,33 @@ export declare const ApprovalsV2026ApiAxiosParamCreator: (configuration?: Config
|
|
|
56974
56991
|
*/
|
|
56975
56992
|
approveApprovalInBulk: (bulkApproveRequestDTOV2026: BulkApproveRequestDTOV2026, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56976
56993
|
/**
|
|
56977
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
56994
|
+
* 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
|
|
56978
56995
|
* @summary Post Bulk Cancel Approvals
|
|
56979
56996
|
* @param {BulkCancelRequestDTOV2026} bulkCancelRequestDTOV2026
|
|
56980
56997
|
* @param {*} [axiosOptions] Override http request option.
|
|
56981
56998
|
* @throws {RequiredError}
|
|
56982
56999
|
*/
|
|
56983
57000
|
cancelApproval: (bulkCancelRequestDTOV2026: BulkCancelRequestDTOV2026, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
57001
|
+
/**
|
|
57002
|
+
* Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel
|
|
57003
|
+
* @summary Post Approval Cancel
|
|
57004
|
+
* @param {string} id ID of the approval request to cancel.
|
|
57005
|
+
* @param {ApprovalCancelRequestV2026} [approvalCancelRequestV2026]
|
|
57006
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
57007
|
+
* @throws {RequiredError}
|
|
57008
|
+
*/
|
|
57009
|
+
cancelApprovalById: (id: string, approvalCancelRequestV2026?: ApprovalCancelRequestV2026, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56984
57010
|
/**
|
|
56985
57011
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
56986
57012
|
* @summary Delete Approval Configuration
|
|
56987
|
-
* @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
|
|
56988
|
-
* @param {DeleteApprovalConfigRequestScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
57013
|
+
* @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
|
|
57014
|
+
* @param {DeleteApprovalConfigRequestScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
56989
57015
|
* @param {*} [axiosOptions] Override http request option.
|
|
56990
57016
|
* @throws {RequiredError}
|
|
56991
57017
|
*/
|
|
56992
57018
|
deleteApprovalConfigRequest: (id: string, scope: DeleteApprovalConfigRequestScopeV2026, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56993
57019
|
/**
|
|
56994
|
-
*
|
|
57020
|
+
* 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\"
|
|
56995
57021
|
* @summary Get an approval
|
|
56996
57022
|
* @param {string} id ID of the approval that is to be returned
|
|
56997
57023
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56999,7 +57025,7 @@ export declare const ApprovalsV2026ApiAxiosParamCreator: (configuration?: Config
|
|
|
56999
57025
|
*/
|
|
57000
57026
|
getApproval: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
57001
57027
|
/**
|
|
57002
|
-
*
|
|
57028
|
+
* 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.
|
|
57003
57029
|
* @summary Get approvals
|
|
57004
57030
|
* @param {boolean} [mine] Returns the list of approvals for the current caller. Defaults to false if admin, true otherwise.
|
|
57005
57031
|
* @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.
|
|
@@ -57009,6 +57035,7 @@ export declare const ApprovalsV2026ApiAxiosParamCreator: (configuration?: Config
|
|
|
57009
57035
|
* @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.
|
|
57010
57036
|
* @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments.
|
|
57011
57037
|
* @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers.
|
|
57038
|
+
* @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history.
|
|
57012
57039
|
* @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch information.
|
|
57013
57040
|
* @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*
|
|
57014
57041
|
* @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.
|
|
@@ -57016,11 +57043,11 @@ export declare const ApprovalsV2026ApiAxiosParamCreator: (configuration?: Config
|
|
|
57016
57043
|
* @param {*} [axiosOptions] Override http request option.
|
|
57017
57044
|
* @throws {RequiredError}
|
|
57018
57045
|
*/
|
|
57019
|
-
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>;
|
|
57046
|
+
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>;
|
|
57020
57047
|
/**
|
|
57021
57048
|
* Retrieves a singular approval configuration that matches the given ID
|
|
57022
57049
|
* @summary Get Approval Config
|
|
57023
|
-
* @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)]
|
|
57050
|
+
* @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)]
|
|
57024
57051
|
* @param {*} [axiosOptions] Override http request option.
|
|
57025
57052
|
* @throws {RequiredError}
|
|
57026
57053
|
*/
|
|
@@ -57036,15 +57063,15 @@ export declare const ApprovalsV2026ApiAxiosParamCreator: (configuration?: Config
|
|
|
57036
57063
|
/**
|
|
57037
57064
|
* 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\'
|
|
57038
57065
|
* @summary Put Approval Config
|
|
57039
|
-
* @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
|
|
57040
|
-
* @param {PutApprovalsConfigScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
57066
|
+
* @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
|
|
57067
|
+
* @param {PutApprovalsConfigScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
57041
57068
|
* @param {ApprovalConfigV2026} approvalConfigV2026
|
|
57042
57069
|
* @param {*} [axiosOptions] Override http request option.
|
|
57043
57070
|
* @throws {RequiredError}
|
|
57044
57071
|
*/
|
|
57045
57072
|
putApprovalsConfig: (id: string, scope: PutApprovalsConfigScopeV2026, approvalConfigV2026: ApprovalConfigV2026, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
57046
57073
|
/**
|
|
57047
|
-
*
|
|
57074
|
+
* 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.
|
|
57048
57075
|
* @summary Post Approvals Reject
|
|
57049
57076
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject.
|
|
57050
57077
|
* @param {ApprovalRejectRequestV2026} [approvalRejectRequestV2026]
|
|
@@ -57061,7 +57088,7 @@ export declare const ApprovalsV2026ApiAxiosParamCreator: (configuration?: Config
|
|
|
57061
57088
|
*/
|
|
57062
57089
|
rejectApprovalInBulk: (bulkRejectRequestDTOV2026: BulkRejectRequestDTOV2026, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
57063
57090
|
/**
|
|
57064
|
-
*
|
|
57091
|
+
* 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.
|
|
57065
57092
|
* @summary Post Approvals Attributes
|
|
57066
57093
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
|
|
57067
57094
|
* @param {ApprovalAttributesRequestV2026} approvalAttributesRequestV2026
|
|
@@ -57070,7 +57097,7 @@ export declare const ApprovalsV2026ApiAxiosParamCreator: (configuration?: Config
|
|
|
57070
57097
|
*/
|
|
57071
57098
|
updateApprovalsAttributes: (id: string, approvalAttributesRequestV2026: ApprovalAttributesRequestV2026, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
57072
57099
|
/**
|
|
57073
|
-
*
|
|
57100
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
57074
57101
|
* @summary Post Approvals Comments
|
|
57075
57102
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to.
|
|
57076
57103
|
* @param {ApprovalCommentsRequestV2026} approvalCommentsRequestV2026
|
|
@@ -57079,7 +57106,7 @@ export declare const ApprovalsV2026ApiAxiosParamCreator: (configuration?: Config
|
|
|
57079
57106
|
*/
|
|
57080
57107
|
updateApprovalsComments: (id: string, approvalCommentsRequestV2026: ApprovalCommentsRequestV2026, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
57081
57108
|
/**
|
|
57082
|
-
*
|
|
57109
|
+
* 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.
|
|
57083
57110
|
* @summary Post Approvals Reassign
|
|
57084
57111
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign.
|
|
57085
57112
|
* @param {ApprovalReassignRequestV2026} approvalReassignRequestV2026
|
|
@@ -57094,9 +57121,9 @@ export declare const ApprovalsV2026ApiAxiosParamCreator: (configuration?: Config
|
|
|
57094
57121
|
*/
|
|
57095
57122
|
export declare const ApprovalsV2026ApiFp: (configuration?: Configuration) => {
|
|
57096
57123
|
/**
|
|
57097
|
-
*
|
|
57124
|
+
* 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.
|
|
57098
57125
|
* @summary Post Approvals Approve
|
|
57099
|
-
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve
|
|
57126
|
+
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve.
|
|
57100
57127
|
* @param {ApprovalApproveRequestV2026} [approvalApproveRequestV2026]
|
|
57101
57128
|
* @param {*} [axiosOptions] Override http request option.
|
|
57102
57129
|
* @throws {RequiredError}
|
|
@@ -57111,24 +57138,33 @@ export declare const ApprovalsV2026ApiFp: (configuration?: Configuration) => {
|
|
|
57111
57138
|
*/
|
|
57112
57139
|
approveApprovalInBulk(bulkApproveRequestDTOV2026: BulkApproveRequestDTOV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
57113
57140
|
/**
|
|
57114
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
57141
|
+
* 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
|
|
57115
57142
|
* @summary Post Bulk Cancel Approvals
|
|
57116
57143
|
* @param {BulkCancelRequestDTOV2026} bulkCancelRequestDTOV2026
|
|
57117
57144
|
* @param {*} [axiosOptions] Override http request option.
|
|
57118
57145
|
* @throws {RequiredError}
|
|
57119
57146
|
*/
|
|
57120
57147
|
cancelApproval(bulkCancelRequestDTOV2026: BulkCancelRequestDTOV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
57148
|
+
/**
|
|
57149
|
+
* Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel
|
|
57150
|
+
* @summary Post Approval Cancel
|
|
57151
|
+
* @param {string} id ID of the approval request to cancel.
|
|
57152
|
+
* @param {ApprovalCancelRequestV2026} [approvalCancelRequestV2026]
|
|
57153
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
57154
|
+
* @throws {RequiredError}
|
|
57155
|
+
*/
|
|
57156
|
+
cancelApprovalById(id: string, approvalCancelRequestV2026?: ApprovalCancelRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
57121
57157
|
/**
|
|
57122
57158
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
57123
57159
|
* @summary Delete Approval Configuration
|
|
57124
|
-
* @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
|
|
57125
|
-
* @param {DeleteApprovalConfigRequestScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
57160
|
+
* @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
|
|
57161
|
+
* @param {DeleteApprovalConfigRequestScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
57126
57162
|
* @param {*} [axiosOptions] Override http request option.
|
|
57127
57163
|
* @throws {RequiredError}
|
|
57128
57164
|
*/
|
|
57129
57165
|
deleteApprovalConfigRequest(id: string, scope: DeleteApprovalConfigRequestScopeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
57130
57166
|
/**
|
|
57131
|
-
*
|
|
57167
|
+
* 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\"
|
|
57132
57168
|
* @summary Get an approval
|
|
57133
57169
|
* @param {string} id ID of the approval that is to be returned
|
|
57134
57170
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57136,7 +57172,7 @@ export declare const ApprovalsV2026ApiFp: (configuration?: Configuration) => {
|
|
|
57136
57172
|
*/
|
|
57137
57173
|
getApproval(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalV2026>>;
|
|
57138
57174
|
/**
|
|
57139
|
-
*
|
|
57175
|
+
* 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.
|
|
57140
57176
|
* @summary Get approvals
|
|
57141
57177
|
* @param {boolean} [mine] Returns the list of approvals for the current caller. Defaults to false if admin, true otherwise.
|
|
57142
57178
|
* @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.
|
|
@@ -57146,6 +57182,7 @@ export declare const ApprovalsV2026ApiFp: (configuration?: Configuration) => {
|
|
|
57146
57182
|
* @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.
|
|
57147
57183
|
* @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments.
|
|
57148
57184
|
* @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers.
|
|
57185
|
+
* @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history.
|
|
57149
57186
|
* @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch information.
|
|
57150
57187
|
* @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*
|
|
57151
57188
|
* @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.
|
|
@@ -57153,11 +57190,11 @@ export declare const ApprovalsV2026ApiFp: (configuration?: Configuration) => {
|
|
|
57153
57190
|
* @param {*} [axiosOptions] Override http request option.
|
|
57154
57191
|
* @throws {RequiredError}
|
|
57155
57192
|
*/
|
|
57156
|
-
getApprovals(mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApprovalV2026>>>;
|
|
57193
|
+
getApprovals(mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeReassignmentHistory?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApprovalV2026>>>;
|
|
57157
57194
|
/**
|
|
57158
57195
|
* Retrieves a singular approval configuration that matches the given ID
|
|
57159
57196
|
* @summary Get Approval Config
|
|
57160
|
-
* @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)]
|
|
57197
|
+
* @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)]
|
|
57161
57198
|
* @param {*} [axiosOptions] Override http request option.
|
|
57162
57199
|
* @throws {RequiredError}
|
|
57163
57200
|
*/
|
|
@@ -57173,15 +57210,15 @@ export declare const ApprovalsV2026ApiFp: (configuration?: Configuration) => {
|
|
|
57173
57210
|
/**
|
|
57174
57211
|
* 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\'
|
|
57175
57212
|
* @summary Put Approval Config
|
|
57176
|
-
* @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
|
|
57177
|
-
* @param {PutApprovalsConfigScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
57213
|
+
* @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
|
|
57214
|
+
* @param {PutApprovalsConfigScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT
|
|
57178
57215
|
* @param {ApprovalConfigV2026} approvalConfigV2026
|
|
57179
57216
|
* @param {*} [axiosOptions] Override http request option.
|
|
57180
57217
|
* @throws {RequiredError}
|
|
57181
57218
|
*/
|
|
57182
57219
|
putApprovalsConfig(id: string, scope: PutApprovalsConfigScopeV2026, approvalConfigV2026: ApprovalConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalConfigV2026>>;
|
|
57183
57220
|
/**
|
|
57184
|
-
*
|
|
57221
|
+
* 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.
|
|
57185
57222
|
* @summary Post Approvals Reject
|
|
57186
57223
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject.
|
|
57187
57224
|
* @param {ApprovalRejectRequestV2026} [approvalRejectRequestV2026]
|
|
@@ -57198,7 +57235,7 @@ export declare const ApprovalsV2026ApiFp: (configuration?: Configuration) => {
|
|
|
57198
57235
|
*/
|
|
57199
57236
|
rejectApprovalInBulk(bulkRejectRequestDTOV2026: BulkRejectRequestDTOV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
57200
57237
|
/**
|
|
57201
|
-
*
|
|
57238
|
+
* 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.
|
|
57202
57239
|
* @summary Post Approvals Attributes
|
|
57203
57240
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
|
|
57204
57241
|
* @param {ApprovalAttributesRequestV2026} approvalAttributesRequestV2026
|
|
@@ -57207,7 +57244,7 @@ export declare const ApprovalsV2026ApiFp: (configuration?: Configuration) => {
|
|
|
57207
57244
|
*/
|
|
57208
57245
|
updateApprovalsAttributes(id: string, approvalAttributesRequestV2026: ApprovalAttributesRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalV2026>>;
|
|
57209
57246
|
/**
|
|
57210
|
-
*
|
|
57247
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
57211
57248
|
* @summary Post Approvals Comments
|
|
57212
57249
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to.
|
|
57213
57250
|
* @param {ApprovalCommentsRequestV2026} approvalCommentsRequestV2026
|
|
@@ -57216,7 +57253,7 @@ export declare const ApprovalsV2026ApiFp: (configuration?: Configuration) => {
|
|
|
57216
57253
|
*/
|
|
57217
57254
|
updateApprovalsComments(id: string, approvalCommentsRequestV2026: ApprovalCommentsRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalV2026>>;
|
|
57218
57255
|
/**
|
|
57219
|
-
*
|
|
57256
|
+
* 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.
|
|
57220
57257
|
* @summary Post Approvals Reassign
|
|
57221
57258
|
* @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign.
|
|
57222
57259
|
* @param {ApprovalReassignRequestV2026} approvalReassignRequestV2026
|
|
@@ -57231,7 +57268,7 @@ export declare const ApprovalsV2026ApiFp: (configuration?: Configuration) => {
|
|
|
57231
57268
|
*/
|
|
57232
57269
|
export declare const ApprovalsV2026ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
57233
57270
|
/**
|
|
57234
|
-
*
|
|
57271
|
+
* 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.
|
|
57235
57272
|
* @summary Post Approvals Approve
|
|
57236
57273
|
* @param {ApprovalsV2026ApiApproveApprovalRequest} requestParameters Request parameters.
|
|
57237
57274
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57247,13 +57284,21 @@ export declare const ApprovalsV2026ApiFactory: (configuration?: Configuration, b
|
|
|
57247
57284
|
*/
|
|
57248
57285
|
approveApprovalInBulk(requestParameters: ApprovalsV2026ApiApproveApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
57249
57286
|
/**
|
|
57250
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
57287
|
+
* 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
|
|
57251
57288
|
* @summary Post Bulk Cancel Approvals
|
|
57252
57289
|
* @param {ApprovalsV2026ApiCancelApprovalRequest} requestParameters Request parameters.
|
|
57253
57290
|
* @param {*} [axiosOptions] Override http request option.
|
|
57254
57291
|
* @throws {RequiredError}
|
|
57255
57292
|
*/
|
|
57256
57293
|
cancelApproval(requestParameters: ApprovalsV2026ApiCancelApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
57294
|
+
/**
|
|
57295
|
+
* Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel
|
|
57296
|
+
* @summary Post Approval Cancel
|
|
57297
|
+
* @param {ApprovalsV2026ApiCancelApprovalByIdRequest} requestParameters Request parameters.
|
|
57298
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
57299
|
+
* @throws {RequiredError}
|
|
57300
|
+
*/
|
|
57301
|
+
cancelApprovalById(requestParameters: ApprovalsV2026ApiCancelApprovalByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
57257
57302
|
/**
|
|
57258
57303
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
57259
57304
|
* @summary Delete Approval Configuration
|
|
@@ -57263,7 +57308,7 @@ export declare const ApprovalsV2026ApiFactory: (configuration?: Configuration, b
|
|
|
57263
57308
|
*/
|
|
57264
57309
|
deleteApprovalConfigRequest(requestParameters: ApprovalsV2026ApiDeleteApprovalConfigRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
57265
57310
|
/**
|
|
57266
|
-
*
|
|
57311
|
+
* 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\"
|
|
57267
57312
|
* @summary Get an approval
|
|
57268
57313
|
* @param {ApprovalsV2026ApiGetApprovalRequest} requestParameters Request parameters.
|
|
57269
57314
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57271,7 +57316,7 @@ export declare const ApprovalsV2026ApiFactory: (configuration?: Configuration, b
|
|
|
57271
57316
|
*/
|
|
57272
57317
|
getApproval(requestParameters: ApprovalsV2026ApiGetApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ApprovalV2026>;
|
|
57273
57318
|
/**
|
|
57274
|
-
*
|
|
57319
|
+
* 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.
|
|
57275
57320
|
* @summary Get approvals
|
|
57276
57321
|
* @param {ApprovalsV2026ApiGetApprovalsRequest} requestParameters Request parameters.
|
|
57277
57322
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57303,7 +57348,7 @@ export declare const ApprovalsV2026ApiFactory: (configuration?: Configuration, b
|
|
|
57303
57348
|
*/
|
|
57304
57349
|
putApprovalsConfig(requestParameters: ApprovalsV2026ApiPutApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ApprovalConfigV2026>;
|
|
57305
57350
|
/**
|
|
57306
|
-
*
|
|
57351
|
+
* 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.
|
|
57307
57352
|
* @summary Post Approvals Reject
|
|
57308
57353
|
* @param {ApprovalsV2026ApiRejectApprovalRequest} requestParameters Request parameters.
|
|
57309
57354
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57319,7 +57364,7 @@ export declare const ApprovalsV2026ApiFactory: (configuration?: Configuration, b
|
|
|
57319
57364
|
*/
|
|
57320
57365
|
rejectApprovalInBulk(requestParameters: ApprovalsV2026ApiRejectApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
57321
57366
|
/**
|
|
57322
|
-
*
|
|
57367
|
+
* 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.
|
|
57323
57368
|
* @summary Post Approvals Attributes
|
|
57324
57369
|
* @param {ApprovalsV2026ApiUpdateApprovalsAttributesRequest} requestParameters Request parameters.
|
|
57325
57370
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57327,7 +57372,7 @@ export declare const ApprovalsV2026ApiFactory: (configuration?: Configuration, b
|
|
|
57327
57372
|
*/
|
|
57328
57373
|
updateApprovalsAttributes(requestParameters: ApprovalsV2026ApiUpdateApprovalsAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ApprovalV2026>;
|
|
57329
57374
|
/**
|
|
57330
|
-
*
|
|
57375
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
57331
57376
|
* @summary Post Approvals Comments
|
|
57332
57377
|
* @param {ApprovalsV2026ApiUpdateApprovalsCommentsRequest} requestParameters Request parameters.
|
|
57333
57378
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57335,7 +57380,7 @@ export declare const ApprovalsV2026ApiFactory: (configuration?: Configuration, b
|
|
|
57335
57380
|
*/
|
|
57336
57381
|
updateApprovalsComments(requestParameters: ApprovalsV2026ApiUpdateApprovalsCommentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ApprovalV2026>;
|
|
57337
57382
|
/**
|
|
57338
|
-
*
|
|
57383
|
+
* 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.
|
|
57339
57384
|
* @summary Post Approvals Reassign
|
|
57340
57385
|
* @param {ApprovalsV2026ApiUpdateApprovalsReassignRequest} requestParameters Request parameters.
|
|
57341
57386
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57350,7 +57395,7 @@ export declare const ApprovalsV2026ApiFactory: (configuration?: Configuration, b
|
|
|
57350
57395
|
*/
|
|
57351
57396
|
export interface ApprovalsV2026ApiApproveApprovalRequest {
|
|
57352
57397
|
/**
|
|
57353
|
-
* Approval ID that correlates to an existing approval request that a user wants to approve
|
|
57398
|
+
* Approval ID that correlates to an existing approval request that a user wants to approve.
|
|
57354
57399
|
* @type {string}
|
|
57355
57400
|
* @memberof ApprovalsV2026ApiApproveApproval
|
|
57356
57401
|
*/
|
|
@@ -57388,6 +57433,25 @@ export interface ApprovalsV2026ApiCancelApprovalRequest {
|
|
|
57388
57433
|
*/
|
|
57389
57434
|
readonly bulkCancelRequestDTOV2026: BulkCancelRequestDTOV2026;
|
|
57390
57435
|
}
|
|
57436
|
+
/**
|
|
57437
|
+
* Request parameters for cancelApprovalById operation in ApprovalsV2026Api.
|
|
57438
|
+
* @export
|
|
57439
|
+
* @interface ApprovalsV2026ApiCancelApprovalByIdRequest
|
|
57440
|
+
*/
|
|
57441
|
+
export interface ApprovalsV2026ApiCancelApprovalByIdRequest {
|
|
57442
|
+
/**
|
|
57443
|
+
* ID of the approval request to cancel.
|
|
57444
|
+
* @type {string}
|
|
57445
|
+
* @memberof ApprovalsV2026ApiCancelApprovalById
|
|
57446
|
+
*/
|
|
57447
|
+
readonly id: string;
|
|
57448
|
+
/**
|
|
57449
|
+
*
|
|
57450
|
+
* @type {ApprovalCancelRequestV2026}
|
|
57451
|
+
* @memberof ApprovalsV2026ApiCancelApprovalById
|
|
57452
|
+
*/
|
|
57453
|
+
readonly approvalCancelRequestV2026?: ApprovalCancelRequestV2026;
|
|
57454
|
+
}
|
|
57391
57455
|
/**
|
|
57392
57456
|
* Request parameters for deleteApprovalConfigRequest operation in ApprovalsV2026Api.
|
|
57393
57457
|
* @export
|
|
@@ -57395,13 +57459,13 @@ export interface ApprovalsV2026ApiCancelApprovalRequest {
|
|
|
57395
57459
|
*/
|
|
57396
57460
|
export interface ApprovalsV2026ApiDeleteApprovalConfigRequestRequest {
|
|
57397
57461
|
/**
|
|
57398
|
-
* 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
|
|
57462
|
+
* 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
|
|
57399
57463
|
* @type {string}
|
|
57400
57464
|
* @memberof ApprovalsV2026ApiDeleteApprovalConfigRequest
|
|
57401
57465
|
*/
|
|
57402
57466
|
readonly id: string;
|
|
57403
57467
|
/**
|
|
57404
|
-
* 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
|
|
57468
|
+
* 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
|
|
57405
57469
|
* @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'}
|
|
57406
57470
|
* @memberof ApprovalsV2026ApiDeleteApprovalConfigRequest
|
|
57407
57471
|
*/
|
|
@@ -57474,6 +57538,12 @@ export interface ApprovalsV2026ApiGetApprovalsRequest {
|
|
|
57474
57538
|
* @memberof ApprovalsV2026ApiGetApprovals
|
|
57475
57539
|
*/
|
|
57476
57540
|
readonly includeApprovers?: boolean;
|
|
57541
|
+
/**
|
|
57542
|
+
* If set to true in the query, the approval requests returned will include reassignment history.
|
|
57543
|
+
* @type {boolean}
|
|
57544
|
+
* @memberof ApprovalsV2026ApiGetApprovals
|
|
57545
|
+
*/
|
|
57546
|
+
readonly includeReassignmentHistory?: boolean;
|
|
57477
57547
|
/**
|
|
57478
57548
|
* If set to true in the query, the approval requests returned will include batch information.
|
|
57479
57549
|
* @type {boolean}
|
|
@@ -57506,7 +57576,7 @@ export interface ApprovalsV2026ApiGetApprovalsRequest {
|
|
|
57506
57576
|
*/
|
|
57507
57577
|
export interface ApprovalsV2026ApiGetApprovalsConfigRequest {
|
|
57508
57578
|
/**
|
|
57509
|
-
* 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)]
|
|
57579
|
+
* 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)]
|
|
57510
57580
|
* @type {string}
|
|
57511
57581
|
* @memberof ApprovalsV2026ApiGetApprovalsConfig
|
|
57512
57582
|
*/
|
|
@@ -57532,13 +57602,13 @@ export interface ApprovalsV2026ApiMoveApprovalRequest {
|
|
|
57532
57602
|
*/
|
|
57533
57603
|
export interface ApprovalsV2026ApiPutApprovalsConfigRequest {
|
|
57534
57604
|
/**
|
|
57535
|
-
* 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
|
|
57605
|
+
* 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
|
|
57536
57606
|
* @type {string}
|
|
57537
57607
|
* @memberof ApprovalsV2026ApiPutApprovalsConfig
|
|
57538
57608
|
*/
|
|
57539
57609
|
readonly id: string;
|
|
57540
57610
|
/**
|
|
57541
|
-
* 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
|
|
57611
|
+
* 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
|
|
57542
57612
|
* @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'}
|
|
57543
57613
|
* @memberof ApprovalsV2026ApiPutApprovalsConfig
|
|
57544
57614
|
*/
|
|
@@ -57647,7 +57717,7 @@ export interface ApprovalsV2026ApiUpdateApprovalsReassignRequest {
|
|
|
57647
57717
|
*/
|
|
57648
57718
|
export declare class ApprovalsV2026Api extends BaseAPI {
|
|
57649
57719
|
/**
|
|
57650
|
-
*
|
|
57720
|
+
* 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.
|
|
57651
57721
|
* @summary Post Approvals Approve
|
|
57652
57722
|
* @param {ApprovalsV2026ApiApproveApprovalRequest} requestParameters Request parameters.
|
|
57653
57723
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57665,7 +57735,7 @@ export declare class ApprovalsV2026Api extends BaseAPI {
|
|
|
57665
57735
|
*/
|
|
57666
57736
|
approveApprovalInBulk(requestParameters: ApprovalsV2026ApiApproveApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
57667
57737
|
/**
|
|
57668
|
-
* Bulk cancels specified approval requests on behalf of the caller
|
|
57738
|
+
* 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
|
|
57669
57739
|
* @summary Post Bulk Cancel Approvals
|
|
57670
57740
|
* @param {ApprovalsV2026ApiCancelApprovalRequest} requestParameters Request parameters.
|
|
57671
57741
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57673,6 +57743,15 @@ export declare class ApprovalsV2026Api extends BaseAPI {
|
|
|
57673
57743
|
* @memberof ApprovalsV2026Api
|
|
57674
57744
|
*/
|
|
57675
57745
|
cancelApproval(requestParameters: ApprovalsV2026ApiCancelApprovalRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
57746
|
+
/**
|
|
57747
|
+
* Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel
|
|
57748
|
+
* @summary Post Approval Cancel
|
|
57749
|
+
* @param {ApprovalsV2026ApiCancelApprovalByIdRequest} requestParameters Request parameters.
|
|
57750
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
57751
|
+
* @throws {RequiredError}
|
|
57752
|
+
* @memberof ApprovalsV2026Api
|
|
57753
|
+
*/
|
|
57754
|
+
cancelApprovalById(requestParameters: ApprovalsV2026ApiCancelApprovalByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
57676
57755
|
/**
|
|
57677
57756
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
57678
57757
|
* @summary Delete Approval Configuration
|
|
@@ -57683,7 +57762,7 @@ export declare class ApprovalsV2026Api extends BaseAPI {
|
|
|
57683
57762
|
*/
|
|
57684
57763
|
deleteApprovalConfigRequest(requestParameters: ApprovalsV2026ApiDeleteApprovalConfigRequestRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
57685
57764
|
/**
|
|
57686
|
-
*
|
|
57765
|
+
* 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\"
|
|
57687
57766
|
* @summary Get an approval
|
|
57688
57767
|
* @param {ApprovalsV2026ApiGetApprovalRequest} requestParameters Request parameters.
|
|
57689
57768
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57692,7 +57771,7 @@ export declare class ApprovalsV2026Api extends BaseAPI {
|
|
|
57692
57771
|
*/
|
|
57693
57772
|
getApproval(requestParameters: ApprovalsV2026ApiGetApprovalRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalV2026, any>>;
|
|
57694
57773
|
/**
|
|
57695
|
-
*
|
|
57774
|
+
* 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.
|
|
57696
57775
|
* @summary Get approvals
|
|
57697
57776
|
* @param {ApprovalsV2026ApiGetApprovalsRequest} requestParameters Request parameters.
|
|
57698
57777
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57728,7 +57807,7 @@ export declare class ApprovalsV2026Api extends BaseAPI {
|
|
|
57728
57807
|
*/
|
|
57729
57808
|
putApprovalsConfig(requestParameters: ApprovalsV2026ApiPutApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalConfigV2026, any>>;
|
|
57730
57809
|
/**
|
|
57731
|
-
*
|
|
57810
|
+
* 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.
|
|
57732
57811
|
* @summary Post Approvals Reject
|
|
57733
57812
|
* @param {ApprovalsV2026ApiRejectApprovalRequest} requestParameters Request parameters.
|
|
57734
57813
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57746,7 +57825,7 @@ export declare class ApprovalsV2026Api extends BaseAPI {
|
|
|
57746
57825
|
*/
|
|
57747
57826
|
rejectApprovalInBulk(requestParameters: ApprovalsV2026ApiRejectApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
57748
57827
|
/**
|
|
57749
|
-
*
|
|
57828
|
+
* 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.
|
|
57750
57829
|
* @summary Post Approvals Attributes
|
|
57751
57830
|
* @param {ApprovalsV2026ApiUpdateApprovalsAttributesRequest} requestParameters Request parameters.
|
|
57752
57831
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57755,7 +57834,7 @@ export declare class ApprovalsV2026Api extends BaseAPI {
|
|
|
57755
57834
|
*/
|
|
57756
57835
|
updateApprovalsAttributes(requestParameters: ApprovalsV2026ApiUpdateApprovalsAttributesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalV2026, any>>;
|
|
57757
57836
|
/**
|
|
57758
|
-
*
|
|
57837
|
+
* Adds comments to a specified approval request. This endpoint does not support access request IDs.
|
|
57759
57838
|
* @summary Post Approvals Comments
|
|
57760
57839
|
* @param {ApprovalsV2026ApiUpdateApprovalsCommentsRequest} requestParameters Request parameters.
|
|
57761
57840
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57764,7 +57843,7 @@ export declare class ApprovalsV2026Api extends BaseAPI {
|
|
|
57764
57843
|
*/
|
|
57765
57844
|
updateApprovalsComments(requestParameters: ApprovalsV2026ApiUpdateApprovalsCommentsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalV2026, any>>;
|
|
57766
57845
|
/**
|
|
57767
|
-
*
|
|
57846
|
+
* 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.
|
|
57768
57847
|
* @summary Post Approvals Reassign
|
|
57769
57848
|
* @param {ApprovalsV2026ApiUpdateApprovalsReassignRequest} requestParameters Request parameters.
|
|
57770
57849
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -64743,11 +64822,13 @@ export declare const CustomFormsV2026ApiAxiosParamCreator: (configuration?: Conf
|
|
|
64743
64822
|
/**
|
|
64744
64823
|
* Returns a list of form instances for the tenant. Optionally filter by form definition ID.
|
|
64745
64824
|
* @summary List form instances by tenant.
|
|
64825
|
+
* @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.
|
|
64826
|
+
* @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.
|
|
64746
64827
|
* @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*
|
|
64747
64828
|
* @param {*} [axiosOptions] Override http request option.
|
|
64748
64829
|
* @throws {RequiredError}
|
|
64749
64830
|
*/
|
|
64750
|
-
searchFormInstancesByTenant: (filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64831
|
+
searchFormInstancesByTenant: (offset?: number, limit?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64751
64832
|
/**
|
|
64752
64833
|
* No parameters required.
|
|
64753
64834
|
* @summary List predefined select options.
|
|
@@ -64915,11 +64996,13 @@ export declare const CustomFormsV2026ApiFp: (configuration?: Configuration) => {
|
|
|
64915
64996
|
/**
|
|
64916
64997
|
* Returns a list of form instances for the tenant. Optionally filter by form definition ID.
|
|
64917
64998
|
* @summary List form instances by tenant.
|
|
64999
|
+
* @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.
|
|
65000
|
+
* @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.
|
|
64918
65001
|
* @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*
|
|
64919
65002
|
* @param {*} [axiosOptions] Override http request option.
|
|
64920
65003
|
* @throws {RequiredError}
|
|
64921
65004
|
*/
|
|
64922
|
-
searchFormInstancesByTenant(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListFormInstancesByTenantResponseV2026>>>;
|
|
65005
|
+
searchFormInstancesByTenant(offset?: number, limit?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListFormInstancesByTenantResponseV2026>>>;
|
|
64923
65006
|
/**
|
|
64924
65007
|
* No parameters required.
|
|
64925
65008
|
* @summary List predefined select options.
|
|
@@ -65384,6 +65467,18 @@ export interface CustomFormsV2026ApiSearchFormElementDataByElementIDRequest {
|
|
|
65384
65467
|
* @interface CustomFormsV2026ApiSearchFormInstancesByTenantRequest
|
|
65385
65468
|
*/
|
|
65386
65469
|
export interface CustomFormsV2026ApiSearchFormInstancesByTenantRequest {
|
|
65470
|
+
/**
|
|
65471
|
+
* 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.
|
|
65472
|
+
* @type {number}
|
|
65473
|
+
* @memberof CustomFormsV2026ApiSearchFormInstancesByTenant
|
|
65474
|
+
*/
|
|
65475
|
+
readonly offset?: number;
|
|
65476
|
+
/**
|
|
65477
|
+
* 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.
|
|
65478
|
+
* @type {number}
|
|
65479
|
+
* @memberof CustomFormsV2026ApiSearchFormInstancesByTenant
|
|
65480
|
+
*/
|
|
65481
|
+
readonly limit?: number;
|
|
65387
65482
|
/**
|
|
65388
65483
|
* 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*
|
|
65389
65484
|
* @type {string}
|
|
@@ -98829,11 +98924,10 @@ export declare const TaskManagementV2026ApiAxiosParamCreator: (configuration?: C
|
|
|
98829
98924
|
* Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
98830
98925
|
* @summary Get task status by id
|
|
98831
98926
|
* @param {string} id Task ID.
|
|
98832
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98833
98927
|
* @param {*} [axiosOptions] Override http request option.
|
|
98834
98928
|
* @throws {RequiredError}
|
|
98835
98929
|
*/
|
|
98836
|
-
getTaskStatus: (id: string,
|
|
98930
|
+
getTaskStatus: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98837
98931
|
/**
|
|
98838
98932
|
* Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field.
|
|
98839
98933
|
* @summary Retrieve task status list
|
|
@@ -98842,21 +98936,19 @@ export declare const TaskManagementV2026ApiAxiosParamCreator: (configuration?: C
|
|
|
98842
98936
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
98843
98937
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION
|
|
98844
98938
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created**
|
|
98845
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98846
98939
|
* @param {*} [axiosOptions] Override http request option.
|
|
98847
98940
|
* @throws {RequiredError}
|
|
98848
98941
|
*/
|
|
98849
|
-
getTaskStatusList: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string,
|
|
98942
|
+
getTaskStatusList: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98850
98943
|
/**
|
|
98851
98944
|
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
98852
98945
|
* @summary Update task status by id
|
|
98853
98946
|
* @param {string} id Task ID.
|
|
98854
98947
|
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
98855
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98856
98948
|
* @param {*} [axiosOptions] Override http request option.
|
|
98857
98949
|
* @throws {RequiredError}
|
|
98858
98950
|
*/
|
|
98859
|
-
updateTaskStatus: (id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>,
|
|
98951
|
+
updateTaskStatus: (id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98860
98952
|
};
|
|
98861
98953
|
/**
|
|
98862
98954
|
* TaskManagementV2026Api - functional programming interface
|
|
@@ -98867,11 +98959,10 @@ export declare const TaskManagementV2026ApiFp: (configuration?: Configuration) =
|
|
|
98867
98959
|
* Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
98868
98960
|
* @summary Get task status by id
|
|
98869
98961
|
* @param {string} id Task ID.
|
|
98870
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98871
98962
|
* @param {*} [axiosOptions] Override http request option.
|
|
98872
98963
|
* @throws {RequiredError}
|
|
98873
98964
|
*/
|
|
98874
|
-
getTaskStatus(id: string,
|
|
98965
|
+
getTaskStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2026>>;
|
|
98875
98966
|
/**
|
|
98876
98967
|
* Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field.
|
|
98877
98968
|
* @summary Retrieve task status list
|
|
@@ -98880,21 +98971,19 @@ export declare const TaskManagementV2026ApiFp: (configuration?: Configuration) =
|
|
|
98880
98971
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
98881
98972
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION
|
|
98882
98973
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created**
|
|
98883
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98884
98974
|
* @param {*} [axiosOptions] Override http request option.
|
|
98885
98975
|
* @throws {RequiredError}
|
|
98886
98976
|
*/
|
|
98887
|
-
getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string,
|
|
98977
|
+
getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskStatusV2026>>>;
|
|
98888
98978
|
/**
|
|
98889
98979
|
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
98890
98980
|
* @summary Update task status by id
|
|
98891
98981
|
* @param {string} id Task ID.
|
|
98892
98982
|
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
98893
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
98894
98983
|
* @param {*} [axiosOptions] Override http request option.
|
|
98895
98984
|
* @throws {RequiredError}
|
|
98896
98985
|
*/
|
|
98897
|
-
updateTaskStatus(id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>,
|
|
98986
|
+
updateTaskStatus(id: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2026>>;
|
|
98898
98987
|
};
|
|
98899
98988
|
/**
|
|
98900
98989
|
* TaskManagementV2026Api - factory interface
|
|
@@ -98938,12 +99027,6 @@ export interface TaskManagementV2026ApiGetTaskStatusRequest {
|
|
|
98938
99027
|
* @memberof TaskManagementV2026ApiGetTaskStatus
|
|
98939
99028
|
*/
|
|
98940
99029
|
readonly id: string;
|
|
98941
|
-
/**
|
|
98942
|
-
* Use this header to enable this experimental API.
|
|
98943
|
-
* @type {string}
|
|
98944
|
-
* @memberof TaskManagementV2026ApiGetTaskStatus
|
|
98945
|
-
*/
|
|
98946
|
-
readonly xSailPointExperimental?: string;
|
|
98947
99030
|
}
|
|
98948
99031
|
/**
|
|
98949
99032
|
* Request parameters for getTaskStatusList operation in TaskManagementV2026Api.
|
|
@@ -98981,12 +99064,6 @@ export interface TaskManagementV2026ApiGetTaskStatusListRequest {
|
|
|
98981
99064
|
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
98982
99065
|
*/
|
|
98983
99066
|
readonly sorters?: string;
|
|
98984
|
-
/**
|
|
98985
|
-
* Use this header to enable this experimental API.
|
|
98986
|
-
* @type {string}
|
|
98987
|
-
* @memberof TaskManagementV2026ApiGetTaskStatusList
|
|
98988
|
-
*/
|
|
98989
|
-
readonly xSailPointExperimental?: string;
|
|
98990
99067
|
}
|
|
98991
99068
|
/**
|
|
98992
99069
|
* Request parameters for updateTaskStatus operation in TaskManagementV2026Api.
|
|
@@ -99006,12 +99083,6 @@ export interface TaskManagementV2026ApiUpdateTaskStatusRequest {
|
|
|
99006
99083
|
* @memberof TaskManagementV2026ApiUpdateTaskStatus
|
|
99007
99084
|
*/
|
|
99008
99085
|
readonly jsonPatchOperationV2026: Array<JsonPatchOperationV2026>;
|
|
99009
|
-
/**
|
|
99010
|
-
* Use this header to enable this experimental API.
|
|
99011
|
-
* @type {string}
|
|
99012
|
-
* @memberof TaskManagementV2026ApiUpdateTaskStatus
|
|
99013
|
-
*/
|
|
99014
|
-
readonly xSailPointExperimental?: string;
|
|
99015
99086
|
}
|
|
99016
99087
|
/**
|
|
99017
99088
|
* TaskManagementV2026Api - object-oriented interface
|