@sailpoint/api-client 2.2.47 → 2.2.49

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.
Files changed (41) hide show
  1. package/dist/accounts/api.d.ts +504 -0
  2. package/dist/accounts/api.js +146 -1
  3. package/dist/accounts/api.js.map +1 -1
  4. package/dist/esm/accounts/api.js +145 -0
  5. package/dist/esm/generic/api.js +262 -335
  6. package/dist/esm/generic/base.js +4 -4
  7. package/dist/esm/generic/common.js +44 -31
  8. package/dist/esm/generic/configuration.js +3 -3
  9. package/dist/esm/generic/index.js +3 -3
  10. package/dist/esm/index.js +3 -0
  11. package/dist/esm/nerm/common.js +2 -2
  12. package/dist/esm/nermv2025/common.js +2 -2
  13. package/dist/generic/api.d.ts +166 -177
  14. package/dist/generic/api.js +265 -338
  15. package/dist/generic/api.js.map +1 -1
  16. package/dist/generic/base.d.ts +3 -3
  17. package/dist/generic/base.js +4 -4
  18. package/dist/generic/base.js.map +1 -1
  19. package/dist/generic/common.d.ts +4 -4
  20. package/dist/generic/common.js +44 -31
  21. package/dist/generic/common.js.map +1 -1
  22. package/dist/generic/configuration.d.ts +3 -3
  23. package/dist/generic/configuration.js +3 -3
  24. package/dist/generic/configuration.js.map +1 -1
  25. package/dist/generic/index.d.ts +3 -3
  26. package/dist/generic/index.js +3 -3
  27. package/dist/generic/index.js.map +1 -1
  28. package/dist/generic.spec.d.ts +1 -0
  29. package/dist/generic.spec.js +133 -0
  30. package/dist/generic.spec.js.map +1 -0
  31. package/dist/index.d.ts +2 -0
  32. package/dist/index.js +5 -1
  33. package/dist/index.js.map +1 -1
  34. package/dist/index.spec.js +40 -0
  35. package/dist/index.spec.js.map +1 -1
  36. package/dist/nerm/common.js +2 -2
  37. package/dist/nerm/common.js.map +1 -1
  38. package/dist/nermv2025/common.js +2 -2
  39. package/dist/nermv2025/common.js.map +1 -1
  40. package/package.json +3 -2
  41. package/sailpoint-scopes.json +16386 -0
@@ -98,6 +98,38 @@ export var AccountAllOfRecommendationMethodEnum = {
98
98
  export var AccountAllOfSourceOwnerTypeEnum = {
99
99
  Identity: 'IDENTITY'
100
100
  };
101
+ export var AccountV2OriginEnum = {
102
+ Aggregated: 'AGGREGATED',
103
+ Provisioned: 'PROVISIONED'
104
+ };
105
+ export var AccountV2ClassificationMethodEnum = {
106
+ Criteria: 'CRITERIA',
107
+ Source: 'SOURCE',
108
+ Discovery: 'DISCOVERY',
109
+ Manual: 'MANUAL',
110
+ ManuallyUnclassified: 'MANUALLY_UNCLASSIFIED'
111
+ };
112
+ export var AccountV2CorrelatedIdentityTypeEnum = {
113
+ Identity: 'IDENTITY'
114
+ };
115
+ export var AccountV2IdentityTypeEnum = {
116
+ Identity: 'IDENTITY'
117
+ };
118
+ export var AccountV2OwnerTypeEnum = {
119
+ Identity: 'IDENTITY'
120
+ };
121
+ export var AccountV2RecommendationTypeEnum = {
122
+ Human: 'HUMAN',
123
+ Machine: 'MACHINE'
124
+ };
125
+ export var AccountV2RecommendationMethodEnum = {
126
+ Discovery: 'DISCOVERY',
127
+ Source: 'SOURCE',
128
+ Criteria: 'CRITERIA'
129
+ };
130
+ export var AccountV2SourceTypeEnum = {
131
+ Source: 'SOURCE'
132
+ };
101
133
  export var AdditionalOwnerRefTypeEnum = {
102
134
  Identity: 'IDENTITY',
103
135
  GovernanceGroup: 'GOVERNANCE_GROUP'
@@ -610,6 +642,66 @@ export var AccountsApiAxiosParamCreator = function (configuration) {
610
642
  });
611
643
  });
