@itentialopensource/adapter-terraform_enterprise 0.2.1 → 0.3.1

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 (45) hide show
  1. package/AUTH.md +11 -14
  2. package/CALLS.md +575 -22
  3. package/CHANGELOG.md +16 -0
  4. package/CONTRIBUTING.md +1 -160
  5. package/ENHANCE.md +2 -2
  6. package/README.md +32 -23
  7. package/SUMMARY.md +1 -1
  8. package/SYSTEMINFO.md +15 -6
  9. package/adapter.js +157 -329
  10. package/adapterBase.js +549 -879
  11. package/changelogs/CHANGELOG.md +52 -0
  12. package/metadata.json +61 -0
  13. package/package.json +24 -24
  14. package/pronghorn.json +470 -138
  15. package/propertiesSchema.json +431 -31
  16. package/refs?service=git-upload-pack +0 -0
  17. package/report/adapter-openapi.json +3984 -0
  18. package/report/adapter-openapi.yaml +2861 -0
  19. package/report/adapterInfo.json +8 -8
  20. package/report/updateReport1691507498223.json +120 -0
  21. package/report/updateReport1692202520108.json +120 -0
  22. package/report/updateReport1694461356284.json +120 -0
  23. package/report/updateReport1698420765161.json +120 -0
  24. package/sampleProperties.json +63 -2
  25. package/test/integration/adapterTestBasicGet.js +2 -4
  26. package/test/integration/adapterTestConnectivity.js +91 -42
  27. package/test/integration/adapterTestIntegration.js +130 -2
  28. package/test/unit/adapterBaseTestUnit.js +388 -313
  29. package/test/unit/adapterTestUnit.js +338 -112
  30. package/utils/adapterInfo.js +1 -1
  31. package/utils/addAuth.js +1 -1
  32. package/utils/artifactize.js +1 -1
  33. package/utils/checkMigrate.js +1 -1
  34. package/utils/entitiesToDB.js +2 -2
  35. package/utils/findPath.js +1 -1
  36. package/utils/methodDocumentor.js +273 -0
  37. package/utils/modify.js +13 -15
  38. package/utils/packModificationScript.js +1 -1
  39. package/utils/pre-commit.sh +2 -0
  40. package/utils/taskMover.js +309 -0
  41. package/utils/tbScript.js +89 -34
  42. package/utils/tbUtils.js +41 -21
  43. package/utils/testRunner.js +1 -1
  44. package/utils/troubleshootingAdapter.js +9 -6
  45. package/workflows/README.md +0 -3
package/CALLS.md CHANGED
@@ -19,7 +19,7 @@ These are adapter methods that IAP or you might use. There are some other method
19
19
  </tr>
20
20
  <tr>
21
21
  <td style="padding:15px">healthCheck(callback)</td>
22
- <td style="padding:15px">This call ensures that the adapter can communicate with TerraformEnterprise. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
22
+ <td style="padding:15px">This call ensures that the adapter can communicate with Adapter for Terraform Enterprise. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
23
23
  <td style="padding:15px">No</td>
24
24
  </tr>
25
25
  <tr>
@@ -29,7 +29,7 @@ These are adapter methods that IAP or you might use. There are some other method
29
29
  </tr>
30
30
  <tr>
31
31
  <td style="padding:15px">encryptProperty(property, technique, callback)</td>
32
- <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with TerraformEnterprise.</td>
32
+ <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for Terraform Enterprise.</td>
33
33
  <td style="padding:15px">No</td>
34
34
  </tr>
35
35
  <tr>
@@ -37,11 +37,6 @@ These are adapter methods that IAP or you might use. There are some other method
37
37
  <td style="padding:15px">This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.</td>
38
38
  <td style="padding:15px">Yes</td>
39
39
  </tr>
40
- <tr>
41
- <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
42
- <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
43
- <td style="padding:15px">Yes</td>
44
- </tr>
45
40
  <tr>
46
41
  <td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
47
42
  <td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td>
@@ -57,12 +52,16 @@ These are adapter methods that IAP or you might use. There are some other method
57
52
  <td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
58
53
  <td style="padding:15px">Yes</td>
59
54
  </tr>
55
+ <tr>
56
+ <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
57
+ <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
58
+ <td style="padding:15px">Yes</td>
59
+ </tr>
60
60
  <tr>
61
61
  <td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
62
62
  <td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
63
63
  <td style="padding:15px">Yes</td>
64
64
  </tr>
65
-
66
65
  <tr>
67
66
  <td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
68
67
  <td style="padding:15px">This call will return the results of a healthcheck.</td>
@@ -83,6 +82,21 @@ These are adapter methods that IAP or you might use. There are some other method
83
82
  <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
84
83
  <td style="padding:15px">Yes</td>
85
84
  </tr>
