sailpoint-api-client 2.0.13 → 2.0.14

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.
Files changed (38) hide show
  1. package/dist/machine_identities/api.d.ts +1220 -44
  2. package/dist/machine_identities/api.js +885 -44
  3. package/dist/machine_identities/api.js.map +1 -1
  4. package/dist/nerm/common.js +2 -2
  5. package/dist/nermv2025/common.js +2 -2
  6. package/dist/workflows/api.d.ts +8 -4
  7. package/dist/workflows/api.js +8 -4
  8. package/dist/workflows/api.js.map +1 -1
  9. package/machine_identities/.openapi-generator/FILES +17 -0
  10. package/machine_identities/api.ts +1659 -44
  11. package/machine_identities/docs/Examples/typescript_code_examples_overlay.yaml +146 -0
  12. package/machine_identities/docs/Methods/MachineIdentitiesApi.md +382 -0
  13. package/machine_identities/docs/Models/ArrayInner.md +18 -0
  14. package/machine_identities/docs/Models/Businessapplicationref.md +23 -0
  15. package/machine_identities/docs/Models/Correlationcondition.md +24 -0
  16. package/machine_identities/docs/Models/Correlationconfig.md +26 -0
  17. package/machine_identities/docs/Models/Correlationrule.md +24 -0
  18. package/machine_identities/docs/Models/Correlationruleaction.md +20 -0
  19. package/machine_identities/docs/Models/Jsonpatchoperation.md +21 -0
  20. package/machine_identities/docs/Models/JsonpatchoperationValue.md +18 -0
  21. package/machine_identities/docs/Models/MachineIdentityV2Risk.md +20 -0
  22. package/machine_identities/docs/Models/MachineIdentityV2Source.md +21 -0
  23. package/machine_identities/docs/Models/Machineidentityownersv2.md +20 -0
  24. package/machine_identities/docs/Models/Machineidentityownersv2Primary.md +21 -0
  25. package/machine_identities/docs/Models/Machineidentityv2.md +42 -0
  26. package/machine_identities/docs/Models/Resourcev2.md +22 -0
  27. package/machine_identities/docs/Models/Sanctionedstatus.md +23 -0
  28. package/machine_identities/docs/Models/Userentitlementv2.md +22 -0
  29. package/machine_identities/docs/Models/Userentitlementv2Source.md +21 -0
  30. package/nerm/README.md +2 -2
  31. package/nerm/common.ts +2 -2
  32. package/nerm/package.json +1 -1
  33. package/nermv2025/README.md +2 -2
  34. package/nermv2025/common.ts +2 -2
  35. package/nermv2025/package.json +1 -1
  36. package/package.json +1 -1
  37. package/workflows/api.ts +8 -4
  38. package/workflows/docs/Methods/WorkflowsApi.md +4 -1
