sailpoint-api-client 2.1.0 → 2.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/access_profiles/api.ts +4 -4
- package/access_profiles/docs/Methods/AccessProfilesApi.md +1 -1
- package/access_requests/api.ts +8 -8
- package/access_requests/docs/Methods/AccessRequestsApi.md +5 -5
- package/account_aggregations/docs/Methods/AccountAggregationsApi.md +1 -1
- package/accounts/api.ts +4 -4
- package/accounts/docs/Methods/AccountsApi.md +1 -1
- package/approvals/docs/Methods/ApprovalsApi.md +1 -1
- package/custom_password_instructions/docs/Methods/CustomPasswordInstructionsApi.md +2 -2
- package/dimensions/api.ts +4 -4
- package/dimensions/docs/Methods/DimensionsApi.md +1 -1
- package/dist/access_profiles/api.d.ts +4 -4
- package/dist/access_profiles/api.js +4 -4
- package/dist/access_requests/api.d.ts +8 -8
- package/dist/access_requests/api.js +8 -8
- package/dist/accounts/api.d.ts +4 -4
- package/dist/accounts/api.js +4 -4
- package/dist/dimensions/api.d.ts +4 -4
- package/dist/dimensions/api.js +4 -4
- package/dist/entitlements/api.d.ts +8 -8
- package/dist/entitlements/api.js +8 -8
- package/dist/identities/api.d.ts +8 -8
- package/dist/identities/api.js +8 -8
- package/dist/jit_activations/api.d.ts +491 -0
- package/dist/jit_activations/api.js +210 -0
- package/dist/jit_activations/api.js.map +1 -1
- package/dist/lifecycle_states/api.d.ts +1 -1
- package/dist/nerm/common.js +2 -2
- package/dist/nermv2025/common.js +2 -2
- package/dist/notifications/api.d.ts +4 -4
- package/dist/notifications/api.js +4 -4
- package/dist/password_management/api.d.ts +4 -4
- package/dist/password_management/api.js +4 -4
- package/dist/requestable_objects/api.d.ts +4 -4
- package/dist/requestable_objects/api.js +4 -4
- package/dist/roles/api.d.ts +5 -5
- package/dist/roles/api.js +4 -4
- package/dist/sources/api.d.ts +4 -4
- package/dist/sources/api.js +4 -4
- package/dist/triggers/api.d.ts +1 -1
- package/dist/workflows/api.d.ts +4 -4
- package/dist/workflows/api.js +4 -4
- package/entitlements/api.ts +8 -8
- package/entitlements/docs/Methods/EntitlementsApi.md +2 -2
- package/identities/api.ts +8 -8
- package/identities/docs/Methods/IdentitiesApi.md +2 -2
- package/jit_activations/.openapi-generator/FILES +7 -0
- package/jit_activations/api.ts +611 -0
- package/jit_activations/docs/Examples/typescript_code_examples_overlay.yaml +38 -0
- package/jit_activations/docs/Methods/JITActivationsApi.md +113 -1
- package/jit_activations/docs/Models/Jitactivationhistorydocument.md +45 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentFrictionsInner.md +22 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummary.md +22 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummaryJustification.md +20 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummaryPolicyMatchesInner.md +20 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummaryReauthentication.md +20 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummaryServiceNowTicket.md +21 -0
- package/lifecycle_states/api.ts +1 -1
- package/lifecycle_states/docs/Models/SetLifecycleStateV1200Response.md +1 -1
- package/nerm/README.md +2 -2
- package/nerm/common.ts +2 -2
- package/nerm/package.json +1 -1
- package/nermv2025/README.md +2 -2
- package/nermv2025/common.ts +2 -2
- package/nermv2025/package.json +1 -1
- package/notifications/api.ts +4 -4
- package/notifications/docs/Methods/NotificationsApi.md +1 -1
- package/package.json +1 -1
- package/password_dictionary/docs/Methods/PasswordDictionaryApi.md +1 -1
- package/password_management/api.ts +4 -4
- package/password_management/docs/Methods/PasswordManagementApi.md +2 -2
- package/public_identities/docs/Methods/PublicIdentitiesApi.md +1 -1
- package/public_identities_config/docs/Methods/PublicIdentitiesConfigApi.md +1 -1
- package/requestable_objects/api.ts +4 -4
- package/requestable_objects/docs/Methods/RequestableObjectsApi.md +3 -3
- package/roles/api.ts +5 -5
- package/roles/docs/Methods/RolesApi.md +1 -1
- package/saved_search/docs/Methods/SavedSearchApi.md +1 -1
- package/search_attribute_configuration/docs/Methods/SearchAttributeConfigurationApi.md +1 -1
- package/sources/api.ts +4 -4
- package/sources/docs/Methods/SourcesApi.md +1 -1
- package/triggers/api.ts +1 -1
- package/triggers/docs/Models/AccessRequestDynamicApprover.md +1 -1
- package/workflows/api.ts +4 -4
- package/workflows/docs/Methods/WorkflowsApi.md +1 -1
|
@@ -2603,7 +2603,7 @@ export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Config
|
|
|
2603
2603
|
*/
|
|
2604
2604
|
cancelAccessRequestV1: (cancelAccessRequest: CancelAccessRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2605
2605
|
/**
|
|
2606
|
-
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/
|
|
2606
|
+
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/docs/api/cancel-access-request-v-1). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/docs/api/list-account-activities-v-1). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
2607
2607
|
* @summary Close access request
|
|
2608
2608
|
* @param {CloseAccessRequest} closeAccessRequest
|
|
2609
2609
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -2611,7 +2611,7 @@ export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Config
|
|
|
2611
2611
|
*/
|
|
2612
2612
|
closeAccessRequestV1: (closeAccessRequest: CloseAccessRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2613
2613
|
/**
|
|
2614
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/
|
|
2614
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/docs/api/list-access-request-status-v-1) or the [Pending Access Request Approvals](https://developer.sailpoint.com/docs/api/list-pending-approvals-v-1) APIs. You can also use the [Search API](https://developer.sailpoint.com/docs/api/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/docs/api/get-access-request-config-v-2) 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 `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * 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 cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * 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.
|
|
2615
2615
|
* @summary Submit access request
|
|
2616
2616
|
* @param {AccessRequest} accessRequest
|
|
2617
2617
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -2734,7 +2734,7 @@ export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
|
|
|
2734
2734
|
*/
|
|
2735
2735
|
cancelAccessRequestV1(cancelAccessRequest: CancelAccessRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
2736
2736
|
/**
|
|
2737
|
-
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/
|
|
2737
|
+
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/docs/api/cancel-access-request-v-1). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/docs/api/list-account-activities-v-1). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
2738
2738
|
* @summary Close access request
|
|
2739
2739
|
* @param {CloseAccessRequest} closeAccessRequest
|
|
2740
2740
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -2742,7 +2742,7 @@ export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
|
|
|
2742
2742
|
*/
|
|
2743
2743
|
closeAccessRequestV1(closeAccessRequest: CloseAccessRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
2744
2744
|
/**
|
|
2745
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/
|
|
2745
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/docs/api/list-access-request-status-v-1) or the [Pending Access Request Approvals](https://developer.sailpoint.com/docs/api/list-pending-approvals-v-1) APIs. You can also use the [Search API](https://developer.sailpoint.com/docs/api/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/docs/api/get-access-request-config-v-2) 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 `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * 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 cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * 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.
|
|
2746
2746
|
* @summary Submit access request
|
|
2747
2747
|
* @param {AccessRequest} accessRequest
|
|
2748
2748
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -2865,7 +2865,7 @@ export declare const AccessRequestsApiFactory: (configuration?: Configuration, b
|
|
|
2865
2865
|
*/
|
|
2866
2866
|
cancelAccessRequestV1(requestParameters: AccessRequestsApiCancelAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
2867
2867
|
/**
|
|
2868
|
-
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/
|
|
2868
|
+
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/docs/api/cancel-access-request-v-1). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/docs/api/list-account-activities-v-1). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
2869
2869
|
* @summary Close access request
|
|
2870
2870
|
* @param {AccessRequestsApiCloseAccessRequestV1Request} requestParameters Request parameters.
|
|
2871
2871
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -2873,7 +2873,7 @@ export declare const AccessRequestsApiFactory: (configuration?: Configuration, b
|
|
|
2873
2873
|
*/
|
|
2874
2874
|
closeAccessRequestV1(requestParameters: AccessRequestsApiCloseAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
2875
2875
|
/**
|
|
2876
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/
|
|
2876
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/docs/api/list-access-request-status-v-1) or the [Pending Access Request Approvals](https://developer.sailpoint.com/docs/api/list-pending-approvals-v-1) APIs. You can also use the [Search API](https://developer.sailpoint.com/docs/api/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/docs/api/get-access-request-config-v-2) 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 `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * 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 cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * 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.
|
|
2877
2877
|
* @summary Submit access request
|
|
2878
2878
|
* @param {AccessRequestsApiCreateAccessRequestV1Request} requestParameters Request parameters.
|
|
2879
2879
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -3249,7 +3249,7 @@ export declare class AccessRequestsApi extends BaseAPI {
|
|
|
3249
3249
|
*/
|
|
3250
3250
|
cancelAccessRequestV1(requestParameters: AccessRequestsApiCancelAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
3251
3251
|
/**
|
|
3252
|
-
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/
|
|
3252
|
+
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/docs/api/cancel-access-request-v-1). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/docs/api/list-account-activities-v-1). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
3253
3253
|
* @summary Close access request
|
|
3254
3254
|
* @param {AccessRequestsApiCloseAccessRequestV1Request} requestParameters Request parameters.
|
|
3255
3255
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -3258,7 +3258,7 @@ export declare class AccessRequestsApi extends BaseAPI {
|
|
|
3258
3258
|
*/
|
|
3259
3259
|
closeAccessRequestV1(requestParameters: AccessRequestsApiCloseAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
3260
3260
|
/**
|
|
3261
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/
|
|
3261
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/docs/api/list-access-request-status-v-1) or the [Pending Access Request Approvals](https://developer.sailpoint.com/docs/api/list-pending-approvals-v-1) APIs. You can also use the [Search API](https://developer.sailpoint.com/docs/api/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/docs/api/get-access-request-config-v-2) 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 `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * 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 cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * 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.
|
|
3262
3262
|
* @summary Submit access request
|
|
3263
3263
|
* @param {AccessRequestsApiCreateAccessRequestV1Request} requestParameters Request parameters.
|
|
3264
3264
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -416,7 +416,7 @@ var AccessRequestsApiAxiosParamCreator = function (configuration) {
|
|
|
416
416
|
});
|
|
417
417
|
},
|
|
418
418
|
/**
|
|
419
|
-
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/
|
|
419
|
+
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/docs/api/cancel-access-request-v-1). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/docs/api/list-account-activities-v-1). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
420
420
|
* @summary Close access request
|
|
421
421
|
* @param {CloseAccessRequest} closeAccessRequest
|
|
422
422
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -450,7 +450,7 @@ var AccessRequestsApiAxiosParamCreator = function (configuration) {
|
|
|
450
450
|
});
|
|
451
451
|
},
|
|
452
452
|
/**
|
|
453
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/
|
|
453
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/docs/api/list-access-request-status-v-1) or the [Pending Access Request Approvals](https://developer.sailpoint.com/docs/api/list-pending-approvals-v-1) APIs. You can also use the [Search API](https://developer.sailpoint.com/docs/api/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/docs/api/get-access-request-config-v-2) 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 `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * 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 cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * 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.
|
|
454
454
|
* @summary Submit access request
|
|
455
455
|
* @param {AccessRequest} accessRequest
|
|
456
456
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -916,7 +916,7 @@ var AccessRequestsApiFp = function (configuration) {
|
|
|
916
916
|
});
|
|
917
917
|
},
|
|
918
918
|
/**
|
|
919
|
-
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/
|
|
919
|
+
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/docs/api/cancel-access-request-v-1). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/docs/api/list-account-activities-v-1). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
920
920
|
* @summary Close access request
|
|
921
921
|
* @param {CloseAccessRequest} closeAccessRequest
|
|
922
922
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -939,7 +939,7 @@ var AccessRequestsApiFp = function (configuration) {
|
|
|
939
939
|
});
|
|
940
940
|
},
|
|
941
941
|
/**
|
|
942
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/
|
|
942
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/docs/api/list-access-request-status-v-1) or the [Pending Access Request Approvals](https://developer.sailpoint.com/docs/api/list-pending-approvals-v-1) APIs. You can also use the [Search API](https://developer.sailpoint.com/docs/api/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/docs/api/get-access-request-config-v-2) 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 `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * 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 cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * 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.
|
|
943
943
|
* @summary Submit access request
|
|
944
944
|
* @param {AccessRequest} accessRequest
|
|
945
945
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1207,7 +1207,7 @@ var AccessRequestsApiFactory = function (configuration, basePath, axios) {
|
|
|
1207
1207
|
return localVarFp.cancelAccessRequestV1(requestParameters.cancelAccessRequest, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1208
1208
|
},
|
|
1209
1209
|
/**
|
|
1210
|
-
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/
|
|
1210
|
+
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/docs/api/cancel-access-request-v-1). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/docs/api/list-account-activities-v-1). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
1211
1211
|
* @summary Close access request
|
|
1212
1212
|
* @param {AccessRequestsApiCloseAccessRequestV1Request} requestParameters Request parameters.
|
|
1213
1213
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1217,7 +1217,7 @@ var AccessRequestsApiFactory = function (configuration, basePath, axios) {
|
|
|
1217
1217
|
return localVarFp.closeAccessRequestV1(requestParameters.closeAccessRequest, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1218
1218
|
},
|
|
1219
1219
|
/**
|
|
1220
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/
|
|
1220
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/docs/api/list-access-request-status-v-1) or the [Pending Access Request Approvals](https://developer.sailpoint.com/docs/api/list-pending-approvals-v-1) APIs. You can also use the [Search API](https://developer.sailpoint.com/docs/api/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/docs/api/get-access-request-config-v-2) 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 `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * 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 cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * 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.
|
|
1221
1221
|
* @summary Submit access request
|
|
1222
1222
|
* @param {AccessRequestsApiCreateAccessRequestV1Request} requestParameters Request parameters.
|
|
1223
1223
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1358,7 +1358,7 @@ var AccessRequestsApi = /** @class */ (function (_super) {
|
|
|
1358
1358
|
return (0, exports.AccessRequestsApiFp)(this.configuration).cancelAccessRequestV1(requestParameters.cancelAccessRequest, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1359
1359
|
};
|
|
1360
1360
|
/**
|
|
1361
|
-
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/
|
|
1361
|
+
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/docs/api/cancel-access-request-v-1). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/docs/api/list-account-activities-v-1). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
1362
1362
|
* @summary Close access request
|
|
1363
1363
|
* @param {AccessRequestsApiCloseAccessRequestV1Request} requestParameters Request parameters.
|
|
1364
1364
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1370,7 +1370,7 @@ var AccessRequestsApi = /** @class */ (function (_super) {
|
|
|
1370
1370
|
return (0, exports.AccessRequestsApiFp)(this.configuration).closeAccessRequestV1(requestParameters.closeAccessRequest, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1371
1371
|
};
|
|
1372
1372
|
/**
|
|
1373
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/
|
|
1373
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::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/docs/api/list-access-request-status-v-1) or the [Pending Access Request Approvals](https://developer.sailpoint.com/docs/api/list-pending-approvals-v-1) APIs. You can also use the [Search API](https://developer.sailpoint.com/docs/api/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/docs/api/get-access-request-config-v-2) 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 `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * 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 cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * 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.
|
|
1374
1374
|
* @summary Submit access request
|
|
1375
1375
|
* @param {AccessRequestsApiCreateAccessRequestV1Request} requestParameters Request parameters.
|
|
1376
1376
|
* @param {*} [axiosOptions] Override http request option.
|
package/dist/accounts/api.d.ts
CHANGED
|
@@ -1032,7 +1032,7 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1032
1032
|
*/
|
|
1033
1033
|
deleteAccountAsyncV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1034
1034
|
/**
|
|
1035
|
-
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/
|
|
1035
|
+
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/docs/api/disable-account-v-1) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.**
|
|
1036
1036
|
* @summary Delete account
|
|
1037
1037
|
* @param {string} id Account ID.
|
|
1038
1038
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1179,7 +1179,7 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
1179
1179
|
*/
|
|
1180
1180
|
deleteAccountAsyncV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskResultDto>>;
|
|
1181
1181
|
/**
|
|
1182
|
-
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/
|
|
1182
|
+
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/docs/api/disable-account-v-1) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.**
|
|
1183
1183
|
* @summary Delete account
|
|
1184
1184
|
* @param {string} id Account ID.
|
|
1185
1185
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1326,7 +1326,7 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
1326
1326
|
*/
|
|
1327
1327
|
deleteAccountAsyncV1(requestParameters: AccountsApiDeleteAccountAsyncV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TaskResultDto>;
|
|
1328
1328
|
/**
|
|
1329
|
-
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/
|
|
1329
|
+
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/docs/api/disable-account-v-1) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.**
|
|
1330
1330
|
* @summary Delete account
|
|
1331
1331
|
* @param {AccountsApiDeleteAccountV1Request} requestParameters Request parameters.
|
|
1332
1332
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1750,7 +1750,7 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
1750
1750
|
*/
|
|
1751
1751
|
deleteAccountAsyncV1(requestParameters: AccountsApiDeleteAccountAsyncV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskResultDto, any>>;
|
|
1752
1752
|
/**
|
|
1753
|
-
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/
|
|
1753
|
+
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/docs/api/disable-account-v-1) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.**
|
|
1754
1754
|
* @summary Delete account
|
|
1755
1755
|
* @param {AccountsApiDeleteAccountV1Request} requestParameters Request parameters.
|
|
1756
1756
|
* @param {*} [axiosOptions] Override http request option.
|
package/dist/accounts/api.js
CHANGED
|
@@ -243,7 +243,7 @@ var AccountsApiAxiosParamCreator = function (configuration) {
|
|
|
243
243
|
});
|
|
244
244
|
},
|
|
245
245
|
/**
|
|
246
|
-
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/
|
|
246
|
+
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/docs/api/disable-account-v-1) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.**
|
|
247
247
|
* @summary Delete account
|
|
248
248
|
* @param {string} id Account ID.
|
|
249
249
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -820,7 +820,7 @@ var AccountsApiFp = function (configuration) {
|
|
|
820
820
|
});
|
|
821
821
|
},
|
|
822
822
|
/**
|
|
823
|
-
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/
|
|
823
|
+
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/docs/api/disable-account-v-1) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.**
|
|
824
824
|
* @summary Delete account
|
|
825
825
|
* @param {string} id Account ID.
|
|
826
826
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1185,7 +1185,7 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
1185
1185
|
return localVarFp.deleteAccountAsyncV1(requestParameters.id, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1186
1186
|
},
|
|
1187
1187
|
/**
|
|
1188
|
-
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/
|
|
1188
|
+
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/docs/api/disable-account-v-1) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.**
|
|
1189
1189
|
* @summary Delete account
|
|
1190
1190
|
* @param {AccountsApiDeleteAccountV1Request} requestParameters Request parameters.
|
|
1191
1191
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1364,7 +1364,7 @@ var AccountsApi = /** @class */ (function (_super) {
|
|
|
1364
1364
|
return (0, exports.AccountsApiFp)(this.configuration).deleteAccountAsyncV1(requestParameters.id, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1365
1365
|
};
|
|
1366
1366
|
/**
|
|
1367
|
-
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/
|
|
1367
|
+
* Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/docs/api/disable-account-v-1) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.**
|
|
1368
1368
|
* @summary Delete account
|
|
1369
1369
|
* @param {AccountsApiDeleteAccountV1Request} requestParameters Request parameters.
|
|
1370
1370
|
* @param {*} [axiosOptions] Override http request option.
|
package/dist/dimensions/api.d.ts
CHANGED
|
@@ -1283,7 +1283,7 @@ export declare const DimensionsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
1283
1283
|
*/
|
|
1284
1284
|
createDimensionV1: (roleId: string, dimension: Dimension, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1285
1285
|
/**
|
|
1286
|
-
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
1286
|
+
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
1287
1287
|
* @summary Delete dimension(s)
|
|
1288
1288
|
* @param {string} roleId Parent Role Id of the dimensions.
|
|
1289
1289
|
* @param {DimensionBulkDeleteRequest} dimensionBulkDeleteRequest
|
|
@@ -1377,7 +1377,7 @@ export declare const DimensionsApiFp: (configuration?: Configuration) => {
|
|
|
1377
1377
|
*/
|
|
1378
1378
|
createDimensionV1(roleId: string, dimension: Dimension, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dimension>>;
|
|
1379
1379
|
/**
|
|
1380
|
-
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
1380
|
+
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
1381
1381
|
* @summary Delete dimension(s)
|
|
1382
1382
|
* @param {string} roleId Parent Role Id of the dimensions.
|
|
1383
1383
|
* @param {DimensionBulkDeleteRequest} dimensionBulkDeleteRequest
|
|
@@ -1470,7 +1470,7 @@ export declare const DimensionsApiFactory: (configuration?: Configuration, baseP
|
|
|
1470
1470
|
*/
|
|
1471
1471
|
createDimensionV1(requestParameters: DimensionsApiCreateDimensionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Dimension>;
|
|
1472
1472
|
/**
|
|
1473
|
-
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
1473
|
+
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
1474
1474
|
* @summary Delete dimension(s)
|
|
1475
1475
|
* @param {DimensionsApiDeleteBulkDimensionsV1Request} requestParameters Request parameters.
|
|
1476
1476
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1791,7 +1791,7 @@ export declare class DimensionsApi extends BaseAPI {
|
|
|
1791
1791
|
*/
|
|
1792
1792
|
createDimensionV1(requestParameters: DimensionsApiCreateDimensionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Dimension, any>>;
|
|
1793
1793
|
/**
|
|
1794
|
-
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
1794
|
+
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
1795
1795
|
* @summary Delete dimension(s)
|
|
1796
1796
|
* @param {DimensionsApiDeleteBulkDimensionsV1Request} requestParameters Request parameters.
|
|
1797
1797
|
* @param {*} [axiosOptions] Override http request option.
|
package/dist/dimensions/api.js
CHANGED
|
@@ -226,7 +226,7 @@ var DimensionsApiAxiosParamCreator = function (configuration) {
|
|
|
226
226
|
});
|
|
227
227
|
},
|
|
228
228
|
/**
|
|
229
|
-
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
229
|
+
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
230
230
|
* @summary Delete dimension(s)
|
|
231
231
|
* @param {string} roleId Parent Role Id of the dimensions.
|
|
232
232
|
* @param {DimensionBulkDeleteRequest} dimensionBulkDeleteRequest
|
|
@@ -585,7 +585,7 @@ var DimensionsApiFp = function (configuration) {
|
|
|
585
585
|
});
|
|
586
586
|
},
|
|
587
587
|
/**
|
|
588
|
-
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
588
|
+
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
589
589
|
* @summary Delete dimension(s)
|
|
590
590
|
* @param {string} roleId Parent Role Id of the dimensions.
|
|
591
591
|
* @param {DimensionBulkDeleteRequest} dimensionBulkDeleteRequest
|
|
@@ -789,7 +789,7 @@ var DimensionsApiFactory = function (configuration, basePath, axios) {
|
|
|
789
789
|
return localVarFp.createDimensionV1(requestParameters.roleId, requestParameters.dimension, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
790
790
|
},
|
|
791
791
|
/**
|
|
792
|
-
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
792
|
+
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
793
793
|
* @summary Delete dimension(s)
|
|
794
794
|
* @param {DimensionsApiDeleteBulkDimensionsV1Request} requestParameters Request parameters.
|
|
795
795
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -885,7 +885,7 @@ var DimensionsApi = /** @class */ (function (_super) {
|
|
|
885
885
|
return (0, exports.DimensionsApiFp)(this.configuration).createDimensionV1(requestParameters.roleId, requestParameters.dimension, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
886
886
|
};
|
|
887
887
|
/**
|
|
888
|
-
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
888
|
+
* This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
889
889
|
* @summary Delete dimension(s)
|
|
890
890
|
* @param {DimensionsApiDeleteBulkDimensionsV1Request} requestParameters Request parameters.
|
|
891
891
|
* @param {*} [axiosOptions] Override http request option.
|