@withgateway/sdk 0.1.20 → 0.2.0

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 (130) hide show
  1. package/README.md +141 -2
  2. package/dist/cli.js +8683 -1343
  3. package/dist/cli.js.map +1 -1
  4. package/dist/cli.mjs +8683 -1344
  5. package/dist/cli.mjs.map +1 -1
  6. package/dist/index.d.mts +1 -1
  7. package/dist/index.d.ts +1 -1
  8. package/dist/index.js +979 -46
  9. package/dist/index.js.map +1 -1
  10. package/dist/index.mjs +943 -38
  11. package/dist/index.mjs.map +1 -1
  12. package/dist/tracing/index.js +9 -2
  13. package/dist/tracing/index.js.map +1 -1
  14. package/dist/tracing/index.mjs +9 -2
  15. package/dist/tracing/index.mjs.map +1 -1
  16. package/dist/worlds/index.d.mts +738 -28
  17. package/dist/worlds/index.d.ts +738 -28
  18. package/dist/worlds/index.js +940 -42
  19. package/dist/worlds/index.js.map +1 -1
  20. package/dist/worlds/index.mjs +934 -36
  21. package/dist/worlds/index.mjs.map +1 -1
  22. package/package.json +9 -2
  23. package/runtime/gatewaysdk/__init__.py +0 -0
  24. package/runtime/gatewaysdk/environment/__init__.py +108 -0
  25. package/runtime/gatewaysdk/environment/_bundle.py +281 -0
  26. package/runtime/gatewaysdk/environment/_harbor.py +276 -0
  27. package/runtime/gatewaysdk/environment/_materialize.py +97 -0
  28. package/runtime/gatewaysdk/environment/_tar.py +33 -0
  29. package/runtime/gatewaysdk/environment/_world.py +346 -0
  30. package/runtime/gatewaysdk/environment/core.py +527 -0
  31. package/runtime/gatewaysdk/environment/errors.py +58 -0
  32. package/runtime/gatewaysdk/environment/runtime.py +150 -0
  33. package/runtime/gatewaysdk/environment/schema/__init__.py +35 -0
  34. package/runtime/gatewaysdk/environment/schema/__main__.py +225 -0
  35. package/runtime/gatewaysdk/environment/schema/_slack_fidelity.py +116 -0
  36. package/runtime/gatewaysdk/environment/schema/_slack_scenario.py +183 -0
  37. package/runtime/gatewaysdk/environment/schema/api.py +1628 -0
  38. package/runtime/gatewaysdk/environment/schema/batch.py +755 -0
  39. package/runtime/gatewaysdk/environment/schema/compiler.py +615 -0
  40. package/runtime/gatewaysdk/environment/schema/conform.py +428 -0
  41. package/runtime/gatewaysdk/environment/schema/connector.py +777 -0
  42. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/handlers.py +17 -0
  43. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/parity.json +28 -0
  44. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/provenance.json +233 -0
  45. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scope.toml +112 -0
  46. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/world.json +1380 -0
  47. package/runtime/gatewaysdk/environment/schema/connectors/base.json +28 -0
  48. package/runtime/gatewaysdk/environment/schema/connectors/custom/handlers.py +18 -0
  49. package/runtime/gatewaysdk/environment/schema/connectors/custom/world.json +123 -0
  50. package/runtime/gatewaysdk/environment/schema/connectors/github/handlers.py +81 -0
  51. package/runtime/gatewaysdk/environment/schema/connectors/github/parity.json +37 -0
  52. package/runtime/gatewaysdk/environment/schema/connectors/github/provenance.json +134 -0
  53. package/runtime/gatewaysdk/environment/schema/connectors/github/scope.toml +158 -0
  54. package/runtime/gatewaysdk/environment/schema/connectors/github/world.json +5869 -0
  55. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/handlers.py +23 -0
  56. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/world.json +209 -0
  57. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/handlers.py +18 -0
  58. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/world.json +286 -0
  59. package/runtime/gatewaysdk/environment/schema/connectors/jamf/handlers.py +34 -0
  60. package/runtime/gatewaysdk/environment/schema/connectors/jamf/parity.json +49 -0
  61. package/runtime/gatewaysdk/environment/schema/connectors/jamf/provenance.json +181 -0
  62. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scope.toml +128 -0
  63. package/runtime/gatewaysdk/environment/schema/connectors/jamf/world.json +2218 -0
  64. package/runtime/gatewaysdk/environment/schema/connectors/jira/handlers.py +28 -0
  65. package/runtime/gatewaysdk/environment/schema/connectors/jira/world.json +389 -0
  66. package/runtime/gatewaysdk/environment/schema/connectors/kandji/handlers.py +38 -0
  67. package/runtime/gatewaysdk/environment/schema/connectors/kandji/parity.json +29 -0
  68. package/runtime/gatewaysdk/environment/schema/connectors/kandji/provenance.json +152 -0
  69. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scope.toml +120 -0
  70. package/runtime/gatewaysdk/environment/schema/connectors/kandji/world.json +765 -0
  71. package/runtime/gatewaysdk/environment/schema/connectors/linear/handlers.py +20 -0
  72. package/runtime/gatewaysdk/environment/schema/connectors/linear/world.json +363 -0
  73. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/fidelity.json +45 -0
  74. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/handlers.py +1 -0
  75. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/provenance.json +851 -0
  76. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scope.md +231 -0
  77. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/teams-types.json +1710 -0
  78. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/world.json +858 -0
  79. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/handlers.py +32 -0
  80. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/parity.json +50 -0
  81. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/provenance.json +137 -0
  82. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scope.toml +78 -0
  83. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/world.json +16243 -0
  84. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/handlers.py +806 -0
  85. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/parity.json +46 -0
  86. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/provenance.json +143 -0
  87. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scope.toml +174 -0
  88. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/world.json +4695 -0
  89. package/runtime/gatewaysdk/environment/schema/connectors/slack/MODEL.md +236 -0
  90. package/runtime/gatewaysdk/environment/schema/connectors/slack/capabilities.json +1039 -0
  91. package/runtime/gatewaysdk/environment/schema/connectors/slack/handlers.py +762 -0
  92. package/runtime/gatewaysdk/environment/schema/connectors/slack/parity.json +65 -0
  93. package/runtime/gatewaysdk/environment/schema/connectors/slack/provenance.json +294 -0
  94. package/runtime/gatewaysdk/environment/schema/connectors/slack/scope.toml +44 -0
  95. package/runtime/gatewaysdk/environment/schema/connectors/slack/world.json +4993 -0
  96. package/runtime/gatewaysdk/environment/schema/connectors/workday/handlers.py +75 -0
  97. package/runtime/gatewaysdk/environment/schema/connectors/workday/parity.json +36 -0
  98. package/runtime/gatewaysdk/environment/schema/connectors/workday/provenance.json +179 -0
  99. package/runtime/gatewaysdk/environment/schema/connectors/workday/scope.toml +180 -0
  100. package/runtime/gatewaysdk/environment/schema/connectors/workday/world.json +806 -0
  101. package/runtime/gatewaysdk/environment/schema/data.py +593 -0
  102. package/runtime/gatewaysdk/environment/schema/extract.py +263 -0
  103. package/runtime/gatewaysdk/environment/schema/host.py +2407 -0
  104. package/runtime/gatewaysdk/environment/schema/host_surfaces.py +275 -0
  105. package/runtime/gatewaysdk/environment/schema/platform.py +1272 -0
  106. package/runtime/gatewaysdk/environment/schema/scaffold.py +250 -0
  107. package/runtime/gatewaysdk/environment/schema/skill.py +118 -0
  108. package/runtime/gatewaysdk/environment/schema/skills/agents/connector-template-author.md +202 -0
  109. package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/CONNECTORS.md +331 -0
  110. package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/CONVENTIONS.md +100 -0
  111. package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/SKILL.md +313 -0
  112. package/runtime/gatewaysdk/environment/schema/skills/world-data-ingestion/ROWS.md +223 -0
  113. package/runtime/gatewaysdk/environment/schema/skills/world-data-ingestion/SKILL.md +293 -0
  114. package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/SKILL.md +390 -0
  115. package/runtime/gatewaysdk/environment/schema/slack.py +757 -0
  116. package/runtime/gatewaysdk/environment/schema/snapshot.py +479 -0
  117. package/runtime/gatewaysdk/environment/schema/store.py +904 -0
  118. package/runtime/gatewaysdk/environment/schema/tasks.py +525 -0
  119. package/runtime/gatewaysdk/environment/schema/tools_world.py +322 -0
  120. package/runtime/gatewaysdk/environment/schema/validation.py +577 -0
  121. package/runtime/gatewaysdk/environment/schema/worker.py +78 -0
  122. package/runtime/gatewaysdk/environment/schema/workers.py +500 -0
  123. package/runtime/gatewaysdk/environment/schema/world_tests.py +336 -0
  124. package/skills/agents/connector-template-author.md +202 -0
  125. package/skills/connector-schema-authoring/CONNECTORS.md +331 -0
  126. package/skills/connector-schema-authoring/CONVENTIONS.md +100 -0
  127. package/skills/connector-schema-authoring/SKILL.md +313 -0
  128. package/skills/world-data-ingestion/ROWS.md +223 -0
  129. package/skills/world-data-ingestion/SKILL.md +293 -0
  130. package/skills/worlds-getting-started/SKILL.md +390 -0