@@ -0,0 +1,24 @@
1
+ ---
2
+ id: v1-correlationcondition
3
+ title: Correlationcondition
4
+ pagination_label: Correlationcondition
5
+ sidebar_label: Correlationcondition
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'Correlationcondition', 'v1Correlationcondition']
8
+ slug: /tools/sdk/typescript/machine_identities/models/correlationcondition
9
+ tags: ['SDK', 'Software Development Kit', 'Correlationcondition', 'v1Correlationcondition']
10
+ ---
11
+
12
+ # Correlationcondition
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **id** | **(optional)** `string` | System-generated unique ID of the condition. | [default to undefined]
19
+ **leftAttributeName** | `string` | The left-hand attribute name of the condition. | [default to undefined]
20
+ **operatorType** | `string` | The comparison operator applied between the left and right attributes. | [default to undefined]
21
+ **rightAttributeName** | `string` | The right-hand attribute name. Use an empty string when there is no RHS attribute. | [default to undefined]
22
+ **transform** | **(optional)** `string` | Optional transform applied before comparison. | [default to undefined]
23
+ **ordinal** | `number` | The position of this condition within the rule. | [default to undefined]
24
+
@@ -0,0 +1,26 @@
1
+ ---
2
+ id: v1-correlationconfig
3
+ title: Correlationconfig
4
+ pagination_label: Correlationconfig
5
+ sidebar_label: Correlationconfig
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'Correlationconfig', 'v1Correlationconfig']
8
+ slug: /tools/sdk/typescript/machine_identities/models/correlationconfig
9
+ tags: ['SDK', 'Software Development Kit', 'Correlationconfig', 'v1Correlationconfig']
10
+ ---
11
+
12
+ # Correlationconfig
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **id** | `string` | System-generated unique ID of the correlation config. | [default to undefined]
19
+ **sourceId** | `string` | The source ID this config belongs to. | [default to undefined]
20
+ **resourceId** | `string` | The source resource identifier for this config scope. | [default to undefined]
21
+ **type** | `string` | The correlation config type. | [default to undefined]
22
+ **attributes** | | JSON object of config attributes. May include syncPrimaryToMachineAccounts (boolean) on OWNER_PRIMARY only. | [default to undefined]
23
+ **rules** | `Array<Correlationrule>` | The ordered set of correlation rules for this config. | [default to undefined]
24
+ **created** | **(optional)** `string` | Creation date of the config. | [readonly] [default to undefined]
25
+ **modified** | **(optional)** `string` | Last modification date of the config. | [readonly] [default to undefined]
26
+
@@ -0,0 +1,24 @@
1
+ ---
2
+ id: v1-correlationrule
3
+ title: Correlationrule
4
+ pagination_label: Correlationrule
5
+ sidebar_label: Correlationrule
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'Correlationrule', 'v1Correlationrule']
8
+ slug: /tools/sdk/typescript/machine_identities/models/correlationrule
9
+ tags: ['SDK', 'Software Development Kit', 'Correlationrule', 'v1Correlationrule']
10
+ ---
11
+
12
+ # Correlationrule
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **id** | **(optional)** `string` | Omit for new rules (server mints a UUID). Send only when updating a rule that already exists on this config (merge on PATCH). Unknown ids are rejected. | [default to undefined]
19
+ **priority** | `number` | The evaluation priority of the rule. Lower values are evaluated first. | [default to undefined]
20
+ **defaultRule** | `boolean` | Whether this rule is the default rule for the config. | [default to undefined]
21
+ **ruleType** | `string` | The rule subject type. When either ruleType or ruleAction.type is GOVERNANCE_GROUP, both must be; ruleType GOVERNANCE_GROUP is allowed only when the parent config type is OWNER_SECONDARY. | [default to undefined]
22
+ **ruleAction** | `Correlationruleaction` | | [default to undefined]
23
+ **conditionExpressions** | `Array<Correlationcondition>` | The conditions that must match for this rule to apply. | [default to undefined]
24
+
@@ -0,0 +1,20 @@
1
+ ---
2
+ id: v1-correlationruleaction
3
+ title: Correlationruleaction
4
+ pagination_label: Correlationruleaction
5
+ sidebar_label: Correlationruleaction
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'Correlationruleaction', 'v1Correlationruleaction']
8
+ slug: /tools/sdk/typescript/machine_identities/models/correlationruleaction
9
+ tags: ['SDK', 'Software Development Kit', 'Correlationruleaction', 'v1Correlationruleaction']
10
+ ---
11
+
12
+ # Correlationruleaction
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **type** | `string` | The target owner type resolved by this action. | [default to undefined]
19
+ **payload** | **(optional)** | Action-specific payload. | [default to undefined]
20
+
@@ -0,0 +1,21 @@
1
+ ---
2
+ id: v1-jsonpatchoperation
3
+ title: Jsonpatchoperation
4
+ pagination_label: Jsonpatchoperation
5
+ sidebar_label: Jsonpatchoperation
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'Jsonpatchoperation', 'v1Jsonpatchoperation']
8
+ slug: /tools/sdk/typescript/machine_identities/models/jsonpatchoperation
9
+ tags: ['SDK', 'Software Development Kit', 'Jsonpatchoperation', 'v1Jsonpatchoperation']
10
+ ---
11
+
12
+ # Jsonpatchoperation
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **op** | `string` | The operation to be performed | [default to undefined]
19
+ **path** | `string` | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined]
20
+ **value** | **(optional)** `JsonpatchoperationValue` | | [default to undefined]
21
+
@@ -0,0 +1,18 @@
1
+ ---
2
+ id: v1-jsonpatchoperation-value
3
+ title: JsonpatchoperationValue
4
+ pagination_label: JsonpatchoperationValue
5
+ sidebar_label: JsonpatchoperationValue
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValue', 'v1JsonpatchoperationValue']
8
+ slug: /tools/sdk/typescript/machine_identities/models/jsonpatchoperation-value
9
+ tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValue', 'v1JsonpatchoperationValue']
10
+ ---
11
+
12
+ # JsonpatchoperationValue
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+
@@ -0,0 +1,20 @@
1
+ ---
2
+ id: v1-machine-identity-v2-risk
3
+ title: MachineIdentityV2Risk
4
+ pagination_label: MachineIdentityV2Risk
5
+ sidebar_label: MachineIdentityV2Risk
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'MachineIdentityV2Risk', 'v1MachineIdentityV2Risk']
8
+ slug: /tools/sdk/typescript/machine_identities/models/machine-identity-v2-risk
9
+ tags: ['SDK', 'Software Development Kit', 'MachineIdentityV2Risk', 'v1MachineIdentityV2Risk']
10
+ ---
11
+
12
+ # MachineIdentityV2Risk
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **score** | **(optional)** `number` | Normalised risk score 0.0-100.0. | [default to undefined]
19
+ **severity** | **(optional)** `string` | Risk severity bucket. | [default to undefined]
20
+
@@ -0,0 +1,21 @@
1
+ ---
2
+ id: v1-machine-identity-v2-source
3
+ title: MachineIdentityV2Source
4
+ pagination_label: MachineIdentityV2Source
5
+ sidebar_label: MachineIdentityV2Source
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'MachineIdentityV2Source', 'v1MachineIdentityV2Source']
8
+ slug: /tools/sdk/typescript/machine_identities/models/machine-identity-v2-source
9
+ tags: ['SDK', 'Software Development Kit', 'MachineIdentityV2Source', 'v1MachineIdentityV2Source']
10
+ ---
11
+
12
+ # MachineIdentityV2Source
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **type** | **(optional)** `Dtotype` | | [default to undefined]
19
+ **id** | **(optional)** `string` | ID of the object to which this reference applies | [default to undefined]
20
+ **name** | **(optional)** `string` | Human-readable display name of the object to which this reference applies | [default to undefined]
21
+
@@ -0,0 +1,20 @@
1
+ ---
2
+ id: v1-machineidentityownersv2
3
+ title: Machineidentityownersv2
4
+ pagination_label: Machineidentityownersv2
5
+ sidebar_label: Machineidentityownersv2
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'Machineidentityownersv2', 'v1Machineidentityownersv2']
8
+ slug: /tools/sdk/typescript/machine_identities/models/machineidentityownersv2
9
+ tags: ['SDK', 'Software Development Kit', 'Machineidentityownersv2', 'v1Machineidentityownersv2']
10
+ ---
11
+
12
+ # Machineidentityownersv2
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **primary** | **(optional)** `Machineidentityownersv2Primary` | | [default to undefined]
19
+ **secondary** | **(optional)** `Array<Basereferencedto>` | Additional owners. Entries are either up to ten human (IDENTITY) references or exactly one GOVERNANCE_GROUP reference - not both. Governance-group owners appear here with type GOVERNANCE_GROUP. | [default to undefined]
20
+
@@ -0,0 +1,21 @@
1
+ ---
2
+ id: v1-machineidentityownersv2-primary
3
+ title: Machineidentityownersv2Primary
4
+ pagination_label: Machineidentityownersv2Primary
5
+ sidebar_label: Machineidentityownersv2Primary
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'Machineidentityownersv2Primary', 'v1Machineidentityownersv2Primary']
8
+ slug: /tools/sdk/typescript/machine_identities/models/machineidentityownersv2-primary
9
+ tags: ['SDK', 'Software Development Kit', 'Machineidentityownersv2Primary', 'v1Machineidentityownersv2Primary']
10
+ ---
11
+
12
+ # Machineidentityownersv2Primary
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **type** | **(optional)** `Dtotype` | | [default to undefined]
19
+ **id** | **(optional)** `string` | ID of the object to which this reference applies | [default to undefined]
20
+ **name** | **(optional)** `string` | Human-readable display name of the object to which this reference applies | [default to undefined]
21
+
@@ -0,0 +1,42 @@
1
+ ---
2
+ id: v1-machineidentityv2
3
+ title: Machineidentityv2
4
+ pagination_label: Machineidentityv2
5
+ sidebar_label: Machineidentityv2
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'Machineidentityv2', 'v1Machineidentityv2']
8
+ slug: /tools/sdk/typescript/machine_identities/models/machineidentityv2
9
+ tags: ['SDK', 'Software Development Kit', 'Machineidentityv2', 'v1Machineidentityv2']
10
+ ---
11
+
12
+ # Machineidentityv2
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **id** | **(optional)** `string` | System-generated unique ID of the Object | [readonly] [default to undefined]
19
+ **name** | `string` | Name of the Object | [default to undefined]
20
+ **created** | **(optional)** `string` | Creation date of the Object | [readonly] [default to undefined]
21
+ **modified** | **(optional)** `string` | Last modification date of the Object | [readonly] [default to undefined]
22
+ **description** | **(optional)** `string` | Description of the machine identity. | [default to undefined]
23
+ **attributes** | **(optional)** | A map of custom machine identity attributes. | [default to undefined]
24
+ **connectorAttributes** | **(optional)** | A map of attributes sourced from the connector during aggregation. | [default to undefined]
25
+ **manuallyEdited** | **(optional)** `boolean` | Indicates if the machine identity has been manually edited. | [default to false]
26
+ **manuallyCreated** | **(optional)** `boolean` | Indicates if the machine identity has been manually created. | [default to false]
27
+ **owners** | **(optional)** `Machineidentityownersv2` | | [default to undefined]
28
+ **subtype** | **(optional)** `string` | The subtype value associated to the machine identity. | [default to undefined]
29
+ **sourceId** | **(optional)** `string` | The source id associated to the machine identity. | [default to undefined]
30
+ **uuid** | **(optional)** `string` | The UUID associated to the machine identity directly aggregated from a source. | [default to undefined]
31
+ **nativeIdentity** | **(optional)** `string` | The native identity associated to the machine identity directly aggregated from a source. | [default to undefined]
32
+ **datasetId** | **(optional)** `string` | The dataset id associated to the source from which the identity was retrieved. | [default to undefined]
33
+ **environment** | **(optional)** `string` | The environment the machine identity belongs to. | [default to undefined]
34
+ **existsOnSource** | **(optional)** `string` | Indicates whether the machine identity still exists on the source. | [default to undefined]
35
+ **status** | **(optional)** `string` | Operational status read from stored attributes.status; null when absent. | [default to undefined]
36
+ **resource** | **(optional)** `Resourcev2` | | [default to undefined]
37
+ **source** | **(optional)** `MachineIdentityV2Source` | | [default to undefined]
38
+ **userEntitlements** | **(optional)** `Array<Userentitlementv2>` | The user entitlements associated to the machine identity. | [default to undefined]
39
+ **businessApplicationRefs** | **(optional)** `Array<Businessapplicationref>` | Optional Business Application references associated with this machine identity. | [default to undefined]
40
+ **effectiveSanctionedStatus** | **(optional)** `Sanctionedstatus` | | [default to undefined]
41
+ **risk** | **(optional)** `MachineIdentityV2Risk` | | [default to undefined]
42
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ id: v1-resourcev2
3
+ title: Resourcev2
4
+ pagination_label: Resourcev2
5
+ sidebar_label: Resourcev2
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'Resourcev2', 'v1Resourcev2']
8
+ slug: /tools/sdk/typescript/machine_identities/models/resourcev2
9
+ tags: ['SDK', 'Software Development Kit', 'Resourcev2', 'v1Resourcev2']
10
+ ---
11
+
12
+ # Resourcev2
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **id** | **(optional)** `string` | The source resource identifier. | [default to undefined]
19
+ **type** | **(optional)** `string` | The type of the source resource. | [default to undefined]
20
+ **name** | **(optional)** `string` | The display name of the source resource. | [default to undefined]
21
+ **features** | **(optional)** `Array<string>` | The set of features supported by the source resource. | [default to undefined]
22
+
@@ -0,0 +1,23 @@
1
+ ---
2
+ id: v1-sanctionedstatus
3
+ title: Sanctionedstatus
4
+ pagination_label: Sanctionedstatus
5
+ sidebar_label: Sanctionedstatus
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'Sanctionedstatus', 'v1Sanctionedstatus']
8
+ slug: /tools/sdk/typescript/machine_identities/models/sanctionedstatus
9
+ tags: ['SDK', 'Software Development Kit', 'Sanctionedstatus', 'v1Sanctionedstatus']
10
+ ---
11
+
12
+ # Sanctionedstatus
13
+
14
+ ## Enum
15
+
16
+
17
+ * `Sanctioned` (value: `'SANCTIONED'`)
18
+
19
+ * `Unsanctioned` (value: `'UNSANCTIONED'`)
20
+
21
+ * `Unknown` (value: `'UNKNOWN'`)
22
+
23
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ id: v1-userentitlementv2
3
+ title: Userentitlementv2
4
+ pagination_label: Userentitlementv2
5
+ sidebar_label: Userentitlementv2
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'Userentitlementv2', 'v1Userentitlementv2']
8
+ slug: /tools/sdk/typescript/machine_identities/models/userentitlementv2
9
+ tags: ['SDK', 'Software Development Kit', 'Userentitlementv2', 'v1Userentitlementv2']
10
+ ---
11
+
12
+ # Userentitlementv2
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **sourceId** | **(optional)** `string` | The source ID of the entitlement. | [default to undefined]
19
+ **entitlementId** | **(optional)** `string` | The ID of the entitlement. | [default to undefined]
20
+ **displayName** | **(optional)** `string` | The display name of the entitlement. | [default to undefined]
21
+ **source** | **(optional)** `Userentitlementv2Source` | | [default to undefined]
22
+
@@ -0,0 +1,21 @@
1
+ ---
2
+ id: v1-userentitlementv2-source
3
+ title: Userentitlementv2Source
4
+ pagination_label: Userentitlementv2Source
5
+ sidebar_label: Userentitlementv2Source
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'Userentitlementv2Source', 'v1Userentitlementv2Source']
8
+ slug: /tools/sdk/typescript/machine_identities/models/userentitlementv2-source
9
+ tags: ['SDK', 'Software Development Kit', 'Userentitlementv2Source', 'v1Userentitlementv2Source']
10
+ ---
11
+
12
+ # Userentitlementv2Source
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **type** | **(optional)** `Dtotype` | | [default to undefined]
19
+ **id** | **(optional)** `string` | ID of the object to which this reference applies | [default to undefined]
20
+ **name** | **(optional)** `string` | Human-readable display name of the object to which this reference applies | [default to undefined]
21
+
package/nerm/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## sailpoint-nerm-sdk@2.0.13
1
+ ## sailpoint-nerm-sdk@2.0.14
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install sailpoint-nerm-sdk@2.0.13 --save
39
+ npm install sailpoint-nerm-sdk@2.0.14 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
package/nerm/common.ts CHANGED
@@ -144,7 +144,7 @@ export const toPathString = function (url: URL) {
144
144
  */
145
145
  export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
146
146
  return async <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
147
- let userAgent = `SailPoint-SDK-TypeScript/2.0.13`;
147
+ let userAgent = `SailPoint-SDK-TypeScript/2.0.14`;
148
148
  if (configuration?.consumerIdentifier && configuration?.consumerVersion) {
149
149
  userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`;
150
150
  }
@@ -152,7 +152,7 @@ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxi
152
152
  const headers = {
153
153
  ...{'Accept': 'application/json'},
154
154
  ...axiosArgs.axiosOptions.headers,
155
- ...{'X-SailPoint-SDK':'typescript-2.0.13'},
155
+ ...{'X-SailPoint-SDK':'typescript-2.0.14'},
156
156
  ...{'User-Agent': userAgent},
157
157
  }
158
158
 
package/nerm/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sailpoint-nerm-sdk",
3
- "version": "2.0.13",
3
+ "version": "2.0.14",
4
4
  "description": "OpenAPI client for sailpoint-nerm-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -1,4 +1,4 @@
1
- ## sailpoint-nerm-sdk@2.0.13
1
+ ## sailpoint-nerm-sdk@2.0.14
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install sailpoint-nerm-sdk@2.0.13 --save
39
+ npm install sailpoint-nerm-sdk@2.0.14 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -144,7 +144,7 @@ export const toPathString = function (url: URL) {
144
144
  */
145
145
  export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
146
146
  return async <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
147
- let userAgent = `SailPoint-SDK-TypeScript/2.0.13`;
147
+ let userAgent = `SailPoint-SDK-TypeScript/2.0.14`;
148
148
  if (configuration?.consumerIdentifier && configuration?.consumerVersion) {
149
149
  userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`;
150
150
  }
@@ -152,7 +152,7 @@ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxi
152
152
  const headers = {
153
153
  ...{'Accept': 'application/json'},
154
154
  ...axiosArgs.axiosOptions.headers,
155
- ...{'X-SailPoint-SDK':'typescript-2.0.13'},
155
+ ...{'X-SailPoint-SDK':'typescript-2.0.14'},
156
156
  ...{'User-Agent': userAgent},
157
157
  }
158
158
 
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sailpoint-nerm-sdk",
3
- "version": "2.0.13",
3
+ "version": "2.0.14",
4
4
  "description": "OpenAPI client for sailpoint-nerm-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sailpoint-api-client",
3
- "version": "2.0.13",
3
+ "version": "2.0.14",
4
4
  "description": "Official library for using the SailPoint API",
5
5
  "author": "SailPoint DevOps",
6
6
  "repository": {
package/workflows/api.ts CHANGED
@@ -1402,13 +1402,14 @@ export const WorkflowsApiAxiosParamCreator = function (configuration?: Configura
1402
1402
  };
1403
1403
  },
1404
1404
  /**
1405
- * 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/idn/api/beta/list-workflows) 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.
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/idn/api/beta/list-workflows) 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.
1409
1409
  * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
1410
1410
  * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq*
1411
1411
  * @param {*} [axiosOptions] Override http request option.
1412
+ * @deprecated
1412
1413
  * @throws {RequiredError}
1413
1414
  */
1414
1415
  getWorkflowExecutionsV1: async (id: string, limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -1948,13 +1949,14 @@ export const WorkflowsApiFp = function(configuration?: Configuration) {
1948
1949
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1949
1950
  },
1950
1951
  /**
1951
- * 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/idn/api/beta/list-workflows) 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.
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/idn/api/beta/list-workflows) 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.
1952
1953
  * @summary List workflow executions
1953
1954
  * @param {string} id Workflow ID.
1954
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.
1955
1956
  * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
1956
1957
  * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq*
1957
1958
  * @param {*} [axiosOptions] Override http request option.
1959
+ * @deprecated
1958
1960
  * @throws {RequiredError}
1959
1961
  */
1960
1962
  async getWorkflowExecutionsV1(id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Workflowexecution>>> {
@@ -2191,10 +2193,11 @@ export const WorkflowsApiFactory = function (configuration?: Configuration, base
2191
2193
  return localVarFp.getWorkflowExecutionV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath));
2192
2194
  },
2193
2195
  /**
2194
- * 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/idn/api/beta/list-workflows) 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.
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/idn/api/beta/list-workflows) 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.
2195
2197
  * @summary List workflow executions
2196
2198
  * @param {WorkflowsApiGetWorkflowExecutionsV1Request} requestParameters Request parameters.
2197
2199
  * @param {*} [axiosOptions] Override http request option.
2200
+ * @deprecated
2198
2201
  * @throws {RequiredError}
2199
2202
  */
2200
2203
  getWorkflowExecutionsV1(requestParameters: WorkflowsApiGetWorkflowExecutionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Workflowexecution>> {
@@ -2734,10 +2737,11 @@ export class WorkflowsApi extends BaseAPI {
2734
2737
  }
2735
2738
 
2736
2739
  /**
2737
- * 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/idn/api/beta/list-workflows) 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.
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/idn/api/beta/list-workflows) 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.
2738
2741
  * @summary List workflow executions
2739
2742
  * @param {WorkflowsApiGetWorkflowExecutionsV1Request} requestParameters Request parameters.
2740
2743
  * @param {*} [axiosOptions] Override http request option.
2744
+ * @deprecated
2741
2745
  * @throws {RequiredError}
2742
2746
  * @memberof WorkflowsApi
2743
2747
  */
@@ -338,8 +338,11 @@ console.log(result);
338
338
  [[Back to top]](#)
339
339
 
340
340
  ## get-workflow-executions-v1
341
+ :::caution deprecated
342
+ This endpoint has been deprecated and may be replaced or removed in future versions of the API.
343
+ :::
341
344
  List workflow executions
342
- 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:
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:
343
346
  1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows.
344
347
  2. Get your workflow ID from the response.
345
348
  3. You can then do either of the following: