sailpoint-api-client 1.6.0 → 1.6.1

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/v3/api.js CHANGED
@@ -1101,7 +1101,7 @@ exports.PreApprovalTriggerDetailsDecisionV3 = {
1101
1101
  Rejected: 'REJECTED'
1102
1102
  };
1103
1103
  /**
1104
- * Supported operations on ProvisioningCriteria
1104
+ * Supported operations on `ProvisioningCriteria`.
1105
1105
  * @export
1106
1106
  * @enum {string}
1107
1107
  */
@@ -1868,6 +1868,7 @@ exports.WorkflowExecutionStatusV3 = {
1868
1868
  Completed: 'Completed',
1869
1869
  Failed: 'Failed',
1870
1870
  Canceled: 'Canceled',
1871
+ Queued: 'Queued',
1871
1872
  Running: 'Running'
1872
1873
  };
1873
1874
  exports.WorkflowExecutionEventTypeV3 = {
@@ -1944,7 +1945,7 @@ var AccessProfilesApiAxiosParamCreator = function (configuration) {
1944
1945
  var _this = this;
1945
1946
  return {
1946
1947
  /**
1947
- * Create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
1948
+ * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes.
1948
1949
  * @summary Create Access Profile
1949
1950
  * @param {AccessProfile} accessProfile
1950
1951
  * @param {*} [axiosOptions] Override http request option.
@@ -2281,13 +2282,13 @@ var AccessProfilesApiAxiosParamCreator = function (configuration) {
2281
2282
  });
2282
2283
  },
2283
2284
  /**
2284
- * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
2285
+ * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
2285
2286
  * @summary List Access Profiles
2286
2287
  * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
2287
2288
  * @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.
2288
2289
  * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
2289
2290
  * @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.
2290
- * @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* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
2291
+ * @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* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
2291
2292
  * @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: **name, created, modified**
2292
2293
  * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
2293
2294
  * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
@@ -2450,7 +2451,7 @@ var AccessProfilesApiFp = function (configuration) {
2450
2451
  var localVarAxiosParamCreator = (0, exports.AccessProfilesApiAxiosParamCreator)(configuration);
2451
2452
  return {
2452
2453
  /**
2453
- * Create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
2454
+ * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes.
2454
2455
  * @summary Create Access Profile
2455
2456
  * @param {AccessProfile} accessProfile
2456
2457
  * @param {*} [axiosOptions] Override http request option.
@@ -2570,13 +2571,13 @@ var AccessProfilesApiFp = function (configuration) {
2570
2571
  });
2571
2572
  },
2572
2573
  /**
2573
- * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
2574
+ * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
2574
2575
  * @summary List Access Profiles
2575
2576
  * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
2576
2577
  * @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.
2577
2578
  * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
2578
2579
  * @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.
2579
- * @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* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
2580
+ * @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* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
2580
2581
  * @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: **name, created, modified**
2581
2582
  * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
2582
2583
  * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
@@ -2634,7 +2635,7 @@ var AccessProfilesApiFactory = function (configuration, basePath, axios) {
2634
2635
  var localVarFp = (0, exports.AccessProfilesApiFp)(configuration);
2635
2636
  return {
2636
2637
  /**
2637
- * Create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
2638
+ * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes.
2638
2639
  * @summary Create Access Profile
2639
2640
  * @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
2640
2641
  * @param {*} [axiosOptions] Override http request option.
@@ -2684,7 +2685,7 @@ var AccessProfilesApiFactory = function (configuration, basePath, axios) {
2684
2685
  return localVarFp.getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then(function (request) { return request(axios, basePath); });
2685
2686
  },
2686
2687
  /**
2687
- * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
2688
+ * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
2688
2689
  * @summary List Access Profiles
2689
2690
  * @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
2690
2691
  * @param {*} [axiosOptions] Override http request option.
@@ -2719,7 +2720,7 @@ var AccessProfilesApi = /** @class */ (function (_super) {
2719
2720
  return _super !== null && _super.apply(this, arguments) || this;
2720
2721
  }
2721
2722
  /**
2722
- * Create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
2723
+ * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes.
2723
2724
  * @summary Create Access Profile
2724
2725
  * @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
2725
2726
  * @param {*} [axiosOptions] Override http request option.
@@ -2779,7 +2780,7 @@ var AccessProfilesApi = /** @class */ (function (_super) {
2779
2780
  return (0, exports.AccessProfilesApiFp)(this.configuration).getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
2780
2781
  };
2781
2782
  /**
2782
- * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
2783
+ * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
2783
2784
  * @summary List Access Profiles
2784
2785
  * @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
2785
2786
  * @param {*} [axiosOptions] Override http request option.
@@ -3064,7 +3065,7 @@ var AccessRequestApprovalsApiAxiosParamCreator = function (configuration) {
3064
3065
  * @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.
3065
3066
  * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
3066
3067
  * @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.
3067
- * @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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in*
3068
+ * @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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in*
3068
3069
  * @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, modified**
3069
3070
  * @param {*} [axiosOptions] Override http request option.
3070
3071
  * @throws {RequiredError}
@@ -3305,7 +3306,7 @@ var AccessRequestApprovalsApiFp = function (configuration) {
3305
3306
  * @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.
3306
3307
  * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
3307
3308
  * @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.
3308
- * @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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in*
3309
+ * @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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in*
3309
3310
  * @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, modified**
3310
3311
  * @param {*} [axiosOptions] Override http request option.
3311
3312
  * @throws {RequiredError}
@@ -27173,9 +27174,9 @@ var RolesApiAxiosParamCreator = function (configuration) {
27173
27174
  });
27174
27175
  },
27175
27176
  /**
27176
- * This API deletes a Role by its ID. A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
27177
- * @summary Delete a Role
27178
- * @param {string} id ID of the Role
27177
+ * Delete a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of.
27178
+ * @summary Delete Role
27179
+ * @param {string} id Role ID.
27179
27180
  * @param {*} [axiosOptions] Override http request option.
27180
27181
  * @throws {RequiredError}
27181
27182
  */
@@ -27226,9 +27227,9 @@ var RolesApiAxiosParamCreator = function (configuration) {
27226
27227
  });
27227
27228
  },
27228
27229
  /**
27229
- * This API returns a Role by its ID. A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
27230
- * @summary Get a Role
27231
- * @param {string} id ID of the Role
27230
+ * Get a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of.
27231
+ * @summary Get Role
27232
+ * @param {string} id Role ID.
27232
27233
  * @param {*} [axiosOptions] Override http request option.
27233
27234
  * @throws {RequiredError}
27234
27235
  */
@@ -27358,7 +27359,7 @@ var RolesApiAxiosParamCreator = function (configuration) {
27358
27359
  * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
27359
27360
  * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
27360
27361
  * @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.
27361
- * @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* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*
27362
+ * @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* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq*
27362
27363
  * @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: **name, created, modified**
27363
27364
  * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
27364
27365
  * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
@@ -27433,9 +27434,9 @@ var RolesApiAxiosParamCreator = function (configuration) {
27433
27434
  });
27434
27435
  },
27435
27436
  /**
27436
- * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
27437
- * @summary Patch a specified Role
27438
- * @param {string} id ID of the Role to patch
27437
+ * Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
27438
+ * @summary Patch Role
27439
+ * @param {string} id Role ID to patch
27439
27440
  * @param {Array<JsonPatchOperation>} jsonPatchOperation
27440
27441
  * @param {*} [axiosOptions] Override http request option.
27441
27442
  * @throws {RequiredError}
@@ -27547,9 +27548,9 @@ var RolesApiFp = function (configuration) {
27547
27548
  });
27548
27549
  },
27549
27550
  /**
27550
- * This API deletes a Role by its ID. A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
27551
- * @summary Delete a Role
27552
- * @param {string} id ID of the Role
27551
+ * Delete a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of.
27552
+ * @summary Delete Role
27553
+ * @param {string} id Role ID.
27553
27554
  * @param {*} [axiosOptions] Override http request option.
27554
27555
  * @throws {RequiredError}
27555
27556
  */
@@ -27570,9 +27571,9 @@ var RolesApiFp = function (configuration) {
27570
27571
  });
27571
27572
  },
