sailpoint-api-client 1.7.17 → 1.7.19
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/beta/README.md +2 -2
- package/beta/api.ts +121 -75
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +100 -59
- package/dist/beta/api.js +49 -35
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/v2024/api.d.ts +95 -54
- package/dist/v2024/api.js +46 -32
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v2025/api.d.ts +114 -77
- package/dist/v2025/api.js +58 -48
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +1 -1
- package/dist/v2026/common.js +1 -1
- package/dist/v3/api.d.ts +4 -4
- package/dist/v3/api.js +4 -4
- package/dist/v3/common.js +1 -1
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/api.ts +116 -70
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +137 -95
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v2026/README.md +2 -2
- package/v2026/common.ts +2 -2
- package/v2026/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +4 -4
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/beta/common.js
CHANGED
|
@@ -250,7 +250,7 @@ var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configu
|
|
|
250
250
|
if (axios === void 0) { axios = globalAxios; }
|
|
251
251
|
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
252
252
|
(0, axios_retry_1.default)(axios, configuration.retriesConfig);
|
|
253
|
-
var headers = __assign(__assign({ 'User-Agent': 'OpenAPI-Generator/1.7.
|
|
253
|
+
var headers = __assign(__assign({ 'User-Agent': 'OpenAPI-Generator/1.7.19/ts' }, axiosArgs.axiosOptions.headers), { 'X-SailPoint-SDK': 'typescript-1.7.19' });
|
|
254
254
|
if (!configuration.experimental && ("X-SailPoint-Experimental" in headers)) {
|
|
255
255
|
throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.");
|
|
256
256
|
}
|
package/dist/v2024/api.d.ts
CHANGED
|
@@ -6503,6 +6503,13 @@ export interface ArgumentV2024 {
|
|
|
6503
6503
|
*/
|
|
6504
6504
|
'type'?: string | null;
|
|
6505
6505
|
}
|
|
6506
|
+
/**
|
|
6507
|
+
*
|
|
6508
|
+
* @export
|
|
6509
|
+
* @interface ArrayInner1V2024
|
|
6510
|
+
*/
|
|
6511
|
+
export interface ArrayInner1V2024 {
|
|
6512
|
+
}
|
|
6506
6513
|
/**
|
|
6507
6514
|
*
|
|
6508
6515
|
* @export
|
|
@@ -21053,6 +21060,42 @@ export interface JITConfigurationV2024 {
|
|
|
21053
21060
|
[key: string]: string;
|
|
21054
21061
|
};
|
|
21055
21062
|
}
|
|
21063
|
+
/**
|
|
21064
|
+
* A JSONPatch Operation for Role Mining endpoints, supporting only remove and replace operations as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)
|
|
21065
|
+
* @export
|
|
21066
|
+
* @interface JsonPatchOperationRoleMiningV2024
|
|
21067
|
+
*/
|
|
21068
|
+
export interface JsonPatchOperationRoleMiningV2024 {
|
|
21069
|
+
/**
|
|
21070
|
+
* The operation to be performed
|
|
21071
|
+
* @type {string}
|
|
21072
|
+
* @memberof JsonPatchOperationRoleMiningV2024
|
|
21073
|
+
*/
|
|
21074
|
+
'op': JsonPatchOperationRoleMiningV2024OpV2024;
|
|
21075
|
+
/**
|
|
21076
|
+
* A string JSON Pointer representing the target path to an element to be affected by the operation
|
|
21077
|
+
* @type {string}
|
|
21078
|
+
* @memberof JsonPatchOperationRoleMiningV2024
|
|
21079
|
+
*/
|
|
21080
|
+
'path': string;
|
|
21081
|
+
/**
|
|
21082
|
+
*
|
|
21083
|
+
* @type {JsonPatchOperationRoleMiningValueV2024}
|
|
21084
|
+
* @memberof JsonPatchOperationRoleMiningV2024
|
|
21085
|
+
*/
|
|
21086
|
+
'value'?: JsonPatchOperationRoleMiningValueV2024;
|
|
21087
|
+
}
|
|
21088
|
+
export declare const JsonPatchOperationRoleMiningV2024OpV2024: {
|
|
21089
|
+
readonly Remove: "remove";
|
|
21090
|
+
readonly Replace: "replace";
|
|
21091
|
+
};
|
|
21092
|
+
export type JsonPatchOperationRoleMiningV2024OpV2024 = typeof JsonPatchOperationRoleMiningV2024OpV2024[keyof typeof JsonPatchOperationRoleMiningV2024OpV2024];
|
|
21093
|
+
/**
|
|
21094
|
+
* @type JsonPatchOperationRoleMiningValueV2024
|
|
21095
|
+
* The value to be used for the operation, required for \"replace\" operations
|
|
21096
|
+
* @export
|
|
21097
|
+
*/
|
|
21098
|
+
export type JsonPatchOperationRoleMiningValueV2024 = Array<ArrayInner1V2024> | boolean | number | object | string;
|
|
21056
21099
|
/**
|
|
21057
21100
|
* A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)
|
|
21058
21101
|
* @export
|
|
@@ -21079,8 +21122,12 @@ export interface JsonPatchOperationV2024 {
|
|
|
21079
21122
|
'value'?: UpdateMultiHostSourcesRequestInnerValueV2024;
|
|
21080
21123
|
}
|
|
21081
21124
|
export declare const JsonPatchOperationV2024OpV2024: {
|
|
21125
|
+
readonly Add: "add";
|
|
21082
21126
|
readonly Remove: "remove";
|
|
21083
21127
|
readonly Replace: "replace";
|
|
21128
|
+
readonly Move: "move";
|
|
21129
|
+
readonly Copy: "copy";
|
|
21130
|
+
readonly Test: "test";
|
|
21084
21131
|
};
|
|
21085
21132
|
export type JsonPatchOperationV2024OpV2024 = typeof JsonPatchOperationV2024OpV2024[keyof typeof JsonPatchOperationV2024OpV2024];
|
|
21086
21133
|
/**
|
|
@@ -27865,36 +27912,6 @@ export declare const PatOwnerV2024TypeV2024: {
|
|
|
27865
27912
|
readonly Identity: "IDENTITY";
|
|
27866
27913
|
};
|
|
27867
27914
|
export type PatOwnerV2024TypeV2024 = typeof PatOwnerV2024TypeV2024[keyof typeof PatOwnerV2024TypeV2024];
|
|
27868
|
-
/**
|
|
27869
|
-
*
|
|
27870
|
-
* @export
|
|
27871
|
-
* @interface PatchPotentialRoleRequestInnerV2024
|
|
27872
|
-
*/
|
|
27873
|
-
export interface PatchPotentialRoleRequestInnerV2024 {
|
|
27874
|
-
/**
|
|
27875
|
-
* The operation to be performed
|
|
27876
|
-
* @type {string}
|
|
27877
|
-
* @memberof PatchPotentialRoleRequestInnerV2024
|
|
27878
|
-
*/
|
|
27879
|
-
'op'?: PatchPotentialRoleRequestInnerV2024OpV2024;
|
|
27880
|
-
/**
|
|
27881
|
-
* A string JSON Pointer representing the target path to an element to be affected by the operation
|
|
27882
|
-
* @type {string}
|
|
27883
|
-
* @memberof PatchPotentialRoleRequestInnerV2024
|
|
27884
|
-
*/
|
|
27885
|
-
'path': string;
|
|
27886
|
-
/**
|
|
27887
|
-
*
|
|
27888
|
-
* @type {UpdateMultiHostSourcesRequestInnerValueV2024}
|
|
27889
|
-
* @memberof PatchPotentialRoleRequestInnerV2024
|
|
27890
|
-
*/
|
|
27891
|
-
'value'?: UpdateMultiHostSourcesRequestInnerValueV2024;
|
|
27892
|
-
}
|
|
27893
|
-
export declare const PatchPotentialRoleRequestInnerV2024OpV2024: {
|
|
27894
|
-
readonly Remove: "remove";
|
|
27895
|
-
readonly Replace: "replace";
|
|
27896
|
-
};
|
|
27897
|
-
export type PatchPotentialRoleRequestInnerV2024OpV2024 = typeof PatchPotentialRoleRequestInnerV2024OpV2024[keyof typeof PatchPotentialRoleRequestInnerV2024OpV2024];
|
|
27898
27915
|
/**
|
|
27899
27916
|
*
|
|
27900
27917
|
* @export
|
|
@@ -33228,7 +33245,7 @@ export interface RoleMiningIdentityDistributionDistributionInnerV2024 {
|
|
|
33228
33245
|
* @type {string}
|
|
33229
33246
|
* @memberof RoleMiningIdentityDistributionDistributionInnerV2024
|
|
33230
33247
|
*/
|
|
33231
|
-
'attributeValue'?: string;
|
|
33248
|
+
'attributeValue'?: string | null;
|
|
33232
33249
|
/**
|
|
33233
33250
|
* The number of identities that have this attribute value
|
|
33234
33251
|
* @type {number}
|
|
@@ -33401,6 +33418,25 @@ export declare const RoleMiningPotentialRoleExportStateV2024: {
|
|
|
33401
33418
|
readonly Error: "ERROR";
|
|
33402
33419
|
};
|
|
33403
33420
|
export type RoleMiningPotentialRoleExportStateV2024 = typeof RoleMiningPotentialRoleExportStateV2024[keyof typeof RoleMiningPotentialRoleExportStateV2024];
|
|
33421
|
+
/**
|
|
33422
|
+
* The potential role reference
|
|
33423
|
+
* @export
|
|
33424
|
+
* @interface RoleMiningPotentialRolePotentialRoleRefV2024
|
|
33425
|
+
*/
|
|
33426
|
+
export interface RoleMiningPotentialRolePotentialRoleRefV2024 {
|
|
33427
|
+
/**
|
|
33428
|
+
* Id of the potential role
|
|
33429
|
+
* @type {string}
|
|
33430
|
+
* @memberof RoleMiningPotentialRolePotentialRoleRefV2024
|
|
33431
|
+
*/
|
|
33432
|
+
'id'?: string;
|
|
33433
|
+
/**
|
|
33434
|
+
* Name of the potential role
|
|
33435
|
+
* @type {string}
|
|
33436
|
+
* @memberof RoleMiningPotentialRolePotentialRoleRefV2024
|
|
33437
|
+
*/
|
|
33438
|
+
'name'?: string;
|
|
33439
|
+
}
|
|
33404
33440
|
/**
|
|
33405
33441
|
*
|
|
33406
33442
|
* @export
|
|
@@ -33675,12 +33711,24 @@ export interface RoleMiningPotentialRoleV2024 {
|
|
|
33675
33711
|
* @memberof RoleMiningPotentialRoleV2024
|
|
33676
33712
|
*/
|
|
33677
33713
|
'identityIds'?: Array<string>;
|
|
33714
|
+
/**
|
|
33715
|
+
* The status for this identity group which can be OBTAINED or COMPRESSED
|
|
33716
|
+
* @type {string}
|
|
33717
|
+
* @memberof RoleMiningPotentialRoleV2024
|
|
33718
|
+
*/
|
|
33719
|
+
'identityGroupStatus'?: string | null;
|
|
33678
33720
|
/**
|
|
33679
33721
|
* Name of the potential role.
|
|
33680
33722
|
* @type {string}
|
|
33681
33723
|
* @memberof RoleMiningPotentialRoleV2024
|
|
33682
33724
|
*/
|
|
33683
33725
|
'name'?: string;
|
|
33726
|
+
/**
|
|
33727
|
+
*
|
|
33728
|
+
* @type {RoleMiningPotentialRolePotentialRoleRefV2024}
|
|
33729
|
+
* @memberof RoleMiningPotentialRoleV2024
|
|
33730
|
+
*/
|
|
33731
|
+
'potentialRoleRef'?: RoleMiningPotentialRolePotentialRoleRefV2024 | null;
|
|
33684
33732
|
/**
|
|
33685
33733
|
*
|
|
33686
33734
|
* @type {RoleMiningPotentialRoleProvisionStateV2024 & object}
|
|
@@ -40269,13 +40317,6 @@ export declare const SubscriptionPatchRequestInnerV2024OpV2024: {
|
|
|
40269
40317
|
readonly Copy: "copy";
|
|
40270
40318
|
};
|
|
40271
40319
|
export type SubscriptionPatchRequestInnerV2024OpV2024 = typeof SubscriptionPatchRequestInnerV2024OpV2024[keyof typeof SubscriptionPatchRequestInnerV2024OpV2024];
|
|
40272
|
-
/**
|
|
40273
|
-
*
|
|
40274
|
-
* @export
|
|
40275
|
-
* @interface SubscriptionPatchRequestInnerValueAnyOfInnerV2024
|
|
40276
|
-
*/
|
|
40277
|
-
export interface SubscriptionPatchRequestInnerValueAnyOfInnerV2024 {
|
|
40278
|
-
}
|
|
40279
40320
|
/**
|
|
40280
40321
|
* The value to be used for the operation, required for \"add\" and \"replace\" operations
|
|
40281
40322
|
* @export
|
|
@@ -46003,7 +46044,7 @@ export declare const AccessRequestsV2024ApiAxiosParamCreator: (configuration?: C
|
|
|
46003
46044
|
*/
|
|
46004
46045
|
closeAccessRequest: (closeAccessRequestV2024: CloseAccessRequestV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46005
46046
|
/**
|
|
46006
|
-
*
|
|
46047
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
46007
46048
|
* @summary Submit access request
|
|
46008
46049
|
* @param {AccessRequestV2024} accessRequestV2024
|
|
46009
46050
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -46118,7 +46159,7 @@ export declare const AccessRequestsV2024ApiFp: (configuration?: Configuration) =
|
|
|
46118
46159
|
*/
|
|
46119
46160
|
closeAccessRequest(closeAccessRequestV2024: CloseAccessRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
46120
46161
|
/**
|
|
46121
|
-
*
|
|
46162
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
46122
46163
|
* @summary Submit access request
|
|
46123
46164
|
* @param {AccessRequestV2024} accessRequestV2024
|
|
46124
46165
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -46233,7 +46274,7 @@ export declare const AccessRequestsV2024ApiFactory: (configuration?: Configurati
|
|
|
46233
46274
|
*/
|
|
46234
46275
|
closeAccessRequest(requestParameters: AccessRequestsV2024ApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
46235
46276
|
/**
|
|
46236
|
-
*
|
|
46277
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
46237
46278
|
* @summary Submit access request
|
|
46238
46279
|
* @param {AccessRequestsV2024ApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
46239
46280
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -46594,7 +46635,7 @@ export declare class AccessRequestsV2024Api extends BaseAPI {
|
|
|
46594
46635
|
*/
|
|
46595
46636
|
closeAccessRequest(requestParameters: AccessRequestsV2024ApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
46596
46637
|
/**
|
|
46597
|
-
*
|
|
46638
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
46598
46639
|
* @summary Submit access request
|
|
46599
46640
|
* @param {AccessRequestsV2024ApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
46600
46641
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61237,23 +61278,23 @@ export declare const IAIRoleMiningV2024ApiAxiosParamCreator: (configuration?: Co
|
|
|
61237
61278
|
* @summary Update a potential role
|
|
61238
61279
|
* @param {string} sessionId The role mining session id
|
|
61239
61280
|
* @param {string} potentialRoleId The potential role summary id
|
|
61240
|
-
* @param {Array<
|
|
61281
|
+
* @param {Array<JsonPatchOperationRoleMiningV2024>} jsonPatchOperationRoleMiningV2024
|
|
61241
61282
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
61242
61283
|
* @param {*} [axiosOptions] Override http request option.
|
|
61243
61284
|
* @throws {RequiredError}
|
|
61244
61285
|
*/
|
|
61245
|
-
patchPotentialRole: (sessionId: string, potentialRoleId: string,
|
|
61286
|
+
patchPotentialRole: (sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2024: Array<JsonPatchOperationRoleMiningV2024>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
61246
61287
|
/**
|
|
61247
61288
|
* The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
61248
61289
|
* @summary Update a potential role session
|
|
61249
61290
|
* @param {string} sessionId The role mining session id
|
|
61250
61291
|
* @param {string} potentialRoleId The potential role summary id
|
|
61251
|
-
* @param {Array<
|
|
61292
|
+
* @param {Array<JsonPatchOperationRoleMiningV2024>} jsonPatchOperationRoleMiningV2024
|
|
61252
61293
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
61253
61294
|
* @param {*} [axiosOptions] Override http request option.
|
|
61254
61295
|
* @throws {RequiredError}
|
|
61255
61296
|
*/
|
|
61256
|
-
patchPotentialRoleSession: (sessionId: string, potentialRoleId: string,
|
|
61297
|
+
patchPotentialRoleSession: (sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2024: Array<JsonPatchOperationRoleMiningV2024>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
61257
61298
|
/**
|
|
61258
61299
|
* The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated.
|
|
61259
61300
|
* @summary Patch a role mining session
|
|
@@ -61541,23 +61582,23 @@ export declare const IAIRoleMiningV2024ApiFp: (configuration?: Configuration) =>
|
|
|
61541
61582
|
* @summary Update a potential role
|
|
61542
61583
|
* @param {string} sessionId The role mining session id
|
|
61543
61584
|
* @param {string} potentialRoleId The potential role summary id
|
|
61544
|
-
* @param {Array<
|
|
61585
|
+
* @param {Array<JsonPatchOperationRoleMiningV2024>} jsonPatchOperationRoleMiningV2024
|
|
61545
61586
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
61546
61587
|
* @param {*} [axiosOptions] Override http request option.
|
|
61547
61588
|
* @throws {RequiredError}
|
|
61548
61589
|
*/
|
|
61549
|
-
patchPotentialRole(sessionId: string, potentialRoleId: string,
|
|
61590
|
+
patchPotentialRole(sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2024: Array<JsonPatchOperationRoleMiningV2024>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
61550
61591
|
/**
|
|
61551
61592
|
* The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
61552
61593
|
* @summary Update a potential role session
|
|
61553
61594
|
* @param {string} sessionId The role mining session id
|
|
61554
61595
|
* @param {string} potentialRoleId The potential role summary id
|
|
61555
|
-
* @param {Array<
|
|
61596
|
+
* @param {Array<JsonPatchOperationRoleMiningV2024>} jsonPatchOperationRoleMiningV2024
|
|
61556
61597
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
61557
61598
|
* @param {*} [axiosOptions] Override http request option.
|
|
61558
61599
|
* @throws {RequiredError}
|
|
61559
61600
|
*/
|
|
61560
|
-
patchPotentialRoleSession(sessionId: string, potentialRoleId: string,
|
|
61601
|
+
patchPotentialRoleSession(sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2024: Array<JsonPatchOperationRoleMiningV2024>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
61561
61602
|
/**
|
|
61562
61603
|
* The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated.
|
|
61563
61604
|
* @summary Patch a role mining session
|
|
@@ -62591,10 +62632,10 @@ export interface IAIRoleMiningV2024ApiPatchPotentialRoleRequest {
|
|
|
62591
62632
|
readonly potentialRoleId: string;
|
|
62592
62633
|
/**
|
|
62593
62634
|
*
|
|
62594
|
-
* @type {Array<
|
|
62635
|
+
* @type {Array<JsonPatchOperationRoleMiningV2024>}
|
|
62595
62636
|
* @memberof IAIRoleMiningV2024ApiPatchPotentialRole
|
|
62596
62637
|
*/
|
|
62597
|
-
readonly
|
|
62638
|
+
readonly jsonPatchOperationRoleMiningV2024: Array<JsonPatchOperationRoleMiningV2024>;
|
|
62598
62639
|
/**
|
|
62599
62640
|
* Use this header to enable this experimental API.
|
|
62600
62641
|
* @type {string}
|
|
@@ -62622,10 +62663,10 @@ export interface IAIRoleMiningV2024ApiPatchPotentialRoleSessionRequest {
|
|
|
62622
62663
|
readonly potentialRoleId: string;
|
|
62623
62664
|
/**
|
|
62624
62665
|
*
|
|
62625
|
-
* @type {Array<
|
|
62666
|
+
* @type {Array<JsonPatchOperationRoleMiningV2024>}
|
|
62626
62667
|
* @memberof IAIRoleMiningV2024ApiPatchPotentialRoleSession
|
|
62627
62668
|
*/
|
|
62628
|
-
readonly
|
|
62669
|
+
readonly jsonPatchOperationRoleMiningV2024: Array<JsonPatchOperationRoleMiningV2024>;
|
|
62629
62670
|
/**
|
|
62630
62671
|
* Use this header to enable this experimental API.
|
|
62631
62672
|
* @type {string}
|