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/api.d.ts
CHANGED
|
@@ -4707,6 +4707,13 @@ export interface ArgumentBeta {
|
|
|
4707
4707
|
*/
|
|
4708
4708
|
export interface ArrayInner1Beta {
|
|
4709
4709
|
}
|
|
4710
|
+
/**
|
|
4711
|
+
*
|
|
4712
|
+
* @export
|
|
4713
|
+
* @interface ArrayInner2Beta
|
|
4714
|
+
*/
|
|
4715
|
+
export interface ArrayInner2Beta {
|
|
4716
|
+
}
|
|
4710
4717
|
/**
|
|
4711
4718
|
*
|
|
4712
4719
|
* @export
|
|
@@ -14783,10 +14790,50 @@ export interface JsonPatchOperationBeta {
|
|
|
14783
14790
|
'value'?: UpdateMultiHostSourcesRequestInnerValueBeta;
|
|
14784
14791
|
}
|
|
14785
14792
|
export declare const JsonPatchOperationBetaOpBeta: {
|
|
14793
|
+
readonly Add: "add";
|
|
14786
14794
|
readonly Remove: "remove";
|
|
14787
14795
|
readonly Replace: "replace";
|
|
14796
|
+
readonly Move: "move";
|
|
14797
|
+
readonly Copy: "copy";
|
|
14798
|
+
readonly Test: "test";
|
|
14788
14799
|
};
|
|
14789
14800
|
export type JsonPatchOperationBetaOpBeta = typeof JsonPatchOperationBetaOpBeta[keyof typeof JsonPatchOperationBetaOpBeta];
|
|
14801
|
+
/**
|
|
14802
|
+
* 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)
|
|
14803
|
+
* @export
|
|
14804
|
+
* @interface JsonPatchOperationRoleMiningBeta
|
|
14805
|
+
*/
|
|
14806
|
+
export interface JsonPatchOperationRoleMiningBeta {
|
|
14807
|
+
/**
|
|
14808
|
+
* The operation to be performed
|
|
14809
|
+
* @type {string}
|
|
14810
|
+
* @memberof JsonPatchOperationRoleMiningBeta
|
|
14811
|
+
*/
|
|
14812
|
+
'op': JsonPatchOperationRoleMiningBetaOpBeta;
|
|
14813
|
+
/**
|
|
14814
|
+
* A string JSON Pointer representing the target path to an element to be affected by the operation
|
|
14815
|
+
* @type {string}
|
|
14816
|
+
* @memberof JsonPatchOperationRoleMiningBeta
|
|
14817
|
+
*/
|
|
14818
|
+
'path': string;
|
|
14819
|
+
/**
|
|
14820
|
+
*
|
|
14821
|
+
* @type {JsonPatchOperationRoleMiningValueBeta}
|
|
14822
|
+
* @memberof JsonPatchOperationRoleMiningBeta
|
|
14823
|
+
*/
|
|
14824
|
+
'value'?: JsonPatchOperationRoleMiningValueBeta;
|
|
14825
|
+
}
|
|
14826
|
+
export declare const JsonPatchOperationRoleMiningBetaOpBeta: {
|
|
14827
|
+
readonly Remove: "remove";
|
|
14828
|
+
readonly Replace: "replace";
|
|
14829
|
+
};
|
|
14830
|
+
export type JsonPatchOperationRoleMiningBetaOpBeta = typeof JsonPatchOperationRoleMiningBetaOpBeta[keyof typeof JsonPatchOperationRoleMiningBetaOpBeta];
|
|
14831
|
+
/**
|
|
14832
|
+
* @type JsonPatchOperationRoleMiningValueBeta
|
|
14833
|
+
* The value to be used for the operation, required for \"replace\" operations
|
|
14834
|
+
* @export
|
|
14835
|
+
*/
|
|
14836
|
+
export type JsonPatchOperationRoleMiningValueBeta = Array<ArrayInner1Beta> | boolean | number | object | string;
|
|
14790
14837
|
/**
|
|
14791
14838
|
* A limited JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)
|
|
14792
14839
|
* @export
|
|
@@ -14823,7 +14870,7 @@ export type JsonPatchOperationsBetaOpBeta = typeof JsonPatchOperationsBetaOpBeta
|
|
|
14823
14870
|
* The value to be used for the operation, required for \"add\" and \"replace\" operations
|
|
14824
14871
|
* @export
|
|
14825
14872
|
*/
|
|
14826
|
-
export type JsonPatchOperationsValueBeta = Array<
|
|
14873
|
+
export type JsonPatchOperationsValueBeta = Array<ArrayInner2Beta> | boolean | string;
|
|
14827
14874
|
/**
|
|
14828
14875
|
*
|
|
14829
14876
|
* @export
|
|
@@ -20588,36 +20635,6 @@ export declare const PatOwnerBetaTypeBeta: {
|
|
|
20588
20635
|
readonly Identity: "IDENTITY";
|
|
20589
20636
|
};
|
|
20590
20637
|
export type PatOwnerBetaTypeBeta = typeof PatOwnerBetaTypeBeta[keyof typeof PatOwnerBetaTypeBeta];
|
|
20591
|
-
/**
|
|
20592
|
-
*
|
|
20593
|
-
* @export
|
|
20594
|
-
* @interface PatchRoleMiningPotentialRoleRequestInnerBeta
|
|
20595
|
-
*/
|
|
20596
|
-
export interface PatchRoleMiningPotentialRoleRequestInnerBeta {
|
|
20597
|
-
/**
|
|
20598
|
-
* The operation to be performed
|
|
20599
|
-
* @type {string}
|
|
20600
|
-
* @memberof PatchRoleMiningPotentialRoleRequestInnerBeta
|
|
20601
|
-
*/
|
|
20602
|
-
'op'?: PatchRoleMiningPotentialRoleRequestInnerBetaOpBeta;
|
|
20603
|
-
/**
|
|
20604
|
-
* A string JSON Pointer representing the target path to an element to be affected by the operation
|
|
20605
|
-
* @type {string}
|
|
20606
|
-
* @memberof PatchRoleMiningPotentialRoleRequestInnerBeta
|
|
20607
|
-
*/
|
|
20608
|
-
'path': string;
|
|
20609
|
-
/**
|
|
20610
|
-
*
|
|
20611
|
-
* @type {UpdateMultiHostSourcesRequestInnerValueBeta}
|
|
20612
|
-
* @memberof PatchRoleMiningPotentialRoleRequestInnerBeta
|
|
20613
|
-
*/
|
|
20614
|
-
'value'?: UpdateMultiHostSourcesRequestInnerValueBeta;
|
|
20615
|
-
}
|
|
20616
|
-
export declare const PatchRoleMiningPotentialRoleRequestInnerBetaOpBeta: {
|
|
20617
|
-
readonly Remove: "remove";
|
|
20618
|
-
readonly Replace: "replace";
|
|
20619
|
-
};
|
|
20620
|
-
export type PatchRoleMiningPotentialRoleRequestInnerBetaOpBeta = typeof PatchRoleMiningPotentialRoleRequestInnerBetaOpBeta[keyof typeof PatchRoleMiningPotentialRoleRequestInnerBetaOpBeta];
|
|
20621
20638
|
/**
|
|
20622
20639
|
*
|
|
20623
20640
|
* @export
|
|
@@ -24338,7 +24355,7 @@ export interface RoleMiningIdentityDistributionDistributionInnerBeta {
|
|
|
24338
24355
|
* @type {string}
|
|
24339
24356
|
* @memberof RoleMiningIdentityDistributionDistributionInnerBeta
|
|
24340
24357
|
*/
|
|
24341
|
-
'attributeValue'?: string;
|
|
24358
|
+
'attributeValue'?: string | null;
|
|
24342
24359
|
/**
|
|
24343
24360
|
* The number of identities that have this attribute value
|
|
24344
24361
|
* @type {number}
|
|
@@ -24425,12 +24442,24 @@ export interface RoleMiningPotentialRoleBeta {
|
|
|
24425
24442
|
* @memberof RoleMiningPotentialRoleBeta
|
|
24426
24443
|
*/
|
|
24427
24444
|
'identityIds'?: Array<string>;
|
|
24445
|
+
/**
|
|
24446
|
+
* The status for this identity group which can be OBTAINED or COMPRESSED
|
|
24447
|
+
* @type {string}
|
|
24448
|
+
* @memberof RoleMiningPotentialRoleBeta
|
|
24449
|
+
*/
|
|
24450
|
+
'identityGroupStatus'?: string | null;
|
|
24428
24451
|
/**
|
|
24429
24452
|
* Name of the potential role.
|
|
24430
24453
|
* @type {string}
|
|
24431
24454
|
* @memberof RoleMiningPotentialRoleBeta
|
|
24432
24455
|
*/
|
|
24433
24456
|
'name'?: string;
|
|
24457
|
+
/**
|
|
24458
|
+
*
|
|
24459
|
+
* @type {RoleMiningPotentialRolePotentialRoleRefBeta}
|
|
24460
|
+
* @memberof RoleMiningPotentialRoleBeta
|
|
24461
|
+
*/
|
|
24462
|
+
'potentialRoleRef'?: RoleMiningPotentialRolePotentialRoleRefBeta | null;
|
|
24434
24463
|
/**
|
|
24435
24464
|
*
|
|
24436
24465
|
* @type {RoleMiningPotentialRoleProvisionStateBeta}
|
|
@@ -24586,6 +24615,25 @@ export declare const RoleMiningPotentialRoleExportStateBeta: {
|
|
|
24586
24615
|
readonly Error: "ERROR";
|
|
24587
24616
|
};
|
|
24588
24617
|
export type RoleMiningPotentialRoleExportStateBeta = typeof RoleMiningPotentialRoleExportStateBeta[keyof typeof RoleMiningPotentialRoleExportStateBeta];
|
|
24618
|
+
/**
|
|
24619
|
+
* The potential role reference
|
|
24620
|
+
* @export
|
|
24621
|
+
* @interface RoleMiningPotentialRolePotentialRoleRefBeta
|
|
24622
|
+
*/
|
|
24623
|
+
export interface RoleMiningPotentialRolePotentialRoleRefBeta {
|
|
24624
|
+
/**
|
|
24625
|
+
* Id of the potential role
|
|
24626
|
+
* @type {string}
|
|
24627
|
+
* @memberof RoleMiningPotentialRolePotentialRoleRefBeta
|
|
24628
|
+
*/
|
|
24629
|
+
'id'?: string;
|
|
24630
|
+
/**
|
|
24631
|
+
* Name of the potential role
|
|
24632
|
+
* @type {string}
|
|
24633
|
+
* @memberof RoleMiningPotentialRolePotentialRoleRefBeta
|
|
24634
|
+
*/
|
|
24635
|
+
'name'?: string;
|
|
24636
|
+
}
|
|
24589
24637
|
/**
|
|
24590
24638
|
*
|
|
24591
24639
|
* @export
|
|
@@ -29800,13 +29848,6 @@ export declare const SubscriptionPatchRequestInnerBetaOpBeta: {
|
|
|
29800
29848
|
readonly Copy: "copy";
|
|
29801
29849
|
};
|
|
29802
29850
|
export type SubscriptionPatchRequestInnerBetaOpBeta = typeof SubscriptionPatchRequestInnerBetaOpBeta[keyof typeof SubscriptionPatchRequestInnerBetaOpBeta];
|
|
29803
|
-
/**
|
|
29804
|
-
*
|
|
29805
|
-
* @export
|
|
29806
|
-
* @interface SubscriptionPatchRequestInnerValueAnyOfInnerBeta
|
|
29807
|
-
*/
|
|
29808
|
-
export interface SubscriptionPatchRequestInnerValueAnyOfInnerBeta {
|
|
29809
|
-
}
|
|
29810
29851
|
/**
|
|
29811
29852
|
* The value to be used for the operation, required for \"add\" and \"replace\" operations
|
|
29812
29853
|
* @export
|
|
@@ -35049,7 +35090,7 @@ export declare const AccessRequestsBetaApiAxiosParamCreator: (configuration?: Co
|
|
|
35049
35090
|
*/
|
|
35050
35091
|
closeAccessRequest: (closeAccessRequestBeta: CloseAccessRequestBeta, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35051
35092
|
/**
|
|
35052
|
-
*
|
|
35093
|
+
* 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.
|
|
35053
35094
|
* @summary Submit access request
|
|
35054
35095
|
* @param {AccessRequestBeta} accessRequestBeta
|
|
35055
35096
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35129,7 +35170,7 @@ export declare const AccessRequestsBetaApiFp: (configuration?: Configuration) =>
|
|
|
35129
35170
|
*/
|
|
35130
35171
|
closeAccessRequest(closeAccessRequestBeta: CloseAccessRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
35131
35172
|
/**
|
|
35132
|
-
*
|
|
35173
|
+
* 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.
|
|
35133
35174
|
* @summary Submit access request
|
|
35134
35175
|
* @param {AccessRequestBeta} accessRequestBeta
|
|
35135
35176
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35209,7 +35250,7 @@ export declare const AccessRequestsBetaApiFactory: (configuration?: Configuratio
|
|
|
35209
35250
|
*/
|
|
35210
35251
|
closeAccessRequest(requestParameters: AccessRequestsBetaApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
35211
35252
|
/**
|
|
35212
|
-
*
|
|
35253
|
+
* 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.
|
|
35213
35254
|
* @summary Submit access request
|
|
35214
35255
|
* @param {AccessRequestsBetaApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
35215
35256
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35466,7 +35507,7 @@ export declare class AccessRequestsBetaApi extends BaseAPI {
|
|
|
35466
35507
|
*/
|
|
35467
35508
|
closeAccessRequest(requestParameters: AccessRequestsBetaApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
35468
35509
|
/**
|
|
35469
|
-
*
|
|
35510
|
+
* 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.
|
|
35470
35511
|
* @summary Submit access request
|
|
35471
35512
|
* @param {AccessRequestsBetaApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
35472
35513
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -44852,23 +44893,23 @@ export declare const IAIRoleMiningBetaApiAxiosParamCreator: (configuration?: Con
|
|
|
44852
44893
|
getSavedPotentialRoles: (sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44853
44894
|
/**
|
|
44854
44895
|
* This method updates an existing potential role using the role mining session id and the potential role summary id. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
44855
|
-
* @summary Update
|
|
44896
|
+
* @summary Update potential role in session
|
|
44856
44897
|
* @param {string} sessionId The role mining session id
|
|
44857
44898
|
* @param {string} potentialRoleId The potential role summary id
|
|
44858
|
-
* @param {Array<
|
|
44899
|
+
* @param {Array<JsonPatchOperationRoleMiningBeta>} jsonPatchOperationRoleMiningBeta
|
|
44859
44900
|
* @param {*} [axiosOptions] Override http request option.
|
|
44860
44901
|
* @throws {RequiredError}
|
|
44861
44902
|
*/
|
|
44862
|
-
patchPotentialRoleSession: (sessionId: string, potentialRoleId: string,
|
|
44903
|
+
patchPotentialRoleSession: (sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningBeta: Array<JsonPatchOperationRoleMiningBeta>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44863
44904
|
/**
|
|
44864
44905
|
* This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
44865
44906
|
* @summary Update a potential role
|
|
44866
44907
|
* @param {string} potentialRoleId The potential role summary id
|
|
44867
|
-
* @param {Array<
|
|
44908
|
+
* @param {Array<JsonPatchOperationRoleMiningBeta>} jsonPatchOperationRoleMiningBeta
|
|
44868
44909
|
* @param {*} [axiosOptions] Override http request option.
|
|
44869
44910
|
* @throws {RequiredError}
|
|
44870
44911
|
*/
|
|
44871
|
-
patchRoleMiningPotentialRole: (potentialRoleId: string,
|
|
44912
|
+
patchRoleMiningPotentialRole: (potentialRoleId: string, jsonPatchOperationRoleMiningBeta: Array<JsonPatchOperationRoleMiningBeta>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44872
44913
|
/**
|
|
44873
44914
|
* 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.
|
|
44874
44915
|
* @summary Patch a role mining session
|
|
@@ -45130,23 +45171,23 @@ export declare const IAIRoleMiningBetaApiFp: (configuration?: Configuration) =>
|
|
|
45130
45171
|
getSavedPotentialRoles(sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RoleMiningSessionDraftRoleDtoBeta>>>;
|
|
45131
45172
|
/**
|
|
45132
45173
|
* This method updates an existing potential role using the role mining session id and the potential role summary id. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
45133
|
-
* @summary Update
|
|
45174
|
+
* @summary Update potential role in session
|
|
45134
45175
|
* @param {string} sessionId The role mining session id
|
|
45135
45176
|
* @param {string} potentialRoleId The potential role summary id
|
|
45136
|
-
* @param {Array<
|
|
45177
|
+
* @param {Array<JsonPatchOperationRoleMiningBeta>} jsonPatchOperationRoleMiningBeta
|
|
45137
45178
|
* @param {*} [axiosOptions] Override http request option.
|
|
45138
45179
|
* @throws {RequiredError}
|
|
45139
45180
|
*/
|
|
45140
|
-
patchPotentialRoleSession(sessionId: string, potentialRoleId: string,
|
|
45181
|
+
patchPotentialRoleSession(sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningBeta: Array<JsonPatchOperationRoleMiningBeta>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
45141
45182
|
/**
|
|
45142
45183
|
* This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
45143
45184
|
* @summary Update a potential role
|
|
45144
45185
|
* @param {string} potentialRoleId The potential role summary id
|
|
45145
|
-
* @param {Array<
|
|
45186
|
+
* @param {Array<JsonPatchOperationRoleMiningBeta>} jsonPatchOperationRoleMiningBeta
|
|
45146
45187
|
* @param {*} [axiosOptions] Override http request option.
|
|
45147
45188
|
* @throws {RequiredError}
|
|
45148
45189
|
*/
|
|
45149
|
-
patchRoleMiningPotentialRole(potentialRoleId: string,
|
|
45190
|
+
patchRoleMiningPotentialRole(potentialRoleId: string, jsonPatchOperationRoleMiningBeta: Array<JsonPatchOperationRoleMiningBeta>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
45150
45191
|
/**
|
|
45151
45192
|
* 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.
|
|
45152
45193
|
* @summary Patch a role mining session
|
|
@@ -45344,7 +45385,7 @@ export declare const IAIRoleMiningBetaApiFactory: (configuration?: Configuration
|
|
|
45344
45385
|
getSavedPotentialRoles(requestParameters?: IAIRoleMiningBetaApiGetSavedPotentialRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<RoleMiningSessionDraftRoleDtoBeta>>;
|
|
45345
45386
|
/**
|
|
45346
45387
|
* This method updates an existing potential role using the role mining session id and the potential role summary id. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
45347
|
-
* @summary Update
|
|
45388
|
+
* @summary Update potential role in session
|
|
45348
45389
|
* @param {IAIRoleMiningBetaApiPatchPotentialRoleSessionRequest} requestParameters Request parameters.
|
|
45349
45390
|
* @param {*} [axiosOptions] Override http request option.
|
|
45350
45391
|
* @throws {RequiredError}
|
|
@@ -46052,10 +46093,10 @@ export interface IAIRoleMiningBetaApiPatchPotentialRoleSessionRequest {
|
|
|
46052
46093
|
readonly potentialRoleId: string;
|
|
46053
46094
|
/**
|
|
46054
46095
|
*
|
|
46055
|
-
* @type {Array<
|
|
46096
|
+
* @type {Array<JsonPatchOperationRoleMiningBeta>}
|
|
46056
46097
|
* @memberof IAIRoleMiningBetaApiPatchPotentialRoleSession
|
|
46057
46098
|
*/
|
|
46058
|
-
readonly
|
|
46099
|
+
readonly jsonPatchOperationRoleMiningBeta: Array<JsonPatchOperationRoleMiningBeta>;
|
|
46059
46100
|
}
|
|
46060
46101
|
/**
|
|
46061
46102
|
* Request parameters for patchRoleMiningPotentialRole operation in IAIRoleMiningBetaApi.
|
|
@@ -46071,10 +46112,10 @@ export interface IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest {
|
|
|
46071
46112
|
readonly potentialRoleId: string;
|
|
46072
46113
|
/**
|
|
46073
46114
|
*
|
|
46074
|
-
* @type {Array<
|
|
46115
|
+
* @type {Array<JsonPatchOperationRoleMiningBeta>}
|
|
46075
46116
|
* @memberof IAIRoleMiningBetaApiPatchRoleMiningPotentialRole
|
|
46076
46117
|
*/
|
|
46077
|
-
readonly
|
|
46118
|
+
readonly jsonPatchOperationRoleMiningBeta: Array<JsonPatchOperationRoleMiningBeta>;
|
|
46078
46119
|
}
|
|
46079
46120
|
/**
|
|
46080
46121
|
* Request parameters for patchRoleMiningSession operation in IAIRoleMiningBetaApi.
|
|
@@ -46320,7 +46361,7 @@ export declare class IAIRoleMiningBetaApi extends BaseAPI {
|
|
|
46320
46361
|
getSavedPotentialRoles(requestParameters?: IAIRoleMiningBetaApiGetSavedPotentialRolesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleMiningSessionDraftRoleDtoBeta[], any>>;
|
|
46321
46362
|
/**
|
|
46322
46363
|
* This method updates an existing potential role using the role mining session id and the potential role summary id. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
46323
|
-
* @summary Update
|
|
46364
|
+
* @summary Update potential role in session
|
|
46324
46365
|
* @param {IAIRoleMiningBetaApiPatchPotentialRoleSessionRequest} requestParameters Request parameters.
|
|
46325
46366
|
* @param {*} [axiosOptions] Override http request option.
|
|
46326
46367
|
* @throws {RequiredError}
|