85
+ <tr>
86
+ <td style="padding:15px">iapDeactivateTasks(tasks, callback)</td>
87
+ <td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td>
88
+ <td style="padding:15px">Yes</td>
89
+ </tr>
90
+ <tr>
91
+ <td style="padding:15px">iapActivateTasks(tasks, callback)</td>
92
+ <td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td>
93
+ <td style="padding:15px">Yes</td>
94
+ </tr>
95
+ <tr>
96
+ <td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td>
97
+ <td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td>
98
+ <td style="padding:15px">Yes</td>
99
+ </tr>
86
100
  <tr>
87
101
  <td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
88
102
  <td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
@@ -94,19 +108,42 @@ These are adapter methods that IAP or you might use. There are some other method
94
108
  <td style="padding:15px">Yes</td>
95
109
  </tr>
96
110
  <tr>
97
- <td style="padding:15px">iapHasAdapterEntity(entityType, entityId, callback)</td>
98
- <td style="padding:15px">This call verifies the adapter has the specific entity.</td>
99
- <td style="padding:15px">No</td>
111
+ <td style="padding:15px">iapRunAdapterLint(callback)</td>
112
+ <td style="padding:15px">Runs lint on the addapter and provides the information back.</td>
113
+ <td style="padding:15px">Yes</td>
100
114
  </tr>
101
115
  <tr>
102
- <td style="padding:15px">iapVerifyAdapterCapability(entityType, actionType, entityId, callback)</td>
103
- <td style="padding:15px">This call verifies the adapter can perform the provided action on the specific entity.</td>
104
- <td style="padding:15px">No</td>
116
+ <td style="padding:15px">iapRunAdapterTests(callback)</td>
117
+ <td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td>
118
+ <td style="padding:15px">Yes</td>
105
119
  </tr>
106
120
  <tr>
107
- <td style="padding:15px">iapUpdateAdapterEntityCache()</td>
108
- <td style="padding:15px">This call will update the entity cache.</td>
109
- <td style="padding:15px">No</td>
121
+ <td style="padding:15px">iapGetAdapterInventory(callback)</td>
122
+ <td style="padding:15px">This call provides some inventory related information about the adapter.</td>
123
+ <td style="padding:15px">Yes</td>
124
+ </tr>
125
+ </table>
126
+ <br>
127
+
128
+ ### Adapter Cache Calls
129
+
130
+ These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
131
+
132
+ <table border="1" class="bordered-table">
133
+ <tr>
134
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
135
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
136
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
137
+ </tr>
138
+ <tr>
139
+ <td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td>
140
+ <td style="padding:15px">This call populates the adapter cache.</td>
141
+ <td style="padding:15px">Yes</td>
142
+ </tr>
143
+ <tr>
144
+ <td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td>
145
+ <td style="padding:15px">This call retrieves the specific items from the adapter cache.</td>
146
+ <td style="padding:15px">Yes</td>
110
147
  </tr>
111
148
  </table>
112
149
  <br>
@@ -129,27 +166,27 @@ These are adapter methods that are used to integrate to IAP Brokers. This adapte
129
166
  <tr>
130
167
  <td style="padding:15px">getDevice(deviceName, callback)</td>
131
168
  <td style="padding:15px">This call returns the details of the requested device.</td>
132
- <td style="padding:15px">Yes</td>
169
+ <td style="padding:15px">No</td>
133
170
  </tr>
134
171
  <tr>
135
172
  <td style="padding:15px">getDevicesFiltered(options, callback)</td>
136
173
  <td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
137
- <td style="padding:15px">Yes</td>
174
+ <td style="padding:15px">No</td>
138
175
  </tr>
139
176
  <tr>
140
177
  <td style="padding:15px">isAlive(deviceName, callback)</td>
141
178
  <td style="padding:15px">This call returns whether the device status is active</td>
142
- <td style="padding:15px">Yes</td>
179
+ <td style="padding:15px">No</td>
143
180
  </tr>
144
181
  <tr>
145
182
  <td style="padding:15px">getConfig(deviceName, format, callback)</td>
146
183
  <td style="padding:15px">This call returns the configuration for the selected device.</td>
147
- <td style="padding:15px">Yes</td>
184
+ <td style="padding:15px">No</td>
148
185
  </tr>
149
186
  <tr>
150
187
  <td style="padding:15px">iapGetDeviceCount(callback)</td>
151
188
  <td style="padding:15px">This call returns the count of devices.</td>
152
- <td style="padding:15px">Yes</td>
189
+ <td style="padding:15px">No</td>
153
190
  </tr>
154
191
  </table>
155
192
  <br>
@@ -165,5 +202,521 @@ Specific adapter calls are built based on the API of the TerraformEnterprise. Th
165
202
  <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
166
203
  <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
167
204
  </tr>
