@sailpoint/api-client 2.2.39 → 2.2.41
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/certifications/api.d.ts +3 -3
- package/dist/certifications/api.js +2 -2
- package/dist/certifications/api.js.map +1 -1
- package/dist/custom_forms/api.d.ts +20 -8
- package/dist/custom_forms/api.js +18 -9
- package/dist/custom_forms/api.js.map +1 -1
- package/dist/esm/certifications/api.js +2 -2
- package/dist/esm/custom_forms/api.js +18 -9
- package/dist/esm/gov_certification/api.js +5565 -0
- package/dist/esm/gov_certification/base.js +83 -0
- package/dist/esm/gov_certification/common.js +287 -0
- package/dist/esm/gov_certification/configuration.js +42 -0
- package/dist/esm/gov_certification/index.js +15 -0
- package/dist/esm/identities/api.js +205 -0
- package/dist/esm/index.js +6 -0
- package/dist/esm/jit_activation_convert/api.js +226 -0
- package/dist/esm/jit_activation_convert/base.js +83 -0
- package/dist/esm/jit_activation_convert/common.js +287 -0
- package/dist/esm/jit_activation_convert/configuration.js +42 -0
- package/dist/esm/jit_activation_convert/index.js +15 -0
- package/dist/esm/nerm/common.js +2 -2
- package/dist/esm/nermv2025/common.js +2 -2
- package/dist/esm/privilege_criteria/api.js +2 -2
- package/dist/esm/sources/api.js +88 -0
- package/dist/gov_certification/api.d.ts +7599 -0
- package/dist/gov_certification/api.js +5576 -0
- package/dist/gov_certification/api.js.map +1 -0
- package/dist/gov_certification/base.d.ts +66 -0
- package/dist/gov_certification/base.js +90 -0
- package/dist/gov_certification/base.js.map +1 -0
- package/dist/gov_certification/common.d.ts +65 -0
- package/dist/gov_certification/common.js +300 -0
- package/dist/gov_certification/common.js.map +1 -0
- package/dist/gov_certification/configuration.d.ts +91 -0
- package/dist/gov_certification/configuration.js +46 -0
- package/dist/gov_certification/configuration.js.map +1 -0
- package/dist/gov_certification/index.d.ts +13 -0
- package/dist/gov_certification/index.js +32 -0
- package/dist/gov_certification/index.js.map +1 -0
- package/dist/identities/api.d.ts +339 -0
- package/dist/identities/api.js +206 -1
- package/dist/identities/api.js.map +1 -1
- package/dist/index.d.ts +6 -0
- package/dist/index.js +240 -234
- package/dist/index.js.map +1 -1
- package/dist/jit_activation_convert/api.d.ts +241 -0
- package/dist/jit_activation_convert/api.js +236 -0
- package/dist/jit_activation_convert/api.js.map +1 -0
- package/dist/jit_activation_convert/base.d.ts +66 -0
- package/dist/jit_activation_convert/base.js +90 -0
- package/dist/jit_activation_convert/base.js.map +1 -0
- package/dist/jit_activation_convert/common.d.ts +65 -0
- package/dist/jit_activation_convert/common.js +300 -0
- package/dist/jit_activation_convert/common.js.map +1 -0
- package/dist/jit_activation_convert/configuration.d.ts +91 -0
- package/dist/jit_activation_convert/configuration.js +46 -0
- package/dist/jit_activation_convert/configuration.js.map +1 -0
- package/dist/jit_activation_convert/index.d.ts +13 -0
- package/dist/jit_activation_convert/index.js +32 -0
- package/dist/jit_activation_convert/index.js.map +1 -0
- 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/privilege_criteria/api.d.ts +3 -3
- package/dist/privilege_criteria/api.js +2 -2
- package/dist/privilege_criteria/api.js.map +1 -1
- package/dist/sources/api.d.ts +87 -0
- package/dist/sources/api.js +88 -0
- package/dist/sources/api.js.map +1 -1
- package/package.json +1 -1
package/dist/identities/api.js
CHANGED
|
@@ -78,7 +78,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
78
78
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
79
79
|
};
|
|
80
80
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
81
|
-
exports.ListIdentitiesV1DefaultFilterEnum = exports.IdentitiesApi = exports.IdentitiesApiFactory = exports.IdentitiesApiFp = exports.IdentitiesApiAxiosParamCreator = exports.TaskStatusMessageTypeEnum = exports.TaskStatusCompletionStatusEnum = exports.TaskStatusTypeEnum = exports.TargetTypeEnum = exports.TaggedObjectDtoTypeEnum = exports.SendAccountVerificationRequestViaEnum = exports.RoleAssignmentDtoAssignerTypeEnum = exports.LocaleOrigin = exports.IdentitySyncJobStatusEnum = exports.IdentityManagerRefTypeEnum = exports.IdentityIdentityStatusEnum = exports.IdentityProcessingStateEnum = exports.DtoType = void 0;
|
|
81
|
+
exports.ListIdentitiesV1DefaultFilterEnum = exports.IdentitiesApi = exports.IdentitiesApiFactory = exports.IdentitiesApiFp = exports.IdentitiesApiAxiosParamCreator = exports.TaskStatusMessageTypeEnum = exports.TaskStatusCompletionStatusEnum = exports.TaskStatusTypeEnum = exports.TargetTypeEnum = exports.TaggedObjectDtoTypeEnum = exports.SendAccountVerificationRequestViaEnum = exports.RoleAssignmentDtoAssignerTypeEnum = exports.LocaleOrigin = exports.IdentityV2PrivilegeLevelEffectiveEnum = exports.IdentitySyncJobStatusEnum = exports.IdentityManagerRefTypeEnum = exports.IdentityIdentityStatusEnum = exports.IdentityProcessingStateEnum = exports.DtoType = void 0;
|
|
82
82
|
var axios_1 = __importDefault(require("axios"));
|
|
83
83
|
// Some imports not used depending on template conditions
|
|
84
84
|
// @ts-ignore
|
|
@@ -146,6 +146,12 @@ exports.IdentitySyncJobStatusEnum = {
|
|
|
146
146
|
Success: 'SUCCESS',
|
|
147
147
|
Error: 'ERROR'
|
|
148
148
|
};
|
|
149
|
+
exports.IdentityV2PrivilegeLevelEffectiveEnum = {
|
|
150
|
+
High: 'HIGH',
|
|
151
|
+
Medium: 'MEDIUM',
|
|
152
|
+
Low: 'LOW',
|
|
153
|
+
None: 'NONE'
|
|
154
|
+
};
|
|
149
155
|
/**
|
|
150
156
|
* An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.
|
|
151
157
|
* @export
|
|
@@ -302,6 +308,46 @@ var IdentitiesApiAxiosParamCreator = function (configuration) {
|
|
|
302
308
|
});
|
|
303
309
|
});
|
|
304
310
|
},
|
|
311
|
+
/**
|
|
312
|
+
* This API returns a single identity from the identities search index. `privilegeLevel.effective` is `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level is returned as `NONE`. `privilegeLevel` is null when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is disabled. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase.
|
|
313
|
+
* @summary Identity details (search)
|
|
314
|
+
* @param {string} id Identity Id
|
|
315
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
316
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
317
|
+
* @throws {RequiredError}
|
|
318
|
+
*/
|
|
319
|
+
getIdentityV2: function (id, xSailPointExperimental, axiosOptions) {
|
|
320
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
321
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
322
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
323
|
+
return __generator(this, function (_a) {
|
|
324
|
+
// verify required parameter 'id' is not null or undefined
|
|
325
|
+
(0, common_1.assertParamExists)('getIdentityV2', 'id', id);
|
|
326
|
+
if (xSailPointExperimental === undefined) {
|
|
327
|
+
xSailPointExperimental = 'true';
|
|
328
|
+
}
|
|
329
|
+
localVarPath = "/identities/v2/{id}"
|
|
330
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
331
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
332
|
+
if (configuration) {
|
|
333
|
+
baseOptions = configuration.baseOptions;
|
|
334
|
+
}
|
|
335
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
336
|
+
localVarHeaderParameter = {};
|
|
337
|
+
localVarQueryParameter = {};
|
|
338
|
+
if (xSailPointExperimental != null) {
|
|
339
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
340
|
+
}
|
|
341
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
342
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
343
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
344
|
+
return [2 /*return*/, {
|
|
345
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
346
|
+
axiosOptions: localVarRequestOptions,
|
|
347
|
+
}];
|
|
348
|
+
});
|
|
349
|
+
});
|
|
350
|
+
},
|
|
305
351
|
/**
|
|
306
352
|
*
|
|
307
353
|
* @summary Role assignment details
|
|
@@ -478,6 +524,66 @@ var IdentitiesApiAxiosParamCreator = function (configuration) {
|
|
|
478
524
|
});
|
|
479
525
|
});
|
|
480
526
|
},
|
|
527
|
+
/**
|
|
528
|
+
* List identities from the identities 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. `privilegeLevel` is returned when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is enabled. When the flag is disabled, `privilegeLevel` is null and a filter or sort on `privilegeLevel.effective` is rejected. When the flag is enabled, an identity with no privilege level is returned as `NONE`. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase: `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level matches `privilegeLevel.effective eq \"NONE\"` and does not match `isnull`.
|
|
529
|
+
* @summary List identities (search)
|
|
530
|
+
* @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.
|
|
531
|
+
* @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.
|
|
532
|
+
* @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.
|
|
533
|
+
* @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=John Mathews,01f04e428c484542a241dc89c303b178&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.
|
|
534
|
+
* @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, sw* **name**: *eq, in, sw, isnull, pr* **alias**: *eq, in, sw, isnull, pr* **type**: *eq, in, sw, isnull, pr* **emailAddress**: *eq, in, sw, isnull, pr* **identityStatus**: *eq, in, sw, isnull, pr* **processingState**: *eq, in, sw, isnull, pr* **protected**: *eq* **correlated**: *eq* **inactive**: *eq* **isManager**: *eq* **locked**: *eq* **disabled**: *eq* **manager.id**: *eq, in, sw* **manager.name**: *eq, in, sw, isnull, pr* **manager.type**: *eq, in, sw, isnull, pr* **lifecycleState.stateName**: *eq, in, sw, isnull, pr* **lifecycleState.manuallyUpdated**: *eq* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* **synced**: *eq, ge, gt, le, lt* **lastRefresh**: *eq, ge, gt, le, lt* **privilegeLevel.effective**: *eq, in, isnull, pr*
|
|
535
|
+
* @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: **id, name, alias, type, emailAddress, identityStatus, processingState, protected, correlated, inactive, isManager, locked, disabled, manager.id, manager.name, manager.type, lifecycleState.stateName, lifecycleState.manuallyUpdated, created, modified, synced, lastRefresh, privilegeLevel.effective** Sorting on **privilegeLevel.effective** is case-insensitive and is accepted only when `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` is enabled. Returned values are uppercase. Default sort is **created** when no collection parameters are sent.
|
|
536
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
537
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
538
|
+
* @throws {RequiredError}
|
|
539
|
+
*/
|
|
540
|
+
listIdentitiesV2: function (limit, offset, count, searchAfter, filters, sorters, xSailPointExperimental, axiosOptions) {
|
|
541
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
542
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
543
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
544
|
+
return __generator(this, function (_a) {
|
|
545
|
+
if (xSailPointExperimental === undefined) {
|
|
546
|
+
xSailPointExperimental = 'true';
|
|
547
|
+
}
|
|
548
|
+
localVarPath = "/identities/v2";
|
|
549
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
550
|
+
if (configuration) {
|
|
551
|
+
baseOptions = configuration.baseOptions;
|
|
552
|
+
}
|
|
553
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
554
|
+
localVarHeaderParameter = {};
|
|
555
|
+
localVarQueryParameter = {};
|
|
556
|
+
if (limit !== undefined) {
|
|
557
|
+
localVarQueryParameter['limit'] = limit;
|
|
558
|
+
}
|
|
559
|
+
if (offset !== undefined) {
|
|
560
|
+
localVarQueryParameter['offset'] = offset;
|
|
561
|
+
}
|
|
562
|
+
if (count !== undefined) {
|
|
563
|
+
localVarQueryParameter['count'] = count;
|
|
564
|
+
}
|
|
565
|
+
if (searchAfter !== undefined) {
|
|
566
|
+
localVarQueryParameter['searchAfter'] = searchAfter;
|
|
567
|
+
}
|
|
568
|
+
if (filters !== undefined) {
|
|
569
|
+
localVarQueryParameter['filters'] = filters;
|
|
570
|
+
}
|
|
571
|
+
if (sorters !== undefined) {
|
|
572
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
573
|
+
}
|
|
574
|
+
if (xSailPointExperimental != null) {
|
|
575
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
576
|
+
}
|
|
577
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
578
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
579
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
580
|
+
return [2 /*return*/, {
|
|
581
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
582
|
+
axiosOptions: localVarRequestOptions,
|
|
583
|
+
}];
|
|
584
|
+
});
|
|
585
|
+
});
|
|
586
|
+
},
|
|
481
587
|
/**
|
|
482
588
|
* Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.
|
|
483
589
|
* @summary Reset an identity
|
|
@@ -757,6 +863,30 @@ var IdentitiesApiFp = function (configuration) {
|
|
|
757
863
|
});
|
|
758
864
|
});
|
|
759
865
|
},
|
|
866
|
+
/**
|
|
867
|
+
* This API returns a single identity from the identities search index. `privilegeLevel.effective` is `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level is returned as `NONE`. `privilegeLevel` is null when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is disabled. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase.
|
|
868
|
+
* @summary Identity details (search)
|
|
869
|
+
* @param {string} id Identity Id
|
|
870
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
871
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
872
|
+
* @throws {RequiredError}
|
|
873
|
+
*/
|
|
874
|
+
getIdentityV2: function (id, xSailPointExperimental, axiosOptions) {
|
|
875
|
+
var _a, _b, _c;
|
|
876
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
877
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
878
|
+
return __generator(this, function (_d) {
|
|
879
|
+
switch (_d.label) {
|
|
880
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getIdentityV2(id, xSailPointExperimental, axiosOptions)];
|
|
881
|
+
case 1:
|
|
882
|
+
localVarAxiosArgs = _d.sent();
|
|
883
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
884
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['IdentitiesApi.getIdentityV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
885
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
886
|
+
}
|
|
887
|
+
});
|
|
888
|
+
});
|
|
889
|
+
},
|
|
760
890
|
/**
|
|
761
891
|
*
|
|
762
892
|
* @summary Role assignment details
|
|
@@ -860,6 +990,35 @@ var IdentitiesApiFp = function (configuration) {
|
|
|
860
990
|
});
|
|
861
991
|
});
|
|
862
992
|
},
|
|
993
|
+
/**
|
|
994
|
+
* List identities from the identities 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. `privilegeLevel` is returned when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is enabled. When the flag is disabled, `privilegeLevel` is null and a filter or sort on `privilegeLevel.effective` is rejected. When the flag is enabled, an identity with no privilege level is returned as `NONE`. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase: `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level matches `privilegeLevel.effective eq \"NONE\"` and does not match `isnull`.
|
|
995
|
+
* @summary List identities (search)
|
|
996
|
+
* @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.
|
|
997
|
+
* @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.
|
|
998
|
+
* @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.
|
|
999
|
+
* @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=John Mathews,01f04e428c484542a241dc89c303b178&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.
|
|
1000
|
+
* @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, sw* **name**: *eq, in, sw, isnull, pr* **alias**: *eq, in, sw, isnull, pr* **type**: *eq, in, sw, isnull, pr* **emailAddress**: *eq, in, sw, isnull, pr* **identityStatus**: *eq, in, sw, isnull, pr* **processingState**: *eq, in, sw, isnull, pr* **protected**: *eq* **correlated**: *eq* **inactive**: *eq* **isManager**: *eq* **locked**: *eq* **disabled**: *eq* **manager.id**: *eq, in, sw* **manager.name**: *eq, in, sw, isnull, pr* **manager.type**: *eq, in, sw, isnull, pr* **lifecycleState.stateName**: *eq, in, sw, isnull, pr* **lifecycleState.manuallyUpdated**: *eq* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* **synced**: *eq, ge, gt, le, lt* **lastRefresh**: *eq, ge, gt, le, lt* **privilegeLevel.effective**: *eq, in, isnull, pr*
|
|
1001
|
+
* @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: **id, name, alias, type, emailAddress, identityStatus, processingState, protected, correlated, inactive, isManager, locked, disabled, manager.id, manager.name, manager.type, lifecycleState.stateName, lifecycleState.manuallyUpdated, created, modified, synced, lastRefresh, privilegeLevel.effective** Sorting on **privilegeLevel.effective** is case-insensitive and is accepted only when `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` is enabled. Returned values are uppercase. Default sort is **created** when no collection parameters are sent.
|
|
1002
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1003
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1004
|
+
* @throws {RequiredError}
|
|
1005
|
+
*/
|
|
1006
|
+
listIdentitiesV2: function (limit, offset, count, searchAfter, filters, sorters, xSailPointExperimental, axiosOptions) {
|
|
1007
|
+
var _a, _b, _c;
|
|
1008
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1009
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1010
|
+
return __generator(this, function (_d) {
|
|
1011
|
+
switch (_d.label) {
|
|
1012
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listIdentitiesV2(limit, offset, count, searchAfter, filters, sorters, xSailPointExperimental, axiosOptions)];
|
|
1013
|
+
case 1:
|
|
1014
|
+
localVarAxiosArgs = _d.sent();
|
|
1015
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1016
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['IdentitiesApi.listIdentitiesV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1017
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1018
|
+
}
|
|
1019
|
+
});
|
|
1020
|
+
});
|
|
1021
|
+
},
|
|
863
1022
|
/**
|
|
864
1023
|
* Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.
|
|
865
1024
|
* @summary Reset an identity
|
|
@@ -1020,6 +1179,16 @@ var IdentitiesApiFactory = function (configuration, basePath, axios) {
|
|
|
1020
1179
|
getIdentityV1: function (requestParameters, axiosOptions) {
|
|
1021
1180
|
return localVarFp.getIdentityV1(requestParameters.id, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1022
1181
|
},
|
|
1182
|
+
/**
|
|
1183
|
+
* This API returns a single identity from the identities search index. `privilegeLevel.effective` is `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level is returned as `NONE`. `privilegeLevel` is null when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is disabled. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase.
|
|
1184
|
+
* @summary Identity details (search)
|
|
1185
|
+
* @param {IdentitiesApiGetIdentityV2Request} requestParameters Request parameters.
|
|
1186
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1187
|
+
* @throws {RequiredError}
|
|
1188
|
+
*/
|
|
1189
|
+
getIdentityV2: function (requestParameters, axiosOptions) {
|
|
1190
|
+
return localVarFp.getIdentityV2(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1191
|
+
},
|
|
1023
1192
|
/**
|
|
1024
1193
|
*
|
|
1025
1194
|
* @summary Role assignment details
|
|
@@ -1061,6 +1230,17 @@ var IdentitiesApiFactory = function (configuration, basePath, axios) {
|
|
|
1061
1230
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1062
1231
|
return localVarFp.listIdentitiesV1(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1063
1232
|
},
|
|
1233
|
+
/**
|
|
1234
|
+
* List identities from the identities 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. `privilegeLevel` is returned when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is enabled. When the flag is disabled, `privilegeLevel` is null and a filter or sort on `privilegeLevel.effective` is rejected. When the flag is enabled, an identity with no privilege level is returned as `NONE`. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase: `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level matches `privilegeLevel.effective eq \"NONE\"` and does not match `isnull`.
|
|
1235
|
+
* @summary List identities (search)
|
|
1236
|
+
* @param {IdentitiesApiListIdentitiesV2Request} requestParameters Request parameters.
|
|
1237
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1238
|
+
* @throws {RequiredError}
|
|
1239
|
+
*/
|
|
1240
|
+
listIdentitiesV2: function (requestParameters, axiosOptions) {
|
|
1241
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1242
|
+
return localVarFp.listIdentitiesV2(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1243
|
+
},
|
|
1064
1244
|
/**
|
|
1065
1245
|
* Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.
|
|
1066
1246
|
* @summary Reset an identity
|
|
@@ -1161,6 +1341,18 @@ var IdentitiesApi = /** @class */ (function (_super) {
|
|
|
1161
1341
|
var _this = this;
|
|
1162
1342
|
return (0, exports.IdentitiesApiFp)(this.configuration).getIdentityV1(requestParameters.id, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1163
1343
|
};
|
|
1344
|
+
/**
|
|
1345
|
+
* This API returns a single identity from the identities search index. `privilegeLevel.effective` is `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level is returned as `NONE`. `privilegeLevel` is null when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is disabled. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase.
|
|
1346
|
+
* @summary Identity details (search)
|
|
1347
|
+
* @param {IdentitiesApiGetIdentityV2Request} requestParameters Request parameters.
|
|
1348
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1349
|
+
* @throws {RequiredError}
|
|
1350
|
+
* @memberof IdentitiesApi
|
|
1351
|
+
*/
|
|
1352
|
+
IdentitiesApi.prototype.getIdentityV2 = function (requestParameters, axiosOptions) {
|
|
1353
|
+
var _this = this;
|
|
1354
|
+
return (0, exports.IdentitiesApiFp)(this.configuration).getIdentityV2(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1355
|
+
};
|
|
1164
1356
|
/**
|
|
1165
1357
|
*
|
|
1166
1358
|
* @summary Role assignment details
|
|
@@ -1210,6 +1402,19 @@ var IdentitiesApi = /** @class */ (function (_super) {
|
|
|
1210
1402
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1211
1403
|
return (0, exports.IdentitiesApiFp)(this.configuration).listIdentitiesV1(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1212
1404
|
};
|
|
1405
|
+
/**
|
|
1406
|
+
* List identities from the identities 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. `privilegeLevel` is returned when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is enabled. When the flag is disabled, `privilegeLevel` is null and a filter or sort on `privilegeLevel.effective` is rejected. When the flag is enabled, an identity with no privilege level is returned as `NONE`. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase: `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level matches `privilegeLevel.effective eq \"NONE\"` and does not match `isnull`.
|
|
1407
|
+
* @summary List identities (search)
|
|
1408
|
+
* @param {IdentitiesApiListIdentitiesV2Request} requestParameters Request parameters.
|
|
1409
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1410
|
+
* @throws {RequiredError}
|
|
1411
|
+
* @memberof IdentitiesApi
|
|
1412
|
+
*/
|
|
1413
|
+
IdentitiesApi.prototype.listIdentitiesV2 = function (requestParameters, axiosOptions) {
|
|
1414
|
+
var _this = this;
|
|
1415
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1416
|
+
return (0, exports.IdentitiesApiFp)(this.configuration).listIdentitiesV2(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1417
|
+
};
|
|
1213
1418
|
/**
|
|
1214
1419
|
* Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.
|
|
1215
1420
|
* @summary Reset an identity
|