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
@@ -14,6 +14,21 @@
14
14
  const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true')
15
15
  const result = await apiInstance.createMachineIdentityV1({ machineidentityrequest: machineidentityrequest });
16
16
  console.log(result);
17
+ - path: /machine-identities/v2
18
+ method: POST
19
+ xCodeSample:
20
+ - lang: TypeScript
21
+ label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#create-machine-identity-v2
22
+ source: |
23
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
24
+ import { Configuration } from 'sailpoint-api-client';
25
+ import { Machineidentityv2 } from 'sailpoint-api-client/dist/machine_identities/api';
26
+
27
+ const configuration = new Configuration();
28
+ const apiInstance = new MachineIdentitiesApi(configuration);
29
+ const machineidentityv2: Machineidentityv2 = ; // Machineidentityv2 |
30
+ const result = await apiInstance.createMachineIdentityV2({ machineidentityv2: machineidentityv2 });
31
+ console.log(result);
17
32
  - path: /machine-identities/v1/{id}
18
33
  method: DELETE
19
34
  xCodeSample:
@@ -29,6 +44,36 @@
29
44
  const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true')
30
45
  const result = await apiInstance.deleteMachineIdentityV1({ id: id });
31
46
  console.log(result);
47
+ - path: /machine-identities/v2/{id}
48
+ method: DELETE
49
+ xCodeSample:
50
+ - lang: TypeScript
51
+ label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#delete-machine-identity-v2
52
+ source: |
53
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
54
+ import { Configuration } from 'sailpoint-api-client';
55
+
56
+ const configuration = new Configuration();
57
+ const apiInstance = new MachineIdentitiesApi(configuration);
58
+ const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Machine Identity ID. (default to undefined)
59
+ const result = await apiInstance.deleteMachineIdentityV2({ id: id });
60
+ console.log(result);
61
+ - path: /sources/v1/{sourceId}/resources/{resourceId}/correlation-configs/{configId}
62
+ method: DELETE
63
+ xCodeSample:
64
+ - lang: TypeScript
65
+ label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#delete-ownership-correlation-config-v1
66
+ source: |
67
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
68
+ import { Configuration } from 'sailpoint-api-client';
69
+
70
+ const configuration = new Configuration();
71
+ const apiInstance = new MachineIdentitiesApi(configuration);
72
+ const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source ID. (default to undefined)
73
+ const resourceId: string = 'aws:iam-role'; // string | The source resource ID (for example, account or aws:iam-role). (default to undefined)
74
+ const configId: string = 'f5dd23fe-3414-42b7-bb1c-869400ad7a10'; // string | The correlation config ID. (default to undefined)
75
+ const result = await apiInstance.deleteOwnershipCorrelationConfigV1({ sourceId: sourceId, resourceId: resourceId, configId: configId });
76
+ console.log(result);
32
77
  - path: /machine-identities/v1/{id}
33
78
  method: GET
34
79
  xCodeSample:
@@ -44,6 +89,36 @@
44
89
  const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true')
45
90
  const result = await apiInstance.getMachineIdentityV1({ id: id });
46
91
  console.log(result);
92
+ - path: /machine-identities/v2/{id}
93
+ method: GET
94
+ xCodeSample:
95
+ - lang: TypeScript
96
+ label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#get-machine-identity-v2
97
+ source: |
98
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
99
+ import { Configuration } from 'sailpoint-api-client';
100
+
101
+ const configuration = new Configuration();
102
+ const apiInstance = new MachineIdentitiesApi(configuration);
103
+ const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Machine Identity ID. (default to undefined)
104
+ const result = await apiInstance.getMachineIdentityV2({ id: id });
105
+ console.log(result);
106
+ - path: /sources/v1/{sourceId}/resources/{resourceId}/correlation-configs/{configId}
107
+ method: GET
108
+ xCodeSample:
109
+ - lang: TypeScript
110
+ label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#get-ownership-correlation-config-v1
111
+ source: |
112
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
113
+ import { Configuration } from 'sailpoint-api-client';
114
+
115
+ const configuration = new Configuration();
116
+ const apiInstance = new MachineIdentitiesApi(configuration);
117
+ const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source ID. (default to undefined)
118
+ const resourceId: string = 'aws:iam-role'; // string | The source resource ID (for example, account or aws:iam-role). (default to undefined)
119
+ const configId: string = 'f5dd23fe-3414-42b7-bb1c-869400ad7a10'; // string | The correlation config ID. (default to undefined)
120
+ const result = await apiInstance.getOwnershipCorrelationConfigV1({ sourceId: sourceId, resourceId: resourceId, configId: configId });
121
+ console.log(result);
47
122
  - path: /machine-identities/v1
