sailpoint-api-client 2.1.1 → 2.1.2
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/access_profiles/api.ts +4 -4
- package/access_profiles/docs/Methods/AccessProfilesApi.md +1 -1
- package/access_requests/api.ts +8 -8
- package/access_requests/docs/Methods/AccessRequestsApi.md +5 -5
- package/account_aggregations/docs/Methods/AccountAggregationsApi.md +1 -1
- package/accounts/api.ts +4 -4
- package/accounts/docs/Methods/AccountsApi.md +1 -1
- package/approvals/docs/Methods/ApprovalsApi.md +1 -1
- package/custom_password_instructions/docs/Methods/CustomPasswordInstructionsApi.md +2 -2
- package/dimensions/api.ts +4 -4
- package/dimensions/docs/Methods/DimensionsApi.md +1 -1
- package/dist/access_profiles/api.d.ts +4 -4
- package/dist/access_profiles/api.js +4 -4
- package/dist/access_requests/api.d.ts +8 -8
- package/dist/access_requests/api.js +8 -8
- package/dist/accounts/api.d.ts +4 -4
- package/dist/accounts/api.js +4 -4
- package/dist/dimensions/api.d.ts +4 -4
- package/dist/dimensions/api.js +4 -4
- package/dist/entitlements/api.d.ts +8 -8
- package/dist/entitlements/api.js +8 -8
- package/dist/identities/api.d.ts +8 -8
- package/dist/identities/api.js +8 -8
- package/dist/jit_activations/api.d.ts +491 -0
- package/dist/jit_activations/api.js +210 -0
- package/dist/jit_activations/api.js.map +1 -1
- package/dist/lifecycle_states/api.d.ts +1 -1
- package/dist/nerm/common.js +2 -2
- package/dist/nermv2025/common.js +2 -2
- package/dist/notifications/api.d.ts +4 -4
- package/dist/notifications/api.js +4 -4
- package/dist/password_management/api.d.ts +4 -4
- package/dist/password_management/api.js +4 -4
- package/dist/requestable_objects/api.d.ts +4 -4
- package/dist/requestable_objects/api.js +4 -4
- package/dist/roles/api.d.ts +5 -5
- package/dist/roles/api.js +4 -4
- package/dist/sources/api.d.ts +4 -4
- package/dist/sources/api.js +4 -4
- package/dist/triggers/api.d.ts +1 -1
- package/dist/workflows/api.d.ts +4 -4
- package/dist/workflows/api.js +4 -4
- package/entitlements/api.ts +8 -8
- package/entitlements/docs/Methods/EntitlementsApi.md +2 -2
- package/identities/api.ts +8 -8
- package/identities/docs/Methods/IdentitiesApi.md +2 -2
- package/jit_activations/.openapi-generator/FILES +7 -0
- package/jit_activations/api.ts +611 -0
- package/jit_activations/docs/Examples/typescript_code_examples_overlay.yaml +38 -0
- package/jit_activations/docs/Methods/JITActivationsApi.md +113 -1
- package/jit_activations/docs/Models/Jitactivationhistorydocument.md +45 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentFrictionsInner.md +22 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummary.md +22 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummaryJustification.md +20 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummaryPolicyMatchesInner.md +20 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummaryReauthentication.md +20 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummaryServiceNowTicket.md +21 -0
- package/lifecycle_states/api.ts +1 -1
- package/lifecycle_states/docs/Models/SetLifecycleStateV1200Response.md +1 -1
- package/nerm/README.md +2 -2
- package/nerm/common.ts +2 -2
- package/nerm/package.json +1 -1
- package/nermv2025/README.md +2 -2
- package/nermv2025/common.ts +2 -2
- package/nermv2025/package.json +1 -1
- package/notifications/api.ts +4 -4
- package/notifications/docs/Methods/NotificationsApi.md +1 -1
- package/package.json +1 -1
- package/password_dictionary/docs/Methods/PasswordDictionaryApi.md +1 -1
- package/password_management/api.ts +4 -4
- package/password_management/docs/Methods/PasswordManagementApi.md +2 -2
- package/public_identities/docs/Methods/PublicIdentitiesApi.md +1 -1
- package/public_identities_config/docs/Methods/PublicIdentitiesConfigApi.md +1 -1
- package/requestable_objects/api.ts +4 -4
- package/requestable_objects/docs/Methods/RequestableObjectsApi.md +3 -3
- package/roles/api.ts +5 -5
- package/roles/docs/Methods/RolesApi.md +1 -1
- package/saved_search/docs/Methods/SavedSearchApi.md +1 -1
- package/search_attribute_configuration/docs/Methods/SearchAttributeConfigurationApi.md +1 -1
- package/sources/api.ts +4 -4
- package/sources/docs/Methods/SourcesApi.md +1 -1
- package/triggers/api.ts +1 -1
- package/triggers/docs/Models/AccessRequestDynamicApprover.md +1 -1
- package/workflows/api.ts +4 -4
- package/workflows/docs/Methods/WorkflowsApi.md +1 -1
|
@@ -231,7 +231,7 @@ export type RequestableObjectType = typeof RequestableObjectType[keyof typeof Re
|
|
|
231
231
|
*/
|
|
232
232
|
export declare const RequestableObjectsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
233
233
|
/**
|
|
234
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/
|
|
234
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/list-entitlements-v-1) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
235
235
|
* @summary Requestable objects list
|
|
236
236
|
* @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
|
|
237
237
|
* @param {Array<ListRequestableObjectsV1TypesEnum>} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
@@ -253,7 +253,7 @@ export declare const RequestableObjectsApiAxiosParamCreator: (configuration?: Co
|
|
|
253
253
|
*/
|
|
254
254
|
export declare const RequestableObjectsApiFp: (configuration?: Configuration) => {
|
|
255
255
|
/**
|
|
256
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/
|
|
256
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/list-entitlements-v-1) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
257
257
|
* @summary Requestable objects list
|
|
258
258
|
* @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
|
|
259
259
|
* @param {Array<ListRequestableObjectsV1TypesEnum>} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
@@ -275,7 +275,7 @@ export declare const RequestableObjectsApiFp: (configuration?: Configuration) =>
|
|
|
275
275
|
*/
|
|
276
276
|
export declare const RequestableObjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
277
277
|
/**
|
|
278
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/
|
|
278
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/list-entitlements-v-1) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
279
279
|
* @summary Requestable objects list
|
|
280
280
|
* @param {RequestableObjectsApiListRequestableObjectsV1Request} requestParameters Request parameters.
|
|
281
281
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -352,7 +352,7 @@ export interface RequestableObjectsApiListRequestableObjectsV1Request {
|
|
|
352
352
|
*/
|
|
353
353
|
export declare class RequestableObjectsApi extends BaseAPI {
|
|
354
354
|
/**
|
|
355
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/
|
|
355
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/list-entitlements-v-1) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
356
356
|
* @summary Requestable objects list
|
|
357
357
|
* @param {RequestableObjectsApiListRequestableObjectsV1Request} requestParameters Request parameters.
|
|
358
358
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -122,7 +122,7 @@ var RequestableObjectsApiAxiosParamCreator = function (configuration) {
|
|
|
122
122
|
var _this = this;
|
|
123
123
|
return {
|
|
124
124
|
/**
|
|
125
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/
|
|
125
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/list-entitlements-v-1) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
126
126
|
* @summary Requestable objects list
|
|
127
127
|
* @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
|
|
128
128
|
* @param {Array<ListRequestableObjectsV1TypesEnum>} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
@@ -197,7 +197,7 @@ var RequestableObjectsApiFp = function (configuration) {
|
|
|
197
197
|
var localVarAxiosParamCreator = (0, exports.RequestableObjectsApiAxiosParamCreator)(configuration);
|
|
198
198
|
return {
|
|
199
199
|
/**
|
|
200
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/
|
|
200
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/list-entitlements-v-1) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
201
201
|
* @summary Requestable objects list
|
|
202
202
|
* @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
|
|
203
203
|
* @param {Array<ListRequestableObjectsV1TypesEnum>} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
@@ -238,7 +238,7 @@ var RequestableObjectsApiFactory = function (configuration, basePath, axios) {
|
|
|
238
238
|
var localVarFp = (0, exports.RequestableObjectsApiFp)(configuration);
|
|
239
239
|
return {
|
|
240
240
|
/**
|
|
241
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/
|
|
241
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/list-entitlements-v-1) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
242
242
|
* @summary Requestable objects list
|
|
243
243
|
* @param {RequestableObjectsApiListRequestableObjectsV1Request} requestParameters Request parameters.
|
|
244
244
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -263,7 +263,7 @@ var RequestableObjectsApi = /** @class */ (function (_super) {
|
|
|
263
263
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
264
264
|
}
|
|
265
265
|
/**
|
|
266
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/
|
|
266
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/list-entitlements-v-1) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
267
267
|
* @summary Requestable objects list
|
|
268
268
|
* @param {RequestableObjectsApiListRequestableObjectsV1Request} requestParameters Request parameters.
|
|
269
269
|
* @param {*} [axiosOptions] Override http request option.
|
package/dist/roles/api.d.ts
CHANGED
|
@@ -1531,7 +1531,7 @@ export interface RoleMetadataBulkUpdateByIdRequestValuesInner {
|
|
|
1531
1531
|
'values': Array<string> | null;
|
|
1532
1532
|
}
|
|
1533
1533
|
/**
|
|
1534
|
-
* Bulk update by query request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. For more information about the query could refer to [V3 API Perform Search](https://developer.sailpoint.com/docs/api/
|
|
1534
|
+
* Bulk update by query request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. For more information about the query could refer to [V3 API Perform Search](https://developer.sailpoint.com/docs/api/search-post-v-1)
|
|
1535
1535
|
* @export
|
|
1536
1536
|
* @interface RoleMetadataBulkUpdateByQueryRequest
|
|
1537
1537
|
*/
|
|
@@ -1634,7 +1634,7 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1634
1634
|
*/
|
|
1635
1635
|
createRoleV1: (role: Role, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1636
1636
|
/**
|
|
1637
|
-
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
1637
|
+
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
1638
1638
|
* @summary Delete role(s)
|
|
1639
1639
|
* @param {RoleBulkDeleteRequest} roleBulkDeleteRequest
|
|
1640
1640
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1797,7 +1797,7 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
1797
1797
|
*/
|
|
1798
1798
|
createRoleV1(role: Role, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Role>>;
|
|
1799
1799
|
/**
|
|
1800
|
-
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
1800
|
+
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
1801
1801
|
* @summary Delete role(s)
|
|
1802
1802
|
* @param {RoleBulkDeleteRequest} roleBulkDeleteRequest
|
|
1803
1803
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1960,7 +1960,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1960
1960
|
*/
|
|
1961
1961
|
createRoleV1(requestParameters: RolesApiCreateRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Role>;
|
|
1962
1962
|
/**
|
|
1963
|
-
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
1963
|
+
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
1964
1964
|
* @summary Delete role(s)
|
|
1965
1965
|
* @param {RolesApiDeleteBulkRolesV1Request} requestParameters Request parameters.
|
|
1966
1966
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -2471,7 +2471,7 @@ export declare class RolesApi extends BaseAPI {
|
|
|
2471
2471
|
*/
|
|
2472
2472
|
createRoleV1(requestParameters: RolesApiCreateRoleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Role, any>>;
|
|
2473
2473
|
/**
|
|
2474
|
-
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
2474
|
+
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
2475
2475
|
* @summary Delete role(s)
|
|
2476
2476
|
* @param {RolesApiDeleteBulkRolesV1Request} requestParameters Request parameters.
|
|
2477
2477
|
* @param {*} [axiosOptions] Override http request option.
|
package/dist/roles/api.js
CHANGED
|
@@ -307,7 +307,7 @@ var RolesApiAxiosParamCreator = function (configuration) {
|
|
|
307
307
|
});
|
|
308
308
|
},
|
|
309
309
|
/**
|
|
310
|
-
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
310
|
+
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
311
311
|
* @summary Delete role(s)
|
|
312
312
|
* @param {RoleBulkDeleteRequest} roleBulkDeleteRequest
|
|
313
313
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -958,7 +958,7 @@ var RolesApiFp = function (configuration) {
|
|
|
958
958
|
});
|
|
959
959
|
},
|
|
960
960
|
/**
|
|
961
|
-
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
961
|
+
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
962
962
|
* @summary Delete role(s)
|
|
963
963
|
* @param {RoleBulkDeleteRequest} roleBulkDeleteRequest
|
|
964
964
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1352,7 +1352,7 @@ var RolesApiFactory = function (configuration, basePath, axios) {
|
|
|
1352
1352
|
return localVarFp.createRoleV1(requestParameters.role, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1353
1353
|
},
|
|
1354
1354
|
/**
|
|
1355
|
-
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
1355
|
+
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
1356
1356
|
* @summary Delete role(s)
|
|
1357
1357
|
* @param {RolesApiDeleteBulkRolesV1Request} requestParameters Request parameters.
|
|
1358
1358
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1529,7 +1529,7 @@ var RolesApi = /** @class */ (function (_super) {
|
|
|
1529
1529
|
return (0, exports.RolesApiFp)(this.configuration).createRoleV1(requestParameters.role, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1530
1530
|
};
|
|
1531
1531
|
/**
|
|
1532
|
-
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
1532
|
+
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
1533
1533
|
* @summary Delete role(s)
|
|
1534
1534
|
* @param {RolesApiDeleteBulkRolesV1Request} requestParameters Request parameters.
|
|
1535
1535
|
* @param {*} [axiosOptions] Override http request option.
|
package/dist/sources/api.d.ts
CHANGED
|
@@ -3857,7 +3857,7 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3857
3857
|
*/
|
|
3858
3858
|
updateSourceScheduleV1: (sourceId: string, scheduleType: UpdateSourceScheduleV1ScheduleTypeEnum, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3859
3859
|
/**
|
|
3860
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/
|
|
3860
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
3861
3861
|
* @summary Update source schema (partial)
|
|
3862
3862
|
* @param {string} sourceId The Source id.
|
|
3863
3863
|
* @param {string} schemaId The Schema id.
|
|
@@ -4435,7 +4435,7 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
4435
4435
|
*/
|
|
4436
4436
|
updateSourceScheduleV1(sourceId: string, scheduleType: UpdateSourceScheduleV1ScheduleTypeEnum, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Schedule3>>;
|
|
4437
4437
|
/**
|
|
4438
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/
|
|
4438
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
4439
4439
|
* @summary Update source schema (partial)
|
|
4440
4440
|
* @param {string} sourceId The Source id.
|
|
4441
4441
|
* @param {string} schemaId The Schema id.
|
|
@@ -4940,7 +4940,7 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
4940
4940
|
*/
|
|
4941
4941
|
updateSourceScheduleV1(requestParameters: SourcesApiUpdateSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Schedule3>;
|
|
4942
4942
|
/**
|
|
4943
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/
|
|
4943
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
4944
4944
|
* @summary Update source schema (partial)
|
|
4945
4945
|
* @param {SourcesApiUpdateSourceSchemaV1Request} requestParameters Request parameters.
|
|
4946
4946
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -6766,7 +6766,7 @@ export declare class SourcesApi extends BaseAPI {
|
|
|
6766
6766
|
*/
|
|
6767
6767
|
updateSourceScheduleV1(requestParameters: SourcesApiUpdateSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Schedule3, any>>;
|
|
6768
6768
|
/**
|
|
6769
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/
|
|
6769
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
6770
6770
|
* @summary Update source schema (partial)
|
|
6771
6771
|
* @param {SourcesApiUpdateSourceSchemaV1Request} requestParameters Request parameters.
|
|
6772
6772
|
* @param {*} [axiosOptions] Override http request option.
|
package/dist/sources/api.js
CHANGED
|
@@ -2943,7 +2943,7 @@ var SourcesApiAxiosParamCreator = function (configuration) {
|
|
|
2943
2943
|
});
|
|
2944
2944
|
},
|
|
2945
2945
|
/**
|
|
2946
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/
|
|
2946
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
2947
2947
|
* @summary Update source schema (partial)
|
|
2948
2948
|
* @param {string} sourceId The Source id.
|
|
2949
2949
|
* @param {string} schemaId The Schema id.
|
|
@@ -4486,7 +4486,7 @@ var SourcesApiFp = function (configuration) {
|
|
|
4486
4486
|
});
|
|
4487
4487
|
},
|
|
4488
4488
|
/**
|
|
4489
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/
|
|
4489
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
4490
4490
|
* @summary Update source schema (partial)
|
|
4491
4491
|
* @param {string} sourceId The Source id.
|
|
4492
4492
|
* @param {string} schemaId The Schema id.
|
|
@@ -5146,7 +5146,7 @@ var SourcesApiFactory = function (configuration, basePath, axios) {
|
|
|
5146
5146
|
return localVarFp.updateSourceScheduleV1(requestParameters.sourceId, requestParameters.scheduleType, requestParameters.jsonPatchOperation, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
5147
5147
|
},
|
|
5148
5148
|
/**
|
|
5149
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/
|
|
5149
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
5150
5150
|
* @summary Update source schema (partial)
|
|
5151
5151
|
* @param {SourcesApiUpdateSourceSchemaV1Request} requestParameters Request parameters.
|
|
5152
5152
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -5901,7 +5901,7 @@ var SourcesApi = /** @class */ (function (_super) {
|
|
|
5901
5901
|
return (0, exports.SourcesApiFp)(this.configuration).updateSourceScheduleV1(requestParameters.sourceId, requestParameters.scheduleType, requestParameters.jsonPatchOperation, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
5902
5902
|
};
|
|
5903
5903
|
/**
|
|
5904
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/
|
|
5904
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
5905
5905
|
* @summary Update source schema (partial)
|
|
5906
5906
|
* @param {SourcesApiUpdateSourceSchemaV1Request} requestParameters Request parameters.
|
|
5907
5907
|
* @param {*} [axiosOptions] Override http request option.
|
package/dist/triggers/api.d.ts
CHANGED
|
@@ -107,7 +107,7 @@ export type AccessItemRequesterDtoTypeEnum = typeof AccessItemRequesterDtoTypeEn
|
|
|
107
107
|
*/
|
|
108
108
|
export interface AccessRequestDynamicApprover {
|
|
109
109
|
/**
|
|
110
|
-
* The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/
|
|
110
|
+
* The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/docs/api/list-access-request-status-v-1) to get the status of the request.
|
|
111
111
|
* @type {string}
|
|
112
112
|
* @memberof AccessRequestDynamicApprover
|
|
113
113
|
*/
|
package/dist/workflows/api.d.ts
CHANGED
|
@@ -1144,7 +1144,7 @@ export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1144
1144
|
*/
|
|
1145
1145
|
getWorkflowExecutionV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1146
1146
|
/**
|
|
1147
|
-
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/
|
|
1147
|
+
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
|
|
1148
1148
|
* @summary List workflow executions
|
|
1149
1149
|
* @param {string} id Workflow ID.
|
|
1150
1150
|
* @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.
|
|
@@ -1314,7 +1314,7 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
|
|
|
1314
1314
|
*/
|
|
1315
1315
|
getWorkflowExecutionV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowExecution>>>;
|
|
1316
1316
|
/**
|
|
1317
|
-
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/
|
|
1317
|
+
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
|
|
1318
1318
|
* @summary List workflow executions
|
|
1319
1319
|
* @param {string} id Workflow ID.
|
|
1320
1320
|
* @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.
|
|
@@ -1483,7 +1483,7 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
|
|
|
1483
1483
|
*/
|
|
1484
1484
|
getWorkflowExecutionV1(requestParameters: WorkflowsApiGetWorkflowExecutionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowExecution>>;
|
|
1485
1485
|
/**
|
|
1486
|
-
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/
|
|
1486
|
+
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
|
|
1487
1487
|
* @summary List workflow executions
|
|
1488
1488
|
* @param {WorkflowsApiGetWorkflowExecutionsV1Request} requestParameters Request parameters.
|
|
1489
1489
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1949,7 +1949,7 @@ export declare class WorkflowsApi extends BaseAPI {
|
|
|
1949
1949
|
*/
|
|
1950
1950
|
getWorkflowExecutionV1(requestParameters: WorkflowsApiGetWorkflowExecutionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowExecution[], any>>;
|
|
1951
1951
|
/**
|
|
1952
|
-
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/
|
|
1952
|
+
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
|
|
1953
1953
|
* @summary List workflow executions
|
|
1954
1954
|
* @param {WorkflowsApiGetWorkflowExecutionsV1Request} requestParameters Request parameters.
|
|
1955
1955
|
* @param {*} [axiosOptions] Override http request option.
|
package/dist/workflows/api.js
CHANGED
|
@@ -451,7 +451,7 @@ var WorkflowsApiAxiosParamCreator = function (configuration) {
|
|
|
451
451
|
});
|
|
452
452
|
},
|
|
453
453
|
/**
|
|
454
|
-
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/
|
|
454
|
+
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
|
|
455
455
|
* @summary List workflow executions
|
|
456
456
|
* @param {string} id Workflow ID.
|
|
457
457
|
* @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.
|
|
@@ -1052,7 +1052,7 @@ var WorkflowsApiFp = function (configuration) {
|
|
|
1052
1052
|
});
|
|
1053
1053
|
},
|
|
1054
1054
|
/**
|
|
1055
|
-
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/
|
|
1055
|
+
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
|
|
1056
1056
|
* @summary List workflow executions
|
|
1057
1057
|
* @param {string} id Workflow ID.
|
|
1058
1058
|
* @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.
|
|
@@ -1406,7 +1406,7 @@ var WorkflowsApiFactory = function (configuration, basePath, axios) {
|
|
|
1406
1406
|
return localVarFp.getWorkflowExecutionV1(requestParameters.id, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1407
1407
|
},
|
|
1408
1408
|
/**
|
|
1409
|
-
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/
|
|
1409
|
+
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
|
|
1410
1410
|
* @summary List workflow executions
|
|
1411
1411
|
* @param {WorkflowsApiGetWorkflowExecutionsV1Request} requestParameters Request parameters.
|
|
1412
1412
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1628,7 +1628,7 @@ var WorkflowsApi = /** @class */ (function (_super) {
|
|
|
1628
1628
|
return (0, exports.WorkflowsApiFp)(this.configuration).getWorkflowExecutionV1(requestParameters.id, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1629
1629
|
};
|
|
1630
1630
|
/**
|
|
1631
|
-
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/
|
|
1631
|
+
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
|
|
1632
1632
|
* @summary List workflow executions
|
|
1633
1633
|
* @param {WorkflowsApiGetWorkflowExecutionsV1Request} requestParameters Request parameters.
|
|
1634
1634
|
* @param {*} [axiosOptions] Override http request option.
|
package/entitlements/api.ts
CHANGED
|
@@ -1202,7 +1202,7 @@ export const EntitlementsApiAxiosParamCreator = function (configuration?: Config
|
|
|
1202
1202
|
};
|
|
1203
1203
|
},
|
|
1204
1204
|
/**
|
|
1205
|
-
* Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/
|
|
1205
|
+
* Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/import-entitlements-v-1). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`.
|
|
1206
1206
|
* @summary Aggregate entitlements
|
|
1207
1207
|
* @param {string} id Source Id
|
|
1208
1208
|
* @param {File} [csvFile] The CSV file containing the source entitlements to aggregate.
|
|
@@ -1586,7 +1586,7 @@ export const EntitlementsApiAxiosParamCreator = function (configuration?: Config
|
|
|
1586
1586
|
};
|
|
1587
1587
|
},
|
|
1588
1588
|
/**
|
|
1589
|
-
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/
|
|
1589
|
+
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/import-accounts-v-1) with `disableOptimization` = `true`.
|
|
1590
1590
|
* @summary Reset source entitlements
|
|
1591
1591
|
* @param {string} id ID of source for the entitlement reset
|
|
1592
1592
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1722,7 +1722,7 @@ export const EntitlementsApiFp = function(configuration?: Configuration) {
|
|
|
1722
1722
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1723
1723
|
},
|
|
1724
1724
|
/**
|
|
1725
|
-
* Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/
|
|
1725
|
+
* Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/import-entitlements-v-1). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`.
|
|
1726
1726
|
* @summary Aggregate entitlements
|
|
1727
1727
|
* @param {string} id Source Id
|
|
1728
1728
|
* @param {File} [csvFile] The CSV file containing the source entitlements to aggregate.
|
|
@@ -1842,7 +1842,7 @@ export const EntitlementsApiFp = function(configuration?: Configuration) {
|
|
|
1842
1842
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1843
1843
|
},
|
|
1844
1844
|
/**
|
|
1845
|
-
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/
|
|
1845
|
+
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/import-accounts-v-1) with `disableOptimization` = `true`.
|
|
1846
1846
|
* @summary Reset source entitlements
|
|
1847
1847
|
* @param {string} id ID of source for the entitlement reset
|
|
1848
1848
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1918,7 +1918,7 @@ export const EntitlementsApiFactory = function (configuration?: Configuration, b
|
|
|
1918
1918
|
return localVarFp.getEntitlementV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath));
|
|
1919
1919
|
},
|
|
1920
1920
|
/**
|
|
1921
|
-
* Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/
|
|
1921
|
+
* Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/import-entitlements-v-1). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`.
|
|
1922
1922
|
* @summary Aggregate entitlements
|
|
1923
1923
|
* @param {EntitlementsApiImportEntitlementsBySourceV1Request} requestParameters Request parameters.
|
|
1924
1924
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1989,7 +1989,7 @@ export const EntitlementsApiFactory = function (configuration?: Configuration, b
|
|
|
1989
1989
|
return localVarFp.putEntitlementRequestConfigV1(requestParameters.id, requestParameters.entitlementRequestConfig, axiosOptions).then((request) => request(axios, basePath));
|
|
1990
1990
|
},
|
|
1991
1991
|
/**
|
|
1992
|
-
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/
|
|
1992
|
+
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/import-accounts-v-1) with `disableOptimization` = `true`.
|
|
1993
1993
|
* @summary Reset source entitlements
|
|
1994
1994
|
* @param {EntitlementsApiResetSourceEntitlementsV1Request} requestParameters Request parameters.
|
|
1995
1995
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -2473,7 +2473,7 @@ export class EntitlementsApi extends BaseAPI {
|
|
|
2473
2473
|
}
|
|
2474
2474
|
|
|
2475
2475
|
/**
|
|
2476
|
-
* Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/
|
|
2476
|
+
* Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/import-entitlements-v-1). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`.
|
|
2477
2477
|
* @summary Aggregate entitlements
|
|
2478
2478
|
* @param {EntitlementsApiImportEntitlementsBySourceV1Request} requestParameters Request parameters.
|
|
2479
2479
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -2558,7 +2558,7 @@ export class EntitlementsApi extends BaseAPI {
|
|
|
2558
2558
|
}
|
|
2559
2559
|
|
|
2560
2560
|
/**
|
|
2561
|
-
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/
|
|
2561
|
+
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/import-accounts-v-1) with `disableOptimization` = `true`.
|
|
2562
2562
|
* @summary Reset source entitlements
|
|
2563
2563
|
* @param {EntitlementsApiResetSourceEntitlementsV1Request} requestParameters Request parameters.
|
|
2564
2564
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -191,7 +191,7 @@ console.log(result);
|
|
|
191
191
|
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
|
|
192
192
|
:::
|
|
193
193
|
Aggregate entitlements
|
|
194
|
-
Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/
|
|
194
|
+
Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/import-entitlements-v-1).
|
|
195
195
|
|
|
196
196
|
If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error.
|
|
197
197
|
|
|
@@ -548,7 +548,7 @@ console.log(result);
|
|
|
548
548
|
## reset-source-entitlements-v1
|
|
549
549
|
Reset source entitlements
|
|
550
550
|
Remove all entitlements from a specific source.
|
|
551
|
-
To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/
|
|
551
|
+
To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/import-accounts-v-1) with `disableOptimization` = `true`.
|
|
552
552
|
|
|
553
553
|
[API Spec](https://developer.sailpoint.com/docs/api/reset-source-entitlements-v-1)
|
|
554
554
|
|