27572
27573
  /**
27573
- * This API returns a Role by its ID. A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
27574
- * @summary Get a Role
27575
- * @param {string} id ID of the Role
27574
+ * Get a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of.
27575
+ * @summary Get Role
27576
+ * @param {string} id Role ID.
27576
27577
  * @param {*} [axiosOptions] Override http request option.
27577
27578
  * @throws {RequiredError}
27578
27579
  */
@@ -27627,7 +27628,7 @@ var RolesApiFp = function (configuration) {
27627
27628
  * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
27628
27629
  * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
27629
27630
  * @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&#x3D;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.
27630
- * @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* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*
27631
+ * @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* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq*
27631
27632
  * @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: **name, created, modified**
27632
27633
  * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
27633
27634
  * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
@@ -27651,9 +27652,9 @@ var RolesApiFp = function (configuration) {
27651
27652
  });
27652
27653
  },
27653
27654
  /**
27654
- * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
27655
- * @summary Patch a specified Role
27656
- * @param {string} id ID of the Role to patch
27655
+ * Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
27656
+ * @summary Patch Role
27657
+ * @param {string} id Role ID to patch
27657
27658
  * @param {Array<JsonPatchOperation>} jsonPatchOperation
27658
27659
  * @param {*} [axiosOptions] Override http request option.
27659
27660
  * @throws {RequiredError}
@@ -27705,8 +27706,8 @@ var RolesApiFactory = function (configuration, basePath, axios) {
27705
27706
  return localVarFp.deleteBulkRoles(requestParameters.roleBulkDeleteRequest, axiosOptions).then(function (request) { return request(axios, basePath); });
27706
27707
  },
27707
27708
  /**
27708
- * This API deletes a Role by its ID. A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
27709
- * @summary Delete a Role
27709
+ * Delete a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of.
27710
+ * @summary Delete Role
27710
27711
  * @param {RolesApiDeleteRoleRequest} requestParameters Request parameters.
27711
27712
  * @param {*} [axiosOptions] Override http request option.
27712
27713
  * @throws {RequiredError}
@@ -27715,8 +27716,8 @@ var RolesApiFactory = function (configuration, basePath, axios) {
27715
27716
  return localVarFp.deleteRole(requestParameters.id, axiosOptions).then(function (request) { return request(axios, basePath); });
27716
27717
  },
27717
27718
  /**
27718
- * This API returns a Role by its ID. A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
27719
- * @summary Get a Role
27719
+ * Get a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of.
27720
+ * @summary Get Role
27720
27721
  * @param {RolesApiGetRoleRequest} requestParameters Request parameters.
27721
27722
  * @param {*} [axiosOptions] Override http request option.
27722
27723
  * @throws {RequiredError}
@@ -27746,8 +27747,8 @@ var RolesApiFactory = function (configuration, basePath, axios) {
27746
27747
  return localVarFp.listRoles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then(function (request) { return request(axios, basePath); });
27747
27748
  },
27748
27749
  /**
27749
- * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
27750
- * @summary Patch a specified Role
27750
+ * Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
27751
+ * @summary Patch Role
27751
27752
  * @param {RolesApiPatchRoleRequest} requestParameters Request parameters.
27752
27753
  * @param {*} [axiosOptions] Override http request option.
27753
27754
  * @throws {RequiredError}
@@ -27794,8 +27795,8 @@ var RolesApi = /** @class */ (function (_super) {
27794
27795
  return (0, exports.RolesApiFp)(this.configuration).deleteBulkRoles(requestParameters.roleBulkDeleteRequest, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
27795
27796
  };
27796
27797
  /**
27797
- * This API deletes a Role by its ID. A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
27798
- * @summary Delete a Role
27798
+ * Delete a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of.
27799
+ * @summary Delete Role
27799
27800
  * @param {RolesApiDeleteRoleRequest} requestParameters Request parameters.
27800
27801
  * @param {*} [axiosOptions] Override http request option.
27801
27802
  * @throws {RequiredError}
@@ -27806,8 +27807,8 @@ var RolesApi = /** @class */ (function (_super) {
27806
27807
  return (0, exports.RolesApiFp)(this.configuration).deleteRole(requestParameters.id, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
27807
27808
  };
27808
27809
  /**
27809
- * This API returns a Role by its ID. A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
27810
- * @summary Get a Role
27810
+ * Get a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of.
27811
+ * @summary Get Role
27811
27812
  * @param {RolesApiGetRoleRequest} requestParameters Request parameters.
27812
27813
  * @param {*} [axiosOptions] Override http request option.
27813
27814
  * @throws {RequiredError}
@@ -27843,8 +27844,8 @@ var RolesApi = /** @class */ (function (_super) {
27843
27844
  return (0, exports.RolesApiFp)(this.configuration).listRoles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
27844
27845
  };
27845
27846
  /**
27846
- * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
27847
- * @summary Patch a specified Role
27847
+ * Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
27848
+ * @summary Patch Role
27848
27849
  * @param {RolesApiPatchRoleRequest} requestParameters Request parameters.
27849
27850
  * @param {*} [axiosOptions] Override http request option.
27850
27851
  * @throws {RequiredError}
@@ -33235,11 +33236,11 @@ var ServiceDeskIntegrationApiAxiosParamCreator = function (configuration) {
33235
33236
  * Update an existing Service Desk integration by ID with a PATCH request.
33236
33237
  * @summary Patch a Service Desk Integration
33237
33238
  * @param {string} id ID of the Service Desk integration to update
33238
- * @param {PatchServiceDeskIntegrationRequest} patchServiceDeskIntegrationRequest A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only &#x60;replace&#x60; operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
33239
+ * @param {Array<JsonPatchOperation>} jsonPatchOperation A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only &#x60;replace&#x60; operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
33239
33240
  * @param {*} [axiosOptions] Override http request option.
33240
33241
  * @throws {RequiredError}
33241
33242
  */
33242
- patchServiceDeskIntegration: function (id, patchServiceDeskIntegrationRequest, axiosOptions) {
33243
+ patchServiceDeskIntegration: function (id, jsonPatchOperation, axiosOptions) {
33243
33244
  if (axiosOptions === void 0) { axiosOptions = {}; }
33244
33245
  return __awaiter(_this, void 0, void 0, function () {
33245
33246
  var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -33248,8 +33249,8 @@ var ServiceDeskIntegrationApiAxiosParamCreator = function (configuration) {
33248
33249
  case 0:
33249
33250
  // verify required parameter 'id' is not null or undefined
33250
33251
  (0, common_1.assertParamExists)('patchServiceDeskIntegration', 'id', id);
33251
- // verify required parameter 'patchServiceDeskIntegrationRequest' is not null or undefined
33252
- (0, common_1.assertParamExists)('patchServiceDeskIntegration', 'patchServiceDeskIntegrationRequest', patchServiceDeskIntegrationRequest);
33252
+ // verify required parameter 'jsonPatchOperation' is not null or undefined
33253
+ (0, common_1.assertParamExists)('patchServiceDeskIntegration', 'jsonPatchOperation', jsonPatchOperation);
33253
33254
  localVarPath = "/service-desk-integrations/{id}"
33254
33255
  .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
33255
33256
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -33280,7 +33281,7 @@ var ServiceDeskIntegrationApiAxiosParamCreator = function (configuration) {
33280
33281
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
33281
33282
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
33282
33283
  localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
33283
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(patchServiceDeskIntegrationRequest, localVarRequestOptions, configuration);
33284
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(jsonPatchOperation, localVarRequestOptions, configuration);
33284
33285
  return [2 /*return*/, {
33285
33286
  url: (0, common_1.toPathString)(localVarUrlObj),
33286
33287
  axiosOptions: localVarRequestOptions,
@@ -33578,17 +33579,17 @@ var ServiceDeskIntegrationApiFp = function (configuration) {
33578
33579
  * Update an existing Service Desk integration by ID with a PATCH request.
33579
33580
  * @summary Patch a Service Desk Integration
33580
33581
  * @param {string} id ID of the Service Desk integration to update
33581
- * @param {PatchServiceDeskIntegrationRequest} patchServiceDeskIntegrationRequest A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only &#x60;replace&#x60; operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
33582
+ * @param {Array<JsonPatchOperation>} jsonPatchOperation A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only &#x60;replace&#x60; operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
33582
33583
  * @param {*} [axiosOptions] Override http request option.
33583
33584
  * @throws {RequiredError}
33584
33585
  */
33585
- patchServiceDeskIntegration: function (id, patchServiceDeskIntegrationRequest, axiosOptions) {
33586
+ patchServiceDeskIntegration: function (id, jsonPatchOperation, axiosOptions) {
33586
33587
  var _a, _b, _c;
33587
33588
  return __awaiter(this, void 0, void 0, function () {
33588
33589
  var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
33589
33590
  return __generator(this, function (_d) {
33590
33591
  switch (_d.label) {
33591
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchServiceDeskIntegration(id, patchServiceDeskIntegrationRequest, axiosOptions)];
33592
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchServiceDeskIntegration(id, jsonPatchOperation, axiosOptions)];
33592
33593
  case 1:
33593
33594
  localVarAxiosArgs = _d.sent();
33594
33595
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
@@ -33732,7 +33733,7 @@ var ServiceDeskIntegrationApiFactory = function (configuration, basePath, axios)
33732
33733
  * @throws {RequiredError}
33733
33734
  */
33734
33735
  patchServiceDeskIntegration: function (requestParameters, axiosOptions) {
33735
- return localVarFp.patchServiceDeskIntegration(requestParameters.id, requestParameters.patchServiceDeskIntegrationRequest, axiosOptions).then(function (request) { return request(axios, basePath); });
33736
+ return localVarFp.patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then(function (request) { return request(axios, basePath); });
33736
33737
  },
33737
33738
  /**
33738
33739
  * Update an existing Service Desk integration by ID.
@@ -33861,7 +33862,7 @@ var ServiceDeskIntegrationApi = /** @class */ (function (_super) {
33861
33862
  */
33862
33863
  ServiceDeskIntegrationApi.prototype.patchServiceDeskIntegration = function (requestParameters, axiosOptions) {
33863
33864
  var _this = this;
33864
- return (0, exports.ServiceDeskIntegrationApiFp)(this.configuration).patchServiceDeskIntegration(requestParameters.id, requestParameters.patchServiceDeskIntegrationRequest, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
33865
+ return (0, exports.ServiceDeskIntegrationApiFp)(this.configuration).patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
33865
33866
  };
33866
33867
  /**
33867
33868
  * Update an existing Service Desk integration by ID.
@@ -40568,7 +40569,7 @@ var WorkflowsApiAxiosParamCreator = function (configuration) {
40568
40569
  });
40569
40570
  },
40570
40571
  /**
40571
- * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response.
40572
+ * Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response.
40572
40573
  * @summary Get Workflow Execution
40573
40574
  * @param {string} id Workflow execution ID.
40574
40575
  * @param {*} [axiosOptions] Override http request option.
@@ -41416,7 +41417,7 @@ var WorkflowsApiFp = function (configuration) {
41416
41417
  });
41417
41418
  },
41418
41419
  /**
41419
- * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response.
41420
+ * Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response.
41420
41421
  * @summary Get Workflow Execution
41421
41422
  * @param {string} id Workflow execution ID.
41422
41423
  * @param {*} [axiosOptions] Override http request option.
@@ -41777,7 +41778,7 @@ var WorkflowsApiFactory = function (configuration, basePath, axios) {
41777
41778
  return localVarFp.getWorkflow(requestParameters.id, requestParameters.workflowMetrics, axiosOptions).then(function (request) { return request(axios, basePath); });
41778
41779
  },
41779
41780
  /**
41780
- * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response.
41781
+ * Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response.
41781
41782
  * @summary Get Workflow Execution
41782
41783
  * @param {WorkflowsApiGetWorkflowExecutionRequest} requestParameters Request parameters.
41783
41784
  * @param {*} [axiosOptions] Override http request option.
@@ -41986,7 +41987,7 @@ var WorkflowsApi = /** @class */ (function (_super) {
41986
41987
  return (0, exports.WorkflowsApiFp)(this.configuration).getWorkflow(requestParameters.id, requestParameters.workflowMetrics, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
41987
41988
  };
41988
41989
  /**
41989
- * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response.
41990
+ * Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response.
41990
41991
  * @summary Get Workflow Execution
41991
41992
  * @param {WorkflowsApiGetWorkflowExecutionRequest} requestParameters Request parameters.
41992
41993
  * @param {*} [axiosOptions] Override http request option.