@sailpoint/api-client 2.2.25 → 2.2.27

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.
@@ -246,8 +246,8 @@ export var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH,
246
246
  // header such as X-SailPoint-SDK forces a CORS preflight that tenants do
247
247
  // not allow, which blocks the request outright.
248
248
  if (typeof process !== 'undefined' && ((_a = process.versions) === null || _a === void 0 ? void 0 : _a.node)) {
249
- headers['X-SailPoint-SDK'] = 'typescript-2.2.25';
250
- userAgent = "SailPoint-SDK-TypeScript/2.2.25";
249
+ headers['X-SailPoint-SDK'] = 'typescript-2.2.27';
250
+ userAgent = "SailPoint-SDK-TypeScript/2.2.27";
251
251
  if ((configuration === null || configuration === void 0 ? void 0 : configuration.consumerIdentifier) && (configuration === null || configuration === void 0 ? void 0 : configuration.consumerVersion)) {
252
252
  userAgent += " (".concat(configuration.consumerIdentifier, "/").concat(configuration.consumerVersion, ")");
253
253
  }
@@ -246,8 +246,8 @@ export var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH,
246
246
  // header such as X-SailPoint-SDK forces a CORS preflight that tenants do
247
247
  // not allow, which blocks the request outright.
248
248
  if (typeof process !== 'undefined' && ((_a = process.versions) === null || _a === void 0 ? void 0 : _a.node)) {
249
- headers['X-SailPoint-SDK'] = 'typescript-2.2.25';
250
- userAgent = "SailPoint-SDK-TypeScript/2.2.25";
249
+ headers['X-SailPoint-SDK'] = 'typescript-2.2.27';
250
+ userAgent = "SailPoint-SDK-TypeScript/2.2.27";
251
251
  if ((configuration === null || configuration === void 0 ? void 0 : configuration.consumerIdentifier) && (configuration === null || configuration === void 0 ? void 0 : configuration.consumerVersion)) {
252
252
  userAgent += " (".concat(configuration.consumerIdentifier, "/").concat(configuration.consumerVersion, ")");
253
253
  }
@@ -250,7 +250,7 @@ export var SearchApiAxiosParamCreator = function (configuration) {
250
250
  });
251
251
  },
