sailpoint-api-client 1.6.2 → 1.6.3
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 +20 -12
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +20 -12
- package/dist/beta/api.js +16 -9
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/index.spec.js +67 -16
- package/dist/index.spec.js.map +1 -1
- package/dist/paginator.d.ts +28 -2
- package/dist/paginator.js +39 -11
- package/dist/paginator.js.map +1 -1
- package/dist/v2024/api.d.ts +136 -189
- package/dist/v2024/api.js +222 -249
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v2025/api.d.ts +1098 -183
- package/dist/v2025/api.js +1564 -273
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +1 -1
- package/dist/v3/api.d.ts +20 -12
- package/dist/v3/api.js +18 -11
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +1 -1
- package/index.spec.ts +44 -2
- package/package.json +1 -1
- package/paginator.ts +77 -13
- package/v2024/README.md +2 -2
- package/v2024/api.ts +251 -390
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +2048 -622
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +22 -14
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/v2025/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.6.
|
|
253
|
+
var headers = __assign(__assign({ 'User-Agent': 'OpenAPI-Generator/1.6.3/ts' }, axiosArgs.axiosOptions.headers), { 'X-SailPoint-SDK': 'typescript-1.6.3' });
|
|
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/v3/api.d.ts
CHANGED
|
@@ -1188,7 +1188,7 @@ export interface AccessRequestItem {
|
|
|
1188
1188
|
[key: string]: string;
|
|
1189
1189
|
};
|
|
1190
1190
|
/**
|
|
1191
|
-
* The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be
|
|
1191
|
+
* The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for.
|
|
1192
1192
|
* @type {string}
|
|
1193
1193
|
* @memberof AccessRequestItem
|
|
1194
1194
|
*/
|
|
@@ -17053,7 +17053,7 @@ export interface RequestedItemDtoRef {
|
|
|
17053
17053
|
[key: string]: string;
|
|
17054
17054
|
};
|
|
17055
17055
|
/**
|
|
17056
|
-
* The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be
|
|
17056
|
+
* The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for.
|
|
17057
17057
|
* @type {string}
|
|
17058
17058
|
* @memberof RequestedItemDtoRef
|
|
17059
17059
|
*/
|
|
@@ -25427,7 +25427,7 @@ export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Config
|
|
|
25427
25427
|
*/
|
|
25428
25428
|
cancelAccessRequest: (cancelAccessRequest: CancelAccessRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25429
25429
|
/**
|
|
25430
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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, the
|
|
25430
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. * 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. __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.
|
|
25431
25431
|
* @summary Submit access request
|
|
25432
25432
|
* @param {AccessRequest} accessRequest
|
|
25433
25433
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25481,7 +25481,7 @@ export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
|
|
|
25481
25481
|
*/
|
|
25482
25482
|
cancelAccessRequest(cancelAccessRequest: CancelAccessRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25483
25483
|
/**
|
|
25484
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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, the
|
|
25484
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. * 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. __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.
|
|
25485
25485
|
* @summary Submit access request
|
|
25486
25486
|
* @param {AccessRequest} accessRequest
|
|
25487
25487
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25535,7 +25535,7 @@ export declare const AccessRequestsApiFactory: (configuration?: Configuration, b
|
|
|
25535
25535
|
*/
|
|
25536
25536
|
cancelAccessRequest(requestParameters: AccessRequestsApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
25537
25537
|
/**
|
|
25538
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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, the
|
|
25538
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. * 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. __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.
|
|
25539
25539
|
* @summary Submit access request
|
|
25540
25540
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
25541
25541
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25689,7 +25689,7 @@ export declare class AccessRequestsApi extends BaseAPI {
|
|
|
25689
25689
|
*/
|
|
25690
25690
|
cancelAccessRequest(requestParameters: AccessRequestsApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
25691
25691
|
/**
|
|
25692
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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, the
|
|
25692
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. * 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. __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.
|
|
25693
25693
|
* @summary Submit access request
|
|
25694
25694
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
25695
25695
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -37531,7 +37531,7 @@ export declare const RequestableObjectsApiAxiosParamCreator: (configuration?: Co
|
|
|
37531
37531
|
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
37532
37532
|
* @summary Requestable objects list
|
|
37533
37533
|
* @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.
|
|
37534
|
-
* @param {Array<
|
|
37534
|
+
* @param {Array<ListRequestableObjectsTypesV3>} [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.
|
|
37535
37535
|
* @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter.
|
|
37536
37536
|
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice.
|
|
37537
37537
|
* @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.
|
|
@@ -37542,7 +37542,7 @@ export declare const RequestableObjectsApiAxiosParamCreator: (configuration?: Co
|
|
|
37542
37542
|
* @param {*} [axiosOptions] Override http request option.
|
|
37543
37543
|
* @throws {RequiredError}
|
|
37544
37544
|
*/
|
|
37545
|
-
listRequestableObjects: (identityId?: string, types?: Array<
|
|
37545
|
+
listRequestableObjects: (identityId?: string, types?: Array<ListRequestableObjectsTypesV3>, term?: string, statuses?: Array<RequestableObjectRequestStatus>, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37546
37546
|
};
|
|
37547
37547
|
/**
|
|
37548
37548
|
* RequestableObjectsApi - functional programming interface
|
|
@@ -37553,7 +37553,7 @@ export declare const RequestableObjectsApiFp: (configuration?: Configuration) =>
|
|
|
37553
37553
|
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
37554
37554
|
* @summary Requestable objects list
|
|
37555
37555
|
* @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.
|
|
37556
|
-
* @param {Array<
|
|
37556
|
+
* @param {Array<ListRequestableObjectsTypesV3>} [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.
|
|
37557
37557
|
* @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter.
|
|
37558
37558
|
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice.
|
|
37559
37559
|
* @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.
|
|
@@ -37564,7 +37564,7 @@ export declare const RequestableObjectsApiFp: (configuration?: Configuration) =>
|
|
|
37564
37564
|
* @param {*} [axiosOptions] Override http request option.
|
|
37565
37565
|
* @throws {RequiredError}
|
|
37566
37566
|
*/
|
|
37567
|
-
listRequestableObjects(identityId?: string, types?: Array<
|
|
37567
|
+
listRequestableObjects(identityId?: string, types?: Array<ListRequestableObjectsTypesV3>, term?: string, statuses?: Array<RequestableObjectRequestStatus>, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RequestableObject>>>;
|
|
37568
37568
|
};
|
|
37569
37569
|
/**
|
|
37570
37570
|
* RequestableObjectsApi - factory interface
|
|
@@ -37594,10 +37594,10 @@ export interface RequestableObjectsApiListRequestableObjectsRequest {
|
|
|
37594
37594
|
readonly identityId?: string;
|
|
37595
37595
|
/**
|
|
37596
37596
|
* 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.
|
|
37597
|
-
* @type {Array<
|
|
37597
|
+
* @type {Array<'ACCESS_PROFILE' | 'ROLE'>}
|
|
37598
37598
|
* @memberof RequestableObjectsApiListRequestableObjects
|
|
37599
37599
|
*/
|
|
37600
|
-
readonly types?: Array<
|
|
37600
|
+
readonly types?: Array<ListRequestableObjectsTypesV3>;
|
|
37601
37601
|
/**
|
|
37602
37602
|
* Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter.
|
|
37603
37603
|
* @type {string}
|
|
@@ -37658,6 +37658,14 @@ export declare class RequestableObjectsApi extends BaseAPI {
|
|
|
37658
37658
|
*/
|
|
37659
37659
|
listRequestableObjects(requestParameters?: RequestableObjectsApiListRequestableObjectsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RequestableObject[], any>>;
|
|
37660
37660
|
}
|
|
37661
|
+
/**
|
|
37662
|
+
* @export
|
|
37663
|
+
*/
|
|
37664
|
+
export declare const ListRequestableObjectsTypesV3: {
|
|
37665
|
+
readonly AccessProfile: "ACCESS_PROFILE";
|
|
37666
|
+
readonly Role: "ROLE";
|
|
37667
|
+
};
|
|
37668
|
+
export type ListRequestableObjectsTypesV3 = typeof ListRequestableObjectsTypesV3[keyof typeof ListRequestableObjectsTypesV3];
|
|
37661
37669
|
/**
|
|
37662
37670
|
* RolesApi - axios parameter creator
|
|
37663
37671
|
* @export
|
package/dist/v3/api.js
CHANGED
|
@@ -85,9 +85,9 @@ exports.SodReportResultDtoTypeV3 = exports.SodRecipientTypeV3 = exports.SodPolic
|
|
|
85
85
|
exports.AccessProfilesApiAxiosParamCreator = exports.WorkflowTriggerAttributesFrequencyV3 = exports.WorkflowTriggerTypeV3 = exports.WorkflowModifiedByTypeV3 = exports.WorkflowLibraryTriggerTypeV3 = exports.WorkflowLibraryFormFieldsTypeV3 = exports.WorkflowExecutionEventTypeV3 = exports.WorkflowExecutionStatusV3 = exports.WorkflowBodyOwnerTypeV3 = exports.WorkflowAllOfCreatorTypeV3 = exports.WorkItemTypeManualWorkItems = exports.WorkItemStateManualWorkItems = exports.WorkItemState = exports.ViolationOwnerAssignmentConfigOwnerRefTypeV3 = exports.ViolationOwnerAssignmentConfigAssignmentRuleV3 = exports.ViolationContextPolicyTypeV3 = exports.VerificationResponseStatusV3 = exports.V3CreateConnectorDtoStatusV3 = exports.V3ConnectorDtoStatusV3 = exports.UsageType = exports.UpdateDetailStatusV3 = exports.UncorrelatedAccountsReportArgumentsSelectedFormatsV3 = exports.TransformReadTypeV3 = exports.TransformTypeV3 = exports.TokenAuthResponseStatusV3 = exports.TokenAuthRequestDeliveryTypeV3 = exports.TaskResultSimplifiedCompletionStatusV3 = exports.TaskResultDtoTypeV3 = exports.TaskResultDetailsMessagesInnerTypeV3 = exports.TaskResultDetailsCompletionStatusV3 = exports.TaskResultDetailsReportTypeV3 = exports.TaskResultDetailsTypeV3 = exports.TaggedObjectDtoTypeV3 = exports.StandardLevel = exports.SpDetailsRoleV3 = exports.SourceUsageStatusStatusV3 = exports.SourceSchemasInnerTypeV3 = exports.SourcePasswordPoliciesInnerTypeV3 = exports.SourceOwnerTypeV3 = exports.SourceManagerCorrelationRuleTypeV3 = exports.SourceManagementWorkgroupTypeV3 = exports.SourceHealthDtoStatusV3 = exports.SourceClusterDtoTypeV3 = exports.SourceClusterTypeV3 = exports.SourceBeforeProvisioningRuleTypeV3 = exports.SourceAccountCorrelationRuleTypeV3 = exports.SourceAccountCorrelationConfigTypeV3 = exports.SourceStatusV3 = exports.SourceFeaturesV3 = exports.SodViolationContextCheckCompletedStateV3 = void 0;
|
|
86
86
|
exports.CertificationSummariesApiFactory = exports.CertificationSummariesApiFp = exports.CertificationSummariesApiAxiosParamCreator = exports.GetCampaignDetailV3 = exports.GetActiveCampaignsDetailV3 = exports.CertificationCampaignsApi = exports.CertificationCampaignsApiFactory = exports.CertificationCampaignsApiFp = exports.CertificationCampaignsApiAxiosParamCreator = exports.CertificationCampaignFiltersApi = exports.CertificationCampaignFiltersApiFactory = exports.CertificationCampaignFiltersApiFp = exports.CertificationCampaignFiltersApiAxiosParamCreator = exports.BrandingApi = exports.BrandingApiFactory = exports.BrandingApiFp = exports.BrandingApiAxiosParamCreator = exports.AuthUsersApi = exports.AuthUsersApiFactory = exports.AuthUsersApiFp = exports.AuthUsersApiAxiosParamCreator = exports.GetDiscoveredApplicationsDetailV3 = exports.ApplicationDiscoveryApi = exports.ApplicationDiscoveryApiFactory = exports.ApplicationDiscoveryApiFp = exports.ApplicationDiscoveryApiAxiosParamCreator = exports.ListAccountsDetailLevelV3 = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.AccountUsagesApi = exports.AccountUsagesApiFactory = exports.AccountUsagesApiFp = exports.AccountUsagesApiAxiosParamCreator = exports.AccountActivitiesApi = exports.AccountActivitiesApiFactory = exports.AccountActivitiesApiFp = exports.AccountActivitiesApiAxiosParamCreator = exports.AccessRequestsApi = exports.AccessRequestsApiFactory = exports.AccessRequestsApiFp = exports.AccessRequestsApiAxiosParamCreator = exports.AccessRequestApprovalsApi = exports.AccessRequestApprovalsApiFactory = exports.AccessRequestApprovalsApiFp = exports.AccessRequestApprovalsApiAxiosParamCreator = exports.AccessProfilesApi = exports.AccessProfilesApiFactory = exports.AccessProfilesApiFp = void 0;
|
|
87
87
|
exports.NonEmployeeLifecycleManagementApiAxiosParamCreator = exports.ManagedClustersApi = exports.ManagedClustersApiFactory = exports.ManagedClustersApiFp = exports.ManagedClustersApiAxiosParamCreator = exports.ManagedClientsApi = exports.ManagedClientsApiFactory = exports.ManagedClientsApiFp = exports.ManagedClientsApiAxiosParamCreator = exports.PingVerificationStatusMethodV3 = exports.MFAControllerApi = exports.MFAControllerApiFactory = exports.MFAControllerApiFp = exports.MFAControllerApiAxiosParamCreator = exports.TestMFAConfigMethodV3 = exports.DeleteMFAConfigMethodV3 = exports.MFAConfigurationApi = exports.MFAConfigurationApiFactory = exports.MFAConfigurationApiFp = exports.MFAConfigurationApiAxiosParamCreator = exports.LifecycleStatesApi = exports.LifecycleStatesApiFactory = exports.LifecycleStatesApiFp = exports.LifecycleStatesApiAxiosParamCreator = exports.IdentityProfilesApi = exports.IdentityProfilesApiFactory = exports.IdentityProfilesApiFp = exports.IdentityProfilesApiAxiosParamCreator = exports.GlobalTenantSecuritySettingsApi = exports.GlobalTenantSecuritySettingsApiFactory = exports.GlobalTenantSecuritySettingsApiFp = exports.GlobalTenantSecuritySettingsApiAxiosParamCreator = exports.PutConnectorTranslationsLocaleV3 = exports.GetConnectorTranslationsLocaleV3 = exports.GetConnectorListLocaleV3 = exports.GetConnectorLocaleV3 = exports.ConnectorsApi = exports.ConnectorsApiFactory = exports.ConnectorsApiFp = exports.ConnectorsApiAxiosParamCreator = exports.ConfigurationHubApi = exports.ConfigurationHubApiFactory = exports.ConfigurationHubApiFp = exports.ConfigurationHubApiAxiosParamCreator = exports.CertificationsApi = exports.CertificationsApiFactory = exports.CertificationsApiFp = exports.CertificationsApiAxiosParamCreator = exports.GetIdentityAccessSummariesTypeV3 = exports.CertificationSummariesApi = void 0;
|
|
88
|
-
exports.
|
|
89
|
-
exports.
|
|
90
|
-
exports.WorkflowsApi = exports.WorkflowsApiFactory = exports.WorkflowsApiFp = exports.WorkflowsApiAxiosParamCreator = exports.WorkItemsApi = exports.WorkItemsApiFactory = exports.WorkItemsApiFp = exports.WorkItemsApiAxiosParamCreator = exports.VendorConnectorMappingsApi = exports.VendorConnectorMappingsApiFactory = exports.VendorConnectorMappingsApiFp = exports.VendorConnectorMappingsApiAxiosParamCreator = exports.TransformsApi = exports.TransformsApiFactory = exports.TransformsApiFp = exports.TransformsApiAxiosParamCreator = exports.PutTaggedObjectTypeV3 = exports.ListTaggedObjectsByTypeTypeV3 = void 0;
|
|
88
|
+
exports.RolesApiAxiosParamCreator = exports.ListRequestableObjectsTypesV3 = exports.RequestableObjectsApi = exports.RequestableObjectsApiFactory = exports.RequestableObjectsApiFp = exports.RequestableObjectsApiAxiosParamCreator = exports.GetReportFileFormatV3 = exports.ReportsDataExtractionApi = exports.ReportsDataExtractionApiFactory = exports.ReportsDataExtractionApiFp = exports.ReportsDataExtractionApiAxiosParamCreator = exports.PublicIdentitiesConfigApi = exports.PublicIdentitiesConfigApiFactory = exports.PublicIdentitiesConfigApiFp = exports.PublicIdentitiesConfigApiAxiosParamCreator = exports.PublicIdentitiesApi = exports.PublicIdentitiesApiFactory = exports.PublicIdentitiesApiFp = exports.PublicIdentitiesApiAxiosParamCreator = exports.PersonalAccessTokensApi = exports.PersonalAccessTokensApiFactory = exports.PersonalAccessTokensApiFp = exports.PersonalAccessTokensApiAxiosParamCreator = exports.PasswordSyncGroupsApi = exports.PasswordSyncGroupsApiFactory = exports.PasswordSyncGroupsApiFp = exports.PasswordSyncGroupsApiAxiosParamCreator = exports.PasswordPoliciesApi = exports.PasswordPoliciesApiFactory = exports.PasswordPoliciesApiFp = exports.PasswordPoliciesApiAxiosParamCreator = exports.PasswordManagementApi = exports.PasswordManagementApiFactory = exports.PasswordManagementApiFp = exports.PasswordManagementApiAxiosParamCreator = exports.PasswordDictionaryApi = exports.PasswordDictionaryApiFactory = exports.PasswordDictionaryApiFp = exports.PasswordDictionaryApiAxiosParamCreator = exports.PasswordConfigurationApi = exports.PasswordConfigurationApiFactory = exports.PasswordConfigurationApiFp = exports.PasswordConfigurationApiAxiosParamCreator = exports.OAuthClientsApi = exports.OAuthClientsApiFactory = exports.OAuthClientsApiFp = exports.OAuthClientsApiAxiosParamCreator = exports.NonEmployeeLifecycleManagementApi = exports.NonEmployeeLifecycleManagementApiFactory = exports.NonEmployeeLifecycleManagementApiFp = void 0;
|
|
89
|
+
exports.DeleteTaggedObjectTypeV3 = exports.TaggedObjectsApi = exports.TaggedObjectsApiFactory = exports.TaggedObjectsApiFp = exports.TaggedObjectsApiAxiosParamCreator = exports.GetSourceSchemasIncludeTypesV3 = exports.SourcesApi = exports.SourcesApiFactory = exports.SourcesApiFp = exports.SourcesApiAxiosParamCreator = exports.SourceUsagesApi = exports.SourceUsagesApiFactory = exports.SourceUsagesApiFp = exports.SourceUsagesApiAxiosParamCreator = exports.ServiceDeskIntegrationApi = exports.ServiceDeskIntegrationApiFactory = exports.ServiceDeskIntegrationApiFp = exports.ServiceDeskIntegrationApiAxiosParamCreator = exports.SegmentsApi = exports.SegmentsApiFactory = exports.SegmentsApiFp = exports.SegmentsApiAxiosParamCreator = exports.SearchAttributeConfigurationApi = exports.SearchAttributeConfigurationApiFactory = exports.SearchAttributeConfigurationApiFp = exports.SearchAttributeConfigurationApiAxiosParamCreator = exports.SearchGetIndexV3 = exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.ScheduledSearchApi = exports.ScheduledSearchApiFactory = exports.ScheduledSearchApiFp = exports.ScheduledSearchApiAxiosParamCreator = exports.SavedSearchApi = exports.SavedSearchApiFactory = exports.SavedSearchApiFp = exports.SavedSearchApiAxiosParamCreator = exports.SODViolationsApi = exports.SODViolationsApiFactory = exports.SODViolationsApiFp = exports.SODViolationsApiAxiosParamCreator = exports.SODPoliciesApi = exports.SODPoliciesApiFactory = exports.SODPoliciesApiFp = exports.SODPoliciesApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = void 0;
|
|
90
|
+
exports.WorkflowsApi = exports.WorkflowsApiFactory = exports.WorkflowsApiFp = exports.WorkflowsApiAxiosParamCreator = exports.WorkItemsApi = exports.WorkItemsApiFactory = exports.WorkItemsApiFp = exports.WorkItemsApiAxiosParamCreator = exports.VendorConnectorMappingsApi = exports.VendorConnectorMappingsApiFactory = exports.VendorConnectorMappingsApiFp = exports.VendorConnectorMappingsApiAxiosParamCreator = exports.TransformsApi = exports.TransformsApiFactory = exports.TransformsApiFp = exports.TransformsApiAxiosParamCreator = exports.PutTaggedObjectTypeV3 = exports.ListTaggedObjectsByTypeTypeV3 = exports.GetTaggedObjectTypeV3 = void 0;
|
|
91
91
|
var axios_1 = __importDefault(require("axios"));
|
|
92
92
|
// Some imports not used depending on template conditions
|
|
93
93
|
// @ts-ignore
|
|
@@ -3014,7 +3014,7 @@ var AccessRequestApprovalsApiAxiosParamCreator = function (configuration) {
|
|
|
3014
3014
|
localVarQueryParameter = {};
|
|
3015
3015
|
// authentication userAuth required
|
|
3016
3016
|
// oauth required
|
|
3017
|
-
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [
|
|
3017
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [], configuration)
|
|
3018
3018
|
// authentication userAuth required
|
|
3019
3019
|
// oauth required
|
|
3020
3020
|
];
|
|
@@ -3024,7 +3024,7 @@ var AccessRequestApprovalsApiAxiosParamCreator = function (configuration) {
|
|
|
3024
3024
|
_a.sent();
|
|
3025
3025
|
// authentication userAuth required
|
|
3026
3026
|
// oauth required
|
|
3027
|
-
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [
|
|
3027
|
+
return [4 /*yield*/, (0, common_1.setOAuthToObject)(localVarHeaderParameter, "userAuth", [], configuration)];
|
|
3028
3028
|
case 2:
|
|
3029
3029
|
// authentication userAuth required
|
|
3030
3030
|
// oauth required
|
|
@@ -3578,7 +3578,7 @@ var AccessRequestsApiAxiosParamCreator = function (configuration) {
|
|
|
3578
3578
|
});
|
|
3579
3579
|
},
|
|
3580
3580
|
/**
|
|
3581
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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, the
|
|
3581
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. * 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. __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.
|
|
3582
3582
|
* @summary Submit access request
|
|
3583
3583
|
* @param {AccessRequest} accessRequest
|
|
3584
3584
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -3857,7 +3857,7 @@ var AccessRequestsApiFp = function (configuration) {
|
|
|
3857
3857
|
});
|
|
3858
3858
|
},
|
|
3859
3859
|
/**
|
|
3860
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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, the
|
|
3860
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. * 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. __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.
|
|
3861
3861
|
* @summary Submit access request
|
|
3862
3862
|
* @param {AccessRequest} accessRequest
|
|
3863
3863
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -3977,7 +3977,7 @@ var AccessRequestsApiFactory = function (configuration, basePath, axios) {
|
|
|
3977
3977
|
return localVarFp.cancelAccessRequest(requestParameters.cancelAccessRequest, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
3978
3978
|
},
|
|
3979
3979
|
/**
|
|
3980
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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, the
|
|
3980
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. * 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. __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.
|
|
3981
3981
|
* @summary Submit access request
|
|
3982
3982
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
3983
3983
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -4043,7 +4043,7 @@ var AccessRequestsApi = /** @class */ (function (_super) {
|
|
|
4043
4043
|
return (0, exports.AccessRequestsApiFp)(this.configuration).cancelAccessRequest(requestParameters.cancelAccessRequest, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
4044
4044
|
};
|
|
4045
4045
|
/**
|
|
4046
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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, the
|
|
4046
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. 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 doesn\'t 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\'s 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. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. * 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. __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.
|
|
4047
4047
|
* @summary Submit access request
|
|
4048
4048
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
4049
4049
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26885,7 +26885,7 @@ var RequestableObjectsApiAxiosParamCreator = function (configuration) {
|
|
|
26885
26885
|
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
26886
26886
|
* @summary Requestable objects list
|
|
26887
26887
|
* @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.
|
|
26888
|
-
* @param {Array<
|
|
26888
|
+
* @param {Array<ListRequestableObjectsTypesV3>} [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.
|
|
26889
26889
|
* @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter.
|
|
26890
26890
|
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice.
|
|
26891
26891
|
* @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.
|
|
@@ -26980,7 +26980,7 @@ var RequestableObjectsApiFp = function (configuration) {
|
|
|
26980
26980
|
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
26981
26981
|
* @summary Requestable objects list
|
|
26982
26982
|
* @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.
|
|
26983
|
-
* @param {Array<
|
|
26983
|
+
* @param {Array<ListRequestableObjectsTypesV3>} [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.
|
|
26984
26984
|
* @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter.
|
|
26985
26985
|
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice.
|
|
26986
26986
|
* @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.
|
|
@@ -27058,6 +27058,13 @@ var RequestableObjectsApi = /** @class */ (function (_super) {
|
|
|
27058
27058
|
return RequestableObjectsApi;
|
|
27059
27059
|
}(base_1.BaseAPI));
|
|
27060
27060
|
exports.RequestableObjectsApi = RequestableObjectsApi;
|
|
27061
|
+
/**
|
|
27062
|
+
* @export
|
|
27063
|
+
*/
|
|
27064
|
+
exports.ListRequestableObjectsTypesV3 = {
|
|
27065
|
+
AccessProfile: 'ACCESS_PROFILE',
|
|
27066
|
+
Role: 'ROLE'
|
|
27067
|
+
};
|
|
27061
27068
|
/**
|
|
27062
27069
|
* RolesApi - axios parameter creator
|
|
27063
27070
|
* @export
|