48
123
  method: GET
49
124
  xCodeSample:
@@ -63,6 +138,24 @@
63
138
  const offset: number = 0; // number | 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. (optional) (default to 0)
64
139
  const result = await apiInstance.listMachineIdentitiesV1({ });
65
140
  console.log(result);
141
+ - path: /machine-identities/v2
142
+ method: GET
143
+ xCodeSample:
144
+ - lang: TypeScript
145
+ label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#list-machine-identities-v2
146
+ source: |
147
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
148
+ import { Configuration } from 'sailpoint-api-client';
149
+
150
+ const configuration = new Configuration();
151
+ const apiInstance = new MachineIdentitiesApi(configuration);
152
+ const filters: string = 'identityId eq "2c9180858082150f0180893dbaf44201"'; // string | 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: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryGovernanceGroup.id**: *eq, in* **owners.secondaryGovernanceGroup.name**: *eq, in, isnull, pr* **source.id**: *eq, in* **source.name**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **risk.severity**: *eq, in* (optional) (default to undefined)
153
+ const sorters: string = 'nativeIdentity'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** (optional) (default to undefined)
154
+ const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false)
155
+ const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
156
+ const offset: number = 0; // number | 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. (optional) (default to 0)
157
+ const result = await apiInstance.listMachineIdentitiesV2({ });
158
+ console.log(result);
66
159
  - path: /machine-identity-user-entitlements/v1
67
160
  method: GET
68
161
  xCodeSample:
@@ -82,6 +175,43 @@
82
175
  const offset: number = 0; // number | 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. (optional) (default to 0)
83
176
  const result = await apiInstance.listMachineIdentityUserEntitlementsV1({ });
84
177
  console.log(result);
178
+ - path: /sources/v1/{sourceId}/resources/{resourceId}/correlation-configs
179
+ method: GET
180
+ xCodeSample:
181
+ - lang: TypeScript
182
+ label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#list-ownership-correlation-configs-v1
183
+ source: |
184
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
185
+ import { Configuration } from 'sailpoint-api-client';
186
+
187
+ const configuration = new Configuration();
188
+ const apiInstance = new MachineIdentitiesApi(configuration);
189
+ const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source ID. (default to undefined)
190
+ const resourceId: string = 'aws:iam-role'; // string | The source resource ID (for example, account or aws:iam-role). (default to undefined)
191
+ const type: string = 'OWNER_PRIMARY'; // 'OWNER_PRIMARY' | 'OWNER_SECONDARY' | When set, filters to the given config type. (optional) (default to undefined)
192
+ const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false)
193
+ const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
194
+ const offset: number = 0; // number | 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. (optional) (default to 0)
195
+ const result = await apiInstance.listOwnershipCorrelationConfigsV1({ sourceId: sourceId, resourceId: resourceId });
196
+ console.log(result);
197
+ - path: /sources/v1/{sourceId}/resources/{resourceId}/correlation-configs/{configId}
198
+ method: PATCH
199
+ xCodeSample:
200
+ - lang: TypeScript
201
+ label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#patch-ownership-correlation-config-v1
202
+ source: |
203
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
204
+ import { Configuration } from 'sailpoint-api-client';
205
+ import { Jsonpatchoperation } from 'sailpoint-api-client/dist/machine_identities/api';
206
+
207
+ const configuration = new Configuration();
208
+ const apiInstance = new MachineIdentitiesApi(configuration);
209
+ const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source ID. (default to undefined)
210
+ const resourceId: string = 'aws:iam-role'; // string | The source resource ID (for example, account or aws:iam-role). (default to undefined)
211
+ const configId: string = 'f5dd23fe-3414-42b7-bb1c-869400ad7a10'; // string | The correlation config ID. (default to undefined)
212
+ const jsonpatchoperation: Array<Jsonpatchoperation> = [{"op":"replace","path":"/attributes","value":{"syncPrimaryToMachineAccounts":true}}]; // Array<Jsonpatchoperation> | The JSONPatch payload used to update the correlation config.
213
+ const result = await apiInstance.patchOwnershipCorrelationConfigV1({ sourceId: sourceId, resourceId: resourceId, configId: configId, jsonpatchoperation: jsonpatchoperation });
214
+ console.log(result);
85
215
  - path: /sources/v1/{sourceId}/aggregate-agents