252
252
  /**
253
- * Fetches a single document from the specified index, using the specified document ID.
253
+ * Fetches a single document from the specified index, using the specified document ID. **Note:** Response fields with an underscore (`_`) prefix, such as `_type` and `_index`, are internal metadata fields. These fields are for SailPoint internal use only and are subject to change without notice. Do not rely on them in your integrations.
254
254
  * @summary Get a document by id
255
255
  * @param {SearchGetV1IndexEnum} index The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*.
256
256
  * @param {string} id ID of the requested document.
@@ -287,7 +287,7 @@ export var SearchApiAxiosParamCreator = function (configuration) {
287
287
  });
288
288
  },
289
289
  /**
290
- * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. 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. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists).
290
+ * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. 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. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). **Note:** Response fields with an underscore (`_`) prefix, such as `_type` and `_index`, are internal metadata fields. These fields are for SailPoint internal use only and are subject to change without notice. Do not rely on them in your integrations.
291
291
  * @summary Perform search
292
292
  * @param {Search} search
293
293
  * @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.
@@ -391,7 +391,7 @@ export var SearchApiFp = function (configuration) {
391
391
  });
392
392
  },
393
393
  /**
394
- * Fetches a single document from the specified index, using the specified document ID.
394
+ * Fetches a single document from the specified index, using the specified document ID. **Note:** Response fields with an underscore (`_`) prefix, such as `_type` and `_index`, are internal metadata fields. These fields are for SailPoint internal use only and are subject to change without notice. Do not rely on them in your integrations.
395
395
  * @summary Get a document by id
396
396
  * @param {SearchGetV1IndexEnum} index The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*.
397
397
  * @param {string} id ID of the requested document.
@@ -415,7 +415,7 @@ export var SearchApiFp = function (configuration) {
415
415
  });
416
416
  },
417
417
  /**
418
- * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. 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. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists).
418
+ * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. 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. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). **Note:** Response fields with an underscore (`_`) prefix, such as `_type` and `_index`, are internal metadata fields. These fields are for SailPoint internal use only and are subject to change without notice. Do not rely on them in your integrations.
419
419
  * @summary Perform search
420
420
  * @param {Search} search
421
421
  * @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.
@@ -470,7 +470,7 @@ export var SearchApiFactory = function (configuration, basePath, axios) {
470
470
  return localVarFp.searchCountV1(requestParameters.search, axiosOptions).then(function (request) { return request(axios, basePath); });
471
471
  },
472
472
  /**
473
- * Fetches a single document from the specified index, using the specified document ID.
473
+ * Fetches a single document from the specified index, using the specified document ID. **Note:** Response fields with an underscore (`_`) prefix, such as `_type` and `_index`, are internal metadata fields. These fields are for SailPoint internal use only and are subject to change without notice. Do not rely on them in your integrations.
474
474
  * @summary Get a document by id
475
475
  * @param {SearchApiSearchGetV1Request} requestParameters Request parameters.
476
476
  * @param {*} [axiosOptions] Override http request option.
@@ -480,7 +480,7 @@ export var SearchApiFactory = function (configuration, basePath, axios) {
480
480
  return localVarFp.searchGetV1(requestParameters.index, requestParameters.id, axiosOptions).then(function (request) { return request(axios, basePath); });
481
481
  },
482
482
  /**
483
- * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. 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. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists).
483
+ * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. 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. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). **Note:** Response fields with an underscore (`_`) prefix, such as `_type` and `_index`, are internal metadata fields. These fields are for SailPoint internal use only and are subject to change without notice. Do not rely on them in your integrations.
484
484
  * @summary Perform search
485
485
  * @param {SearchApiSearchPostV1Request} requestParameters Request parameters.
486
486
  * @param {*} [axiosOptions] Override http request option.
@@ -527,7 +527,7 @@ var SearchApi = /** @class */ (function (_super) {
527
527
  return SearchApiFp(this.configuration).searchCountV1(requestParameters.search, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
528
528
  };
529
529
  /**
530
- * Fetches a single document from the specified index, using the specified document ID.
530
+ * Fetches a single document from the specified index, using the specified document ID. **Note:** Response fields with an underscore (`_`) prefix, such as `_type` and `_index`, are internal metadata fields. These fields are for SailPoint internal use only and are subject to change without notice. Do not rely on them in your integrations.
531
531
  * @summary Get a document by id
532
532
  * @param {SearchApiSearchGetV1Request} requestParameters Request parameters.
533
533
  * @param {*} [axiosOptions] Override http request option.
@@ -539,7 +539,7 @@ var SearchApi = /** @class */ (function (_super) {
539
539
  return SearchApiFp(this.configuration).searchGetV1(requestParameters.index, requestParameters.id, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
540
540
  };
541
541
  /**
542
- * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. 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. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists).
542
+ * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. 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. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). **Note:** Response fields with an underscore (`_`) prefix, such as `_type` and `_index`, are internal metadata fields. These fields are for SailPoint internal use only and are subject to change without notice. Do not rely on them in your integrations.
543
543
  * @summary Perform search
544
544
  * @param {SearchApiSearchPostV1Request} requestParameters Request parameters.
545
545
  * @param {*} [axiosOptions] Override http request option.
@@ -136,7 +136,9 @@ export var ExceptionCriteriaCriteriaListInnerTypeEnum = {
136
136
  Entitlement: 'ENTITLEMENT'
137
137
  };
138
138
  export var IdentityWithNewAccessAccessRefsInnerTypeEnum = {
139
- Entitlement: 'ENTITLEMENT'
139
+ Entitlement: 'ENTITLEMENT',
140
+ AccessProfile: 'ACCESS_PROFILE',
141
+ Role: 'ROLE'
140
142
  };
141
143
  /**
142
144
  * 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.
@@ -429,7 +431,7 @@ export var SODViolationsApiAxiosParamCreator = function (configuration) {
429
431
  });
430
432
  },
431
433
  /**
432
- * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.
434
+ * This API is used to check if granting some additional accesses (entitlements, access profiles, or roles) would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.
433
435
  * @summary Predict sod violations for identity.
434
436
  * @param {IdentityWithNewAccess} identityWithNewAccess
435
437
  * @param {*} [axiosOptions] Override http request option.
@@ -636,7 +638,7 @@ export var SODViolationsApiFp = function (configuration) {
636
638
  });
637
639
  },
638
640
  /**
639
- * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.
641
+ * This API is used to check if granting some additional accesses (entitlements, access profiles, or roles) would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.
640
642
  * @summary Predict sod violations for identity.
641
643
  * @param {IdentityWithNewAccess} identityWithNewAccess
642
644
  * @param {*} [axiosOptions] Override http request option.
@@ -743,7 +745,7 @@ export var SODViolationsApiFactory = function (configuration, basePath, axios) {
743
745
  return localVarFp.startApplyControlV1(requestParameters.id, requestParameters.appliedcontrolcreate, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
744
746
  },
745
747
  /**
746
- * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.
748
+ * This API is used to check if granting some additional accesses (entitlements, access profiles, or roles) would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.
747
749
  * @summary Predict sod violations for identity.
748
750
  * @param {SODViolationsApiStartPredictSodViolationsV1Request} requestParameters Request parameters.
749
751
  * @param {*} [axiosOptions] Override http request option.
@@ -838,7 +840,7 @@ var SODViolationsApi = /** @class */ (function (_super) {
838
840
  return SODViolationsApiFp(this.configuration).startApplyControlV1(requestParameters.id, requestParameters.appliedcontrolcreate, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
839
841
  };
840
842
  /**
841
- * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.
843
+ * This API is used to check if granting some additional accesses (entitlements, access profiles, or roles) would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.
842
844
  * @summary Predict sod violations for identity.
843
845
  * @param {SODViolationsApiStartPredictSodViolationsV1Request} requestParameters Request parameters.
844
846
  * @param {*} [axiosOptions] Override http request option.
@@ -103,6 +103,18 @@ export interface JitActivationActivateRequest {
103
103
  * @memberof JitActivationActivateRequest
104
104
  */
105
105
  'activationPeriodMins': number;
106
+ /**
107
+ * Origin of the request.
108
+ * @type {string}
109
+ * @memberof JitActivationActivateRequest
110
+ */
111
+ 'requestOrigin'?: string;
112
+ /**
113
+ *
114
+ * @type {JitActivationCallerMetadata}
115
+ * @memberof JitActivationActivateRequest
116
+ */
117
+ 'metaData'?: JitActivationCallerMetadata;
106
118
  }
107
119
  /**
108
120
  *
@@ -147,6 +159,55 @@ export interface JitActivationActivateResponse {
147
159
  */
148
160
  'startTime': string;
149
161
  }
162
+ /**
163
+ * Caller-specific context for the request. Field names depend on the request origin. The properties below apply when the request origin is Slack.
164
+ * @export
165
+ * @interface JitActivationCallerMetadata
166
+ */
167
+ export interface JitActivationCallerMetadata {
168
+ /**
169
+ * Request origin type. Matches `requestOrigin` when both are sent.
170
+ * @type {string}
171
+ * @memberof JitActivationCallerMetadata
172
+ */
173
+ 'type'?: string;
174
+ /**
175
+ * Slack user identifier of the caller.
176
+ * @type {string}
177
+ * @memberof JitActivationCallerMetadata
178
+ */
179
+ 'slackUserId'?: string;
180
+ /**
181
+ * Slack command text that produced this request.
182
+ * @type {string}
183
+ * @memberof JitActivationCallerMetadata
184
+ */
185
+ 'commandText'?: string;
186
+ /**
187
+ * Slack channel identifier.
188
+ * @type {string}
189
+ * @memberof JitActivationCallerMetadata
190
+ */
191
+ 'channelId'?: string;
192
+ /**
193
+ * Slack thread identifier of the message that produced this request.
194
+ * @type {string}
195
+ * @memberof JitActivationCallerMetadata
196
+ */
197
+ 'threadId'?: string;
198
+ /**
199
+ * Slack message identifier of the message that produced this request.
200
+ * @type {string}
201
+ * @memberof JitActivationCallerMetadata
202
+ */
203
+ 'messageId'?: string;
204
+ /**
205
+ * Slack workspace identifier.
206
+ * @type {string}
207
+ * @memberof JitActivationCallerMetadata
208
+ */
209
+ 'workspaceId'?: string;
210
+ }
150
211
  /**
151
212
  *
152
213
  * @export
@@ -159,6 +220,18 @@ export interface JitActivationDeactivateRequest {
159
220
  * @memberof JitActivationDeactivateRequest
160
221
  */
161
222
  'connectionId': string;
223
+ /**
224
+ * Origin of the request.
225
+ * @type {string}
226
+ * @memberof JitActivationDeactivateRequest
227
+ */
228
+ 'requestOrigin'?: string;
229
+ /**
230
+ *
231
+ * @type {JitActivationCallerMetadata}
232
+ * @memberof JitActivationDeactivateRequest
233
+ */
234
+ 'metaData'?: JitActivationCallerMetadata;
162
235
  }
163
236
  /**
164
237
  *
@@ -215,6 +288,18 @@ export interface JitActivationExtendRequest {
215
288
  * @memberof JitActivationExtendRequest
216
289
  */
217
290
  'activationPeriodExtensionMins': number;
291
+ /**
292
+ * Origin of the request.
293
+ * @type {string}
294
+ * @memberof JitActivationExtendRequest
295
+ */
296
+ 'requestOrigin'?: string;
297
+ /**
298
+ *
299
+ * @type {JitActivationCallerMetadata}
300
+ * @memberof JitActivationExtendRequest
301
+ */
302
+ 'metaData'?: JitActivationCallerMetadata;
218
303
  }
219
304
  /**
220
305
  *