@@ -0,0 +1,2218 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "urn:gateway:connector:jamf",
4
+ "$defs": {
5
+ "ApiErrorCause": {
6
+ "description": "Jamf Pro API error cause; `field` is the only property the vendor marks required.",
7
+ "type": "object",
8
+ "properties": {
9
+ "code": {
10
+ "description": "Error-specific code that can be used to identify a localization string.",
11
+ "type": "string"
12
+ },
13
+ "field": {
14
+ "description": "Name of the field that caused the error.",
15
+ "type": "string"
16
+ },
17
+ "description": {
18
+ "description": "A general description of the error for troubleshooting/debugging.",
19
+ "type": "string"
20
+ },
21
+ "id": {
22
+ "description": "Id of the object with the error. Optional.",
23
+ "type": [
24
+ "string",
25
+ "null"
26
+ ]
27
+ }
28
+ },
29
+ "required": [
30
+ "field"
31
+ ],
32
+ "additionalProperties": false
33
+ },
34
+ "ApiError": {
35
+ "description": "Jamf Pro API error body. Handlers raise the vendor's status and description for the failures the vendor documents.",
36
+ "type": "object",
37
+ "properties": {
38
+ "httpStatus": {
39
+ "description": "HTTP status of the response.",
40
+ "type": "integer"
41
+ },
42
+ "errors": {
43
+ "type": "array",
44
+ "items": {
45
+ "$ref": "#/$defs/ApiErrorCause"
46
+ }
47
+ }
48
+ },
49
+ "required": [],
50
+ "additionalProperties": false
51
+ },
52
+ "ComputerGeneral": {
53
+ "type": "object",
54
+ "properties": {
55
+ "name": {
56
+ "type": "string",
57
+ "minLength": 1
58
+ },
59
+ "lastIpAddress": {
60
+ "type": "string"
61
+ },
62
+ "lastReportedIp": {
63
+ "type": "string",
64
+ "description": "Last reported IPv4 address (Deprecated. Use lastReportedIpV4 instead.)",
65
+ "deprecated": true
66
+ },
67
+ "lastReportedIpV4": {
68
+ "type": "string",
69
+ "description": "Last reported IPv4 address"
70
+ },
71
+ "lastReportedIpV6": {
72
+ "type": "string"
73
+ },
74
+ "jamfBinaryVersion": {
75
+ "type": "string"
76
+ },
77
+ "platform": {
78
+ "type": "string"
79
+ },
80
+ "barcode1": {
81
+ "type": "string"
82
+ },
83
+ "barcode2": {
84
+ "type": "string"
85
+ },
86
+ "assetTag": {
87
+ "type": "string"
88
+ },
89
+ "supervised": {
90
+ "type": "boolean"
91
+ },
92
+ "mdmCapable": {
93
+ "type": "object",
94
+ "properties": {
95
+ "capable": {
96
+ "type": "boolean"
97
+ },
98
+ "capableUsers": {
99
+ "type": "array",
100
+ "description": "Deprecated. Use userManagementInfo instead.",
101
+ "deprecated": true,
102
+ "items": {
103
+ "type": "string"
104
+ }
105
+ },
106
+ "userManagementInfo": {
107
+ "type": "array",
108
+ "items": {
109
+ "type": "object",
110
+ "properties": {
111
+ "capableUser": {
112
+ "type": "string"
113
+ },
114
+ "managementId": {
115
+ "type": "string"
116
+ }
117
+ },
118
+ "required": [
119
+ "capableUser",
120
+ "managementId"
121
+ ],
122
+ "additionalProperties": false
123
+ }
124
+ }
125
+ },
126
+ "required": [],
127
+ "additionalProperties": false
128
+ },
129
+ "reportDate": {
130
+ "type": "string",
131
+ "format": "date-time"
132
+ },
133
+ "lastContactTime": {
134
+ "type": "string",
135
+ "format": "date-time"
136
+ },
137
+ "lastCloudBackupDate": {
138
+ "type": "string",
139
+ "format": "date-time"
140
+ },
141
+ "lastEnrolledDate": {
142
+ "type": "string",
143
+ "format": "date-time"
144
+ },
145
+ "initialEntryDate": {
146
+ "type": "string",
147
+ "format": "date",
148
+ "readOnly": true
149
+ },
150
+ "mdmProfileExpiration": {
151
+ "type": "string",
152
+ "format": "date-time"
153
+ },
154
+ "distributionPoint": {
155
+ "type": "string"
156
+ },
157
+ "enrollmentMethod": {
158
+ "type": "object",
159
+ "properties": {
160
+ "id": {
161
+ "type": "string",
162
+ "readOnly": true
163
+ },
164
+ "objectName": {
165
+ "type": "string",
166
+ "readOnly": true
167
+ },
168
+ "objectType": {
169
+ "type": "string",
170
+ "readOnly": true
171
+ }
172
+ },
173
+ "required": [],
174
+ "additionalProperties": false
175
+ },
176
+ "site": {
177
+ "type": "object",
178
+ "properties": {
179
+ "id": {
180
+ "type": "string"
181
+ },
182
+ "name": {
183
+ "type": "string"
184
+ }
185
+ },
186
+ "required": [],
187
+ "additionalProperties": false
188
+ },
189
+ "itunesStoreAccountActive": {
190
+ "type": "boolean"
191
+ },
192
+ "enrolledViaAutomatedDeviceEnrollment": {
193
+ "type": "boolean"
194
+ },
195
+ "userApprovedMdm": {
196
+ "type": "boolean"
197
+ },
198
+ "declarativeDeviceManagementEnabled": {
199
+ "type": "boolean"
200
+ },
201
+ "managementId": {
202
+ "type": "string",
203
+ "readOnly": true
204
+ },
205
+ "lastLoggedInUsernameSelfService": {
206
+ "type": [
207
+ "string",
208
+ "null"
209
+ ]
210
+ },
211
+ "lastLoggedInUsernameSelfServiceTimestamp": {
212
+ "type": [
213
+ "string",
214
+ "null"
215
+ ],
216
+ "format": "date-time"
217
+ },
218
+ "lastLoggedInUsernameBinary": {
219
+ "type": [
220
+ "string",
221
+ "null"
222
+ ]
223
+ },
224
+ "lastLoggedInUsernameBinaryTimestamp": {
225
+ "type": [
226
+ "string",
227
+ "null"
228
+ ],
229
+ "format": "date-time"
230
+ },
231
+ "lastLoggedInUsernameMdm": {
232
+ "type": [
233
+ "string",
234
+ "null"
235
+ ]
236
+ },
237
+ "lastLoggedInUsernameMdmTimestamp": {
238
+ "type": [
239
+ "string",
240
+ "null"
241
+ ],
242
+ "format": "date-time"
243
+ }
244
+ },
245
+ "required": [],
246
+ "additionalProperties": false,
247
+ "description": "GENERAL section of a computer inventory response."
248
+ },
249
+ "ComputerHardware": {
250
+ "type": "object",
251
+ "properties": {
252
+ "make": {
253
+ "type": "string",
254
+ "readOnly": true
255
+ },
256
+ "model": {
257
+ "type": "string",
258
+ "readOnly": true
259
+ },
260
+ "modelIdentifier": {
261
+ "type": "string",
262
+ "readOnly": true
263
+ },
264
+ "serialNumber": {
265
+ "type": "string",
266
+ "readOnly": true
267
+ },
268
+ "processorSpeedMhz": {
269
+ "type": "integer",
270
+ "description": "Processor Speed in MHz.",
271
+ "readOnly": true
272
+ },
273
+ "processorCount": {
274
+ "type": "integer",
275
+ "readOnly": true
276
+ },
277
+ "coreCount": {
278
+ "type": "integer",
279
+ "readOnly": true
280
+ },
281
+ "processorType": {
282
+ "type": "string",
283
+ "readOnly": true
284
+ },
285
+ "processorArchitecture": {
286
+ "type": "string",
287
+ "readOnly": true
288
+ },
289
+ "busSpeedMhz": {
290
+ "type": "integer",
291
+ "readOnly": true
292
+ },
293
+ "cacheSizeKilobytes": {
294
+ "type": "integer",
295
+ "description": "Cache Size in KB.",
296
+ "readOnly": true
297
+ },
298
+ "networkAdapterType": {
299
+ "type": "string"
300
+ },
301
+ "macAddress": {
302
+ "type": "string"
303
+ },
304
+ "altNetworkAdapterType": {
305
+ "type": "string"
306
+ },
307
+ "altMacAddress": {
308
+ "type": "string"
309
+ },
310
+ "totalRamMegabytes": {
311
+ "type": "integer",
312
+ "description": "Total RAM Size in MB.",
313
+ "readOnly": true
314
+ },
315
+ "openRamSlots": {
316
+ "type": "integer",
317
+ "description": "Available RAM slots.",
318
+ "readOnly": true
319
+ },
320
+ "batteryCapacityPercent": {
321
+ "type": "integer",
322
+ "description": "Remaining percentage of battery power.",
323
+ "minimum": 0,
324
+ "maximum": 100,
325
+ "readOnly": true
326
+ },
327
+ "batteryHealth": {
328
+ "type": "string",
329
+ "description": "- NON_GENUINE: The battery isn’t a genuine Apple battery.\n- NORMAL: The battery is operating normally.\n- SERVICE_RECOMMENDED: The system recommends battery service.\n- UNKNOWN: The system couldn’t determine battery health information.\n- UNSUPPORTED: The device doesn’t support battery health reporting.\n",
330
+ "enum": [
331
+ "NON_GENUINE",
332
+ "NORMAL",
333
+ "SERVICE_RECOMMENDED",
334
+ "UNKNOWN",
335
+ "UNSUPPORTED"
336
+ ],
337
+ "default": "UNKNOWN",
338
+ "readOnly": true
339
+ },
340
+ "smcVersion": {
341
+ "type": "string",
342
+ "readOnly": true
343
+ },
344
+ "nicSpeed": {
345
+ "type": "string",
346
+ "readOnly": true
347
+ },
348
+ "opticalDrive": {
349
+ "type": "string",
350
+ "readOnly": true
351
+ },
352
+ "bootRom": {
353
+ "type": "string",
354
+ "readOnly": true
355
+ },
356
+ "bleCapable": {
357
+ "type": "boolean",
358
+ "readOnly": true
359
+ },
360
+ "supportsIosAppInstalls": {
361
+ "type": "boolean",
362
+ "readOnly": true
363
+ },
364
+ "appleSilicon": {
365
+ "type": "boolean",
366
+ "readOnly": true
367
+ },
368
+ "provisioningUdid": {
369
+ "type": "string",
370
+ "readOnly": true
371
+ }
372
+ },
373
+ "required": [],
374
+ "additionalProperties": false,
375
+ "description": "HARDWARE section of a computer inventory response."
376
+ },
377
+ "ComputerOperatingSystem": {
378
+ "type": "object",
379
+ "properties": {
380
+ "name": {
381
+ "type": "string",
382
+ "readOnly": true
383
+ },
384
+ "version": {
385
+ "type": "string",
386
+ "readOnly": true
387
+ },
388
+ "build": {
389
+ "type": "string",
390
+ "readOnly": true
391
+ },
392
+ "supplementalBuildVersion": {
393
+ "type": "string",
394
+ "description": "Collected for macOS 13.0 or later",
395
+ "readOnly": true
396
+ },
397
+ "rapidSecurityResponse": {
398
+ "type": "string",
399
+ "description": "Collected for macOS 13.0 or later",
400
+ "readOnly": true
401
+ },
402
+ "activeDirectoryStatus": {
403
+ "type": "string",
404
+ "readOnly": true
405
+ },
406
+ "fileVault2Status": {
407
+ "type": "string",
408
+ "enum": [
409
+ "NOT_APPLICABLE",
410
+ "NOT_ENCRYPTED",
411
+ "BOOT_ENCRYPTED",
412
+ "SOME_ENCRYPTED",
413
+ "ALL_ENCRYPTED"
414
+ ]
415
+ },
416
+ "softwareUpdateDeviceId": {
417
+ "type": "string",
418
+ "readOnly": true
419
+ }
420
+ },
421
+ "required": [],
422
+ "additionalProperties": false,
423
+ "description": "OPERATING_SYSTEM section of a computer inventory response."
424
+ },
425
+ "ComputerUserAndLocation": {
426
+ "type": "object",
427
+ "properties": {
428
+ "username": {
429
+ "type": "string"
430
+ },
431
+ "realname": {
432
+ "type": "string"
433
+ },
434
+ "email": {
435
+ "type": "string"
436
+ },
437
+ "position": {
438
+ "type": "string"
439
+ },
440
+ "phone": {
441
+ "type": "string"
442
+ },
443
+ "departmentId": {
444
+ "type": "string"
445
+ },
446
+ "buildingId": {
447
+ "type": "string"
448
+ },
449
+ "room": {
450
+ "type": "string"
451
+ }
452
+ },
453
+ "required": [],
454
+ "additionalProperties": false,
455
+ "description": "USER_AND_LOCATION section of a computer inventory response."
456
+ },
457
+ "Computer": {
458
+ "description": "Computer inventory record. Jamf returns only requested sections, so each retained section is optional as a whole.",
459
+ "type": "object",
460
+ "properties": {
461
+ "id": {
462
+ "type": "string",
463
+ "minLength": 1,
464
+ "readOnly": true
465
+ },
466
+ "udid": {
467
+ "type": "string"
468
+ },
469
+ "general": {
470
+ "$ref": "#/$defs/ComputerGeneral"
471
+ },
472
+ "hardware": {
473
+ "$ref": "#/$defs/ComputerHardware"
474
+ },
475
+ "operatingSystem": {
476
+ "$ref": "#/$defs/ComputerOperatingSystem"
477
+ },
478
+ "userAndLocation": {
479
+ "$ref": "#/$defs/ComputerUserAndLocation"
480
+ }
481
+ },
482
+ "required": [
483
+ "id"
484
+ ],
485
+ "additionalProperties": false
486
+ },
487
+ "MobileDevice": {
488
+ "description": "Union of scalar properties returned by MobileDeviceV2 summary and MobileDeviceDetailsV2 detail reads; only the vendor id is required across persisted projections.",
489
+ "type": "object",
490
+ "properties": {
491
+ "id": {
492
+ "type": "string",
493
+ "readOnly": true
494
+ },
495
+ "name": {
496
+ "type": "string"
497
+ },
498
+ "serialNumber": {
499
+ "type": "string"
500
+ },
501
+ "wifiMacAddress": {
502
+ "type": "string"
503
+ },
504
+ "udid": {
505
+ "type": "string"
506
+ },
507
+ "phoneNumber": {
508
+ "type": "string"
509
+ },
510
+ "model": {
511
+ "type": "string"
512
+ },
513
+ "modelIdentifier": {
514
+ "type": "string"
515
+ },
516
+ "username": {
517
+ "type": "string"
518
+ },
519
+ "type": {
520
+ "type": "string",
521
+ "enum": [
522
+ "ios",
523
+ "tvos",
524
+ "watchos",
525
+ "visionos",
526
+ "unknown"
527
+ ]
528
+ },
529
+ "managementId": {
530
+ "type": "string",
531
+ "readOnly": true
532
+ },
533
+ "softwareUpdateDeviceId": {
534
+ "type": "string"
535
+ },
536
+ "enforceName": {
537
+ "type": "boolean",
538
+ "description": "Enforce the mobile device name. Device must be supervised. If set to true, Jamf Pro will revert the Mobile Device Name to the ‘name’ value each time the device checks in."
539
+ },
540
+ "assetTag": {
541
+ "type": "string"
542
+ },
543
+ "lastInventoryUpdateTimestamp": {
544
+ "type": "string",
545
+ "format": "date-time"
546
+ },
547
+ "lastContactTimestamp": {
548
+ "type": "string",
549
+ "format": "date-time"
550
+ },
551
+ "osVersion": {
552
+ "type": "string"
553
+ },
554
+ "osBuild": {
555
+ "type": "string"
556
+ },
557
+ "osSupplementalBuildVersion": {
558
+ "type": "string",
559
+ "description": "Collected for iOS 16 and iPadOS 16.1 or later"
560
+ },
561
+ "osRapidSecurityResponse": {
562
+ "type": "string",
563
+ "description": "Collected for iOS 16 and iPadOS 16.1 or later"
564
+ },
565
+ "ipAddress": {
566
+ "type": "string"
567
+ },
568
+ "bluetoothMacAddress": {
569
+ "type": "string"
570
+ },
571
+ "managed": {
572
+ "type": "boolean"
573
+ },
574
+ "timeZone": {
575
+ "type": "string"
576
+ },
577
+ "initialEntryTimestamp": {
578
+ "type": "string",
579
+ "format": "date-time"
580
+ },
581
+ "lastEnrollmentTimestamp": {
582
+ "type": "string",
583
+ "format": "date-time"
584
+ },
585
+ "mdmProfileExpirationTimestamp": {
586
+ "type": "string",
587
+ "format": "date-time"
588
+ },
589
+ "deviceOwnershipLevel": {
590
+ "type": "string"
591
+ },
592
+ "enrollmentMethod": {
593
+ "type": "string"
594
+ },
595
+ "enrollmentSessionTokenValid": {
596
+ "type": "boolean"
597
+ },
598
+ "declarativeDeviceManagementEnabled": {
599
+ "type": "boolean"
600
+ }
601
+ },
602
+ "required": [
603
+ "id"
604
+ ],
605
+ "additionalProperties": false
606
+ },
607
+ "ComputerGroup": {
608
+ "type": "object",
609
+ "properties": {
610
+ "id": {
611
+ "type": "string",
612
+ "minLength": 1
613
+ },
614
+ "name": {
615
+ "type": "string"
616
+ },
617
+ "description": {
618
+ "type": [
619
+ "string",
620
+ "null"
621
+ ]
622
+ },
623
+ "smartGroup": {
624
+ "type": "boolean"
625
+ }
626
+ },
627
+ "required": [
628
+ "id",
629
+ "name"
630
+ ],
631
+ "additionalProperties": false
632
+ },
633
+ "ComputerGroupMember": {
634
+ "description": "Projected static-group membership join.",
635
+ "type": "object",
636
+ "properties": {
637
+ "groupId": {
638
+ "type": "string"
639
+ },
640
+ "computerId": {
641
+ "type": "string"
642
+ }
643
+ },
644
+ "required": [
645
+ "groupId",
646
+ "computerId"
647
+ ],
648
+ "additionalProperties": false
649
+ },
650
+ "Policy": {
651
+ "description": "Union of the Classic API policy list identity and detail response; detail sections retain vendor nesting.",
652
+ "type": "object",
653
+ "properties": {
654
+ "id": {
655
+ "type": "integer"
656
+ },
657
+ "name": {
658
+ "type": "string"
659
+ },
660
+ "general": {
661
+ "type": "object",
662
+ "properties": {
663
+ "id": {
664
+ "type": "integer"
665
+ },
666
+ "name": {
667
+ "type": "string"
668
+ },
669
+ "enabled": {
670
+ "type": "boolean"
671
+ },
672
+ "trigger": {
673
+ "type": "string"
674
+ },
675
+ "trigger_checkin": {
676
+ "type": "boolean",
677
+ "default": false
678
+ },
679
+ "trigger_enrollment_complete": {
680
+ "type": "boolean",
681
+ "default": false
682
+ },
683
+ "trigger_login": {
684
+ "type": "boolean",
685
+ "default": false
686
+ },
687
+ "trigger_logout": {
688
+ "type": "boolean",
689
+ "default": false
690
+ },
691
+ "trigger_network_state_changed": {
692
+ "type": "boolean",
693
+ "default": false
694
+ },
695
+ "trigger_startup": {
696
+ "type": "boolean",
697
+ "default": false
698
+ },
699
+ "trigger_other": {
700
+ "type": "string"
701
+ },
702
+ "frequency": {
703
+ "type": "string",
704
+ "enum": [
705
+ "Once per computer",
706
+ "Once per user per computer",
707
+ "Once per user",
708
+ "Once every day",
709
+ "Once every week",
710
+ "Once every month",
711
+ "Ongoing"
712
+ ]
713
+ },
714
+ "retry_event": {
715
+ "type": "string",
716
+ "enum": [
717
+ "none",
718
+ "trigger",
719
+ "check-in"
720
+ ],
721
+ "default": "none"
722
+ },
723
+ "retry_attempts": {
724
+ "type": "integer",
725
+ "default": -1
726
+ },
727
+ "notify_on_each_failed_retry": {
728
+ "type": "boolean",
729
+ "default": false
730
+ },
731
+ "location_user_only": {
732
+ "type": "boolean"
733
+ },
734
+ "target_drive": {
735
+ "type": "string"
736
+ },
737
+ "offline": {
738
+ "type": "boolean"
739
+ },
740
+ "category": {
741
+ "type": "object",
742
+ "title": "category",
743
+ "properties": {
744
+ "id": {
745
+ "type": "integer",
746
+ "default": -1
747
+ },
748
+ "name": {
749
+ "type": "string",
750
+ "description": "Name of the category",
751
+ "default": "Unknown"
752
+ }
753
+ },
754
+ "required": [
755
+ "name"
756
+ ],
757
+ "additionalProperties": false
758
+ },
759
+ "date_time_limitations": {
760
+ "type": "object",
761
+ "properties": {
762
+ "activation_date": {
763
+ "type": "string"
764
+ },
765
+ "activation_date_epoch": {
766
+ "type": "integer"
767
+ },
768
+ "activation_date_utc": {
769
+ "type": "string"
770
+ },
771
+ "expiration_date": {
772
+ "type": "string"
773
+ },
774
+ "expiration_date_epoch": {
775
+ "type": "integer"
776
+ },
777
+ "expiration_date_utc": {
778
+ "type": "string"
779
+ },
780
+ "no_execute_on": {
781
+ "type": "object",
782
+ "properties": {
783
+ "day": {
784
+ "type": "string",
785
+ "enum": [
786
+ "Sun",
787
+ "Mon",
788
+ "Tue",
789
+ "Wed",
790
+ "Thu",
791
+ "Fri",
792
+ "Sat"
793
+ ]
794
+ }
795
+ },
796
+ "required": [],
797
+ "additionalProperties": false
798
+ },
799
+ "no_execute_start": {
800
+ "type": "string"
801
+ },
802
+ "no_execute_end": {
803
+ "type": "string"
804
+ }
805
+ },
806
+ "required": [],
807
+ "additionalProperties": false
808
+ },
809
+ "network_limitations": {
810
+ "type": "object",
811
+ "properties": {
812
+ "minimum_network_connection": {
813
+ "type": "string",
814
+ "enum": [
815
+ "No Minimum",
816
+ "Ethernet"
817
+ ]
818
+ },
819
+ "any_ip_address": {
820
+ "type": "boolean"
821
+ }
822
+ },
823
+ "required": [],
824
+ "additionalProperties": false
825
+ },
826
+ "override_default_settings": {
827
+ "type": "object",
828
+ "properties": {
829
+ "target_drive": {
830
+ "type": "string"
831
+ },
832
+ "distribution_point": {
833
+ "type": "string"
834
+ },
835
+ "force_afp_smb": {
836
+ "type": "boolean"
837
+ },
838
+ "sus": {
839
+ "type": "string"
840
+ }
841
+ },
842
+ "required": [],
843
+ "additionalProperties": false
844
+ },
845
+ "network_requirements": {
846
+ "type": "string",
847
+ "enum": [
848
+ "Any",
849
+ "Ethernet"
850
+ ]
851
+ },
852
+ "site": {
853
+ "type": "object",
854
+ "properties": {
855
+ "id": {
856
+ "type": "integer",
857
+ "default": -1
858
+ },
859
+ "name": {
860
+ "type": "string",
861
+ "description": "Name of the site"
862
+ }
863
+ },
864
+ "required": [
865
+ "name"
866
+ ],
867
+ "additionalProperties": false
868
+ }
869
+ },
870
+ "required": [
871
+ "name"
872
+ ],
873
+ "additionalProperties": false
874
+ },
875
+ "scope": {
876
+ "type": "object",
877
+ "properties": {
878
+ "all_computers": {
879
+ "type": "boolean",
880
+ "default": false
881
+ },
882
+ "computers": {
883
+ "type": "array",
884
+ "items": {
885
+ "type": "object",
886
+ "properties": {
887
+ "computer": {
888
+ "type": "object",
889
+ "properties": {
890
+ "id": {
891
+ "type": "integer"
892
+ },
893
+ "name": {
894
+ "type": "string",
895
+ "description": "Name of the computer"
896
+ },
897
+ "udid": {
898
+ "type": "string"
899
+ }
900
+ },
901
+ "required": [],
902
+ "additionalProperties": false
903
+ }
904
+ },
905
+ "required": [],
906
+ "additionalProperties": false
907
+ }
908
+ },
909
+ "computer_groups": {
910
+ "type": "array",
911
+ "items": {
912
+ "type": "object",
913
+ "properties": {
914
+ "computer_group": {
915
+ "type": "object",
916
+ "properties": {
917
+ "id": {
918
+ "type": "integer"
919
+ },
920
+ "name": {
921
+ "type": "string"
922
+ }
923
+ },
924
+ "required": [],
925
+ "additionalProperties": false
926
+ }
927
+ },
928
+ "required": [],
929
+ "additionalProperties": false
930
+ }
931
+ },
932
+ "buildings": {
933
+ "type": "array",
934
+ "items": {
935
+ "type": "object",
936
+ "properties": {
937
+ "building": {
938
+ "type": "object",
939
+ "properties": {
940
+ "id": {
941
+ "type": "integer"
942
+ },
943
+ "name": {
944
+ "type": "string"
945
+ }
946
+ },
947
+ "required": [],
948
+ "additionalProperties": false
949
+ }
950
+ },
951
+ "required": [],
952
+ "additionalProperties": false
953
+ }
954
+ },
955
+ "departments": {
956
+ "type": "array",
957
+ "items": {
958
+ "type": "object",
959
+ "properties": {
960
+ "department": {
961
+ "type": "object",
962
+ "properties": {
963
+ "id": {
964
+ "type": "integer"
965
+ },
966
+ "name": {
967
+ "type": "string"
968
+ }
969
+ },
970
+ "required": [],
971
+ "additionalProperties": false
972
+ }
973
+ },
974
+ "required": [],
975
+ "additionalProperties": false
976
+ }
977
+ },
978
+ "limit_to_users": {
979
+ "type": "object",
980
+ "properties": {
981
+ "user_groups": {
982
+ "type": "array",
983
+ "items": {
984
+ "type": "object",
985
+ "properties": {
986
+ "user_group": {
987
+ "type": "string"
988
+ }
989
+ },
990
+ "required": [],
991
+ "additionalProperties": false
992
+ }
993
+ }
994
+ },
995
+ "required": [],
996
+ "additionalProperties": false
997
+ },
998
+ "limitations": {
999
+ "type": "object",
1000
+ "properties": {
1001
+ "users": {
1002
+ "type": "array",
1003
+ "items": {
1004
+ "type": "object",
1005
+ "properties": {
1006
+ "user": {
1007
+ "type": "object",
1008
+ "properties": {
1009
+ "id": {
1010
+ "type": "integer"
1011
+ },
1012
+ "name": {
1013
+ "type": "string"
1014
+ }
1015
+ },
1016
+ "required": [],
1017
+ "additionalProperties": false
1018
+ }
1019
+ },
1020
+ "required": [],
1021
+ "additionalProperties": false
1022
+ }
1023
+ },
1024
+ "user_groups": {
1025
+ "type": "array",
1026
+ "items": {
1027
+ "type": "object",
1028
+ "properties": {
1029
+ "user_group": {
1030
+ "type": "object",
1031
+ "properties": {
1032
+ "id": {
1033
+ "type": "integer"
1034
+ },
1035
+ "name": {
1036
+ "type": "string"
1037
+ }
1038
+ },
1039
+ "required": [],
1040
+ "additionalProperties": false
1041
+ }
1042
+ },
1043
+ "required": [],
1044
+ "additionalProperties": false
1045
+ }
1046
+ },
1047
+ "network_segments": {
1048
+ "type": "array",
1049
+ "items": {
1050
+ "type": "object",
1051
+ "properties": {
1052
+ "network_segment": {
1053
+ "type": "object",
1054
+ "properties": {
1055
+ "id": {
1056
+ "type": "integer"
1057
+ },
1058
+ "name": {
1059
+ "type": "string"
1060
+ }
1061
+ },
1062
+ "required": [],
1063
+ "additionalProperties": false
1064
+ }
1065
+ },
1066
+ "required": [],
1067
+ "additionalProperties": false
1068
+ }
1069
+ },
1070
+ "ibeacons": {
1071
+ "type": "array",
1072
+ "items": {
1073
+ "type": "object",
1074
+ "properties": {
1075
+ "ibeacon": {
1076
+ "type": "object",
1077
+ "properties": {
1078
+ "id": {
1079
+ "type": "integer"
1080
+ },
1081
+ "name": {
1082
+ "type": "string"
1083
+ }
1084
+ },
1085
+ "required": [],
1086
+ "additionalProperties": false
1087
+ }
1088
+ },
1089
+ "required": [],
1090
+ "additionalProperties": false
1091
+ }
1092
+ }
1093
+ },
1094
+ "required": [],
1095
+ "additionalProperties": false
1096
+ },
1097
+ "exclusions": {
1098
+ "type": "object",
1099
+ "properties": {
1100
+ "computers": {
1101
+ "type": "array",
1102
+ "items": {
1103
+ "type": "object",
1104
+ "properties": {
1105
+ "computer": {
1106
+ "type": "object",
1107
+ "properties": {
1108
+ "id": {
1109
+ "type": "integer"
1110
+ },
1111
+ "name": {
1112
+ "type": "string",
1113
+ "description": "Name of the computer"
1114
+ },
1115
+ "udid": {
1116
+ "type": "string"
1117
+ }
1118
+ },
1119
+ "required": [],
1120
+ "additionalProperties": false
1121
+ }
1122
+ },
1123
+ "required": [],
1124
+ "additionalProperties": false
1125
+ }
1126
+ },
1127
+ "computer_groups": {
1128
+ "type": "array",
1129
+ "items": {
1130
+ "type": "object",
1131
+ "properties": {
1132
+ "computer_group": {
1133
+ "type": "object",
1134
+ "properties": {
1135
+ "id": {
1136
+ "type": "integer"
1137
+ },
1138
+ "name": {
1139
+ "type": "string"
1140
+ }
1141
+ },
1142
+ "required": [],
1143
+ "additionalProperties": false
1144
+ }
1145
+ },
1146
+ "required": [],
1147
+ "additionalProperties": false
1148
+ }
1149
+ },
1150
+ "buildings": {
1151
+ "type": "array",
1152
+ "items": {
1153
+ "type": "object",
1154
+ "properties": {
1155
+ "building": {
1156
+ "type": "object",
1157
+ "properties": {
1158
+ "id": {
1159
+ "type": "integer"
1160
+ },
1161
+ "name": {
1162
+ "type": "string"
1163
+ }
1164
+ },
1165
+ "required": [],
1166
+ "additionalProperties": false
1167
+ }
1168
+ },
1169
+ "required": [],
1170
+ "additionalProperties": false
1171
+ }
1172
+ },
1173
+ "departments": {
1174
+ "type": "array",
1175
+ "items": {
1176
+ "type": "object",
1177
+ "properties": {
1178
+ "department": {
1179
+ "type": "object",
1180
+ "properties": {
1181
+ "id": {
1182
+ "type": "integer"
1183
+ },
1184
+ "name": {
1185
+ "type": "string"
1186
+ }
1187
+ },
1188
+ "required": [],
1189
+ "additionalProperties": false
1190
+ }
1191
+ },
1192
+ "required": [],
1193
+ "additionalProperties": false
1194
+ }
1195
+ },
1196
+ "users": {
1197
+ "type": "array",
1198
+ "items": {
1199
+ "type": "object",
1200
+ "properties": {
1201
+ "user": {
1202
+ "type": "object",
1203
+ "properties": {
1204
+ "name": {
1205
+ "type": "string"
1206
+ }
1207
+ },
1208
+ "required": [],
1209
+ "additionalProperties": false
1210
+ }
1211
+ },
1212
+ "required": [],
1213
+ "additionalProperties": false
1214
+ }
1215
+ },
1216
+ "user_groups": {
1217
+ "type": "array",
1218
+ "items": {
1219
+ "type": "object",
1220
+ "properties": {
1221
+ "user_group": {
1222
+ "type": "object",
1223
+ "properties": {
1224
+ "id": {
1225
+ "type": "integer"
1226
+ },
1227
+ "name": {
1228
+ "type": "string"
1229
+ }
1230
+ },
1231
+ "required": [],
1232
+ "additionalProperties": false
1233
+ }
1234
+ },
1235
+ "required": [],
1236
+ "additionalProperties": false
1237
+ }
1238
+ },
1239
+ "network_segments": {
1240
+ "type": "array",
1241
+ "items": {
1242
+ "type": "object",
1243
+ "properties": {
1244
+ "network_segment": {
1245
+ "type": "object",
1246
+ "properties": {
1247
+ "id": {
1248
+ "type": "integer"
1249
+ },
1250
+ "uid": {
1251
+ "type": "string"
1252
+ },
1253
+ "name": {
1254
+ "type": "string",
1255
+ "description": "Name of the network segment"
1256
+ }
1257
+ },
1258
+ "required": [],
1259
+ "additionalProperties": false
1260
+ }
1261
+ },
1262
+ "required": [],
1263
+ "additionalProperties": false
1264
+ }
1265
+ },
1266
+ "ibeacons": {
1267
+ "type": "array",
1268
+ "items": {
1269
+ "type": "object",
1270
+ "properties": {
1271
+ "ibeacon": {
1272
+ "type": "object",
1273
+ "properties": {
1274
+ "id": {
1275
+ "type": "integer"
1276
+ },
1277
+ "name": {
1278
+ "type": "string"
1279
+ }
1280
+ },
1281
+ "required": [],
1282
+ "additionalProperties": false
1283
+ }
1284
+ },
1285
+ "required": [],
1286
+ "additionalProperties": false
1287
+ }
1288
+ }
1289
+ },
1290
+ "required": [],
1291
+ "additionalProperties": false
1292
+ }
1293
+ },
1294
+ "required": [],
1295
+ "additionalProperties": false
1296
+ }
1297
+ },
1298
+ "required": [
1299
+ "id"
1300
+ ],
1301
+ "additionalProperties": false
1302
+ },
1303
+ "ConfigurationProfile": {
1304
+ "description": "Union of the Classic API macOS configuration-profile list identity and detail response; detail sections retain vendor nesting.",
1305
+ "type": "object",
1306
+ "properties": {
1307
+ "id": {
1308
+ "type": "integer"
1309
+ },
1310
+ "name": {
1311
+ "type": "string"
1312
+ },
1313
+ "general": {
1314
+ "type": "object",
1315
+ "properties": {
1316
+ "id": {
1317
+ "type": "integer"
1318
+ },
1319
+ "name": {
1320
+ "type": "string",
1321
+ "description": "Name of the configuration profile"
1322
+ },
1323
+ "description": {
1324
+ "type": "string"
1325
+ },
1326
+ "site": {
1327
+ "type": "object",
1328
+ "properties": {
1329
+ "id": {
1330
+ "type": "integer",
1331
+ "default": -1
1332
+ },
1333
+ "name": {
1334
+ "type": "string",
1335
+ "description": "Name of the site"
1336
+ }
1337
+ },
1338
+ "required": [
1339
+ "name"
1340
+ ],
1341
+ "additionalProperties": false
1342
+ },
1343
+ "category": {
1344
+ "type": "object",
1345
+ "title": "category",
1346
+ "properties": {
1347
+ "id": {
1348
+ "type": "integer",
1349
+ "default": -1
1350
+ },
1351
+ "name": {
1352
+ "type": "string",
1353
+ "description": "Name of the category",
1354
+ "default": "Unknown"
1355
+ }
1356
+ },
1357
+ "required": [
1358
+ "name"
1359
+ ],
1360
+ "additionalProperties": false
1361
+ },
1362
+ "distribution_method": {
1363
+ "type": "string",
1364
+ "enum": [
1365
+ "Install Automatically",
1366
+ "Make Available in Self Service"
1367
+ ]
1368
+ },
1369
+ "user_removable": {
1370
+ "type": "boolean"
1371
+ },
1372
+ "level": {
1373
+ "type": "string",
1374
+ "enum": [
1375
+ "computer",
1376
+ "user"
1377
+ ]
1378
+ },
1379
+ "uuid": {
1380
+ "type": "string"
1381
+ },
1382
+ "redeploy_on_update": {
1383
+ "type": "string"
1384
+ }
1385
+ },
1386
+ "required": [
1387
+ "name"
1388
+ ],
1389
+ "additionalProperties": false
1390
+ },
1391
+ "scope": {
1392
+ "type": "object",
1393
+ "properties": {
1394
+ "all_computers": {
1395
+ "type": "boolean",
1396
+ "default": false
1397
+ },
1398
+ "all_jss_users": {
1399
+ "type": "boolean",
1400
+ "default": false
1401
+ },
1402
+ "computers": {
1403
+ "type": "array",
1404
+ "items": {
1405
+ "type": "object",
1406
+ "properties": {
1407
+ "computer": {
1408
+ "type": "object",
1409
+ "properties": {
1410
+ "id": {
1411
+ "type": "integer"
1412
+ },
1413
+ "name": {
1414
+ "type": "string",
1415
+ "description": "Name of the computer"
1416
+ },
1417
+ "udid": {
1418
+ "type": "string"
1419
+ }
1420
+ },
1421
+ "required": [],
1422
+ "additionalProperties": false
1423
+ }
1424
+ },
1425
+ "required": [],
1426
+ "additionalProperties": false
1427
+ }
1428
+ },
1429
+ "buildings": {
1430
+ "type": "array",
1431
+ "items": {
1432
+ "type": "object",
1433
+ "properties": {
1434
+ "building": {
1435
+ "type": "object",
1436
+ "properties": {
1437
+ "id": {
1438
+ "type": "integer"
1439
+ },
1440
+ "name": {
1441
+ "type": "string"
1442
+ }
1443
+ },
1444
+ "required": [],
1445
+ "additionalProperties": false
1446
+ }
1447
+ },
1448
+ "required": [],
1449
+ "additionalProperties": false
1450
+ }
1451
+ },
1452
+ "departments": {
1453
+ "type": "array",
1454
+ "items": {
1455
+ "type": "object",
1456
+ "properties": {
1457
+ "department": {
1458
+ "type": "object",
1459
+ "properties": {
1460
+ "id": {
1461
+ "type": "integer"
1462
+ },
1463
+ "name": {
1464
+ "type": "string"
1465
+ }
1466
+ },
1467
+ "required": [],
1468
+ "additionalProperties": false
1469
+ }
1470
+ },
1471
+ "required": [],
1472
+ "additionalProperties": false
1473
+ }
1474
+ },
1475
+ "computer_groups": {
1476
+ "type": "array",
1477
+ "items": {
1478
+ "type": "object",
1479
+ "properties": {
1480
+ "computer_group": {
1481
+ "type": "object",
1482
+ "properties": {
1483
+ "id": {
1484
+ "type": "integer"
1485
+ },
1486
+ "name": {
1487
+ "type": "string"
1488
+ }
1489
+ },
1490
+ "required": [],
1491
+ "additionalProperties": false
1492
+ }
1493
+ },
1494
+ "required": [],
1495
+ "additionalProperties": false
1496
+ }
1497
+ },
1498
+ "jss_users": {
1499
+ "type": "array",
1500
+ "items": {
1501
+ "type": "object",
1502
+ "properties": {
1503
+ "users": {
1504
+ "type": "object",
1505
+ "properties": {
1506
+ "id": {
1507
+ "type": "integer"
1508
+ },
1509
+ "name": {
1510
+ "type": "string"
1511
+ }
1512
+ },
1513
+ "required": [],
1514
+ "additionalProperties": false
1515
+ }
1516
+ },
1517
+ "required": [],
1518
+ "additionalProperties": false
1519
+ }
1520
+ },
1521
+ "jss_user_groups": {
1522
+ "type": "array",
1523
+ "items": {
1524
+ "type": "object",
1525
+ "properties": {
1526
+ "jss_user_group": {
1527
+ "type": "object",
1528
+ "properties": {
1529
+ "id": {
1530
+ "type": "integer"
1531
+ },
1532
+ "name": {
1533
+ "type": "string"
1534
+ }
1535
+ },
1536
+ "required": [],
1537
+ "additionalProperties": false
1538
+ }
1539
+ },
1540
+ "required": [],
1541
+ "additionalProperties": false
1542
+ }
1543
+ },
1544
+ "limitations": {
1545
+ "type": "object",
1546
+ "properties": {
1547
+ "users": {
1548
+ "type": "array",
1549
+ "items": {
1550
+ "type": "object",
1551
+ "properties": {
1552
+ "user": {
1553
+ "type": "object",
1554
+ "properties": {
1555
+ "id": {
1556
+ "type": "integer"
1557
+ },
1558
+ "name": {
1559
+ "type": "string"
1560
+ }
1561
+ },
1562
+ "required": [],
1563
+ "additionalProperties": false
1564
+ }
1565
+ },
1566
+ "required": [],
1567
+ "additionalProperties": false
1568
+ }
1569
+ },
1570
+ "user_groups": {
1571
+ "type": "array",
1572
+ "items": {
1573
+ "type": "object",
1574
+ "properties": {
1575
+ "user_group": {
1576
+ "type": "object",
1577
+ "properties": {
1578
+ "id": {
1579
+ "type": "integer"
1580
+ },
1581
+ "name": {
1582
+ "type": "string"
1583
+ }
1584
+ },
1585
+ "required": [],
1586
+ "additionalProperties": false
1587
+ }
1588
+ },
1589
+ "required": [],
1590
+ "additionalProperties": false
1591
+ }
1592
+ },
1593
+ "network_segments": {
1594
+ "type": "array",
1595
+ "items": {
1596
+ "type": "object",
1597
+ "properties": {
1598
+ "network_segment": {
1599
+ "type": "object",
1600
+ "properties": {
1601
+ "id": {
1602
+ "type": "integer"
1603
+ },
1604
+ "name": {
1605
+ "type": "string"
1606
+ }
1607
+ },
1608
+ "required": [],
1609
+ "additionalProperties": false
1610
+ }
1611
+ },
1612
+ "required": [],
1613
+ "additionalProperties": false
1614
+ }
1615
+ },
1616
+ "ibeacons": {
1617
+ "type": "array",
1618
+ "items": {
1619
+ "type": "object",
1620
+ "properties": {
1621
+ "ibeacon": {
1622
+ "type": "object",
1623
+ "properties": {
1624
+ "id": {
1625
+ "type": "integer"
1626
+ },
1627
+ "name": {
1628
+ "type": "string"
1629
+ }
1630
+ },
1631
+ "required": [],
1632
+ "additionalProperties": false
1633
+ }
1634
+ },
1635
+ "required": [],
1636
+ "additionalProperties": false
1637
+ }
1638
+ }
1639
+ },
1640
+ "required": [],
1641
+ "additionalProperties": false
1642
+ },
1643
+ "exclusions": {
1644
+ "type": "object",
1645
+ "properties": {
1646
+ "computers": {
1647
+ "type": "array",
1648
+ "items": {
1649
+ "type": "object",
1650
+ "properties": {
1651
+ "computer": {
1652
+ "type": "object",
1653
+ "properties": {
1654
+ "id": {
1655
+ "type": "integer"
1656
+ },
1657
+ "name": {
1658
+ "type": "string",
1659
+ "description": "Name of the computer"
1660
+ },
1661
+ "udid": {
1662
+ "type": "string"
1663
+ }
1664
+ },
1665
+ "required": [],
1666
+ "additionalProperties": false
1667
+ }
1668
+ },
1669
+ "required": [],
1670
+ "additionalProperties": false
1671
+ }
1672
+ },
1673
+ "buildings": {
1674
+ "type": "array",
1675
+ "items": {
1676
+ "type": "object",
1677
+ "properties": {
1678
+ "building": {
1679
+ "type": "object",
1680
+ "properties": {
1681
+ "id": {
1682
+ "type": "integer"
1683
+ },
1684
+ "name": {
1685
+ "type": "string"
1686
+ }
1687
+ },
1688
+ "required": [],
1689
+ "additionalProperties": false
1690
+ }
1691
+ },
1692
+ "required": [],
1693
+ "additionalProperties": false
1694
+ }
1695
+ },
1696
+ "departments": {
1697
+ "type": "array",
1698
+ "items": {
1699
+ "type": "object",
1700
+ "properties": {
1701
+ "department": {
1702
+ "type": "object",
1703
+ "properties": {
1704
+ "id": {
1705
+ "type": "integer"
1706
+ },
1707
+ "name": {
1708
+ "type": "string"
1709
+ }
1710
+ },
1711
+ "required": [],
1712
+ "additionalProperties": false
1713
+ }
1714
+ },
1715
+ "required": [],
1716
+ "additionalProperties": false
1717
+ }
1718
+ },
1719
+ "computer_groups": {
1720
+ "type": "array",
1721
+ "items": {
1722
+ "type": "object",
1723
+ "properties": {
1724
+ "computer_group": {
1725
+ "type": "object",
1726
+ "properties": {
1727
+ "id": {
1728
+ "type": "integer"
1729
+ },
1730
+ "name": {
1731
+ "type": "string"
1732
+ }
1733
+ },
1734
+ "required": [],
1735
+ "additionalProperties": false
1736
+ }
1737
+ },
1738
+ "required": [],
1739
+ "additionalProperties": false
1740
+ }
1741
+ },
1742
+ "users": {
1743
+ "type": "array",
1744
+ "items": {
1745
+ "type": "object",
1746
+ "properties": {
1747
+ "user": {
1748
+ "type": "object",
1749
+ "properties": {
1750
+ "name": {
1751
+ "type": "string"
1752
+ }
1753
+ },
1754
+ "required": [],
1755
+ "additionalProperties": false
1756
+ }
1757
+ },
1758
+ "required": [],
1759
+ "additionalProperties": false
1760
+ }
1761
+ },
1762
+ "user_groups": {
1763
+ "type": "array",
1764
+ "items": {
1765
+ "type": "object",
1766
+ "properties": {
1767
+ "user_group": {
1768
+ "type": "object",
1769
+ "properties": {
1770
+ "id": {
1771
+ "type": "integer"
1772
+ },
1773
+ "name": {
1774
+ "type": "string"
1775
+ }
1776
+ },
1777
+ "required": [],
1778
+ "additionalProperties": false
1779
+ }
1780
+ },
1781
+ "required": [],
1782
+ "additionalProperties": false
1783
+ }
1784
+ },
1785
+ "network_segments": {
1786
+ "type": "array",
1787
+ "items": {
1788
+ "type": "object",
1789
+ "properties": {
1790
+ "network_segment": {
1791
+ "type": "object",
1792
+ "properties": {
1793
+ "id": {
1794
+ "type": "integer"
1795
+ },
1796
+ "uid": {
1797
+ "type": "string"
1798
+ },
1799
+ "name": {
1800
+ "type": "string",
1801
+ "description": "Name of the network segment"
1802
+ }
1803
+ },
1804
+ "required": [],
1805
+ "additionalProperties": false
1806
+ }
1807
+ },
1808
+ "required": [],
1809
+ "additionalProperties": false
1810
+ }
1811
+ },
1812
+ "ibeacons": {
1813
+ "type": "array",
1814
+ "items": {
1815
+ "type": "object",
1816
+ "properties": {
1817
+ "ibeacon": {
1818
+ "type": "object",
1819
+ "properties": {
1820
+ "id": {
1821
+ "type": "integer"
1822
+ },
1823
+ "name": {
1824
+ "type": "string"
1825
+ }
1826
+ },
1827
+ "required": [],
1828
+ "additionalProperties": false
1829
+ }
1830
+ },
1831
+ "required": [],
1832
+ "additionalProperties": false
1833
+ }
1834
+ },
1835
+ "jss_users": {
1836
+ "type": "array",
1837
+ "items": {
1838
+ "type": "object",
1839
+ "properties": {
1840
+ "jss_user": {
1841
+ "type": "object",
1842
+ "properties": {
1843
+ "id": {
1844
+ "type": "integer"
1845
+ },
1846
+ "name": {
1847
+ "type": "string"
1848
+ }
1849
+ },
1850
+ "required": [],
1851
+ "additionalProperties": false
1852
+ }
1853
+ },
1854
+ "required": [],
1855
+ "additionalProperties": false
1856
+ }
1857
+ },
1858
+ "jss_user_groups": {
1859
+ "type": "array",
1860
+ "items": {
1861
+ "type": "object",
1862
+ "properties": {
1863
+ "jss_user_group": {
1864
+ "type": "object",
1865
+ "properties": {
1866
+ "id": {
1867
+ "type": "integer"
1868
+ },
1869
+ "name": {
1870
+ "type": "string"
1871
+ }
1872
+ },
1873
+ "required": [],
1874
+ "additionalProperties": false
1875
+ }
1876
+ },
1877
+ "required": [],
1878
+ "additionalProperties": false
1879
+ }
1880
+ }
1881
+ },
1882
+ "required": [],
1883
+ "additionalProperties": false
1884
+ }
1885
+ },
1886
+ "required": [],
1887
+ "additionalProperties": false
1888
+ }
1889
+ },
1890
+ "required": [
1891
+ "id"
1892
+ ],
1893
+ "additionalProperties": false
1894
+ },
1895
+ "ExtensionAttribute": {
1896
+ "type": "object",
1897
+ "properties": {
1898
+ "id": {
1899
+ "type": "string",
1900
+ "description": "Unique Id for Mobile Device Extension Attribute.",
1901
+ "readOnly": true
1902
+ },
1903
+ "name": {
1904
+ "type": "string",
1905
+ "description": "Display name for the extension attribute."
1906
+ },
1907
+ "description": {
1908
+ "type": "string",
1909
+ "description": "Description for the extension attribute."
1910
+ },
1911
+ "dataType": {
1912
+ "type": "string",
1913
+ "description": "Type of data being collected.",
1914
+ "enum": [
1915
+ "INTEGER",
1916
+ "STRING",
1917
+ "DATE"
1918
+ ],
1919
+ "default": "STRING"
1920
+ },
1921
+ "enabled": {
1922
+ "type": "boolean",
1923
+ "description": "Enabled by default, but for inputType Script we can disable it as well. <br/> Possible values are:<br/> false <br/> true",
1924
+ "default": true
1925
+ },
1926
+ "inventoryDisplayType": {
1927
+ "type": "string",
1928
+ "description": "Category in which to display the extension attribute in Jamf Pro.",
1929
+ "enum": [
1930
+ "GENERAL",
1931
+ "HARDWARE",
1932
+ "OPERATING_SYSTEM",
1933
+ "USER_AND_LOCATION",
1934
+ "PURCHASING",
1935
+ "EXTENSION_ATTRIBUTES"
1936
+ ],
1937
+ "default": "GENERAL"
1938
+ },
1939
+ "inputType": {
1940
+ "type": "string",
1941
+ "description": "Extension attributes collect inventory data by using an input type.The type of the Input used to populate the extension attribute.",
1942
+ "enum": [
1943
+ "SCRIPT",
1944
+ "TEXT",
1945
+ "POPUP",
1946
+ "DIRECTORY_SERVICE_ATTRIBUTE_MAPPING"
1947
+ ],
1948
+ "default": "TEXT"
1949
+ },
1950
+ "scriptContents": {
1951
+ "type": [
1952
+ "string",
1953
+ "null"
1954
+ ],
1955
+ "description": "When we run this script it returns a data value each time a computer submits inventory to Jamf Pro. Provide scriptContents only when inputType is 'SCRIPT'."
1956
+ },
1957
+ "popupMenuChoices": {
1958
+ "type": "array",
1959
+ "description": "When added with list of choices while creating computer extension attributes these Pop-up menu can be displayed in inventory information. User can choose a value from the pop-up menu list when enrolling a computer any time using Jamf Pro. Provide popupMenuChoices only when inputType is 'POPUP'.",
1960
+ "minItems": 0,
1961
+ "items": {
1962
+ "type": "string",
1963
+ "description": "Popup Menu choices."
1964
+ }
1965
+ },
1966
+ "ldapAttributeMapping": {
1967
+ "type": "string",
1968
+ "description": "Directory Service attribute use to populate the extension attribute. <br/> Required when inputType is \"DIRECTORY_SERVICE_ATTRIBUTE_MAPPING\""
1969
+ },
1970
+ "ldapExtensionAttributeAllowed": {
1971
+ "type": "boolean",
1972
+ "description": "Collect multiple values for this extension attribute. ldapExtensionAttributeAllowed is disabled by default, only for inputType 'DIRECTORY_SERVICE_ATTRIBUTE_MAPPING' it can be enabled. It's value cannot be modified during edit operation.<br/> Possible values are:<br/> false <br/> true <br/>",
1973
+ "default": false
1974
+ },
1975
+ "manageExistingData": {
1976
+ "type": "string",
1977
+ "description": "It is used to specify to either delete or retain the extension attributes values when inputType is Script and enabled is false.",
1978
+ "enum": [
1979
+ "RETAIN",
1980
+ "DELETE"
1981
+ ]
1982
+ }
1983
+ },
1984
+ "required": [
1985
+ "id",
1986
+ "dataType",
1987
+ "name",
1988
+ "inputType",
1989
+ "inventoryDisplayType"
1990
+ ],
1991
+ "additionalProperties": false,
1992
+ "description": "Computer extension attribute definition. Collected values are tenant overlay data."
1993
+ },
1994
+ "User": {
1995
+ "type": "object",
1996
+ "properties": {
1997
+ "username": {
1998
+ "type": "string"
1999
+ },
2000
+ "realname": {
2001
+ "type": "string"
2002
+ },
2003
+ "email": {
2004
+ "type": "string"
2005
+ },
2006
+ "phone": {
2007
+ "type": [
2008
+ "string",
2009
+ "null"
2010
+ ]
2011
+ },
2012
+ "position": {
2013
+ "type": [
2014
+ "string",
2015
+ "null"
2016
+ ]
2017
+ },
2018
+ "enableCustomPhotoUrl": {
2019
+ "type": "boolean"
2020
+ },
2021
+ "customPhotoUrl": {
2022
+ "type": "string"
2023
+ },
2024
+ "managedAppleId": {
2025
+ "type": "string"
2026
+ },
2027
+ "id": {
2028
+ "type": "string",
2029
+ "minLength": 1,
2030
+ "readOnly": true
2031
+ }
2032
+ },
2033
+ "required": [
2034
+ "id"
2035
+ ],
2036
+ "additionalProperties": false,
2037
+ "description": "Jamf Pro API user read shape."
2038
+ }
2039
+ },
2040
+ "x-gateway": {
2041
+ "version": 1,
2042
+ "domain_version": "2.0.0",
2043
+ "package": {
2044
+ "id": "gateway-connector-jamf",
2045
+ "version": "2.0.0"
2046
+ },
2047
+ "entities": {
2048
+ "jamf_computers": {
2049
+ "schema": {
2050
+ "$ref": "#/$defs/Computer"
2051
+ },
2052
+ "primary_key": [
2053
+ "id"
2054
+ ],
2055
+ "unique": [],
2056
+ "relationships": []
2057
+ },
2058
+ "jamf_mobile_devices": {
2059
+ "schema": {
2060
+ "$ref": "#/$defs/MobileDevice"
2061
+ },
2062
+ "primary_key": [
2063
+ "id"
2064
+ ],
2065
+ "unique": [],
2066
+ "relationships": []
2067
+ },
2068
+ "jamf_computer_groups": {
2069
+ "schema": {
2070
+ "$ref": "#/$defs/ComputerGroup"
2071
+ },
2072
+ "primary_key": [
2073
+ "id"
2074
+ ],
2075
+ "unique": [
2076
+ [
2077
+ "name"
2078
+ ]
2079
+ ],
2080
+ "relationships": []
2081
+ },
2082
+ "jamf_computer_group_members": {
2083
+ "schema": {
2084
+ "$ref": "#/$defs/ComputerGroupMember"
2085
+ },
2086
+ "primary_key": [
2087
+ "groupId",
2088
+ "computerId"
2089
+ ],
2090
+ "unique": [],
2091
+ "relationships": [
2092
+ {
2093
+ "fields": [
2094
+ "groupId"
2095
+ ],
2096
+ "target": "jamf_computer_groups",
2097
+ "on_delete": "restrict"
2098
+ },
2099
+ {
2100
+ "fields": [
2101
+ "computerId"
2102
+ ],
2103
+ "target": "jamf_computers",
2104
+ "on_delete": "restrict"
2105
+ }
2106
+ ]
2107
+ },
2108
+ "jamf_policies": {
2109
+ "schema": {
2110
+ "$ref": "#/$defs/Policy"
2111
+ },
2112
+ "primary_key": [
2113
+ "id"
2114
+ ],
2115
+ "unique": [],
2116
+ "relationships": []
2117
+ },
2118
+ "jamf_configuration_profiles": {
2119
+ "schema": {
2120
+ "$ref": "#/$defs/ConfigurationProfile"
2121
+ },
2122
+ "primary_key": [
2123
+ "id"
2124
+ ],
2125
+ "unique": [],
2126
+ "relationships": []
2127
+ },
2128
+ "jamf_extension_attributes": {
2129
+ "schema": {
2130
+ "$ref": "#/$defs/ExtensionAttribute"
2131
+ },
2132
+ "primary_key": [
2133
+ "id"
2134
+ ],
2135
+ "unique": [],
2136
+ "relationships": []
2137
+ },
2138
+ "jamf_users": {
2139
+ "schema": {
2140
+ "$ref": "#/$defs/User"
2141
+ },
2142
+ "primary_key": [
2143
+ "id"
2144
+ ],
2145
+ "unique": [],
2146
+ "relationships": []
2147
+ }
2148
+ },
2149
+ "tools": {
2150
+ "list_computers": {
2151
+ "input": {
2152
+ "type": "object",
2153
+ "properties": {},
2154
+ "required": [],
2155
+ "additionalProperties": false
2156
+ },
2157
+ "output": {
2158
+ "type": "array",
2159
+ "items": {
2160
+ "$ref": "#/$defs/Computer"
2161
+ }
2162
+ },
2163
+ "description": "Every computer inventory record in the instance."
2164
+ },
2165
+ "get_computer": {
2166
+ "input": {
2167
+ "type": "object",
2168
+ "properties": {
2169
+ "id": {
2170
+ "$ref": "base.json#/$defs/Id"
2171
+ }
2172
+ },
2173
+ "required": [
2174
+ "id"
2175
+ ],
2176
+ "additionalProperties": false
2177
+ },
2178
+ "output": {
2179
+ "$ref": "#/$defs/Computer"
2180
+ },
2181
+ "description": "One computer inventory record; raises the vendor's 404 when the id does not exist."
2182
+ },
2183
+ "list_policies": {
2184
+ "input": {
2185
+ "type": "object",
2186
+ "properties": {},
2187
+ "required": [],
2188
+ "additionalProperties": false
2189
+ },
2190
+ "output": {
2191
+ "type": "array",
2192
+ "items": {
2193
+ "$ref": "#/$defs/Policy"
2194
+ }
2195
+ },
2196
+ "description": "Every policy in the instance."
2197
+ },
2198
+ "create_computer_group": {
2199
+ "input": {
2200
+ "type": "object",
2201
+ "properties": {
2202
+ "group": {
2203
+ "$ref": "#/$defs/ComputerGroup"
2204
+ }
2205
+ },
2206
+ "required": [
2207
+ "group"
2208
+ ],
2209
+ "additionalProperties": false
2210
+ },
2211
+ "output": {
2212
+ "$ref": "#/$defs/ComputerGroup"
2213
+ },
2214
+ "description": "Create a computer group; raises the vendor's 422 when the name is already taken."
2215
+ }
2216
+ }
2217
+ }
2218
+ }