sailpoint-api-client 2.1.1 → 2.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/access_profiles/api.ts +4 -4
- package/access_profiles/docs/Methods/AccessProfilesApi.md +1 -1
- package/access_requests/api.ts +8 -8
- package/access_requests/docs/Methods/AccessRequestsApi.md +5 -5
- package/account_aggregations/docs/Methods/AccountAggregationsApi.md +1 -1
- package/accounts/api.ts +4 -4
- package/accounts/docs/Methods/AccountsApi.md +1 -1
- package/approvals/docs/Methods/ApprovalsApi.md +1 -1
- package/custom_password_instructions/docs/Methods/CustomPasswordInstructionsApi.md +2 -2
- package/dimensions/api.ts +4 -4
- package/dimensions/docs/Methods/DimensionsApi.md +1 -1
- package/dist/access_profiles/api.d.ts +4 -4
- package/dist/access_profiles/api.js +4 -4
- package/dist/access_requests/api.d.ts +8 -8
- package/dist/access_requests/api.js +8 -8
- package/dist/accounts/api.d.ts +4 -4
- package/dist/accounts/api.js +4 -4
- package/dist/dimensions/api.d.ts +4 -4
- package/dist/dimensions/api.js +4 -4
- package/dist/entitlements/api.d.ts +8 -8
- package/dist/entitlements/api.js +8 -8
- package/dist/identities/api.d.ts +8 -8
- package/dist/identities/api.js +8 -8
- package/dist/jit_activations/api.d.ts +491 -0
- package/dist/jit_activations/api.js +210 -0
- package/dist/jit_activations/api.js.map +1 -1
- package/dist/lifecycle_states/api.d.ts +1 -1
- package/dist/nerm/common.js +2 -2
- package/dist/nermv2025/common.js +2 -2
- package/dist/notifications/api.d.ts +4 -4
- package/dist/notifications/api.js +4 -4
- package/dist/password_management/api.d.ts +4 -4
- package/dist/password_management/api.js +4 -4
- package/dist/requestable_objects/api.d.ts +4 -4
- package/dist/requestable_objects/api.js +4 -4
- package/dist/roles/api.d.ts +5 -5
- package/dist/roles/api.js +4 -4
- package/dist/sources/api.d.ts +4 -4
- package/dist/sources/api.js +4 -4
- package/dist/triggers/api.d.ts +1 -1
- package/dist/workflows/api.d.ts +4 -4
- package/dist/workflows/api.js +4 -4
- package/entitlements/api.ts +8 -8
- package/entitlements/docs/Methods/EntitlementsApi.md +2 -2
- package/identities/api.ts +8 -8
- package/identities/docs/Methods/IdentitiesApi.md +2 -2
- package/jit_activations/.openapi-generator/FILES +7 -0
- package/jit_activations/api.ts +611 -0
- package/jit_activations/docs/Examples/typescript_code_examples_overlay.yaml +38 -0
- package/jit_activations/docs/Methods/JITActivationsApi.md +113 -1
- package/jit_activations/docs/Models/Jitactivationhistorydocument.md +45 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentFrictionsInner.md +22 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummary.md +22 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummaryJustification.md +20 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummaryPolicyMatchesInner.md +20 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummaryReauthentication.md +20 -0
- package/jit_activations/docs/Models/JitactivationhistorydocumentSummaryServiceNowTicket.md +21 -0
- package/lifecycle_states/api.ts +1 -1
- package/lifecycle_states/docs/Models/SetLifecycleStateV1200Response.md +1 -1
- package/nerm/README.md +2 -2
- package/nerm/common.ts +2 -2
- package/nerm/package.json +1 -1
- package/nermv2025/README.md +2 -2
- package/nermv2025/common.ts +2 -2
- package/nermv2025/package.json +1 -1
- package/notifications/api.ts +4 -4
- package/notifications/docs/Methods/NotificationsApi.md +1 -1
- package/package.json +1 -1
- package/password_dictionary/docs/Methods/PasswordDictionaryApi.md +1 -1
- package/password_management/api.ts +4 -4
- package/password_management/docs/Methods/PasswordManagementApi.md +2 -2
- package/public_identities/docs/Methods/PublicIdentitiesApi.md +1 -1
- package/public_identities_config/docs/Methods/PublicIdentitiesConfigApi.md +1 -1
- package/requestable_objects/api.ts +4 -4
- package/requestable_objects/docs/Methods/RequestableObjectsApi.md +3 -3
- package/roles/api.ts +5 -5
- package/roles/docs/Methods/RolesApi.md +1 -1
- package/saved_search/docs/Methods/SavedSearchApi.md +1 -1
- package/search_attribute_configuration/docs/Methods/SearchAttributeConfigurationApi.md +1 -1
- package/sources/api.ts +4 -4
- package/sources/docs/Methods/SourcesApi.md +1 -1
- package/triggers/api.ts +1 -1
- package/triggers/docs/Models/AccessRequestDynamicApprover.md +1 -1
- package/workflows/api.ts +4 -4
- package/workflows/docs/Methods/WorkflowsApi.md +1 -1
|
@@ -473,7 +473,7 @@ export const PasswordManagementApiAxiosParamCreator = function (configuration?:
|
|
|
473
473
|
};
|
|
474
474
|
},
|
|
475
475
|
/**
|
|
476
|
-
* This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/
|
|
476
|
+
* This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/update-source-v-1) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/docs/api/get-password-change-status-v-1) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
|
|
477
477
|
* @summary Set identity\'s password
|
|
478
478
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
479
479
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -559,7 +559,7 @@ export const PasswordManagementApiFp = function(configuration?: Configuration) {
|
|
|
559
559
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
560
560
|
},
|
|
561
561
|
/**
|
|
562
|
-
* This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/
|
|
562
|
+
* This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/update-source-v-1) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/docs/api/get-password-change-status-v-1) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
|
|
563
563
|
* @summary Set identity\'s password
|
|
564
564
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
565
565
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -612,7 +612,7 @@ export const PasswordManagementApiFactory = function (configuration?: Configurat
|
|
|
612
612
|
return localVarFp.queryPasswordInfoV1(requestParameters.passwordInfoQueryDTO, axiosOptions).then((request) => request(axios, basePath));
|
|
613
613
|
},
|
|
614
614
|
/**
|
|
615
|
-
* This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/
|
|
615
|
+
* This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/update-source-v-1) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/docs/api/get-password-change-status-v-1) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
|
|
616
616
|
* @summary Set identity\'s password
|
|
617
617
|
* @param {PasswordManagementApiSetPasswordV1Request} requestParameters Request parameters.
|
|
618
618
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -731,7 +731,7 @@ export class PasswordManagementApi extends BaseAPI {
|
|
|
731
731
|
}
|
|
732
732
|
|
|
733
733
|
/**
|
|
734
|
-
* This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/
|
|
734
|
+
* This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/update-source-v-1) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/docs/api/get-password-change-status-v-1) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
|
|
735
735
|
* @summary Set identity\'s password
|
|
736
736
|
* @param {PasswordManagementApiSetPasswordV1Request} requestParameters Request parameters.
|
|
737
737
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -177,7 +177,7 @@ This API is used to set a password for an identity.
|
|
|
177
177
|
|
|
178
178
|
An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow).
|
|
179
179
|
|
|
180
|
-
>**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/
|
|
180
|
+
>**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/update-source-v-1) to add the `PASSWORD` feature.**
|
|
181
181
|
|
|
182
182
|
To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command:
|
|
183
183
|
|
|
@@ -191,7 +191,7 @@ To successfully run this command, you must have OpenSSL installed on your machin
|
|
|
191
191
|
|
|
192
192
|
If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL.
|
|
193
193
|
|
|
194
|
-
You can then use [Get Password Change Request Status](https://developer.sailpoint.com/
|
|
194
|
+
You can then use [Get Password Change Request Status](https://developer.sailpoint.com/docs/api/get-password-change-status-v-1) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
|
|
195
195
|
|
|
196
196
|
|
|
197
197
|
[API Spec](https://developer.sailpoint.com/docs/api/set-password-v-1)
|
|
@@ -10,7 +10,7 @@ tags: ['SDK', 'Software Development Kit', 'PublicIdentities', 'v1PublicIdentitie
|
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# PublicIdentitiesApi
|
|
13
|
-
Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/
|
|
13
|
+
Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/public-identities-config) to enable non-administrators to view identities' publicly visible attributes.
|
|
14
14
|
With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public.
|
|
15
15
|
This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks.
|
|
16
16
|
|
|
@@ -19,7 +19,7 @@ However, it may be helpful for a non-administrator reviewer to see other identit
|
|
|
19
19
|
Administrators can use this API to make those necessary identity attributes public to non-administrators.
|
|
20
20
|
|
|
21
21
|
For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department.
|
|
22
|
-
If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/
|
|
22
|
+
If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/update-public-identity-config-v-1) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information.
|
|
23
23
|
|
|
24
24
|
All URIs are relative to *https://sailpoint.api.identitynow.com*
|
|
25
25
|
|
|
@@ -259,7 +259,7 @@ export type RequestableObjectType = typeof RequestableObjectType[keyof typeof Re
|
|
|
259
259
|
export const RequestableObjectsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
260
260
|
return {
|
|
261
261
|
/**
|
|
262
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/
|
|
262
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/list-entitlements-v-1) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
263
263
|
* @summary Requestable objects list
|
|
264
264
|
* @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
|
|
265
265
|
* @param {Array<ListRequestableObjectsV1TypesEnum>} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
@@ -344,7 +344,7 @@ export const RequestableObjectsApiFp = function(configuration?: Configuration) {
|
|
|
344
344
|
const localVarAxiosParamCreator = RequestableObjectsApiAxiosParamCreator(configuration)
|
|
345
345
|
return {
|
|
346
346
|
/**
|
|
347
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/
|
|
347
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/list-entitlements-v-1) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
348
348
|
* @summary Requestable objects list
|
|
349
349
|
* @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
|
|
350
350
|
* @param {Array<ListRequestableObjectsV1TypesEnum>} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
@@ -375,7 +375,7 @@ export const RequestableObjectsApiFactory = function (configuration?: Configurat
|
|
|
375
375
|
const localVarFp = RequestableObjectsApiFp(configuration)
|
|
376
376
|
return {
|
|
377
377
|
/**
|
|
378
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/
|
|
378
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/list-entitlements-v-1) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
379
379
|
* @summary Requestable objects list
|
|
380
380
|
* @param {RequestableObjectsApiListRequestableObjectsV1Request} requestParameters Request parameters.
|
|
381
381
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -465,7 +465,7 @@ export interface RequestableObjectsApiListRequestableObjectsV1Request {
|
|
|
465
465
|
*/
|
|
466
466
|
export class RequestableObjectsApi extends BaseAPI {
|
|
467
467
|
/**
|
|
468
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/
|
|
468
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/list-entitlements-v-1) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
469
469
|
* @summary Requestable objects list
|
|
470
470
|
* @param {RequestableObjectsApiListRequestableObjectsV1Request} requestParameters Request parameters.
|
|
471
471
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'RequestableObjects', 'v1RequestableOb
|
|
|
11
11
|
|
|
12
12
|
# RequestableObjectsApi
|
|
13
13
|
Use this API to implement requestable object functionality.
|
|
14
|
-
With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/
|
|
14
|
+
With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/access-requests), along with their statuses.
|
|
15
15
|
This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available.
|
|
16
16
|
|
|
17
17
|
All URIs are relative to *https://sailpoint.api.identitynow.com*
|
|
@@ -23,8 +23,8 @@ Method | HTTP request | Description
|
|
|
23
23
|
|
|
24
24
|
## list-requestable-objects-v1
|
|
25
25
|
Requestable objects list
|
|
26
|
-
Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/
|
|
27
|
-
This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/
|
|
26
|
+
Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter.
|
|
27
|
+
This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/list-entitlements-v-1) can be used with the segmented-for-identity parameter.
|
|
28
28
|
Any authenticated token can call this endpoint to see their requestable access items.
|
|
29
29
|
|
|
30
30
|
[API Spec](https://developer.sailpoint.com/docs/api/list-requestable-objects-v-1)
|
package/roles/api.ts
CHANGED
|
@@ -1617,7 +1617,7 @@ export interface RoleMetadataBulkUpdateByIdRequestValuesInner {
|
|
|
1617
1617
|
'values': Array<string> | null;
|
|
1618
1618
|
}
|
|
1619
1619
|
/**
|
|
1620
|
-
* Bulk update by query request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. For more information about the query could refer to [V3 API Perform Search](https://developer.sailpoint.com/docs/api/
|
|
1620
|
+
* Bulk update by query request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. For more information about the query could refer to [V3 API Perform Search](https://developer.sailpoint.com/docs/api/search-post-v-1)
|
|
1621
1621
|
* @export
|
|
1622
1622
|
* @interface RoleMetadataBulkUpdateByQueryRequest
|
|
1623
1623
|
*/
|
|
@@ -1757,7 +1757,7 @@ export const RolesApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
1757
1757
|
};
|
|
1758
1758
|
},
|
|
1759
1759
|
/**
|
|
1760
|
-
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
1760
|
+
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
1761
1761
|
* @summary Delete role(s)
|
|
1762
1762
|
* @param {RoleBulkDeleteRequest} roleBulkDeleteRequest
|
|
1763
1763
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -2445,7 +2445,7 @@ export const RolesApiFp = function(configuration?: Configuration) {
|
|
|
2445
2445
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2446
2446
|
},
|
|
2447
2447
|
/**
|
|
2448
|
-
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
2448
|
+
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
2449
2449
|
* @summary Delete role(s)
|
|
2450
2450
|
* @param {RoleBulkDeleteRequest} roleBulkDeleteRequest
|
|
2451
2451
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -2689,7 +2689,7 @@ export const RolesApiFactory = function (configuration?: Configuration, basePath
|
|
|
2689
2689
|
return localVarFp.createRoleV1(requestParameters.role, axiosOptions).then((request) => request(axios, basePath));
|
|
2690
2690
|
},
|
|
2691
2691
|
/**
|
|
2692
|
-
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
2692
|
+
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
2693
2693
|
* @summary Delete role(s)
|
|
2694
2694
|
* @param {RolesApiDeleteBulkRolesV1Request} requestParameters Request parameters.
|
|
2695
2695
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -3280,7 +3280,7 @@ export class RolesApi extends BaseAPI {
|
|
|
3280
3280
|
}
|
|
3281
3281
|
|
|
3282
3282
|
/**
|
|
3283
|
-
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/
|
|
3283
|
+
* This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
3284
3284
|
* @summary Delete role(s)
|
|
3285
3285
|
* @param {RolesApiDeleteBulkRolesV1Request} requestParameters Request parameters.
|
|
3286
3286
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -302,7 +302,7 @@ console.log(result);
|
|
|
302
302
|
## delete-bulk-roles-v1
|
|
303
303
|
Delete role(s)
|
|
304
304
|
This endpoint initiates a bulk deletion of one or more roles.
|
|
305
|
-
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/
|
|
305
|
+
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.
|
|
306
306
|
This endpoint can only bulk delete up to a limit of 50 roles per request.
|
|
307
307
|
A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
308
308
|
|
|
@@ -15,7 +15,7 @@ With saved search functionality in place, users can save search queries and then
|
|
|
15
15
|
|
|
16
16
|
Search queries in Identity Security Cloud can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries.
|
|
17
17
|
It also opens the possibility to configure Identity Security Cloud to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources.
|
|
18
|
-
Refer to [Scheduled Search](https://developer.sailpoint.com/docs/api/
|
|
18
|
+
Refer to [Scheduled Search](https://developer.sailpoint.com/docs/api/scheduled-search) for more information about running saved searches on a schedule.
|
|
19
19
|
|
|
20
20
|
In Identity Security Cloud, users can save searches under a name, and then they can access that saved search and run it again when they want.
|
|
21
21
|
|
|
@@ -10,7 +10,7 @@ tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfiguration', 'v1Sea
|
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# SearchAttributeConfigurationApi
|
|
13
|
-
Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/
|
|
13
|
+
Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/search).
|
|
14
14
|
With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want.
|
|
15
15
|
|
|
16
16
|
Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential.
|
package/sources/api.ts
CHANGED
|
@@ -5932,7 +5932,7 @@ export const SourcesApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
5932
5932
|
};
|
|
5933
5933
|
},
|
|
5934
5934
|
/**
|
|
5935
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/
|
|
5935
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
5936
5936
|
* @summary Update source schema (partial)
|
|
5937
5937
|
* @param {string} sourceId The Source id.
|
|
5938
5938
|
* @param {string} schemaId The Schema id.
|
|
@@ -6879,7 +6879,7 @@ export const SourcesApiFp = function(configuration?: Configuration) {
|
|
|
6879
6879
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6880
6880
|
},
|
|
6881
6881
|
/**
|
|
6882
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/
|
|
6882
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
6883
6883
|
* @summary Update source schema (partial)
|
|
6884
6884
|
* @param {string} sourceId The Source id.
|
|
6885
6885
|
* @param {string} schemaId The Schema id.
|
|
@@ -7518,7 +7518,7 @@ export const SourcesApiFactory = function (configuration?: Configuration, basePa
|
|
|
7518
7518
|
return localVarFp.updateSourceScheduleV1(requestParameters.sourceId, requestParameters.scheduleType, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath));
|
|
7519
7519
|
},
|
|
7520
7520
|
/**
|
|
7521
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/
|
|
7521
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
7522
7522
|
* @summary Update source schema (partial)
|
|
7523
7523
|
* @param {SourcesApiUpdateSourceSchemaV1Request} requestParameters Request parameters.
|
|
7524
7524
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -9668,7 +9668,7 @@ export class SourcesApi extends BaseAPI {
|
|
|
9668
9668
|
}
|
|
9669
9669
|
|
|
9670
9670
|
/**
|
|
9671
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/
|
|
9671
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
9672
9672
|
* @summary Update source schema (partial)
|
|
9673
9673
|
* @param {SourcesApiUpdateSourceSchemaV1Request} requestParameters Request parameters.
|
|
9674
9674
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -3193,7 +3193,7 @@ The following schema fields are immutable and cannot be updated:
|
|
|
3193
3193
|
To switch an account attribute to a group entitlement, you need to have the following in place:
|
|
3194
3194
|
|
|
3195
3195
|
- `isEntitlement: true`
|
|
3196
|
-
- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/
|
|
3196
|
+
- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group:
|
|
3197
3197
|
```json
|
|
3198
3198
|
{
|
|
3199
3199
|
"name": "groups",
|
package/triggers/api.ts
CHANGED
|
@@ -126,7 +126,7 @@ export type AccessItemRequesterDtoTypeEnum = typeof AccessItemRequesterDtoTypeEn
|
|
|
126
126
|
*/
|
|
127
127
|
export interface AccessRequestDynamicApprover {
|
|
128
128
|
/**
|
|
129
|
-
* The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/
|
|
129
|
+
* The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/docs/api/list-access-request-status-v-1) to get the status of the request.
|
|
130
130
|
* @type {string}
|
|
131
131
|
* @memberof AccessRequestDynamicApprover
|
|
132
132
|
*/
|
|
@@ -15,7 +15,7 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover', 'v1Acc
|
|
|
15
15
|
|
|
16
16
|
Name | Type | Description | Notes
|
|
17
17
|
------------ | ------------- | ------------- | -------------
|
|
18
|
-
**accessRequestId** | `string` | The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/
|
|
18
|
+
**accessRequestId** | `string` | The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/docs/api/list-access-request-status-v-1) to get the status of the request. | [default to undefined]
|
|
19
19
|
**requestedFor** | `Array<AccessItemRequestedForDto>` | Identities access was requested for. | [default to undefined]
|
|
20
20
|
**requestedItems** | `Array<AccessRequestDynamicApproverRequestedItemsInner>` | The access items that are being requested. | [default to undefined]
|
|
21
21
|
**requestedBy** | `AccessItemRequesterDto` | | [default to undefined]
|
package/workflows/api.ts
CHANGED
|
@@ -1402,7 +1402,7 @@ export const WorkflowsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1402
1402
|
};
|
|
1403
1403
|
},
|
|
1404
1404
|
/**
|
|
1405
|
-
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/
|
|
1405
|
+
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
|
|
1406
1406
|
* @summary List workflow executions
|
|
1407
1407
|
* @param {string} id Workflow ID.
|
|
1408
1408
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -1949,7 +1949,7 @@ export const WorkflowsApiFp = function(configuration?: Configuration) {
|
|
|
1949
1949
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1950
1950
|
},
|
|
1951
1951
|
/**
|
|
1952
|
-
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/
|
|
1952
|
+
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
|
|
1953
1953
|
* @summary List workflow executions
|
|
1954
1954
|
* @param {string} id Workflow ID.
|
|
1955
1955
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -2193,7 +2193,7 @@ export const WorkflowsApiFactory = function (configuration?: Configuration, base
|
|
|
2193
2193
|
return localVarFp.getWorkflowExecutionV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath));
|
|
2194
2194
|
},
|
|
2195
2195
|
/**
|
|
2196
|
-
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/
|
|
2196
|
+
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
|
|
2197
2197
|
* @summary List workflow executions
|
|
2198
2198
|
* @param {WorkflowsApiGetWorkflowExecutionsV1Request} requestParameters Request parameters.
|
|
2199
2199
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -2737,7 +2737,7 @@ export class WorkflowsApi extends BaseAPI {
|
|
|
2737
2737
|
}
|
|
2738
2738
|
|
|
2739
2739
|
/**
|
|
2740
|
-
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/
|
|
2740
|
+
* [Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/docs/api/list-workflows-v-1) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
|
|
2741
2741
|
* @summary List workflow executions
|
|
2742
2742
|
* @param {WorkflowsApiGetWorkflowExecutionsV1Request} requestParameters Request parameters.
|
|
2743
2743
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -343,7 +343,7 @@ This endpoint has been deprecated and may be replaced or removed in future versi
|
|
|
343
343
|
:::
|
|
344
344
|
List workflow executions
|
|
345
345
|
[Deprecated] This endpoint will be removed in July 2028. Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following:
|
|
346
|
-
1. Use the [Get Workflows](https://developer.sailpoint.com/
|
|
346
|
+
1. Use the [Get Workflows](https://developer.sailpoint.com/docs/api/list-workflows-v-1) endpoint to get your workflows.
|
|
347
347
|
2. Get your workflow ID from the response.
|
|
348
348
|
3. You can then do either of the following:
|
|
349
349
|
|