612
644
  },
645
+ /**
646
+ * List accounts from the accounts search index. Use standard collection parameters for paging (`limit`, `offset`, `count`). Default page size is 25 when no collection parameters are sent. Maximum `limit` is 250. Requests that specify a larger `limit` are capped at 250. `offset + limit` cannot exceed 10,000. To page beyond that window, use `searchAfter` instead of a large offset. `searchAfter` cannot be combined with `offset`. Always include `id` in `sorters` when using `searchAfter`. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information.
647
+ * @summary List accounts (search)
648
+ * @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.
649
+ * @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.
650
+ * @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.
651
+ * @param {string} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to page beyond the offset limit of 10,000 records by shifting the search window to begin at this value. `searchAfter` cannot be combined with `offset`. When `searchAfter` is provided, `id` must be included in `sorters`. It is recommended that you always include the ID of the object in addition to any other sort fields in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
652
+ * @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: **id**: *eq, in, sw* **name**: *eq, in, sw, isnull, pr* **uuid**: *eq, in, sw, isnull, pr* **nativeIdentity**: *eq, in, sw, isnull, pr* **description**: *eq, in, sw, isnull, pr* **type**: *eq, ne* **recommendation.type**: *eq, in, sw, isnull, pr* **recommendation.method**: *eq, in, sw, isnull, pr* **locked**: *eq* **disabled**: *eq* **hasEntitlements**: *eq* **manuallyCorrelated**: *eq* **privilegeLevel.effective**: *eq, in, isnull, pr* **correlated**: *eq* **classificationMethod**: *eq, ne, in, sw, isnull, pr* **subType**: *eq, ne, in, sw, isnull, pr* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* **synced**: *eq, ge, gt, le, lt* **owner.id**: *eq, in, sw* **owner.name**: *eq, in, sw, isnull, pr* **owner.state**: *eq, in, sw, isnull, pr* **correlatedIdentity.id**: *eq, in, sw* **correlatedIdentity.name**: *eq, in, sw, isnull, pr* **correlatedIdentity.state**: *eq, in, sw, isnull, pr* **source.id**: *eq, in, sw* **source.name**: *eq, in, sw* **source.authoritative**: *eq* **source.connectionType**: *eq, in, isnull, pr* **origin**: *eq, in* Filter values are case-insensitive for **name, description, type, origin, source.name, source.connectionType, owner.name, correlatedIdentity.name, correlatedIdentity.state, privilegeLevel.effective, recommendation.type, recommendation.method, classificationMethod, subType**. Filter values remain case-sensitive for the identifier fields **id, uuid, nativeIdentity, source.id, owner.id, correlatedIdentity.id**.
653
+ * @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, uuid, nativeIdentity, created, modified, manuallyCorrelated, description, type, recommendation.type, recommendation.method, locked, disabled, correlated, hasEntitlements, origin, privilegeLevel.effective, classificationMethod, subType, owner.id, owner.name, owner.state, correlatedIdentity.id, correlatedIdentity.name, correlatedIdentity.state, source.id, source.name, source.authoritative, source.connectionType, synced** Sorting on the following fields is case-insensitive: **name, description, type, origin, source.name, source.connectionType, owner.name, correlatedIdentity.name, correlatedIdentity.state, privilegeLevel.effective, recommendation.type, recommendation.method, classificationMethod, subType**. Identifier fields such as **id, uuid, nativeIdentity, source.id, owner.id,** and **correlatedIdentity.id** remain case-sensitive. Default sort is **created** when no collection parameters are sent.
654
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
655
+ * @param {*} [axiosOptions] Override http request option.
656
+ * @throws {RequiredError}
657
+ */
658
+ listAccountsV2: function (limit, offset, count, searchAfter, filters, sorters, xSailPointExperimental, axiosOptions) {
659
+ if (axiosOptions === void 0) { axiosOptions = {}; }
660
+ return __awaiter(_this, void 0, void 0, function () {
661
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
662
+ return __generator(this, function (_a) {
663
+ if (xSailPointExperimental === undefined) {
664
+ xSailPointExperimental = 'true';
665
+ }
666
+ localVarPath = "/accounts/v2";
667
+ localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
668
+ if (configuration) {
669
+ baseOptions = configuration.baseOptions;
670
+ }
671
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
672
+ localVarHeaderParameter = {};
673
+ localVarQueryParameter = {};
674
+ if (limit !== undefined) {
675
+ localVarQueryParameter['limit'] = limit;
676
+ }
677
+ if (offset !== undefined) {
678
+ localVarQueryParameter['offset'] = offset;
679
+ }
680
+ if (count !== undefined) {
681
+ localVarQueryParameter['count'] = count;
682
+ }
683
+ if (searchAfter !== undefined) {
684
+ localVarQueryParameter['searchAfter'] = searchAfter;
685
+ }
686
+ if (filters !== undefined) {
687
+ localVarQueryParameter['filters'] = filters;
688
+ }
689
+ if (sorters !== undefined) {
690
+ localVarQueryParameter['sorters'] = sorters;
691
+ }
692
+ if (xSailPointExperimental != null) {
693
+ localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
694
+ }
695
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
696
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
697
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
698
+ return [2 /*return*/, {
699
+ url: toPathString(localVarUrlObj),
700
+ axiosOptions: localVarRequestOptions,
701
+ }];
702
+ });
703
+ });
704
+ },
613
705
  /**
614
706
  * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
615
707
  * @summary Update account
@@ -1052,6 +1144,35 @@ export var AccountsApiFp = function (configuration) {
1052
1144
  });
1053
1145
  });
1054
1146
  },
1147
+ /**
1148
+ * List accounts from the accounts search index. Use standard collection parameters for paging (`limit`, `offset`, `count`). Default page size is 25 when no collection parameters are sent. Maximum `limit` is 250. Requests that specify a larger `limit` are capped at 250. `offset + limit` cannot exceed 10,000. To page beyond that window, use `searchAfter` instead of a large offset. `searchAfter` cannot be combined with `offset`. Always include `id` in `sorters` when using `searchAfter`. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information.
1149
+ * @summary List accounts (search)
1150
+ * @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.
1151
+ * @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.
1152
+ * @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.
1153
+ * @param {string} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to page beyond the offset limit of 10,000 records by shifting the search window to begin at this value. `searchAfter` cannot be combined with `offset`. When `searchAfter` is provided, `id` must be included in `sorters`. It is recommended that you always include the ID of the object in addition to any other sort fields in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
1154
+ * @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: **id**: *eq, in, sw* **name**: *eq, in, sw, isnull, pr* **uuid**: *eq, in, sw, isnull, pr* **nativeIdentity**: *eq, in, sw, isnull, pr* **description**: *eq, in, sw, isnull, pr* **type**: *eq, ne* **recommendation.type**: *eq, in, sw, isnull, pr* **recommendation.method**: *eq, in, sw, isnull, pr* **locked**: *eq* **disabled**: *eq* **hasEntitlements**: *eq* **manuallyCorrelated**: *eq* **privilegeLevel.effective**: *eq, in, isnull, pr* **correlated**: *eq* **classificationMethod**: *eq, ne, in, sw, isnull, pr* **subType**: *eq, ne, in, sw, isnull, pr* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* **synced**: *eq, ge, gt, le, lt* **owner.id**: *eq, in, sw* **owner.name**: *eq, in, sw, isnull, pr* **owner.state**: *eq, in, sw, isnull, pr* **correlatedIdentity.id**: *eq, in, sw* **correlatedIdentity.name**: *eq, in, sw, isnull, pr* **correlatedIdentity.state**: *eq, in, sw, isnull, pr* **source.id**: *eq, in, sw* **source.name**: *eq, in, sw* **source.authoritative**: *eq* **source.connectionType**: *eq, in, isnull, pr* **origin**: *eq, in* Filter values are case-insensitive for **name, description, type, origin, source.name, source.connectionType, owner.name, correlatedIdentity.name, correlatedIdentity.state, privilegeLevel.effective, recommendation.type, recommendation.method, classificationMethod, subType**. Filter values remain case-sensitive for the identifier fields **id, uuid, nativeIdentity, source.id, owner.id, correlatedIdentity.id**.
1155
+ * @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, uuid, nativeIdentity, created, modified, manuallyCorrelated, description, type, recommendation.type, recommendation.method, locked, disabled, correlated, hasEntitlements, origin, privilegeLevel.effective, classificationMethod, subType, owner.id, owner.name, owner.state, correlatedIdentity.id, correlatedIdentity.name, correlatedIdentity.state, source.id, source.name, source.authoritative, source.connectionType, synced** Sorting on the following fields is case-insensitive: **name, description, type, origin, source.name, source.connectionType, owner.name, correlatedIdentity.name, correlatedIdentity.state, privilegeLevel.effective, recommendation.type, recommendation.method, classificationMethod, subType**. Identifier fields such as **id, uuid, nativeIdentity, source.id, owner.id,** and **correlatedIdentity.id** remain case-sensitive. Default sort is **created** when no collection parameters are sent.
1156
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
1157
+ * @param {*} [axiosOptions] Override http request option.
1158
+ * @throws {RequiredError}
1159
+ */
1160
+ listAccountsV2: function (limit, offset, count, searchAfter, filters, sorters, xSailPointExperimental, axiosOptions) {
1161
+ var _a, _b, _c;
1162
+ return __awaiter(this, void 0, void 0, function () {
1163
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
1164
+ return __generator(this, function (_d) {
1165
+ switch (_d.label) {
1166
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listAccountsV2(limit, offset, count, searchAfter, filters, sorters, xSailPointExperimental, axiosOptions)];
1167
+ case 1:
1168
+ localVarAxiosArgs = _d.sent();
1169
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1170
+ localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccountsApi.listAccountsV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1171
+ return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
1172
+ }
1173
+ });
1174
+ });
1175
+ },
1055
1176
  /**
1056
1177
  * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
1057
1178
  * @summary Update account
@@ -1277,6 +1398,17 @@ export var AccountsApiFactory = function (configuration, basePath, axios) {
1277
1398
  if (requestParameters === void 0) { requestParameters = {}; }
1278
1399
  return localVarFp.listAccountsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, axiosOptions).then(function (request) { return request(axios, basePath); });
1279
1400
  },
1401
+ /**
1402
+ * List accounts from the accounts search index. Use standard collection parameters for paging (`limit`, `offset`, `count`). Default page size is 25 when no collection parameters are sent. Maximum `limit` is 250. Requests that specify a larger `limit` are capped at 250. `offset + limit` cannot exceed 10,000. To page beyond that window, use `searchAfter` instead of a large offset. `searchAfter` cannot be combined with `offset`. Always include `id` in `sorters` when using `searchAfter`. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information.
1403
+ * @summary List accounts (search)
1404
+ * @param {AccountsApiListAccountsV2Request} requestParameters Request parameters.
1405
+ * @param {*} [axiosOptions] Override http request option.
1406
+ * @throws {RequiredError}
1407
+ */
1408
+ listAccountsV2: function (requestParameters, axiosOptions) {
1409
+ if (requestParameters === void 0) { requestParameters = {}; }
1410
+ return localVarFp.listAccountsV2(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
1411
+ },
1280
1412
  /**
1281
1413
  * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
1282
1414
  * @summary Update account
@@ -1475,6 +1607,19 @@ var AccountsApi = /** @class */ (function (_super) {
1475
1607
  if (requestParameters === void 0) { requestParameters = {}; }
1476
1608
  return AccountsApiFp(this.configuration).listAccountsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
1477
1609
  };
1610
+ /**
1611
+ * List accounts from the accounts search index. Use standard collection parameters for paging (`limit`, `offset`, `count`). Default page size is 25 when no collection parameters are sent. Maximum `limit` is 250. Requests that specify a larger `limit` are capped at 250. `offset + limit` cannot exceed 10,000. To page beyond that window, use `searchAfter` instead of a large offset. `searchAfter` cannot be combined with `offset`. Always include `id` in `sorters` when using `searchAfter`. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information.
1612
+ * @summary List accounts (search)
1613
+ * @param {AccountsApiListAccountsV2Request} requestParameters Request parameters.
1614
+ * @param {*} [axiosOptions] Override http request option.
1615
+ * @throws {RequiredError}
1616
+ * @memberof AccountsApi
1617
+ */
1618
+ AccountsApi.prototype.listAccountsV2 = function (requestParameters, axiosOptions) {
1619
+ var _this = this;
1620
+ if (requestParameters === void 0) { requestParameters = {}; }
1621
+ return AccountsApiFp(this.configuration).listAccountsV2(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
1622
+ };
1478
1623
  /**
1479
1624
  * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
1480
1625
  * @summary Update account