@sailpoint/api-client 2.2.51 → 2.2.52
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/dist/approvals/api.d.ts +121 -46
- package/dist/approvals/api.js +37 -24
- package/dist/approvals/api.js.map +1 -1
- package/dist/capabilities/api.d.ts +2 -2
- package/dist/capabilities/api.js +2 -2
- package/dist/capabilities/api.js.map +1 -1
- package/dist/capabilities/base.d.ts +2 -2
- package/dist/capabilities/base.js +2 -2
- package/dist/capabilities/base.js.map +1 -1
- package/dist/capabilities/common.d.ts +2 -2
- package/dist/capabilities/common.js +2 -2
- package/dist/capabilities/common.js.map +1 -1
- package/dist/capabilities/configuration.d.ts +2 -2
- package/dist/capabilities/configuration.js +2 -2
- package/dist/capabilities/configuration.js.map +1 -1
- package/dist/capabilities/index.d.ts +2 -2
- package/dist/capabilities/index.js +2 -2
- package/dist/capabilities/index.js.map +1 -1
- package/dist/credentials/api.d.ts +2 -2
- package/dist/credentials/api.js +2 -2
- package/dist/credentials/api.js.map +1 -1
- package/dist/credentials/base.d.ts +2 -2
- package/dist/credentials/base.js +2 -2
- package/dist/credentials/base.js.map +1 -1
- package/dist/credentials/common.d.ts +2 -2
- package/dist/credentials/common.js +2 -2
- package/dist/credentials/common.js.map +1 -1
- package/dist/credentials/configuration.d.ts +2 -2
- package/dist/credentials/configuration.js +2 -2
- package/dist/credentials/configuration.js.map +1 -1
- package/dist/credentials/index.d.ts +2 -2
- package/dist/credentials/index.js +2 -2
- package/dist/credentials/index.js.map +1 -1
- package/dist/devices/api.d.ts +2 -2
- package/dist/devices/api.js +2 -2
- package/dist/devices/api.js.map +1 -1
- package/dist/devices/base.d.ts +2 -2
- package/dist/devices/base.js +2 -2
- package/dist/devices/base.js.map +1 -1
- package/dist/devices/common.d.ts +2 -2
- package/dist/devices/common.js +2 -2
- package/dist/devices/common.js.map +1 -1
- package/dist/devices/configuration.d.ts +2 -2
- package/dist/devices/configuration.js +2 -2
- package/dist/devices/configuration.js.map +1 -1
- package/dist/devices/index.d.ts +2 -2
- package/dist/devices/index.js +2 -2
- package/dist/devices/index.js.map +1 -1
- package/dist/esm/approvals/api.js +36 -23
- package/dist/esm/capabilities/api.js +2 -2
- package/dist/esm/capabilities/base.js +2 -2
- package/dist/esm/capabilities/common.js +2 -2
- package/dist/esm/capabilities/configuration.js +2 -2
- package/dist/esm/capabilities/index.js +2 -2
- package/dist/esm/credentials/api.js +2 -2
- package/dist/esm/credentials/base.js +2 -2
- package/dist/esm/credentials/common.js +2 -2
- package/dist/esm/credentials/configuration.js +2 -2
- package/dist/esm/credentials/index.js +2 -2
- package/dist/esm/devices/api.js +2 -2
- package/dist/esm/devices/base.js +2 -2
- package/dist/esm/devices/common.js +2 -2
- package/dist/esm/devices/configuration.js +2 -2
- package/dist/esm/devices/index.js +2 -2
- package/dist/esm/generic_request_approval_config/api.js +2 -2
- package/dist/esm/generic_request_approval_config/base.js +2 -2
- package/dist/esm/generic_request_approval_config/common.js +2 -2
- package/dist/esm/generic_request_approval_config/configuration.js +2 -2
- package/dist/esm/generic_request_approval_config/index.js +2 -2
- package/dist/esm/index.js +6 -0
- package/dist/esm/machine_account_recommendation/api.js +2 -2
- package/dist/esm/machine_account_recommendation/base.js +2 -2
- package/dist/esm/machine_account_recommendation/common.js +2 -2
- package/dist/esm/machine_account_recommendation/configuration.js +2 -2
- package/dist/esm/machine_account_recommendation/index.js +2 -2
- package/dist/esm/machine_identities_lifecycle_actions/api.js +35 -32
- package/dist/esm/machine_identity_metadata/api.js +2 -2
- package/dist/esm/machine_identity_metadata/base.js +2 -2
- package/dist/esm/machine_identity_metadata/common.js +2 -2
- package/dist/esm/machine_identity_metadata/configuration.js +2 -2
- package/dist/esm/machine_identity_metadata/index.js +2 -2
- package/dist/esm/machine_mapping_metadata/api.js +2 -2
- package/dist/esm/machine_mapping_metadata/base.js +2 -2
- package/dist/esm/machine_mapping_metadata/common.js +2 -2
- package/dist/esm/machine_mapping_metadata/configuration.js +2 -2
- package/dist/esm/machine_mapping_metadata/index.js +2 -2
- package/dist/esm/nerm/common.js +2 -2
- package/dist/esm/nermv2025/common.js +2 -2
- package/dist/esm/reminder_escalations/api.js +522 -0
- package/dist/esm/reminder_escalations/base.js +83 -0
- package/dist/esm/reminder_escalations/common.js +287 -0
- package/dist/esm/reminder_escalations/configuration.js +42 -0
- package/dist/esm/reminder_escalations/index.js +15 -0
- package/dist/esm/roles/api.js +529 -2
- package/dist/esm/sources/api.js +2 -1
- package/dist/esm/ui_plugins/api.js +1657 -0
- package/dist/esm/ui_plugins/base.js +83 -0
- package/dist/esm/ui_plugins/common.js +287 -0
- package/dist/esm/ui_plugins/configuration.js +42 -0
- package/dist/esm/ui_plugins/index.js +15 -0
- package/dist/generic_request_approval_config/api.d.ts +2 -2
- package/dist/generic_request_approval_config/api.js +2 -2
- package/dist/generic_request_approval_config/api.js.map +1 -1
- package/dist/generic_request_approval_config/base.d.ts +2 -2
- package/dist/generic_request_approval_config/base.js +2 -2
- package/dist/generic_request_approval_config/base.js.map +1 -1
- package/dist/generic_request_approval_config/common.d.ts +2 -2
- package/dist/generic_request_approval_config/common.js +2 -2
- package/dist/generic_request_approval_config/common.js.map +1 -1
- package/dist/generic_request_approval_config/configuration.d.ts +2 -2
- package/dist/generic_request_approval_config/configuration.js +2 -2
- package/dist/generic_request_approval_config/configuration.js.map +1 -1
- package/dist/generic_request_approval_config/index.d.ts +2 -2
- package/dist/generic_request_approval_config/index.js +2 -2
- package/dist/generic_request_approval_config/index.js.map +1 -1
- package/dist/index.d.ts +6 -0
- package/dist/index.js +103 -97
- package/dist/index.js.map +1 -1
- package/dist/machine_account_recommendation/api.d.ts +2 -2
- package/dist/machine_account_recommendation/api.js +2 -2
- package/dist/machine_account_recommendation/api.js.map +1 -1
- package/dist/machine_account_recommendation/base.d.ts +2 -2
- package/dist/machine_account_recommendation/base.js +2 -2
- package/dist/machine_account_recommendation/base.js.map +1 -1
- package/dist/machine_account_recommendation/common.d.ts +2 -2
- package/dist/machine_account_recommendation/common.js +2 -2
- package/dist/machine_account_recommendation/common.js.map +1 -1
- package/dist/machine_account_recommendation/configuration.d.ts +2 -2
- package/dist/machine_account_recommendation/configuration.js +2 -2
- package/dist/machine_account_recommendation/configuration.js.map +1 -1
- package/dist/machine_account_recommendation/index.d.ts +2 -2
- package/dist/machine_account_recommendation/index.js +2 -2
- package/dist/machine_account_recommendation/index.js.map +1 -1
- package/dist/machine_identities_lifecycle_actions/api.d.ts +67 -63
- package/dist/machine_identities_lifecycle_actions/api.js +36 -33
- package/dist/machine_identities_lifecycle_actions/api.js.map +1 -1
- package/dist/machine_identity_metadata/api.d.ts +2 -2
- package/dist/machine_identity_metadata/api.js +2 -2
- package/dist/machine_identity_metadata/api.js.map +1 -1
- package/dist/machine_identity_metadata/base.d.ts +2 -2
- package/dist/machine_identity_metadata/base.js +2 -2
- package/dist/machine_identity_metadata/base.js.map +1 -1
- package/dist/machine_identity_metadata/common.d.ts +2 -2
- package/dist/machine_identity_metadata/common.js +2 -2
- package/dist/machine_identity_metadata/common.js.map +1 -1
- package/dist/machine_identity_metadata/configuration.d.ts +2 -2
- package/dist/machine_identity_metadata/configuration.js +2 -2
- package/dist/machine_identity_metadata/configuration.js.map +1 -1
- package/dist/machine_identity_metadata/index.d.ts +2 -2
- package/dist/machine_identity_metadata/index.js +2 -2
- package/dist/machine_identity_metadata/index.js.map +1 -1
- package/dist/machine_mapping_metadata/api.d.ts +2 -2
- package/dist/machine_mapping_metadata/api.js +2 -2
- package/dist/machine_mapping_metadata/api.js.map +1 -1
- package/dist/machine_mapping_metadata/base.d.ts +2 -2
- package/dist/machine_mapping_metadata/base.js +2 -2
- package/dist/machine_mapping_metadata/base.js.map +1 -1
- package/dist/machine_mapping_metadata/common.d.ts +2 -2
- package/dist/machine_mapping_metadata/common.js +2 -2
- package/dist/machine_mapping_metadata/common.js.map +1 -1
- package/dist/machine_mapping_metadata/configuration.d.ts +2 -2
- package/dist/machine_mapping_metadata/configuration.js +2 -2
- package/dist/machine_mapping_metadata/configuration.js.map +1 -1
- package/dist/machine_mapping_metadata/index.d.ts +2 -2
- package/dist/machine_mapping_metadata/index.js +2 -2
- package/dist/machine_mapping_metadata/index.js.map +1 -1
- package/dist/nerm/common.js +2 -2
- package/dist/nerm/common.js.map +1 -1
- package/dist/nermv2025/common.js +2 -2
- package/dist/nermv2025/common.js.map +1 -1
- package/dist/reminder_escalations/api.d.ts +665 -0
- package/dist/reminder_escalations/api.js +532 -0
- package/dist/reminder_escalations/api.js.map +1 -0
- package/dist/reminder_escalations/base.d.ts +66 -0
- package/dist/reminder_escalations/base.js +90 -0
- package/dist/reminder_escalations/base.js.map +1 -0
- package/dist/reminder_escalations/common.d.ts +65 -0
- package/dist/reminder_escalations/common.js +300 -0
- package/dist/reminder_escalations/common.js.map +1 -0
- package/dist/reminder_escalations/configuration.d.ts +91 -0
- package/dist/reminder_escalations/configuration.js +46 -0
- package/dist/reminder_escalations/configuration.js.map +1 -0
- package/dist/reminder_escalations/index.d.ts +13 -0
- package/dist/reminder_escalations/index.js +32 -0
- package/dist/reminder_escalations/index.js.map +1 -0
- package/dist/roles/api.d.ts +972 -88
- package/dist/roles/api.js +530 -3
- package/dist/roles/api.js.map +1 -1
- package/dist/sources/api.d.ts +2 -1
- package/dist/sources/api.js +2 -1
- package/dist/sources/api.js.map +1 -1
- package/dist/ui_plugins/api.d.ts +1514 -0
- package/dist/ui_plugins/api.js +1667 -0
- package/dist/ui_plugins/api.js.map +1 -0
- package/dist/ui_plugins/base.d.ts +66 -0
- package/dist/ui_plugins/base.js +90 -0
- package/dist/ui_plugins/base.js.map +1 -0
- package/dist/ui_plugins/common.d.ts +65 -0
- package/dist/ui_plugins/common.js +300 -0
- package/dist/ui_plugins/common.js.map +1 -0
- package/dist/ui_plugins/configuration.d.ts +91 -0
- package/dist/ui_plugins/configuration.js +46 -0
- package/dist/ui_plugins/configuration.js.map +1 -0
- package/dist/ui_plugins/index.d.ts +13 -0
- package/dist/ui_plugins/index.js +32 -0
- package/dist/ui_plugins/index.js.map +1 -0
- package/package.json +1 -1
- package/sailpoint-scopes.json +325 -1
package/dist/approvals/api.d.ts
CHANGED
|
@@ -190,11 +190,11 @@ export interface Approval2 {
|
|
|
190
190
|
*/
|
|
191
191
|
'modifiedDate'?: string;
|
|
192
192
|
/**
|
|
193
|
-
*
|
|
194
|
-
* @type {
|
|
193
|
+
*
|
|
194
|
+
* @type {ApprovalRequestedTarget}
|
|
195
195
|
* @memberof Approval2
|
|
196
196
|
*/
|
|
197
|
-
'requestedTarget'?:
|
|
197
|
+
'requestedTarget'?: ApprovalRequestedTarget;
|
|
198
198
|
}
|
|
199
199
|
export declare const Approval2MediumEnum: {
|
|
200
200
|
readonly Email: "EMAIL";
|
|
@@ -472,7 +472,7 @@ export interface ApprovalConfig {
|
|
|
472
472
|
*/
|
|
473
473
|
'circumventApprovalProcess'?: boolean;
|
|
474
474
|
/**
|
|
475
|
-
* OFF will prevent the approval request from being assigned to the requester or requestee by assigning it to their manager instead. DIRECT when the requester != requestee this will cause steps assigned directly to the requester to be auto-approved. INDIRECT when the requester != requestee this will cause steps assigned to the requester or a group containing the requester to be auto-approved. This field will only be effective if requestedTarget.reauthRequired is set to false, otherwise the approval will have to be manually approved.
|
|
475
|
+
* OFF will prevent the approval request from being assigned to the requester or requestee by assigning it to their manager instead. DIRECT when the requester != requestee this will cause steps assigned directly to the requester to be auto-approved. INDIRECT when the requester != requestee this will cause steps assigned to the requester or a group containing the requester to be auto-approved. SELF_REQUEST will cause steps assigned to the requester or a group containing the requester to be auto-approved whether or not the requester is the same as the requestee. This field will only be effective if requestedTarget.reauthRequired is set to false, otherwise the approval will have to be manually approved.
|
|
476
476
|
* @type {string}
|
|
477
477
|
* @memberof ApprovalConfig
|
|
478
478
|
*/
|
|
@@ -499,6 +499,7 @@ export declare const ApprovalConfigAutoApproveEnum: {
|
|
|
499
499
|
readonly Off: "OFF";
|
|
500
500
|
readonly Direct: "DIRECT";
|
|
501
501
|
readonly Indirect: "INDIRECT";
|
|
502
|
+
readonly SelfRequest: "SELF_REQUEST";
|
|
502
503
|
};
|
|
503
504
|
export type ApprovalConfigAutoApproveEnum = typeof ApprovalConfigAutoApproveEnum[keyof typeof ApprovalConfigAutoApproveEnum];
|
|
504
505
|
/**
|
|
@@ -1192,54 +1193,128 @@ export interface ApprovalRejectRequest {
|
|
|
1192
1193
|
'overrideApproverID'?: string;
|
|
1193
1194
|
}
|
|
1194
1195
|
/**
|
|
1195
|
-
*
|
|
1196
|
+
* Specifies the actual object or target the approval request is for.
|
|
1196
1197
|
* @export
|
|
1197
1198
|
* @interface ApprovalRequestedTarget
|
|
1198
1199
|
*/
|
|
1199
1200
|
export interface ApprovalRequestedTarget {
|
|
1200
1201
|
/**
|
|
1201
|
-
*
|
|
1202
|
+
* Target ID (for example a role ID or access profile ID).
|
|
1202
1203
|
* @type {string}
|
|
1203
1204
|
* @memberof ApprovalRequestedTarget
|
|
1204
1205
|
*/
|
|
1205
|
-
'
|
|
1206
|
+
'id'?: string;
|
|
1206
1207
|
/**
|
|
1207
|
-
*
|
|
1208
|
-
* @type {string}
|
|
1208
|
+
* Target IDs when the approval request applies to multiple targets.
|
|
1209
|
+
* @type {Array<string>}
|
|
1209
1210
|
* @memberof ApprovalRequestedTarget
|
|
1210
1211
|
*/
|
|
1211
|
-
'
|
|
1212
|
+
'ids'?: Array<string>;
|
|
1212
1213
|
/**
|
|
1213
|
-
*
|
|
1214
|
+
* Target name (for example a role name or access profile name).
|
|
1214
1215
|
* @type {string}
|
|
1215
1216
|
* @memberof ApprovalRequestedTarget
|
|
1216
1217
|
*/
|
|
1217
1218
|
'name'?: string;
|
|
1218
1219
|
/**
|
|
1219
|
-
*
|
|
1220
|
+
* Target names when the approval request applies to multiple targets.
|
|
1221
|
+
* @type {Array<string>}
|
|
1222
|
+
* @memberof ApprovalRequestedTarget
|
|
1223
|
+
*/
|
|
1224
|
+
'names'?: Array<string>;
|
|
1225
|
+
/**
|
|
1226
|
+
* Target type (for example Role or Access Profile).
|
|
1227
|
+
* @type {string}
|
|
1228
|
+
* @memberof ApprovalRequestedTarget
|
|
1229
|
+
*/
|
|
1230
|
+
'targetType'?: string;
|
|
1231
|
+
/**
|
|
1232
|
+
* Target types when the approval request applies to multiple targets.
|
|
1233
|
+
* @type {Array<string>}
|
|
1234
|
+
* @memberof ApprovalRequestedTarget
|
|
1235
|
+
*/
|
|
1236
|
+
'targetTypes'?: Array<string>;
|
|
1237
|
+
/**
|
|
1238
|
+
* Optional description for the requested target.
|
|
1239
|
+
* @type {string}
|
|
1240
|
+
* @memberof ApprovalRequestedTarget
|
|
1241
|
+
*/
|
|
1242
|
+
'description'?: string;
|
|
1243
|
+
/**
|
|
1244
|
+
* Effective privilege (EP) level at approval creation.
|
|
1245
|
+
* @type {string}
|
|
1246
|
+
* @memberof ApprovalRequestedTarget
|
|
1247
|
+
*/
|
|
1248
|
+
'epLevelAtCreation'?: ApprovalRequestedTargetEpLevelAtCreationEnum;
|
|
1249
|
+
/**
|
|
1250
|
+
* Current effective privilege (EP) level for the requested target.
|
|
1251
|
+
* @type {string}
|
|
1252
|
+
* @memberof ApprovalRequestedTarget
|
|
1253
|
+
*/
|
|
1254
|
+
'currentEPLevel'?: ApprovalRequestedTargetCurrentEPLevelEnum;
|
|
1255
|
+
/**
|
|
1256
|
+
* Date and time when the current effective privilege level was last modified.
|
|
1257
|
+
* @type {string}
|
|
1258
|
+
* @memberof ApprovalRequestedTarget
|
|
1259
|
+
*/
|
|
1260
|
+
'currentEPModifiedDate'?: string;
|
|
1261
|
+
/**
|
|
1262
|
+
* Access request type (for example GRANT_ACCESS or REVOKE_ACCESS).
|
|
1263
|
+
* @type {string}
|
|
1264
|
+
* @memberof ApprovalRequestedTarget
|
|
1265
|
+
*/
|
|
1266
|
+
'requestType'?: string;
|
|
1267
|
+
/**
|
|
1268
|
+
* Signature required for forced authentication.
|
|
1269
|
+
* @type {string}
|
|
1270
|
+
* @memberof ApprovalRequestedTarget
|
|
1271
|
+
*/
|
|
1272
|
+
'forcedAuthSignature'?: string;
|
|
1273
|
+
/**
|
|
1274
|
+
* Indicates whether forced reauthentication is required upon approval.
|
|
1220
1275
|
* @type {boolean}
|
|
1221
1276
|
* @memberof ApprovalRequestedTarget
|
|
1222
1277
|
*/
|
|
1223
1278
|
'reauthRequired'?: boolean;
|
|
1224
1279
|
/**
|
|
1225
|
-
*
|
|
1280
|
+
* When temporary access will be granted, if applicable.
|
|
1281
|
+
* @type {string}
|
|
1282
|
+
* @memberof ApprovalRequestedTarget
|
|
1283
|
+
*/
|
|
1284
|
+
'startDate'?: string;
|
|
1285
|
+
/**
|
|
1286
|
+
* When temporary access will be removed, if applicable.
|
|
1226
1287
|
* @type {string}
|
|
1227
1288
|
* @memberof ApprovalRequestedTarget
|
|
1228
1289
|
*/
|
|
1229
1290
|
'removalDate'?: string;
|
|
1230
1291
|
/**
|
|
1231
|
-
*
|
|
1292
|
+
* Updated start date when startDate is edited during the approval request.
|
|
1232
1293
|
* @type {string}
|
|
1233
1294
|
* @memberof ApprovalRequestedTarget
|
|
1234
1295
|
*/
|
|
1235
|
-
'
|
|
1296
|
+
'modifiedStartDate'?: string;
|
|
1236
1297
|
/**
|
|
1237
|
-
*
|
|
1298
|
+
* Updated removal date when removalDate is edited during the approval request.
|
|
1238
1299
|
* @type {string}
|
|
1239
1300
|
* @memberof ApprovalRequestedTarget
|
|
1240
1301
|
*/
|
|
1241
|
-
'
|
|
1302
|
+
'modifiedRemovalDate'?: string;
|
|
1242
1303
|
}
|
|
1304
|
+
export declare const ApprovalRequestedTargetEpLevelAtCreationEnum: {
|
|
1305
|
+
readonly High: "HIGH";
|
|
1306
|
+
readonly Medium: "MEDIUM";
|
|
1307
|
+
readonly Low: "LOW";
|
|
1308
|
+
readonly None: "NONE";
|
|
1309
|
+
};
|
|
1310
|
+
export type ApprovalRequestedTargetEpLevelAtCreationEnum = typeof ApprovalRequestedTargetEpLevelAtCreationEnum[keyof typeof ApprovalRequestedTargetEpLevelAtCreationEnum];
|
|
1311
|
+
export declare const ApprovalRequestedTargetCurrentEPLevelEnum: {
|
|
1312
|
+
readonly High: "HIGH";
|
|
1313
|
+
readonly Medium: "MEDIUM";
|
|
1314
|
+
readonly Low: "LOW";
|
|
1315
|
+
readonly None: "NONE";
|
|
1316
|
+
};
|
|
1317
|
+
export type ApprovalRequestedTargetCurrentEPLevelEnum = typeof ApprovalRequestedTargetCurrentEPLevelEnum[keyof typeof ApprovalRequestedTargetCurrentEPLevelEnum];
|
|
1243
1318
|
/**
|
|
1244
1319
|
* BulkApproveRequestDTO is the input struct that represents the request body required to facilitate a bulk approval action for a set of generic approval requests.
|
|
1245
1320
|
* @export
|
|
@@ -1470,14 +1545,14 @@ export declare const ApprovalsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1470
1545
|
/**
|
|
1471
1546
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
1472
1547
|
* @summary Delete Approval Configuration
|
|
1473
|
-
* @param {string} id The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1474
|
-
* @param {DeleteApprovalConfigRequestV1ScopeEnum} scope The scope that defines the type of id, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1548
|
+
* @param {string} id The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1549
|
+
* @param {DeleteApprovalConfigRequestV1ScopeEnum} scope The scope that defines the type of id, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1475
1550
|
* @param {*} [axiosOptions] Override http request option.
|
|
1476
1551
|
* @throws {RequiredError}
|
|
1477
1552
|
*/
|
|
1478
1553
|
deleteApprovalConfigRequestV1: (id: string, scope: DeleteApprovalConfigRequestV1ScopeEnum, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1479
1554
|
/**
|
|
1480
|
-
* 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\"
|
|
1555
|
+
* Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals/v1?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"
|
|
1481
1556
|
* @summary Get an approval
|
|
1482
1557
|
* @param {string} id ID of the approval that is to be returned
|
|
1483
1558
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1487,25 +1562,25 @@ export declare const ApprovalsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1487
1562
|
/**
|
|
1488
1563
|
* Retrieves a singular approval configuration that matches the given ID
|
|
1489
1564
|
* @summary Get Approval Config
|
|
1490
|
-
* @param {string} id The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1565
|
+
* @param {string} id The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1491
1566
|
* @param {*} [axiosOptions] Override http request option.
|
|
1492
1567
|
* @throws {RequiredError}
|
|
1493
1568
|
*/
|
|
1494
1569
|
getApprovalsConfigV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1495
1570
|
/**
|
|
1496
|
-
* Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\'
|
|
1571
|
+
* Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals/v1?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\'
|
|
1497
1572
|
* @summary Get approvals
|
|
1498
1573
|
* @param {boolean} [mine] Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\').
|
|
1499
1574
|
* @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.
|
|
1500
1575
|
* @param {string} [requesteeId] Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin.
|
|
1501
1576
|
* @param {string} [approverId] Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin.
|
|
1502
|
-
* @param {boolean} [count]
|
|
1577
|
+
* @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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1503
1578
|
* @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.
|
|
1504
1579
|
* @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments.
|
|
1505
1580
|
* @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers.
|
|
1506
1581
|
* @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history.
|
|
1507
1582
|
* @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch information.
|
|
1508
|
-
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *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* **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* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw*
|
|
1583
|
+
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *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* **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* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **currentEPLevel**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw*
|
|
1509
1584
|
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1510
1585
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1511
1586
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1523,8 +1598,8 @@ export declare const ApprovalsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1523
1598
|
/**
|
|
1524
1599
|
* 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\'
|
|
1525
1600
|
* @summary Put Approval Config
|
|
1526
|
-
* @param {string} id The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1527
|
-
* @param {PutApprovalsConfigV1ScopeEnum} scope The scope that defines the type of id, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1601
|
+
* @param {string} id The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1602
|
+
* @param {PutApprovalsConfigV1ScopeEnum} scope The scope that defines the type of id, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1528
1603
|
* @param {ApprovalConfig} approvalConfig
|
|
1529
1604
|
* @param {*} [axiosOptions] Override http request option.
|
|
1530
1605
|
* @throws {RequiredError}
|
|
@@ -1617,14 +1692,14 @@ export declare const ApprovalsApiFp: (configuration?: Configuration) => {
|
|
|
1617
1692
|
/**
|
|
1618
1693
|
* Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted.
|
|
1619
1694
|
* @summary Delete Approval Configuration
|
|
1620
|
-
* @param {string} id The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1621
|
-
* @param {DeleteApprovalConfigRequestV1ScopeEnum} scope The scope that defines the type of id, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1695
|
+
* @param {string} id The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1696
|
+
* @param {DeleteApprovalConfigRequestV1ScopeEnum} scope The scope that defines the type of id, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1622
1697
|
* @param {*} [axiosOptions] Override http request option.
|
|
1623
1698
|
* @throws {RequiredError}
|
|
1624
1699
|
*/
|
|
1625
1700
|
deleteApprovalConfigRequestV1(id: string, scope: DeleteApprovalConfigRequestV1ScopeEnum, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1626
1701
|
/**
|
|
1627
|
-
* 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\"
|
|
1702
|
+
* Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals/v1?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"
|
|
1628
1703
|
* @summary Get an approval
|
|
1629
1704
|
* @param {string} id ID of the approval that is to be returned
|
|
1630
1705
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1634,25 +1709,25 @@ export declare const ApprovalsApiFp: (configuration?: Configuration) => {
|
|
|
1634
1709
|
/**
|
|
1635
1710
|
* Retrieves a singular approval configuration that matches the given ID
|
|
1636
1711
|
* @summary Get Approval Config
|
|
1637
|
-
* @param {string} id The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1712
|
+
* @param {string} id The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1638
1713
|
* @param {*} [axiosOptions] Override http request option.
|
|
1639
1714
|
* @throws {RequiredError}
|
|
1640
1715
|
*/
|
|
1641
1716
|
getApprovalsConfigV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalConfig>>;
|
|
1642
1717
|
/**
|
|
1643
|
-
* Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\'
|
|
1718
|
+
* Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals/v1?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\'
|
|
1644
1719
|
* @summary Get approvals
|
|
1645
1720
|
* @param {boolean} [mine] Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\').
|
|
1646
1721
|
* @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.
|
|
1647
1722
|
* @param {string} [requesteeId] Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin.
|
|
1648
1723
|
* @param {string} [approverId] Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin.
|
|
1649
|
-
* @param {boolean} [count]
|
|
1724
|
+
* @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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1650
1725
|
* @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.
|
|
1651
1726
|
* @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments.
|
|
1652
1727
|
* @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers.
|
|
1653
1728
|
* @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history.
|
|
1654
1729
|
* @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch information.
|
|
1655
|
-
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *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* **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* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw*
|
|
1730
|
+
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *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* **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* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **currentEPLevel**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw*
|
|
1656
1731
|
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1657
1732
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1658
1733
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1670,8 +1745,8 @@ export declare const ApprovalsApiFp: (configuration?: Configuration) => {
|
|
|
1670
1745
|
/**
|
|
1671
1746
|
* 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\'
|
|
1672
1747
|
* @summary Put Approval Config
|
|
1673
|
-
* @param {string} id The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1674
|
-
* @param {PutApprovalsConfigV1ScopeEnum} scope The scope that defines the type of id, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1748
|
+
* @param {string} id The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1749
|
+
* @param {PutApprovalsConfigV1ScopeEnum} scope The scope that defines the type of id, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1675
1750
|
* @param {ApprovalConfig} approvalConfig
|
|
1676
1751
|
* @param {*} [axiosOptions] Override http request option.
|
|
1677
1752
|
* @throws {RequiredError}
|
|
@@ -1768,7 +1843,7 @@ export declare const ApprovalsApiFactory: (configuration?: Configuration, basePa
|
|
|
1768
1843
|
*/
|
|
1769
1844
|
deleteApprovalConfigRequestV1(requestParameters: ApprovalsApiDeleteApprovalConfigRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1770
1845
|
/**
|
|
1771
|
-
* 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\"
|
|
1846
|
+
* Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals/v1?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"
|
|
1772
1847
|
* @summary Get an approval
|
|
1773
1848
|
* @param {ApprovalsApiGetApprovalV1Request} requestParameters Request parameters.
|
|
1774
1849
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1784,7 +1859,7 @@ export declare const ApprovalsApiFactory: (configuration?: Configuration, basePa
|
|
|
1784
1859
|
*/
|
|
1785
1860
|
getApprovalsConfigV1(requestParameters: ApprovalsApiGetApprovalsConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ApprovalConfig>;
|
|
1786
1861
|
/**
|
|
1787
|
-
* Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\'
|
|
1862
|
+
* Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals/v1?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\'
|
|
1788
1863
|
* @summary Get approvals
|
|
1789
1864
|
* @param {ApprovalsApiGetApprovalsV1Request} requestParameters Request parameters.
|
|
1790
1865
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1919,13 +1994,13 @@ export interface ApprovalsApiCancelApprovalV1Request {
|
|
|
1919
1994
|
*/
|
|
1920
1995
|
export interface ApprovalsApiDeleteApprovalConfigRequestV1Request {
|
|
1921
1996
|
/**
|
|
1922
|
-
* The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1997
|
+
* The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1923
1998
|
* @type {string}
|
|
1924
1999
|
* @memberof ApprovalsApiDeleteApprovalConfigRequestV1
|
|
1925
2000
|
*/
|
|
1926
2001
|
readonly id: string;
|
|
1927
2002
|
/**
|
|
1928
|
-
* The scope that defines the type of id, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
2003
|
+
* The scope that defines the type of id, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1929
2004
|
* @type {'DOMAIN_OBJECT' | 'ACCOUNT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'}
|
|
1930
2005
|
* @memberof ApprovalsApiDeleteApprovalConfigRequestV1
|
|
1931
2006
|
*/
|
|
@@ -1951,7 +2026,7 @@ export interface ApprovalsApiGetApprovalV1Request {
|
|
|
1951
2026
|
*/
|
|
1952
2027
|
export interface ApprovalsApiGetApprovalsConfigV1Request {
|
|
1953
2028
|
/**
|
|
1954
|
-
* The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
2029
|
+
* The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
1955
2030
|
* @type {string}
|
|
1956
2031
|
* @memberof ApprovalsApiGetApprovalsConfigV1
|
|
1957
2032
|
*/
|
|
@@ -1988,7 +2063,7 @@ export interface ApprovalsApiGetApprovalsV1Request {
|
|
|
1988
2063
|
*/
|
|
1989
2064
|
readonly approverId?: string;
|
|
1990
2065
|
/**
|
|
1991
|
-
*
|
|
2066
|
+
* 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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1992
2067
|
* @type {boolean}
|
|
1993
2068
|
* @memberof ApprovalsApiGetApprovalsV1
|
|
1994
2069
|
*/
|
|
@@ -2024,7 +2099,7 @@ export interface ApprovalsApiGetApprovalsV1Request {
|
|
|
2024
2099
|
*/
|
|
2025
2100
|
readonly includeBatchInfo?: boolean;
|
|
2026
2101
|
/**
|
|
2027
|
-
* Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *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* **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* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw*
|
|
2102
|
+
* Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *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* **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* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **currentEPLevel**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw*
|
|
2028
2103
|
* @type {string}
|
|
2029
2104
|
* @memberof ApprovalsApiGetApprovalsV1
|
|
2030
2105
|
*/
|
|
@@ -2062,13 +2137,13 @@ export interface ApprovalsApiMoveApprovalV1Request {
|
|
|
2062
2137
|
*/
|
|
2063
2138
|
export interface ApprovalsApiPutApprovalsConfigV1Request {
|
|
2064
2139
|
/**
|
|
2065
|
-
* The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
2140
|
+
* The ID defined by the scope field, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
2066
2141
|
* @type {string}
|
|
2067
2142
|
* @memberof ApprovalsApiPutApprovalsConfigV1
|
|
2068
2143
|
*/
|
|
2069
2144
|
readonly id: string;
|
|
2070
2145
|
/**
|
|
2071
|
-
* The scope that defines the type of id, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
2146
|
+
* The scope that defines the type of id, where id/scope is the following: * `{accountID}`/`ACCOUNT` * `{roleID}`/`ROLE` * `{entitlementID}`/`ENTITLEMENT` * `{accessProfileID}`/`ACCESS_PROFILE` * `{domainObjectID}`/`DOMAIN_OBJECT` * `ENTITLEMENT_DESCRIPTIONS`/`APPROVAL_TYPE` * `ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `CUSTOM_ACCESS_REQUEST_APPROVAL`/`APPROVAL_TYPE` * `ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST`/`APPROVAL_TYPE` * `AGENT_ACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `AGENT_DEACTIVATE_APPROVAL`/`APPROVAL_TYPE` * `PRIVILEGED_ENTITLEMENT_RECOMMENDATION`/`APPROVAL_TYPE` * `{tenantID}`/`TENANT` Replace placeholders such as `{roleID}` with the actual resource ID.
|
|
2072
2147
|
* @type {'DOMAIN_OBJECT' | 'ACCOUNT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'}
|
|
2073
2148
|
* @memberof ApprovalsApiPutApprovalsConfigV1
|
|
2074
2149
|
*/
|
|
@@ -2222,7 +2297,7 @@ export declare class ApprovalsApi extends BaseAPI {
|
|
|
2222
2297
|
*/
|
|
2223
2298
|
deleteApprovalConfigRequestV1(requestParameters: ApprovalsApiDeleteApprovalConfigRequestV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2224
2299
|
/**
|
|
2225
|
-
* 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\"
|
|
2300
|
+
* Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals/v1?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"
|
|
2226
2301
|
* @summary Get an approval
|
|
2227
2302
|
* @param {ApprovalsApiGetApprovalV1Request} requestParameters Request parameters.
|
|
2228
2303
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -2240,7 +2315,7 @@ export declare class ApprovalsApi extends BaseAPI {
|
|
|
2240
2315
|
*/
|
|
2241
2316
|
getApprovalsConfigV1(requestParameters: ApprovalsApiGetApprovalsConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalConfig, any>>;
|
|
2242
2317
|
/**
|
|
2243
|
-
* Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\'
|
|
2318
|
+
* Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals/v1?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\'
|
|
2244
2319
|
* @summary Get approvals
|
|
2245
2320
|
* @param {ApprovalsApiGetApprovalsV1Request} requestParameters Request parameters.
|
|
2246
2321
|
* @param {*} [axiosOptions] Override http request option.
|