86
216
  method: POST
87
217
  xCodeSample:
@@ -115,3 +245,19 @@
115
245
  const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true')
116
246
  const result = await apiInstance.updateMachineIdentityV1({ id: id, requestBody: requestBody });
117
247
  console.log(result);
248
+ - path: /machine-identities/v2/{id}
249
+ method: PATCH
250
+ xCodeSample:
251
+ - lang: TypeScript
252
+ label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#update-machine-identity-v2
253
+ source: |
254
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
255
+ import { Configuration } from 'sailpoint-api-client';
256
+ import { Jsonpatchoperation } from 'sailpoint-api-client/dist/machine_identities/api';
257
+
258
+ const configuration = new Configuration();
259
+ const apiInstance = new MachineIdentitiesApi(configuration);
260
+ const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Machine Identity ID. (default to undefined)
261
+ const jsonpatchoperation: Array<Jsonpatchoperation> = [{"op":"add","path":"/attributes/securityRisk","value":"medium"}]; // Array<Jsonpatchoperation> | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
262
+ const result = await apiInstance.updateMachineIdentityV2({ id: id, jsonpatchoperation: jsonpatchoperation });
263
+ console.log(result);
@@ -16,12 +16,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com*
16
16
  Method | HTTP request | Description
17
17
  ------------- | ------------- | -------------