205
+ <tr>
206
+ <td style="padding:15px">get(callback)</td>
207
+ <td style="padding:15px">GetAccountDetails</td>
208
+ <td style="padding:15px">{base_path}/{version}/account/details?{query}</td>
209
+ <td style="padding:15px">Yes</td>
210
+ </tr>
211
+ <tr>
212
+ <td style="padding:15px">updateAccount(body, callback)</td>
213
+ <td style="padding:15px">Update Account</td>
214
+ <td style="padding:15px">{base_path}/{version}/account/update?{query}</td>
215
+ <td style="padding:15px">Yes</td>
216
+ </tr>
217
+ <tr>
218
+ <td style="padding:15px">changePassword(body, callback)</td>
219
+ <td style="padding:15px">Change Password</td>
220
+ <td style="padding:15px">{base_path}/{version}/account/password?{query}</td>
221
+ <td style="padding:15px">Yes</td>
222
+ </tr>
223
+ <tr>
224
+ <td style="padding:15px">createRun(body, callback)</td>
225
+ <td style="padding:15px">Create a Run</td>
226
+ <td style="padding:15px">{base_path}/{version}/runs?{query}</td>
227
+ <td style="padding:15px">Yes</td>
228
+ </tr>
229
+ <tr>
230
+ <td style="padding:15px">applyRun(runId, body, callback)</td>
231
+ <td style="padding:15px">Apply a Run</td>
232
+ <td style="padding:15px">{base_path}/{version}/runs/{pathv1}/actions/apply?{query}</td>
233
+ <td style="padding:15px">Yes</td>
234
+ </tr>
235
+ <tr>
236
+ <td style="padding:15px">listRuns(workspaceId, pageNumber, pageSize, callback)</td>
237
+ <td style="padding:15px">List Runs in a Workspace</td>
238
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}/runs?{query}</td>
239
+ <td style="padding:15px">Yes</td>
240
+ </tr>
241
+ <tr>
242
+ <td style="padding:15px">getRunDetails(runId, callback)</td>
243
+ <td style="padding:15px">Get run details</td>
244
+ <td style="padding:15px">{base_path}/{version}/runs/{pathv1}?{query}</td>
245
+ <td style="padding:15px">Yes</td>
246
+ </tr>
247
+ <tr>
248
+ <td style="padding:15px">discardRun(runId, body, callback)</td>
249
+ <td style="padding:15px">Discard a Run</td>
250
+ <td style="padding:15px">{base_path}/{version}/runs/{pathv1}/actions/discard?{query}</td>
251
+ <td style="padding:15px">Yes</td>
252
+ </tr>
253
+ <tr>
254
+ <td style="padding:15px">cancelRun(runId, body, callback)</td>
255
+ <td style="padding:15px">Cancel a Run</td>
256
+ <td style="padding:15px">{base_path}/{version}/runs/{pathv1}/actions/cancel?{query}</td>
257
+ <td style="padding:15px">Yes</td>
258
+ </tr>
259
+ <tr>
260
+ <td style="padding:15px">forceCancel(runId, body, callback)</td>
261
+ <td style="padding:15px">Forcefully cancel a run</td>
262
+ <td style="padding:15px">{base_path}/{version}/runs/{pathv1}/actions/force-cancel?{query}</td>
263
+ <td style="padding:15px">Yes</td>
264
+ </tr>
265
+ <tr>
266
+ <td style="padding:15px">forceExecute(runId, callback)</td>
267
+ <td style="padding:15px">Forcefully execute a run</td>
268
+ <td style="padding:15px">{base_path}/{version}/runs/{pathv1}/actions/force-execute?{query}</td>
269
+ <td style="padding:15px">Yes</td>
270
+ </tr>
271
+ <tr>
272
+ <td style="padding:15px">getApply(id, callback)</td>
273
+ <td style="padding:15px">Get Apply</td>
274
+ <td style="padding:15px">{base_path}/{version}/applies/{pathv1}?{query}</td>
275
+ <td style="padding:15px">Yes</td>
276
+ </tr>
277
+ <tr>
278
+ <td style="padding:15px">getCostEstimate(id, callback)</td>
279
+ <td style="padding:15px">Get Cost Estimate</td>
280
+ <td style="padding:15px">{base_path}/{version}/cost-estimates/{pathv1}?{query}</td>
281
+ <td style="padding:15px">Yes</td>
282
+ </tr>
283
+ <tr>
284
+ <td style="padding:15px">createNotificationConfiguration(body, callback)</td>
285
+ <td style="padding:15px">Create Notification Configuration</td>
286
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}/notification-configurations?{query}</td>
287
+ <td style="padding:15px">Yes</td>
288
+ </tr>
289
+ <tr>
290
+ <td style="padding:15px">listNotificationConfigurations(workspaceId, callback)</td>
291
+ <td style="padding:15px">List Notification Configurations</td>
292
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}/notification-configurations?{query}</td>
293
+ <td style="padding:15px">Yes</td>
294
+ </tr>
295
+ <tr>
296
+ <td style="padding:15px">getNotificationConfiguration(notificationConfigurationId, callback)</td>
297
+ <td style="padding:15px">Get Notification Configuration</td>
298
+ <td style="padding:15px">{base_path}/{version}/notification-configurations/{pathv1}?{query}</td>
299
+ <td style="padding:15px">Yes</td>
300
+ </tr>
301
+ <tr>
302
+ <td style="padding:15px">updateNotificationConfiguration(notificationConfigurationId, callback)</td>
303
+ <td style="padding:15px">Update Notification Configuration</td>
304
+ <td style="padding:15px">{base_path}/{version}/notification-configurations/{pathv1}?{query}</td>
305
+ <td style="padding:15px">Yes</td>
306
+ </tr>
307
+ <tr>
308
+ <td style="padding:15px">deleteNotificationConfiguration(notificationConfigurationId, callback)</td>
309
+ <td style="padding:15px">Delete Notification Configuration</td>
310
+ <td style="padding:15px">{base_path}/{version}/notification-configurations/{pathv1}?{query}</td>
311
+ <td style="padding:15px">Yes</td>
312
+ </tr>
313
+ <tr>
314
+ <td style="padding:15px">verifyNotificationConfiguration(notificationConfigurationId, callback)</td>
315
+ <td style="padding:15px">Verify a Notification Configuration</td>
316
+ <td style="padding:15px">{base_path}/{version}/notification-configurations/{pathv1}/actions/verify?{query}</td>
317
+ <td style="padding:15px">Yes</td>
318
+ </tr>
319
+ <tr>
320
+ <td style="padding:15px">listOrganizations(callback)</td>
321
+ <td style="padding:15px">List Organizations</td>
322
+ <td style="padding:15px">{base_path}/{version}/organizations?{query}</td>
323
+ <td style="padding:15px">Yes</td>
324
+ </tr>
325
+ <tr>
326
+ <td style="padding:15px">getOrganization(organizationName, callback)</td>
327
+ <td style="padding:15px">Get Organization</td>
328
+ <td style="padding:15px">{base_path}/{version}/organizations/{pathv1}?{query}</td>
329
+ <td style="padding:15px">Yes</td>
330
+ </tr>
331
+ <tr>
332
+ <td style="padding:15px">inviteUserToOrganization(organizationName, body, callback)</td>
333
+ <td style="padding:15px">Invite a User to an Organization</td>
334
+ <td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/organization-memberships?{query}</td>
335
+ <td style="padding:15px">Yes</td>
336
+ </tr>
337
+ <tr>
338
+ <td style="padding:15px">listMembershipsOrganization(organizationName, q, filterStatus, pageNumber, pageSize, callback)</td>
339
+ <td style="padding:15px">List Memberships for an Organization</td>
340
+ <td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/organization-memberships?{query}</td>
341
+ <td style="padding:15px">Yes</td>
342
+ </tr>
343
+ <tr>
344
+ <td style="padding:15px">listUserOwnMemberships(callback)</td>
345
+ <td style="padding:15px">List User's Own Memberships</td>
346
+ <td style="padding:15px">{base_path}/{version}/organization-memberships?{query}</td>
347
+ <td style="padding:15px">Yes</td>
348
+ </tr>
349
+ <tr>
350
+ <td style="padding:15px">showMembership(organizationMembershipId, callback)</td>
351
+ <td style="padding:15px">Show a Membership</td>
352
+ <td style="padding:15px">{base_path}/{version}/organization-memberships/{pathv1}?{query}</td>
353
+ <td style="padding:15px">Yes</td>
354
+ </tr>
355
+ <tr>
356
+ <td style="padding:15px">removeUserFromOrganization(organizationMembershipId, callback)</td>
357
+ <td style="padding:15px">Remove User from Organization</td>
358
+ <td style="padding:15px">{base_path}/{version}/organization-memberships/{pathv1}?{query}</td>
359
+ <td style="padding:15px">Yes</td>
360
+ </tr>
361
+ <tr>
362
+ <td style="padding:15px">showPlan(id, callback)</td>
363
+ <td style="padding:15px">Show a plan</td>
364
+ <td style="padding:15px">{base_path}/{version}/plans/{pathv1}?{query}</td>
365
+ <td style="padding:15px">Yes</td>
366
+ </tr>
367
+ <tr>
368
+ <td style="padding:15px">createPolicy(organizationName, body, callback)</td>
369
+ <td style="padding:15px">Create a Policy</td>
370
+ <td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/policies?{query}</td>
371
+ <td style="padding:15px">Yes</td>
372
+ </tr>
373
+ <tr>
374
+ <td style="padding:15px">listPolicies(organizationName, pageNumber, pageSize, searchName, callback)</td>
375
+ <td style="padding:15px">List Policies</td>
376
+ <td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/policies?{query}</td>
377
+ <td style="padding:15px">Yes</td>
378
+ </tr>
379
+ <tr>
380
+ <td style="padding:15px">showPolicy(policyId, callback)</td>
381
+ <td style="padding:15px">Show a Policy</td>
382
+ <td style="padding:15px">{base_path}/{version}/policies/{pathv1}?{query}</td>
383
+ <td style="padding:15px">Yes</td>
384
+ </tr>
385
+ <tr>
386
+ <td style="padding:15px">updatePolicy(policyId, body, callback)</td>
387
+ <td style="padding:15px">Update a Policy</td>
388
+ <td style="padding:15px">{base_path}/{version}/policies/{pathv1}?{query}</td>
389
+ <td style="padding:15px">Yes</td>
390
+ </tr>
391
+ <tr>
392
+ <td style="padding:15px">deletePolicy(policyId, callback)</td>
393
+ <td style="padding:15px">Delete a Policy</td>
394
+ <td style="padding:15px">{base_path}/{version}/policies/{pathv1}?{query}</td>
395
+ <td style="padding:15px">Yes</td>
396
+ </tr>
397
+ <tr>
398
+ <td style="padding:15px">uploadPolicy(policyId, callback)</td>
399
+ <td style="padding:15px">Upload a Policy</td>
400
+ <td style="padding:15px">{base_path}/{version}/policies/{pathv1}/upload?{query}</td>
401
+ <td style="padding:15px">Yes</td>
402
+ </tr>
403
+ <tr>
404
+ <td style="padding:15px">listPolicyChecks(runId, callback)</td>
405
+ <td style="padding:15px">List policy checks</td>
406
+ <td style="padding:15px">{base_path}/{version}/runs/{pathv1}/policy-checks?{query}</td>
407
+ <td style="padding:15px">Yes</td>
408
+ </tr>
409
+ <tr>
410
+ <td style="padding:15px">overridePolicy(policyCheckId, callback)</td>
411
+ <td style="padding:15px">Override Policy</td>
412
+ <td style="padding:15px">{base_path}/{version}/policy-checks/{pathv1}/actions/override?{query}</td>
413
+ <td style="padding:15px">Yes</td>
414
+ </tr>
415
+ <tr>
416
+ <td style="padding:15px">createPolicySet(organizationName, body, callback)</td>
417
+ <td style="padding:15px">Create a Policy Set</td>
418
+ <td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/policy-sets?{query}</td>
419
+ <td style="padding:15px">Yes</td>
420
+ </tr>
421
+ <tr>
422
+ <td style="padding:15px">listPolicySets(organizationName, filterVersioned, include, pageNumber, pageSize, searchName, callback)</td>
423
+ <td style="padding:15px">List Policy Sets</td>
424
+ <td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/policy-sets?{query}</td>
425
+ <td style="padding:15px">Yes</td>
426
+ </tr>
427
+ <tr>
428
+ <td style="padding:15px">showPolicySet(id, callback)</td>
429
+ <td style="padding:15px">Show a Policy Set</td>
430
+ <td style="padding:15px">{base_path}/{version}/policy-sets/{pathv1}?{query}</td>
431
+ <td style="padding:15px">Yes</td>
432
+ </tr>
433
+ <tr>
434
+ <td style="padding:15px">updatePolicySet(id, body, callback)</td>
435
+ <td style="padding:15px">Update a Policy Set</td>
436
+ <td style="padding:15px">{base_path}/{version}/policy-sets/{pathv1}?{query}</td>
437
+ <td style="padding:15px">Yes</td>
438
+ </tr>
439
+ <tr>
440
+ <td style="padding:15px">deletePolicySet(id, callback)</td>
441
+ <td style="padding:15px">Delete a Policy Set</td>
442
+ <td style="padding:15px">{base_path}/{version}/policy-sets/{pathv1}?{query}</td>
443
+ <td style="padding:15px">Yes</td>
444
+ </tr>
445
+ <tr>
446
+ <td style="padding:15px">addPoliciesToPolicySet(id, body, callback)</td>
447
+ <td style="padding:15px">Add Policies to the Policy Set</td>
448
+ <td style="padding:15px">{base_path}/{version}/policy-sets/{pathv1}/relationships/policies?{query}</td>
449
+ <td style="padding:15px">Yes</td>
450
+ </tr>
451
+ <tr>
452
+ <td style="padding:15px">removePoliciesFromThePolicySet(id, callback)</td>
453
+ <td style="padding:15px">Remove Policies from the Policy Set</td>
454
+ <td style="padding:15px">{base_path}/{version}/policy-sets/{pathv1}/relationships/policies?{query}</td>
455
+ <td style="padding:15px">Yes</td>
456
+ </tr>
457
+ <tr>
458
+ <td style="padding:15px">attachPolicySetToWorkspaces(id, body, callback)</td>
459
+ <td style="padding:15px">Attach a Policy Set to workspaces</td>
460
+ <td style="padding:15px">{base_path}/{version}/policy-sets/{pathv1}/relationships/workspaces?{query}</td>
461
+ <td style="padding:15px">Yes</td>
462
+ </tr>
463
+ <tr>
464
+ <td style="padding:15px">detachthePolicySetFromWorkspaces(id, callback)</td>
465
+ <td style="padding:15px">Detach the Policy Set from workspaces</td>
466
+ <td style="padding:15px">{base_path}/{version}/policy-sets/{pathv1}/relationships/workspaces?{query}</td>
467
+ <td style="padding:15px">Yes</td>
468
+ </tr>
469
+ <tr>
470
+ <td style="padding:15px">createPolicySetVersion(id, callback)</td>
471
+ <td style="padding:15px">Create a Policy Set Version</td>
472
+ <td style="padding:15px">{base_path}/{version}/policy-sets/{pathv1}/versions?{query}</td>
473
+ <td style="padding:15px">Yes</td>
474
+ </tr>
475
+ <tr>
476
+ <td style="padding:15px">showPolicySetVersion(id, callback)</td>
477
+ <td style="padding:15px">Show a Policy Set Version</td>
478
+ <td style="padding:15px">{base_path}/{version}/policy-set-versions/{pathv1}?{query}</td>
479
+ <td style="padding:15px">Yes</td>
480
+ </tr>
481
+ <tr>
482
+ <td style="padding:15px">createParameter(policySetId, body, callback)</td>
483
+ <td style="padding:15px">Create a Parameter</td>
484
+ <td style="padding:15px">{base_path}/{version}/policy-sets/{pathv1}/parameters?{query}</td>
485
+ <td style="padding:15px">Yes</td>
486
+ </tr>
487
+ <tr>
488
+ <td style="padding:15px">listParameters(policySetId, callback)</td>
489
+ <td style="padding:15px">List Parameters</td>
490
+ <td style="padding:15px">{base_path}/{version}/policy-sets/{pathv1}/parameters?{query}</td>
491
+ <td style="padding:15px">Yes</td>
492
+ </tr>
493
+ <tr>
494
+ <td style="padding:15px">updateParameters(policySetId, parameterId, body, callback)</td>
495
+ <td style="padding:15px">Update Parameters</td>
496
+ <td style="padding:15px">{base_path}/{version}/policy-sets/{pathv1}/parameters/{pathv2}?{query}</td>
497
+ <td style="padding:15px">Yes</td>
498
+ </tr>
499
+ <tr>
500
+ <td style="padding:15px">deleteParameters(policySetId, parameterId, callback)</td>
501
+ <td style="padding:15px">Delete Parameters</td>
502
+ <td style="padding:15px">{base_path}/{version}/policy-sets/{pathv1}/parameters/{pathv2}?{query}</td>
503
+ <td style="padding:15px">Yes</td>
504
+ </tr>
505
+ <tr>
506
+ <td style="padding:15px">createStateVersion(workspaceId, body, callback)</td>
507
+ <td style="padding:15px">Create a State Version</td>
508
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}/state-versions?{query}</td>
509
+ <td style="padding:15px">Yes</td>
510
+ </tr>
511
+ <tr>
512
+ <td style="padding:15px">listStateVersions(filterWorkspaceName, filterOrganizationName, pageNumber, pageSize, callback)</td>
513
+ <td style="padding:15px">List State Versions</td>
514
+ <td style="padding:15px">{base_path}/{version}/state-versions?{query}</td>
515
+ <td style="padding:15px">Yes</td>
516
+ </tr>
517
+ <tr>
518
+ <td style="padding:15px">fetchCurrentStateVersionForWorkspace(workspaceId, callback)</td>
519
+ <td style="padding:15px">Fetch Current State Version</td>
520
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}/current-state-version?{query}</td>
521
+ <td style="padding:15px">Yes</td>
522
+ </tr>
523
+ <tr>
524
+ <td style="padding:15px">showStateVersion(stateVersionId, callback)</td>
525
+ <td style="padding:15px">Show a State Version</td>
526
+ <td style="padding:15px">{base_path}/{version}/state-versions/{pathv1}?{query}</td>
527
+ <td style="padding:15px">Yes</td>
528
+ </tr>
529
+ <tr>
530
+ <td style="padding:15px">showStateVersionOutput(stateVersionOutputId, callback)</td>
531
+ <td style="padding:15px">Show a State Version Output</td>
532
+ <td style="padding:15px">{base_path}/{version}/state-version-outputs/{pathv1}?{query}</td>
533
+ <td style="padding:15px">Yes</td>
534
+ </tr>
535
+ <tr>
536
+ <td style="padding:15px">createVariable(body, callback)</td>
537
+ <td style="padding:15px">Create a Variable</td>
538
+ <td style="padding:15px">{base_path}/{version}/vars?{query}</td>
539
+ <td style="padding:15px">Yes</td>
540
+ </tr>
541
+ <tr>
542
+ <td style="padding:15px">listVariables(filterWorkspaceName, filterOrganizationName, callback)</td>
543
+ <td style="padding:15px">List Variables</td>
544
+ <td style="padding:15px">{base_path}/{version}/vars?{query}</td>
545
+ <td style="padding:15px">Yes</td>
546
+ </tr>
547
+ <tr>
548
+ <td style="padding:15px">updateVariables(variableId, body, callback)</td>
549
+ <td style="padding:15px">Update Variables</td>
550
+ <td style="padding:15px">{base_path}/{version}/vars/{pathv1}?{query}</td>
551
+ <td style="padding:15px">Yes</td>
552
+ </tr>
553
+ <tr>
554
+ <td style="padding:15px">deleteVariables(variableId, callback)</td>
555
+ <td style="padding:15px">Delete Variables</td>
556
+ <td style="padding:15px">{base_path}/{version}/vars/{pathv1}?{query}</td>
557
+ <td style="padding:15px">Yes</td>
558
+ </tr>
559
+ <tr>
560
+ <td style="padding:15px">createWorkspace(organizationName, body, callback)</td>
561
+ <td style="padding:15px">Create a Workspace</td>
562
+ <td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/workspaces?{query}</td>
563
+ <td style="padding:15px">Yes</td>
564
+ </tr>
565
+ <tr>
566
+ <td style="padding:15px">listWorkspaces(organizationName, pageNumber, pageSize, callback)</td>
567
+ <td style="padding:15px">List Workspaces</td>
568
+ <td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/workspaces?{query}</td>
569
+ <td style="padding:15px">Yes</td>
570
+ </tr>
571
+ <tr>
572
+ <td style="padding:15px">showWorkspace(workspaceId, callback)</td>
573
+ <td style="padding:15px">Show Workspace</td>
574
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}?{query}</td>
575
+ <td style="padding:15px">Yes</td>
576
+ </tr>
577
+ <tr>
578
+ <td style="padding:15px">lockWorkspace(workspaceId, callback)</td>
579
+ <td style="padding:15px">Lock a workspace</td>
580
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}/actions/lock?{query}</td>
581
+ <td style="padding:15px">Yes</td>
582
+ </tr>
583
+ <tr>
584
+ <td style="padding:15px">unlockWorkspace(workspaceId, callback)</td>
585
+ <td style="padding:15px">Unlock a workspace</td>
586
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}/actions/unlock?{query}</td>
587
+ <td style="padding:15px">Yes</td>
588
+ </tr>
589
+ <tr>
590
+ <td style="padding:15px">forceUnlockWorkspace(workspaceId, callback)</td>
591
+ <td style="padding:15px">Force Unlock a workspace</td>
592
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}/actions/force-unlock?{query}</td>
593
+ <td style="padding:15px">Yes</td>
594
+ </tr>
595
+ <tr>
596
+ <td style="padding:15px">assignSSHKeyToWorkspace(workspaceId, body, callback)</td>
597
+ <td style="padding:15px">Assign/Unassign an SSH key to a workspace</td>
598
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}/relationships/ssh-key?{query}</td>
599
+ <td style="padding:15px">Yes</td>
600
+ </tr>
601
+ <tr>
602
+ <td style="padding:15px">createWorkspaceVariable(workspaceId, body, callback)</td>
603
+ <td style="padding:15px">Create a Workspace Variable</td>
604
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}/vars?{query}</td>
605
+ <td style="padding:15px">Yes</td>
606
+ </tr>
607
+ <tr>
608
+ <td style="padding:15px">listWorkspaceVariables(workspaceId, callback)</td>
609
+ <td style="padding:15px">List Workspace Variables</td>
610
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}/vars?{query}</td>
611
+ <td style="padding:15px">Yes</td>
612
+ </tr>
613
+ <tr>
614
+ <td style="padding:15px">updateWorkspaceVariables(workspaceId, variableId, body, callback)</td>
615
+ <td style="padding:15px">Update Workspace Variables</td>
616
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}/vars/{pathv2}?{query}</td>
617
+ <td style="padding:15px">Yes</td>
618
+ </tr>
619
+ <tr>
620
+ <td style="padding:15px">deleteWorkspaceVariables(workspaceId, variableId, callback)</td>
621
+ <td style="padding:15px">Delete Workspace Variables</td>
622
+ <td style="padding:15px">{base_path}/{version}/workspaces/{pathv1}/vars/{pathv2}?{query}</td>
623
+ <td style="padding:15px">Yes</td>
624
+ </tr>
625
+ <tr>
626
+ <td style="padding:15px">listOauthClients(organizationName, callback)</td>
627
+ <td style="padding:15px">List OAuth Clients</td>
628
+ <td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/oauth-clients?{query}</td>
629
+ <td style="padding:15px">Yes</td>
630
+ </tr>
631
+ <tr>
632
+ <td style="padding:15px">createOAuthClient(organizationName, body, callback)</td>
633
+ <td style="padding:15px">Create an OAuth Client</td>
634
+ <td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/oauth-clients?{query}</td>
635
+ <td style="padding:15px">Yes</td>
636
+ </tr>
637
+ <tr>
638
+ <td style="padding:15px">showOAuthClient(id, callback)</td>
639
+ <td style="padding:15px">Show an OAuth Client</td>
640
+ <td style="padding:15px">{base_path}/{version}/oauth-clients/{pathv1}?{query}</td>
641
+ <td style="padding:15px">Yes</td>
642
+ </tr>
643
+ <tr>
644
+ <td style="padding:15px">updateOAuthClient(id, body, callback)</td>
645
+ <td style="padding:15px">Update an OAuth Client</td>
646
+ <td style="padding:15px">{base_path}/{version}/oauth-clients/{pathv1}?{query}</td>
647
+ <td style="padding:15px">Yes</td>
648
+ </tr>
649
+ <tr>
650
+ <td style="padding:15px">destroyOAuthClient(id, callback)</td>
651
+ <td style="padding:15px">Destroy an OAuth Client</td>
652
+ <td style="padding:15px">{base_path}/{version}/oauth-clients/{pathv1}?{query}</td>
653
+ <td style="padding:15px">Yes</td>
654
+ </tr>
655
+ <tr>
656
+ <td style="padding:15px">listOAuthTokens(oauthClientId, callback)</td>
657
+ <td style="padding:15px">List OAuth Tokens</td>
658
+ <td style="padding:15px">{base_path}/{version}/oauth-clients/{pathv1}/oauth-tokens?{query}</td>
659
+ <td style="padding:15px">Yes</td>
660
+ </tr>
661
+ <tr>
662
+ <td style="padding:15px">showOAuthToken(id, callback)</td>
663
+ <td style="padding:15px">Show an OAuth Token</td>
664
+ <td style="padding:15px">{base_path}/{version}/oauth-tokens/{pathv1}?{query}</td>
665
+ <td style="padding:15px">Yes</td>
666
+ </tr>
667
+ <tr>
668
+ <td style="padding:15px">updateOAuthToken(id, body, callback)</td>
669
+ <td style="padding:15px">Update an OAuth Token</td>
670
+ <td style="padding:15px">{base_path}/{version}/oauth-tokens/{pathv1}?{query}</td>
671
+ <td style="padding:15px">Yes</td>
672
+ </tr>
673
+ <tr>
674
+ <td style="padding:15px">destroyOAuthToken(id, callback)</td>
675
+ <td style="padding:15px">Destroy an OAuth Token</td>
676
+ <td style="padding:15px">{base_path}/{version}/oauth-tokens/{pathv1}?{query}</td>
677
+ <td style="padding:15px">Yes</td>
678
+ </tr>
679
+ <tr>
680
+ <td style="padding:15px">generateOrganizationToken(organizationName, callback)</td>
681
+ <td style="padding:15px">Generate a new organization token</td>
682
+ <td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/authentication-token?{query}</td>
683
+ <td style="padding:15px">Yes</td>
684
+ </tr>
685
+ <tr>
686
+ <td style="padding:15px">deleteOrganizationToken(organizationName, callback)</td>
687
+ <td style="padding:15px">Delete the organization token</td>
688
+ <td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/authentication-token?{query}</td>
689
+ <td style="padding:15px">Yes</td>
690
+ </tr>
691
+ <tr>
692
+ <td style="padding:15px">createPlanExport(body, callback)</td>
693
+ <td style="padding:15px">Create a plan export</td>
694
+ <td style="padding:15px">{base_path}/{version}/plan-exports?{query}</td>
695
+ <td style="padding:15px">Yes</td>
696
+ </tr>
697
+ <tr>
698
+ <td style="padding:15px">showPlanExport(id, callback)</td>
699
+ <td style="padding:15px">Show a plan export</td>
700
+ <td style="padding:15px">{base_path}/{version}/plan-exports/{pathv1}?{query}</td>
701
+ <td style="padding:15px">Yes</td>
702
+ </tr>
703
+ <tr>
704
+ <td style="padding:15px">deleteExportedPlanData(id, callback)</td>
705
+ <td style="padding:15px">Delete exported plan data</td>
706
+ <td style="padding:15px">{base_path}/{version}/plan-exports/{pathv1}?{query}</td>
707
+ <td style="padding:15px">Yes</td>
708
+ </tr>
709
+ <tr>
710
+ <td style="padding:15px">downloadPlanExport(id, callback)</td>
711
+ <td style="padding:15px">Download exported plan data</td>
712
+ <td style="padding:15px">{base_path}/{version}/plan-exports/{pathv1}/download?{query}</td>
713
+ <td style="padding:15px">Yes</td>
714
+ </tr>
715
+ <tr>
716
+ <td style="padding:15px">showUser(user, callback)</td>
717
+ <td style="padding:15px">Show a User</td>
718
+ <td style="padding:15px">{base_path}/{version}/users/{pathv1}?{query}</td>
719
+ <td style="padding:15px">Yes</td>
720
+ </tr>
168
721
  </table>
169
722
  <br>