18
18
  [**create-machine-identity-v1**](#create-machine-identity-v1) | **POST** `/machine-identities/v1` | Create machine identity
19
+ [**create-machine-identity-v2**](#create-machine-identity-v2) | **POST** `/machine-identities/v2` | Create machine identity
19
20
  [**delete-machine-identity-v1**](#delete-machine-identity-v1) | **DELETE** `/machine-identities/v1/{id}` | Delete machine identity
21
+ [**delete-machine-identity-v2**](#delete-machine-identity-v2) | **DELETE** `/machine-identities/v2/{id}` | Delete machine identity
22
+ [**delete-ownership-correlation-config-v1**](#delete-ownership-correlation-config-v1) | **DELETE** `/sources/v1/{sourceId}/resources/{resourceId}/correlation-configs/{configId}` | Delete ownership correlation config
20
23
  [**get-machine-identity-v1**](#get-machine-identity-v1) | **GET** `/machine-identities/v1/{id}` | Get machine identity details
24
+ [**get-machine-identity-v2**](#get-machine-identity-v2) | **GET** `/machine-identities/v2/{id}` | Get machine identity details
25
+ [**get-ownership-correlation-config-v1**](#get-ownership-correlation-config-v1) | **GET** `/sources/v1/{sourceId}/resources/{resourceId}/correlation-configs/{configId}` | Get ownership correlation config
21
26
  [**list-machine-identities-v1**](#list-machine-identities-v1) | **GET** `/machine-identities/v1` | List machine identities
27
+ [**list-machine-identities-v2**](#list-machine-identities-v2) | **GET** `/machine-identities/v2` | List machine identities
22
28
  [**list-machine-identity-user-entitlements-v1**](#list-machine-identity-user-entitlements-v1) | **GET** `/machine-identity-user-entitlements/v1` | List machine identity\&#39;s user entitlements
29
+ [**list-ownership-correlation-configs-v1**](#list-ownership-correlation-configs-v1) | **GET** `/sources/v1/{sourceId}/resources/{resourceId}/correlation-configs` | List ownership correlation configs
30
+ [**patch-ownership-correlation-config-v1**](#patch-ownership-correlation-config-v1) | **PATCH** `/sources/v1/{sourceId}/resources/{resourceId}/correlation-configs/{configId}` | Patch ownership correlation config
23
31
  [**start-machine-identity-aggregation-v1**](#start-machine-identity-aggregation-v1) | **POST** `/sources/v1/{sourceId}/aggregate-agents` | Start machine identity aggregation
24
32
  [**update-machine-identity-v1**](#update-machine-identity-v1) | **PATCH** `/machine-identities/v1/{id}` | Update machine identity details
33
+ [**update-machine-identity-v2**](#update-machine-identity-v2) | **PATCH** `/machine-identities/v2/{id}` | Partial update of machine identity
25
34
 
26
35
 
27
36
  ## create-machine-identity-v1
@@ -68,6 +77,44 @@ console.log(result);
68
77
 
69
78
  [[Back to top]](#)
70
79
 
80
+ ## create-machine-identity-v2
81
+ Create machine identity
82
+ Use this API to create a machine identity. Additional owners may be either up to ten human (IDENTITY) references or exactly one GOVERNANCE_GROUP reference - not both. The maximum supported length for the description field is 2000 characters.
83
+
84
+ [API Spec](https://developer.sailpoint.com/docs/api/create-machine-identity-v-2)
85
+
86
+ ### Parameters
87
+
88
+
89
+ Name | Type | Description | Notes
90
+ ------------- | ------------- | ------------- | -------------
91
+ **machineidentityv2** | `Machineidentityv2` | |
92
+
93
+ ### Return type
94
+
95
+ `Machineidentityv2`
96
+
97
+ ### HTTP request headers
98
+
99
+ - **Content-Type**: application/json
100
+ - **Accept**: application/json
101
+
102
+ ### Example
103
+
104
+ ```typescript
105
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
106
+ import { Configuration } from 'sailpoint-api-client';
107
+ import { Machineidentityv2 } from 'sailpoint-api-client/dist/machine_identities/api';
108
+
109
+ const configuration = new Configuration();
110
+ const apiInstance = new MachineIdentitiesApi(configuration);
111
+ const machineidentityv2: Machineidentityv2 = ; //
112
+ const result = await apiInstance.createMachineIdentityV2({ machineidentityv2: machineidentityv2 });
113
+ console.log(result);
114
+ ```
115
+
116
+ [[Back to top]](#)
117
+
71
118
  ## delete-machine-identity-v1
72
119
  :::warning experimental
73
120
  This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
@@ -110,6 +157,84 @@ console.log(result);
110
157
 
111
158
  [[Back to top]](#)
112
159
 
160
+ ## delete-machine-identity-v2
161
+ Delete machine identity
162
+ The API returns a successful response if the requested machine identity was deleted.
163
+
164
+ [API Spec](https://developer.sailpoint.com/docs/api/delete-machine-identity-v-2)
165
+
166
+ ### Parameters
167
+
168
+
169
+ Name | Type | Description | Notes
170
+ ------------- | ------------- | ------------- | -------------
171
+ **id** | `string` | Machine Identity ID. | [default to undefined]
172
+
173
+ ### Return type
174
+
175
+ (empty response body)
176
+
177
+ ### HTTP request headers
178
+
179
+ - **Content-Type**: Not defined
180
+ - **Accept**: application/json
181
+
182
+ ### Example
183
+
184
+ ```typescript
185
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
186
+ import { Configuration } from 'sailpoint-api-client';
187
+
188
+ const configuration = new Configuration();
189
+ const apiInstance = new MachineIdentitiesApi(configuration);
190
+ const id: string = ef38f94347e94562b5bb8424a56397d8; // Machine Identity ID.
191
+ const result = await apiInstance.deleteMachineIdentityV2({ id: id });
192
+ console.log(result);
193
+ ```
194
+
195
+ [[Back to top]](#)
196
+
197
+ ## delete-ownership-correlation-config-v1
198
+ Delete ownership correlation config
199
+ Deletes the ownership correlation config with the specified ID for the given source resource.
200
+
201
+ [API Spec](https://developer.sailpoint.com/docs/api/delete-ownership-correlation-config-v-1)
202
+
203
+ ### Parameters
204
+
205
+
206
+ Name | Type | Description | Notes
207
+ ------------- | ------------- | ------------- | -------------
208
+ **sourceId** | `string` | The Source ID. | [default to undefined]
209
+ **resourceId** | `string` | The source resource ID (for example, account or aws:iam-role). | [default to undefined]
210
+ **configId** | `string` | The correlation config ID. | [default to undefined]
211
+
212
+ ### Return type
213
+
214
+ (empty response body)
215
+
216
+ ### HTTP request headers
217
+
218
+ - **Content-Type**: Not defined
219
+ - **Accept**: application/json
220
+
221
+ ### Example
222
+
223
+ ```typescript
224
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
225
+ import { Configuration } from 'sailpoint-api-client';
226
+
227
+ const configuration = new Configuration();
228
+ const apiInstance = new MachineIdentitiesApi(configuration);
229
+ const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source ID.
230
+ const resourceId: string = aws:iam-role; // The source resource ID (for example, account or aws:iam-role).
231
+ const configId: string = f5dd23fe-3414-42b7-bb1c-869400ad7a10; // The correlation config ID.
232
+ const result = await apiInstance.deleteOwnershipCorrelationConfigV1({ sourceId: sourceId, resourceId: resourceId, configId: configId });
233
+ console.log(result);
234
+ ```
235
+
236
+ [[Back to top]](#)
237
+
113
238
  ## get-machine-identity-v1
114
239
  :::warning experimental
115
240
  This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
@@ -152,6 +277,84 @@ console.log(result);
152
277
 
153
278
  [[Back to top]](#)
154
279
 
280
+ ## get-machine-identity-v2
281
+ Get machine identity details
282
+ This API returns a single machine identity using the Machine Identity ID.
283
+
284
+ [API Spec](https://developer.sailpoint.com/docs/api/get-machine-identity-v-2)
285
+
286
+ ### Parameters
287
+
288
+
289
+ Name | Type | Description | Notes
290
+ ------------- | ------------- | ------------- | -------------
291
+ **id** | `string` | Machine Identity ID. | [default to undefined]
292
+
293
+ ### Return type
294
+
295
+ `Machineidentityv2`
296
+
297
+ ### HTTP request headers
298
+
299
+ - **Content-Type**: Not defined
300
+ - **Accept**: application/json
301
+
302
+ ### Example
303
+
304
+ ```typescript
305
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
306
+ import { Configuration } from 'sailpoint-api-client';
307
+
308
+ const configuration = new Configuration();
309
+ const apiInstance = new MachineIdentitiesApi(configuration);
310
+ const id: string = ef38f94347e94562b5bb8424a56397d8; // Machine Identity ID.
311
+ const result = await apiInstance.getMachineIdentityV2({ id: id });
312
+ console.log(result);
313
+ ```
314
+
315
+ [[Back to top]](#)
316
+
317
+ ## get-ownership-correlation-config-v1
318
+ Get ownership correlation config
319
+ This end-point retrieves a single ownership correlation config by ID for the specified source resource.
320
+
321
+ [API Spec](https://developer.sailpoint.com/docs/api/get-ownership-correlation-config-v-1)
322
+
323
+ ### Parameters
324
+
325
+
326
+ Name | Type | Description | Notes
327
+ ------------- | ------------- | ------------- | -------------
328
+ **sourceId** | `string` | The Source ID. | [default to undefined]
329
+ **resourceId** | `string` | The source resource ID (for example, account or aws:iam-role). | [default to undefined]
330
+ **configId** | `string` | The correlation config ID. | [default to undefined]
331
+
332
+ ### Return type
333
+
334
+ `Correlationconfig`
335
+
336
+ ### HTTP request headers
337
+
338
+ - **Content-Type**: Not defined
339
+ - **Accept**: application/json
340
+
341
+ ### Example
342
+
343
+ ```typescript
344
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
345
+ import { Configuration } from 'sailpoint-api-client';
346
+
347
+ const configuration = new Configuration();
348
+ const apiInstance = new MachineIdentitiesApi(configuration);
349
+ const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source ID.
350
+ const resourceId: string = aws:iam-role; // The source resource ID (for example, account or aws:iam-role).
351
+ const configId: string = f5dd23fe-3414-42b7-bb1c-869400ad7a10; // The correlation config ID.
352
+ const result = await apiInstance.getOwnershipCorrelationConfigV1({ sourceId: sourceId, resourceId: resourceId, configId: configId });
353
+ console.log(result);
354
+ ```
355
+
356
+ [[Back to top]](#)
357
+
155
358
  ## list-machine-identities-v1
156
359
  :::warning experimental
157
360
  This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
@@ -202,6 +405,51 @@ console.log(result);
202
405
 
203
406
  [[Back to top]](#)
204
407
 
408
+ ## list-machine-identities-v2
409
+ List machine identities
410
+ This API returns a list of machine identities.
411
+
412
+ [API Spec](https://developer.sailpoint.com/docs/api/list-machine-identities-v-2)
413
+
414
+ ### Parameters
415
+
416
+
417
+ Name | Type | Description | Notes
418
+ ------------- | ------------- | ------------- | -------------
419
+ **filters** | `string` | 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: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryGovernanceGroup.id**: *eq, in* **owners.secondaryGovernanceGroup.name**: *eq, in, isnull, pr* **source.id**: *eq, in* **source.name**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **risk.severity**: *eq, in* | [optional] [default to undefined]
420
+ **sorters** | `string` | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** | [optional] [default to undefined]
421
+ **count** | `boolean` | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false]
422
+ **limit** | `number` | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250]
423
+ **offset** | `number` | 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. | [optional] [default to 0]
424
+
425
+ ### Return type
426
+
427
+ `Array<Machineidentityv2>`
428
+
429
+ ### HTTP request headers
430
+
431
+ - **Content-Type**: Not defined
432
+ - **Accept**: application/json
433
+
434
+ ### Example
435
+
436
+ ```typescript
437
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
438
+ import { Configuration } from 'sailpoint-api-client';
439
+
440
+ const configuration = new Configuration();
441
+ const apiInstance = new MachineIdentitiesApi(configuration);
442
+ const filters: string = identityId eq "2c9180858082150f0180893dbaf44201"; // 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: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryGovernanceGroup.id**: *eq, in* **owners.secondaryGovernanceGroup.name**: *eq, in, isnull, pr* **source.id**: *eq, in* **source.name**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **risk.severity**: *eq, in* (optional)
443
+ const sorters: string = nativeIdentity; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** (optional)
444
+ const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
445
+ const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
446
+ const offset: number = 0; // 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. (optional)
447
+ const result = await apiInstance.listMachineIdentitiesV2({ });
448
+ console.log(result);
449
+ ```
450
+
451
+ [[Back to top]](#)
452
+
205
453
  ## list-machine-identity-user-entitlements-v1
206
454
  :::warning experimental
207
455
  This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
@@ -252,6 +500,97 @@ console.log(result);
252
500
 
253
501
  [[Back to top]](#)
254
502
 
503
+ ## list-ownership-correlation-configs-v1
504
+ List ownership correlation configs
505
+ Returns the OWNER_PRIMARY and OWNER_SECONDARY correlation configs for the specified source resource, creating default rows if they are missing. Use the optional type query parameter to return a single matching config.
506
+
507
+ [API Spec](https://developer.sailpoint.com/docs/api/list-ownership-correlation-configs-v-1)
508
+
509
+ ### Parameters
510
+
511
+
512
+ Name | Type | Description | Notes
513
+ ------------- | ------------- | ------------- | -------------
514
+ **sourceId** | `string` | The Source ID. | [default to undefined]
515
+ **resourceId** | `string` | The source resource ID (for example, account or aws:iam-role). | [default to undefined]
516
+ **type** | `'OWNER_PRIMARY' | 'OWNER_SECONDARY'` | When set, filters to the given config type. | [optional] [default to undefined]
517
+ **count** | `boolean` | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false]
518
+ **limit** | `number` | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250]
519
+ **offset** | `number` | 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. | [optional] [default to 0]
520
+
521
+ ### Return type
522
+
523
+ `Array<Correlationconfig>`
524
+
525
+ ### HTTP request headers
526
+
527
+ - **Content-Type**: Not defined
528
+ - **Accept**: application/json
529
+
530
+ ### Example
531
+
532
+ ```typescript
533
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
534
+ import { Configuration } from 'sailpoint-api-client';
535
+
536
+ const configuration = new Configuration();
537
+ const apiInstance = new MachineIdentitiesApi(configuration);
538
+ const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source ID.
539
+ const resourceId: string = aws:iam-role; // The source resource ID (for example, account or aws:iam-role).
540
+ const type: string = OWNER_PRIMARY; // When set, filters to the given config type. (optional)
541
+ const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
542
+ const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
543
+ const offset: number = 0; // 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. (optional)
544
+ const result = await apiInstance.listOwnershipCorrelationConfigsV1({ sourceId: sourceId, resourceId: resourceId });
545
+ console.log(result);
546
+ ```
547
+
548
+ [[Back to top]](#)
549
+
550
+ ## patch-ownership-correlation-config-v1
551
+ Patch ownership correlation config
552
+ Selectively updates an ownership correlation config using an RFC 6902 JSONPatch payload. Only replace on /attributes (full object) and replace on /rules (full array; merge by stable rule id, remove rules omitted from the array) are allowed.
553
+
554
+ [API Spec](https://developer.sailpoint.com/docs/api/patch-ownership-correlation-config-v-1)
555
+
556
+ ### Parameters
557
+
558
+
559
+ Name | Type | Description | Notes
560
+ ------------- | ------------- | ------------- | -------------
561
+ **sourceId** | `string` | The Source ID. | [default to undefined]
562
+ **resourceId** | `string` | The source resource ID (for example, account or aws:iam-role). | [default to undefined]
563
+ **configId** | `string` | The correlation config ID. | [default to undefined]
564
+ **jsonpatchoperation** | `Array<Jsonpatchoperation>` | The JSONPatch payload used to update the correlation config. |
565
+
566
+ ### Return type
567
+
568
+ `Correlationconfig`
569
+
570
+ ### HTTP request headers
571
+
572
+ - **Content-Type**: application/json-patch+json
573
+ - **Accept**: application/json
574
+
575
+ ### Example
576
+
577
+ ```typescript
578
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
579
+ import { Configuration } from 'sailpoint-api-client';
580
+ import { Jsonpatchoperation } from 'sailpoint-api-client/dist/machine_identities/api';
581
+
582
+ const configuration = new Configuration();
583
+ const apiInstance = new MachineIdentitiesApi(configuration);
584
+ const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source ID.
585
+ const resourceId: string = aws:iam-role; // The source resource ID (for example, account or aws:iam-role).
586
+ const configId: string = f5dd23fe-3414-42b7-bb1c-869400ad7a10; // The correlation config ID.
587
+ const jsonpatchoperation: Array<Jsonpatchoperation> = [{"op":"replace","path":"/attributes","value":{"syncPrimaryToMachineAccounts":true}}]; // The JSONPatch payload used to update the correlation config.
588
+ const result = await apiInstance.patchOwnershipCorrelationConfigV1({ sourceId: sourceId, resourceId: resourceId, configId: configId, jsonpatchoperation: jsonpatchoperation });
589
+ console.log(result);
590
+ ```
591
+
592
+ [[Back to top]](#)
593
+
255
594
  ## start-machine-identity-aggregation-v1
256
595
  :::warning experimental
257
596
  This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
@@ -342,3 +681,46 @@ console.log(result);
342
681
 
343
682
  [[Back to top]](#)
344
683
 
684
+ ## update-machine-identity-v2
685
+ Partial update of machine identity
686
+ Use this API to selectively update machine identity details using a JSONPatch payload.
687
+
688
+ Patchable fields include **name**, **description**, **nativeIdentity**, **subtype**, **environment**, **attributes**, **owners**, **userEntitlements**, and **manuallyEdited** only.
689
+
690
+
691
+ [API Spec](https://developer.sailpoint.com/docs/api/update-machine-identity-v-2)
692
+
693
+ ### Parameters
694
+
695
+
696
+ Name | Type | Description | Notes
697
+ ------------- | ------------- | ------------- | -------------
698
+ **id** | `string` | Machine Identity ID. | [default to undefined]
699
+ **jsonpatchoperation** | `Array<Jsonpatchoperation>` | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. |
700
+
701
+ ### Return type
702
+
703
+ `Machineidentityv2`
704
+
705
+ ### HTTP request headers
706
+
707
+ - **Content-Type**: application/json-patch+json
708
+ - **Accept**: application/json
709
+
710
+ ### Example
711
+
712
+ ```typescript
713
+ import { MachineIdentitiesApi } from 'sailpoint-api-client';
714
+ import { Configuration } from 'sailpoint-api-client';
715
+ import { Jsonpatchoperation } from 'sailpoint-api-client/dist/machine_identities/api';
716
+
717
+ const configuration = new Configuration();
718
+ const apiInstance = new MachineIdentitiesApi(configuration);
719
+ const id: string = ef38f94347e94562b5bb8424a56397d8; // Machine Identity ID.
720
+ const jsonpatchoperation: Array<Jsonpatchoperation> = [{"op":"add","path":"/attributes/securityRisk","value":"medium"}]; // A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
721
+ const result = await apiInstance.updateMachineIdentityV2({ id: id, jsonpatchoperation: jsonpatchoperation });
722
+ console.log(result);
723
+ ```
724
+
725
+ [[Back to top]](#)
726
+
@@ -0,0 +1,18 @@
1
+ ---
2
+ id: v1-array-inner
3
+ title: ArrayInner
4
+ pagination_label: ArrayInner
5
+ sidebar_label: ArrayInner
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInner', 'v1ArrayInner']
8
+ slug: /tools/sdk/typescript/machine_identities/models/array-inner
9
+ tags: ['SDK', 'Software Development Kit', 'ArrayInner', 'v1ArrayInner']
10
+ ---
11
+
12
+ # ArrayInner
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+
@@ -0,0 +1,23 @@
1
+ ---
2
+ id: v1-businessapplicationref
3
+ title: Businessapplicationref
4
+ pagination_label: Businessapplicationref
5
+ sidebar_label: Businessapplicationref
6
+ sidebar_class_name: typescriptsdk
7
+ keywords: ['typescript', 'TypeScript', 'sdk', 'Businessapplicationref', 'v1Businessapplicationref']
8
+ slug: /tools/sdk/typescript/machine_identities/models/businessapplicationref
9
+ tags: ['SDK', 'Software Development Kit', 'Businessapplicationref', 'v1Businessapplicationref']
10
+ ---
11
+
12
+ # Businessapplicationref
13
+
14
+ ## Properties
15
+
16
+ Name | Type | Description | Notes
17
+ ------------ | ------------- | ------------- | -------------
18
+ **type** | **(optional)** `string` | Reference type. | [default to undefined]
19
+ **id** | **(optional)** `string` | Business Application ID. | [default to undefined]
20
+ **name** | **(optional)** `string` | Business Application display name. | [default to undefined]
21
+ **sanctionedStatus** | **(optional)** `Sanctionedstatus` | | [default to undefined]
22
+ **correlationType** | **(optional)** `string` | Whether the Business Application reference was manually assigned or automatically correlated. | [default to undefined]
23
+