@withgateway/sdk 0.2.0 → 0.2.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 (1188) hide show
  1. package/README.md +30 -6
  2. package/dist/cli.js +7815 -2406
  3. package/dist/cli.js.map +1 -1
  4. package/dist/cli.mjs +7807 -2398
  5. package/dist/cli.mjs.map +1 -1
  6. package/dist/files/index.d.mts +2 -0
  7. package/dist/files/index.d.ts +2 -0
  8. package/dist/files/index.js +446 -0
  9. package/dist/files/index.js.map +1 -0
  10. package/dist/files/index.mjs +395 -0
  11. package/dist/files/index.mjs.map +1 -0
  12. package/dist/index-BgvvQ3BC.d.ts +170 -0
  13. package/dist/index-CLkMr6VG.d.ts +171 -0
  14. package/dist/index-CdbmO4aX.d.mts +171 -0
  15. package/dist/index-CiKWoroJ.d.mts +170 -0
  16. package/dist/index.d.mts +3 -1
  17. package/dist/index.d.ts +3 -1
  18. package/dist/index.js +2283 -116
  19. package/dist/index.js.map +1 -1
  20. package/dist/index.mjs +2255 -116
  21. package/dist/index.mjs.map +1 -1
  22. package/dist/traces/index.d.mts +2 -0
  23. package/dist/traces/index.d.ts +2 -0
  24. package/dist/traces/index.js +320 -0
  25. package/dist/traces/index.js.map +1 -0
  26. package/dist/traces/index.mjs +278 -0
  27. package/dist/traces/index.mjs.map +1 -0
  28. package/dist/tracing/index.js +16 -1
  29. package/dist/tracing/index.js.map +1 -1
  30. package/dist/tracing/index.mjs +16 -1
  31. package/dist/tracing/index.mjs.map +1 -1
  32. package/dist/worlds/index.d.mts +685 -1
  33. package/dist/worlds/index.d.ts +685 -1
  34. package/dist/worlds/index.js +1876 -32
  35. package/dist/worlds/index.js.map +1 -1
  36. package/dist/worlds/index.mjs +1875 -32
  37. package/dist/worlds/index.mjs.map +1 -1
  38. package/package.json +16 -1
  39. package/runtime/gatewaysdk/environment/_world.py +14 -1
  40. package/runtime/gatewaysdk/environment/schema/__init__.py +8 -0
  41. package/runtime/gatewaysdk/environment/schema/__main__.py +154 -19
  42. package/runtime/gatewaysdk/environment/schema/api.py +233 -37
  43. package/runtime/gatewaysdk/environment/schema/batch.py +38 -8
  44. package/runtime/gatewaysdk/environment/schema/compiler.py +89 -11
  45. package/runtime/gatewaysdk/environment/schema/conform.py +105 -13
  46. package/runtime/gatewaysdk/environment/schema/connector.py +442 -103
  47. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/api/handlers.py +778 -0
  48. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/connector.toml +671 -0
  49. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/handlers.py +3 -2
  50. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/parity.json +11 -5
  51. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/provenance.json +1635 -100
  52. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/instruction.md +7 -0
  53. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/scenario.toml +2 -0
  54. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_activities.json +24 -0
  55. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_activity_devices.json +12 -0
  56. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_applecare_coverages.json +52 -0
  57. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_apps.json +35 -0
  58. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_audit_events.json +139 -0
  59. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprint_apps.json +12 -0
  60. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprint_configurations.json +20 -0
  61. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprint_devices.json +16 -0
  62. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprint_packages.json +8 -0
  63. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprint_user_groups.json +12 -0
  64. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprint_users.json +12 -0
  65. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_blueprints.json +39 -0
  66. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_configurations.json +64 -0
  67. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_device_assignments.json +20 -0
  68. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_mdm_device_details.json +55 -0
  69. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_mdm_devices.json +33 -0
  70. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_mdm_servers.json +56 -0
  71. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_org_devices.json +178 -0
  72. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_organizational_unit_memberships.json +16 -0
  73. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_organizational_units.json +24 -0
  74. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_packages.json +20 -0
  75. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_user_group_memberships.json +16 -0
  76. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_user_groups.json +30 -0
  77. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scenarios/default/seed/abm_users.json +115 -0
  78. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scope.toml +49 -22
  79. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/tests/tools.json +48 -0
  80. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/world.json +1180 -194
  81. package/runtime/gatewaysdk/environment/schema/connectors/asana/api/handlers.py +1026 -0
  82. package/runtime/gatewaysdk/environment/schema/connectors/asana/connector.toml +511 -0
  83. package/runtime/gatewaysdk/environment/schema/connectors/asana/fidelity.json +89 -0
  84. package/runtime/gatewaysdk/environment/schema/connectors/asana/handlers.py +40 -0
  85. package/runtime/gatewaysdk/environment/schema/connectors/asana/provenance.json +101 -0
  86. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/scenario.toml +2 -0
  87. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/account_settings.json +12 -0
  88. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/custom_field_settings.json +60 -0
  89. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/custom_fields.json +43 -0
  90. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/enum_options.json +52 -0
  91. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/notifications.json +103 -0
  92. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/project_favorites.json +12 -0
  93. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/project_memberships.json +144 -0
  94. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/projects.json +120 -0
  95. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/recent_projects.json +19 -0
  96. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/sections.json +102 -0
  97. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/stories.json +852 -0
  98. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/task_custom_fields.json +508 -0
  99. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/task_followers.json +368 -0
  100. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/task_memberships.json +184 -0
  101. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/tasks.json +1921 -0
  102. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/teams.json +22 -0
  103. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/user_task_list_sections.json +32 -0
  104. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/user_task_lists.json +11 -0
  105. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/users.json +60 -0
  106. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/workspace_memberships.json +76 -0
  107. package/runtime/gatewaysdk/environment/schema/connectors/asana/scenarios/default/seed/workspaces.json +13 -0
  108. package/runtime/gatewaysdk/environment/schema/connectors/asana/scope.toml +156 -0
  109. package/runtime/gatewaysdk/environment/schema/connectors/asana/tests/routes.json +298 -0
  110. package/runtime/gatewaysdk/environment/schema/connectors/asana/tests/tools.json +152 -0
  111. package/runtime/gatewaysdk/environment/schema/connectors/asana/ui/static/assets/index-DTTTJ6a4.css +1 -0
  112. package/runtime/gatewaysdk/environment/schema/connectors/asana/ui/static/assets/index-WS8dLEjv.js +67 -0
  113. package/runtime/gatewaysdk/environment/schema/connectors/asana/ui/static/index.html +40 -0
  114. package/runtime/gatewaysdk/environment/schema/connectors/asana/world.json +1911 -0
  115. package/runtime/gatewaysdk/environment/schema/connectors/confluence/api/handlers.py +847 -0
  116. package/runtime/gatewaysdk/environment/schema/connectors/confluence/connector.toml +457 -0
  117. package/runtime/gatewaysdk/environment/schema/connectors/confluence/handlers.py +176 -0
  118. package/runtime/gatewaysdk/environment/schema/connectors/confluence/provenance.json +187 -0
  119. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/instruction.md +39 -0
  120. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/scenario.toml +3 -0
  121. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_favourites.json +29 -0
  122. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_footer_comments.json +984 -0
  123. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_inline_comments.json +355 -0
  124. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_labels.json +99 -0
  125. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_notifications.json +40 -0
  126. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_page_labels.json +209 -0
  127. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_page_versions.json +828 -0
  128. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_pages.json +949 -0
  129. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_recently_viewed_pages.json +59 -0
  130. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_sites.json +12 -0
  131. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_spaces.json +128 -0
  132. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_users.json +100 -0
  133. package/runtime/gatewaysdk/environment/schema/connectors/confluence/scenarios/default/seed/confluence_watches.json +96 -0
  134. package/runtime/gatewaysdk/environment/schema/connectors/confluence/tests/routes.json +212 -0
  135. package/runtime/gatewaysdk/environment/schema/connectors/confluence/tests/tools.json +140 -0
  136. package/runtime/gatewaysdk/environment/schema/connectors/confluence/tests/writes.json +201 -0
  137. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/assets/index-BWaOVdpn.js +70 -0
  138. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/assets/index-CKyfi3i5.css +1 -0
  139. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/acct-01.svg +1 -0
  140. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/acct-02.svg +1 -0
  141. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/acct-03.svg +1 -0
  142. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/acct-04.svg +1 -0
  143. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/acct-05.svg +1 -0
  144. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/acct-06.svg +1 -0
  145. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/space-DES.svg +1 -0
  146. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/space-ENG.svg +1 -0
  147. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/space-OPS.svg +1 -0
  148. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/space-ORB.svg +1 -0
  149. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/avatars/space-PN.svg +1 -0
  150. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/fonts/AtlassianMono-latin.woff2 +0 -0
  151. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/fonts/AtlassianSans-latin.woff2 +0 -0
  152. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/fonts/AtlassianSansItalic-latin.woff2 +0 -0
  153. package/runtime/gatewaysdk/environment/schema/connectors/confluence/ui/static/index.html +47 -0
  154. package/runtime/gatewaysdk/environment/schema/connectors/confluence/world.json +1346 -0
  155. package/runtime/gatewaysdk/environment/schema/connectors/custom/provenance.json +35 -0
  156. package/runtime/gatewaysdk/environment/schema/connectors/custom/tests/tools.json +123 -0
  157. package/runtime/gatewaysdk/environment/schema/connectors/custom/world.json +112 -24
  158. package/runtime/gatewaysdk/environment/schema/connectors/github/api/handlers.py +2923 -0
  159. package/runtime/gatewaysdk/environment/schema/connectors/github/connector.toml +2091 -0
  160. package/runtime/gatewaysdk/environment/schema/connectors/github/provenance.json +109 -81
  161. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/instruction.md +18 -0
  162. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/scenario.toml +2 -0
  163. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_apps.json +49 -0
  164. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_artifacts.json +26 -0
  165. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_branches.json +443 -0
  166. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_check_runs.json +220 -0
  167. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_check_suites.json +404 -0
  168. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_code_scanning_alerts.json +126 -0
  169. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_collaborators.json +100 -0
  170. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_commit_comments.json +43 -0
  171. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_commit_statuses.json +80 -0
  172. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_commits.json +461 -0
  173. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_dependabot_alerts.json +168 -0
  174. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_deployment_statuses.json +86 -0
  175. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_deployments.json +94 -0
  176. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_environments.json +31 -0
  177. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_gist_comments.json +38 -0
  178. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_gists.json +118 -0
  179. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_git_refs.json +59 -0
  180. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_installations.json +54 -0
  181. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_issue_comments.json +151 -0
  182. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_issue_events.json +606 -0
  183. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_issue_types.json +26 -0
  184. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_issues.json +758 -0
  185. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_labels.json +64 -0
  186. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_licenses.json +54 -0
  187. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_milestones.json +130 -0
  188. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_organization_memberships.json +139 -0
  189. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_organizations.json +38 -0
  190. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_pull_requests.json +874 -0
  191. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_release_assets.json +45 -0
  192. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_releases.json +92 -0
  193. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_repositories.json +797 -0
  194. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_repository_invitations.json +184 -0
  195. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_review_comments.json +66 -0
  196. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_reviews.json +138 -0
  197. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_secret_scanning_alerts.json +50 -0
  198. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_stargazers.json +88 -0
  199. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_tags.json +28 -0
  200. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_team_memberships.json +25 -0
  201. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_team_repositories.json +258 -0
  202. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_teams.json +130 -0
  203. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_users.json +174 -0
  204. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_webhooks.json +31 -0
  205. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_workflow_jobs.json +115 -0
  206. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_workflow_runs.json +1021 -0
  207. package/runtime/gatewaysdk/environment/schema/connectors/github/scenarios/default/seed/github_workflows.json +30 -0
  208. package/runtime/gatewaysdk/environment/schema/connectors/github/scope.toml +501 -62
  209. package/runtime/gatewaysdk/environment/schema/connectors/github/tests/tools.json +79 -0
  210. package/runtime/gatewaysdk/environment/schema/connectors/github/vendor-openapi.json +1 -0
  211. package/runtime/gatewaysdk/environment/schema/connectors/github/world.json +14340 -4447
  212. package/runtime/gatewaysdk/environment/schema/connectors/gmail/api/handlers.py +1413 -0
  213. package/runtime/gatewaysdk/environment/schema/connectors/gmail/connector.toml +630 -0
  214. package/runtime/gatewaysdk/environment/schema/connectors/gmail/handlers.py +136 -0
  215. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/scenario.toml +1 -0
  216. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/10-gmail_profiles.json +10 -0
  217. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/20-gmail_labels.json +205 -0
  218. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/30-gmail_contacts.json +234 -0
  219. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/40-gmail_threads.json +374 -0
  220. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/50-gmail_messages.json +1015 -0
  221. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/60-gmail_message_parts.json +3039 -0
  222. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/70-gmail_attachments.json +28 -0
  223. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/80-gmail_drafts.json +39 -0
  224. package/runtime/gatewaysdk/environment/schema/connectors/gmail/scenarios/default/seed/90-gmail_client_settings.json +103 -0
  225. package/runtime/gatewaysdk/environment/schema/connectors/gmail/world.json +784 -0
  226. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/api/handlers.py +454 -0
  227. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/connector.toml +519 -0
  228. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/provenance.json +229 -0
  229. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/instruction.md +25 -0
  230. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/scenario.toml +1 -0
  231. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/10-calendar_calendars.json +75 -0
  232. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/20-calendar_calendar_list_entries.json +115 -0
  233. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/30-calendar_acl_rules.json +124 -0
  234. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/40-calendar_events.json +810 -0
  235. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/50-calendar_settings.json +76 -0
  236. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/60-calendar_channels.json +26 -0
  237. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scenarios/default/seed/70-calendar_colors.json +48 -0
  238. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/scope.toml +105 -0
  239. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/tests/tools.json +53 -0
  240. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/vendor-openapi.json +4185 -0
  241. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/world.json +1255 -80
  242. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/api/handlers.py +782 -0
  243. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/connector.toml +373 -0
  244. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/google-docs-types.json +4939 -0
  245. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/handlers.py +197 -0
  246. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/provenance.json +191 -0
  247. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/instruction.md +29 -0
  248. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/scenario.toml +2 -0
  249. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_comments.json +50 -0
  250. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_documents.json +8096 -0
  251. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_files.json +1187 -0
  252. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_permissions.json +543 -0
  253. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_replies.json +22 -0
  254. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_revisions.json +643 -0
  255. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scenarios/default/seed/gdocs_users.json +32 -0
  256. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/scope.toml +148 -0
  257. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/tests/api.json +319 -0
  258. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/tests/tools.json +262 -0
  259. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/assets/index-BH9fmZSS.css +1 -0
  260. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/assets/index-CU4Fk9dX.js +67 -0
  261. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/fonts/README.md +20 -0
  262. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/fonts/google-sans-variable.woff2 +0 -0
  263. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/fonts/roboto-italic-variable-latin.woff2 +0 -0
  264. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/fonts/roboto-variable-latin-ext.woff2 +0 -0
  265. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/fonts/roboto-variable-latin.woff2 +0 -0
  266. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/icons/material_common_sprite1038_gm3_grey_medium.svg +1 -0
  267. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/ui/static/index.html +13 -0
  268. package/runtime/gatewaysdk/environment/schema/connectors/google-docs/world.json +4489 -0
  269. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/api/handlers.py +466 -0
  270. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/connector.toml +626 -0
  271. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/handlers.py +42 -5
  272. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/provenance.json +342 -0
  273. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/instruction.md +11 -0
  274. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/scenario.toml +2 -0
  275. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_access_proposals.json +31 -0
  276. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_approvals.json +145 -0
  277. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_apps.json +81 -0
  278. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_comments.json +70 -0
  279. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_drives.json +71 -0
  280. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_files.json +700 -0
  281. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_labels.json +75 -0
  282. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_permissions.json +93 -0
  283. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_replies.json +66 -0
  284. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scenarios/default/seed/drive_revisions.json +82 -0
  285. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/scope.toml +126 -0
  286. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/tests/tools.json +101 -0
  287. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/vendor-openapi.json +6193 -0
  288. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/world.json +1972 -108
  289. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/api/handlers.py +1645 -0
  290. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/connector.toml +414 -0
  291. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/handlers.py +200 -0
  292. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/scenario.toml +2 -0
  293. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_cells.json +10252 -0
  294. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_charts.json +103 -0
  295. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_conditional_formats.json +138 -0
  296. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_dimensions.json +256 -0
  297. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_named_ranges.json +16 -0
  298. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_permissions.json +31 -0
  299. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_sheets.json +95 -0
  300. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_spreadsheets.json +14 -0
  301. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/scenarios/default/seed/gsheets_view_states.json +26 -0
  302. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/tests/page.json +311 -0
  303. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/tests/vendor.json +843 -0
  304. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/assets/index-CUpfKgm_.js +40 -0
  305. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/assets/index-D3VhwBIC.css +1 -0
  306. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/GoogleSans-400.woff2 +0 -0
  307. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/GoogleSans-500.woff2 +0 -0
  308. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/GoogleSans-700.woff2 +0 -0
  309. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/GoogleSansText-400.woff2 +0 -0
  310. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/GoogleSansText-500.woff2 +0 -0
  311. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/GoogleSansText-700.woff2 +0 -0
  312. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/Roboto-400.woff2 +0 -0
  313. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/Roboto-500.woff2 +0 -0
  314. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/fonts/Roboto-700.woff2 +0 -0
  315. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/ui/static/index.html +26 -0
  316. package/runtime/gatewaysdk/environment/schema/connectors/google-sheets/world.json +4029 -0
  317. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/api/handlers.py +800 -0
  318. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/connector.toml +776 -0
  319. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/handlers.py +226 -0
  320. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/instruction.md +11 -0
  321. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/scenario.toml +2 -0
  322. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_accounts.json +17 -0
  323. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_associations.json +1478 -0
  324. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_calls.json +147 -0
  325. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_companies.json +144 -0
  326. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_contacts.json +284 -0
  327. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_deals.json +204 -0
  328. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_emails.json +160 -0
  329. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_meetings.json +147 -0
  330. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_nav_items.json +204 -0
  331. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_notes.json +160 -0
  332. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_notifications.json +25 -0
  333. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_object_views.json +334 -0
  334. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_owners.json +76 -0
  335. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_pipeline_stages.json +109 -0
  336. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_pipelines.json +13 -0
  337. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_properties.json +1220 -0
  338. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_tasks.json +394 -0
  339. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/scenarios/default/seed/hubspot_tickets.json +34 -0
  340. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/assets/index-hdb5vB78.css +1 -0
  341. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/assets/index-xhg5ASqE.js +68 -0
  342. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/fonts/lexend-deca-300.ttf +0 -0
  343. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/fonts/lexend-deca-400.ttf +0 -0
  344. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/fonts/lexend-deca-500.ttf +0 -0
  345. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/fonts/lexend-deca-600.ttf +0 -0
  346. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/fonts/lexend-deca-700.ttf +0 -0
  347. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/fonts/lexend-deca-latin.woff2 +0 -0
  348. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/add.svg +1 -0
  349. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/avatar.svg +1 -0
  350. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/bell.svg +3 -0
  351. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/breeze.svg +4 -0
  352. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/call.svg +1 -0
  353. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/chevron-up.svg +3 -0
  354. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/companies.svg +1 -0
  355. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/contact.svg +1 -0
  356. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/contacts.svg +1 -0
  357. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/date.svg +1 -0
  358. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/deals.svg +1 -0
  359. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/duplicate.svg +1 -0
  360. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/export.svg +3 -0
  361. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/external-link.svg +1 -0
  362. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/filter-lines.svg +3 -0
  363. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/frame-expand.svg +3 -0
  364. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/funnel.svg +3 -0
  365. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/help.svg +1 -0
  366. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/hierarchy.svg +4 -0
  367. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/home.svg +1 -0
  368. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/hubspot-logo.svg +1 -0
  369. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/info.svg +1 -0
  370. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/kanban.svg +1 -0
  371. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/marketing-email.svg +1 -0
  372. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/marketplace.svg +1 -0
  373. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/meetings.svg +1 -0
  374. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/more.svg +1 -0
  375. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/pencil.svg +3 -0
  376. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/pin.svg +3 -0
  377. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/prospecting.svg +1 -0
  378. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/refresh.svg +1 -0
  379. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/search.svg +1 -0
  380. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/settings.svg +1 -0
  381. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/sidebar-collapse.svg +3 -0
  382. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/sort.svg +3 -0
  383. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/table.svg +1 -0
  384. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/tasks.svg +1 -0
  385. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/thumbs-down.svg +1 -0
  386. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/thumbs-up.svg +1 -0
  387. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/undo.svg +3 -0
  388. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/upgrade-arrow.svg +1 -0
  389. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/vertical-dots.svg +5 -0
  390. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/icons/workflows.svg +1 -0
  391. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/ui/static/index.html +37 -0
  392. package/runtime/gatewaysdk/environment/schema/connectors/hubspot/world.json +1347 -0
  393. package/runtime/gatewaysdk/environment/schema/connectors/jamf/api/handlers.py +987 -0
  394. package/runtime/gatewaysdk/environment/schema/connectors/jamf/connector.toml +3057 -0
  395. package/runtime/gatewaysdk/environment/schema/connectors/jamf/provenance.json +9443 -129
  396. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/scenario.toml +4 -0
  397. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_account_groups.json +64 -0
  398. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_accounts.json +58 -0
  399. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_advanced_computer_searches.json +139 -0
  400. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_advanced_mobile_device_searches.json +61 -0
  401. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_advanced_user_content_searches.json +61 -0
  402. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_advanced_user_searches.json +124 -0
  403. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_api_integrations.json +37 -0
  404. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_api_roles.json +25 -0
  405. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_app_request_form_input_fields.json +22 -0
  406. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_buildings.json +34 -0
  407. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_byo_profiles.json +46 -0
  408. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_categories.json +19 -0
  409. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_classes.json +217 -0
  410. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_cloud_idps.json +19 -0
  411. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_computer_group_members.json +16 -0
  412. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_computer_groups.json +38 -0
  413. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_computer_invitations.json +82 -0
  414. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_computer_prestages.json +274 -0
  415. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_computers.json +1537 -0
  416. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_configuration_profiles.json +649 -0
  417. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_departments.json +16 -0
  418. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_device_enrollment_devices.json +70 -0
  419. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_device_enrollments.json +46 -0
  420. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_directory_bindings.json +34 -0
  421. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_disk_encryption_configurations.json +22 -0
  422. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_distribution_points.json +91 -0
  423. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_dock_items.json +25 -0
  424. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_ebooks.json +43 -0
  425. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_enrollment_customizations.json +43 -0
  426. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_extension_attributes.json +52 -0
  427. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_ibeacons.json +25 -0
  428. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_inventory_preload_records.json +100 -0
  429. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_ios_branding_configurations.json +31 -0
  430. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_ldap_servers.json +16 -0
  431. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_licensed_software_records.json +244 -0
  432. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mac_applications.json +610 -0
  433. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_macos_branding_configurations.json +34 -0
  434. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_managed_software_update_plans.json +67 -0
  435. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mdm_commands.json +58 -0
  436. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_applications.json +700 -0
  437. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_configuration_profiles.json +652 -0
  438. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_enrollment_profiles.json +160 -0
  439. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_extension_attributes.json +43 -0
  440. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_group_members.json +16 -0
  441. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_groups.json +38 -0
  442. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_prestages.json +280 -0
  443. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_device_provisioning_profiles.json +31 -0
  444. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_mobile_devices.json +1558 -0
  445. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_network_segments.json +46 -0
  446. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_packages.json +118 -0
  447. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_patch_software_title_configurations.json +88 -0
  448. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_policies.json +1054 -0
  449. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_printers.json +52 -0
  450. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_removable_mac_addresses.json +16 -0
  451. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_restricted_software_titles.json +289 -0
  452. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_return_to_service_configurations.json +19 -0
  453. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_scripts.json +61 -0
  454. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_sites.json +19 -0
  455. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_software_update_servers.json +25 -0
  456. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_supervision_identities.json +22 -0
  457. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_user_extension_attributes.json +31 -0
  458. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_user_groups.json +112 -0
  459. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_users.json +37 -0
  460. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_volume_purchasing_locations.json +106 -0
  461. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_volume_purchasing_subscriptions.json +76 -0
  462. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scenarios/default/seed/jamf_webhooks.json +70 -0
  463. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scope.toml +839 -67
  464. package/runtime/gatewaysdk/environment/schema/connectors/jamf/tests/tools.json +95 -0
  465. package/runtime/gatewaysdk/environment/schema/connectors/jamf/vendor-openapi.json +1 -0
  466. package/runtime/gatewaysdk/environment/schema/connectors/jamf/world.json +10835 -1494
  467. package/runtime/gatewaysdk/environment/schema/connectors/jira/api/handlers.py +1056 -0
  468. package/runtime/gatewaysdk/environment/schema/connectors/jira/connector.toml +955 -0
  469. package/runtime/gatewaysdk/environment/schema/connectors/jira/handlers.py +73 -14
  470. package/runtime/gatewaysdk/environment/schema/connectors/jira/parity.json +27 -0
  471. package/runtime/gatewaysdk/environment/schema/connectors/jira/provenance.json +166 -0
  472. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/instruction.md +22 -0
  473. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/scenario.toml +3 -0
  474. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_boards.json +61 -0
  475. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_changelogs.json +136 -0
  476. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_comments.json +205 -0
  477. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_components.json +78 -0
  478. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_fields.json +498 -0
  479. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_issue_link_types.json +25 -0
  480. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_issue_links.json +190 -0
  481. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_issue_types.json +44 -0
  482. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_issues.json +1448 -0
  483. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_priorities.json +40 -0
  484. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_project_categories.json +16 -0
  485. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_projects.json +111 -0
  486. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_resolutions.json +22 -0
  487. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_sprint_issues.json +20 -0
  488. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_sprints.json +39 -0
  489. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_status_categories.json +25 -0
  490. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_statuses.json +60 -0
  491. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_transitions.json +179 -0
  492. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_users.json +83 -0
  493. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_versions.json +30 -0
  494. package/runtime/gatewaysdk/environment/schema/connectors/jira/scenarios/default/seed/jira_worklogs.json +96 -0
  495. package/runtime/gatewaysdk/environment/schema/connectors/jira/scope.toml +255 -0
  496. package/runtime/gatewaysdk/environment/schema/connectors/jira/tests/tools.json +151 -0
  497. package/runtime/gatewaysdk/environment/schema/connectors/jira/vendor-openapi.json +13562 -0
  498. package/runtime/gatewaysdk/environment/schema/connectors/jira/world.json +3381 -183
  499. package/runtime/gatewaysdk/environment/schema/connectors/kandji/api/handlers.py +406 -0
  500. package/runtime/gatewaysdk/environment/schema/connectors/kandji/connector.toml +531 -0
  501. package/runtime/gatewaysdk/environment/schema/connectors/kandji/provenance.json +229 -46
  502. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/scenario.toml +2 -0
  503. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_blueprint_items.json +22 -0
  504. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_blueprint_template_categories.json +14 -0
  505. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_blueprint_templates.json +38 -0
  506. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_blueprints.json +52 -0
  507. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_custom_apps.json +45 -0
  508. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_custom_profiles.json +32 -0
  509. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_custom_scripts.json +27 -0
  510. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_device_activities.json +43 -0
  511. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_device_apps.json +52 -0
  512. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_device_commands.json +41 -0
  513. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_device_notes.json +20 -0
  514. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_device_parameters.json +28 -0
  515. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_device_tags.json +16 -0
  516. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_devices.json +122 -0
  517. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_in_house_apps.json +33 -0
  518. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_library_item_activities.json +33 -0
  519. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_library_item_statuses.json +98 -0
  520. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_library_items.json +24 -0
  521. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_self_service_categories.json +12 -0
  522. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_tags.json +16 -0
  523. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scenarios/default/seed/kandji_users.json +61 -0
  524. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scope.toml +118 -39
  525. package/runtime/gatewaysdk/environment/schema/connectors/kandji/tests/tools.json +64 -0
  526. package/runtime/gatewaysdk/environment/schema/connectors/kandji/vendor-openapi.json +5463 -0
  527. package/runtime/gatewaysdk/environment/schema/connectors/kandji/world.json +1257 -205
  528. package/runtime/gatewaysdk/environment/schema/connectors/linear/api/handlers.py +139 -0
  529. package/runtime/gatewaysdk/environment/schema/connectors/linear/connector.toml +1574 -0
  530. package/runtime/gatewaysdk/environment/schema/connectors/linear/handlers.py +8 -5
  531. package/runtime/gatewaysdk/environment/schema/connectors/linear/provenance.json +142 -0
  532. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/scenario.toml +2 -0
  533. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/attachments.json +21 -0
  534. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/comments.json +79 -0
  535. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/customer_needs.json +21 -0
  536. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/customer_statuses.json +26 -0
  537. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/customer_tiers.json +26 -0
  538. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/customers.json +48 -0
  539. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/cycles.json +86 -0
  540. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/documents.json +27 -0
  541. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/initiative_projects.json +13 -0
  542. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/initiative_updates.json +23 -0
  543. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/initiatives.json +41 -0
  544. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/issue_labels.json +16 -0
  545. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/issue_relations.json +13 -0
  546. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/issues.json +264 -0
  547. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/labels.json +52 -0
  548. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/organizations.json +53 -0
  549. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/project_labels.json +34 -0
  550. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/project_members.json +16 -0
  551. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/project_milestones.json +30 -0
  552. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/project_relations.json +18 -0
  553. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/project_statuses.json +76 -0
  554. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/project_updates.json +42 -0
  555. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/projects.json +110 -0
  556. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/reactions.json +28 -0
  557. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/roadmap_projects.json +13 -0
  558. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/roadmaps.json +19 -0
  559. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/team_memberships.json +34 -0
  560. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/teams.json +114 -0
  561. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/templates.json +27 -0
  562. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/users.json +106 -0
  563. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/webhooks.json +21 -0
  564. package/runtime/gatewaysdk/environment/schema/connectors/linear/scenarios/default/seed/workflow_states.json +108 -0
  565. package/runtime/gatewaysdk/environment/schema/connectors/linear/scope.toml +87 -0
  566. package/runtime/gatewaysdk/environment/schema/connectors/linear/tests/tools.json +52 -0
  567. package/runtime/gatewaysdk/environment/schema/connectors/linear/world.json +5957 -172
  568. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/api/handlers.py +1218 -0
  569. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/connector.toml +1246 -0
  570. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/fidelity.json +49 -19
  571. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/provenance.json +785 -4
  572. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/instruction.md +12 -0
  573. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/scenario.toml +2 -0
  574. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_async_operations.json +47 -0
  575. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_channel_hosted_contents.json +12 -0
  576. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_channel_members.json +88 -0
  577. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_channel_messages.json +313 -0
  578. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_channel_replies.json +128 -0
  579. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_channels.json +319 -0
  580. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_chat_hosted_contents.json +18 -0
  581. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_chat_members.json +155 -0
  582. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_chat_messages.json +265 -0
  583. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_chat_views.json +37 -0
  584. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_chats.json +167 -0
  585. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_incoming_channels.json +25 -0
  586. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_pinned_messages.json +9 -0
  587. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_reply_hosted_contents.json +13 -0
  588. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_shared_channel_teams.json +32 -0
  589. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_tag_members.json +31 -0
  590. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_tags.json +32 -0
  591. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_team_members.json +117 -0
  592. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scenarios/default/seed/teams_teams.json +193 -0
  593. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scope.md +76 -4
  594. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/teams-types.json +29 -0
  595. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/tests/routes.json +101 -0
  596. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/vendor-openapi.json +11280 -0
  597. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/world.json +74 -6
  598. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/api/handlers.py +571 -0
  599. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/connector.toml +1484 -0
  600. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/parity.json +28 -1
  601. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/provenance.json +215 -49
  602. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/instruction.md +11 -0
  603. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/scenario.toml +2 -0
  604. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_accounting_periods.json +107 -0
  605. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_accounts.json +514 -0
  606. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_classifications.json +64 -0
  607. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_contacts.json +90 -0
  608. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_credit_memos.json +112 -0
  609. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_currencies.json +37 -0
  610. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_customer_payments.json +108 -0
  611. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_customers.json +232 -0
  612. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_departments.json +80 -0
  613. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_employees.json +124 -0
  614. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_invoices.json +229 -0
  615. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_item_fulfillments.json +85 -0
  616. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_items.json +237 -0
  617. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_journal_entries.json +217 -0
  618. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_locations.json +62 -0
  619. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_price_levels.json +28 -0
  620. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_purchase_orders.json +152 -0
  621. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_sales_order_lines.json +235 -0
  622. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_sales_orders.json +219 -0
  623. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_subsidiaries.json +85 -0
  624. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_terms.json +48 -0
  625. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_vendor_bills.json +170 -0
  626. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scenarios/default/seed/netsuite_vendors.json +140 -0
  627. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scope.toml +251 -33
  628. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/tests/tools.json +82 -0
  629. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/world.json +31065 -8232
  630. package/runtime/gatewaysdk/environment/schema/connectors/notion/api/handlers.py +1330 -0
  631. package/runtime/gatewaysdk/environment/schema/connectors/notion/connector.toml +386 -0
  632. package/runtime/gatewaysdk/environment/schema/connectors/notion/handlers.py +54 -0
  633. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/scenario.toml +2 -0
  634. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/blocks.json +4197 -0
  635. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/calendar_events.json +18 -0
  636. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/collection_views.json +175 -0
  637. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/comments.json +109 -0
  638. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/databases.json +417 -0
  639. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/favorites.json +3 -0
  640. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/notifications.json +49 -0
  641. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/pages.json +3758 -0
  642. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/spaces.json +28 -0
  643. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/teamspaces.json +3 -0
  644. package/runtime/gatewaysdk/environment/schema/connectors/notion/scenarios/default/seed/users.json +92 -0
  645. package/runtime/gatewaysdk/environment/schema/connectors/notion/tests/01-reads.json +165 -0
  646. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/assets/index-DQ36W7RG.css +1 -0
  647. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/assets/index-DythuuUy.js +67 -0
  648. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000002.svg +1 -0
  649. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000003.svg +1 -0
  650. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000004.svg +1 -0
  651. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000005.svg +1 -0
  652. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000006.svg +1 -0
  653. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000007.svg +1 -0
  654. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/avatars/eeee0000000000000000000000000008.svg +1 -0
  655. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/covers/dusk-harbor.png +0 -0
  656. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/covers/ember-coast.png +0 -0
  657. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/covers/green-ridge.png +0 -0
  658. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f30a.svg +1 -0
  659. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f331.svg +1 -0
  660. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f373.svg +1 -0
  661. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3a7.svg +1 -0
  662. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3a8.svg +1 -0
  663. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3ac.svg +1 -0
  664. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3af.svg +1 -0
  665. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3c4.svg +1 -0
  666. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3d6.svg +1 -0
  667. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f3e0.svg +1 -0
  668. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f44b.svg +1 -0
  669. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4a1.svg +1 -0
  670. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4b0.svg +1 -0
  671. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4bc.svg +1 -0
  672. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4c5.svg +1 -0
  673. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4c8.svg +1 -0
  674. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4cb.svg +1 -0
  675. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4ce.svg +1 -0
  676. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4d1.svg +1 -0
  677. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4d3.svg +1 -0
  678. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4d6.svg +1 -0
  679. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4da.svg +1 -0
  680. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4dd.svg +1 -0
  681. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4ec.svg +1 -0
  682. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f4f7.svg +1 -0
  683. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f527.svg +1 -0
  684. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f55b.svg +1 -0
  685. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f5c2.svg +1 -0
  686. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f5d3.svg +1 -0
  687. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f680.svg +1 -0
  688. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f6a2.svg +1 -0
  689. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f9ca.svg +1 -0
  690. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f9e0.svg +1 -0
  691. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f9ea.svg +1 -0
  692. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f9ed.svg +1 -0
  693. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1f9f0.svg +1 -0
  694. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/1fab6.svg +1 -0
  695. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/2600.svg +1 -0
  696. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/2693.svg +1 -0
  697. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/2705.svg +1 -0
  698. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/2708.svg +1 -0
  699. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/270f.svg +1 -0
  700. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/emoji/2b50.svg +1 -0
  701. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/favicon.svg +1 -0
  702. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/fonts/SourceSerif4-latin.woff2 +0 -0
  703. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/index.html +31 -0
  704. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/learn/content-blocks.png +0 -0
  705. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/learn/databases.png +0 -0
  706. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/learn/sharing.png +0 -0
  707. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/learn/style-content.png +0 -0
  708. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/photos/home-icon.png +0 -0
  709. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/photos/viewer.png +0 -0
  710. package/runtime/gatewaysdk/environment/schema/connectors/notion/ui/static/photos/workspace.png +0 -0
  711. package/runtime/gatewaysdk/environment/schema/connectors/notion/world.json +2796 -0
  712. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_admin_role_assignments.json +44 -0
  713. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_app_assignments.json +40 -0
  714. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_app_group_assignments.json +59 -0
  715. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_applications.json +265 -0
  716. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_console_dashboards.json +91 -0
  717. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_device_users.json +32 -0
  718. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_devices.json +89 -0
  719. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_group_memberships.json +156 -0
  720. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_groups.json +100 -0
  721. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_orgs.json +20 -0
  722. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_policies.json +84 -0
  723. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_system_log_events.json +9656 -0
  724. package/runtime/gatewaysdk/environment/schema/connectors/okta/scenarios/default/seed/okta_users.json +744 -0
  725. package/runtime/gatewaysdk/environment/schema/connectors/outlook/api/handlers.py +624 -0
  726. package/runtime/gatewaysdk/environment/schema/connectors/outlook/connector.toml +381 -0
  727. package/runtime/gatewaysdk/environment/schema/connectors/outlook/handlers.py +54 -0
  728. package/runtime/gatewaysdk/environment/schema/connectors/outlook/provenance.json +408 -0
  729. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/instruction.md +22 -0
  730. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/scenario.toml +2 -0
  731. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_attachments.json +44 -0
  732. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_calendars.json +52 -0
  733. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_contacts.json +326 -0
  734. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_events.json +3050 -0
  735. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_mail_folders.json +84 -0
  736. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_mailbox_settings.json +35 -0
  737. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_mailboxes.json +14 -0
  738. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_messages.json +1400 -0
  739. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_system_senders.json +44 -0
  740. package/runtime/gatewaysdk/environment/schema/connectors/outlook/scenarios/default/seed/outlook_users.json +256 -0
  741. package/runtime/gatewaysdk/environment/schema/connectors/outlook/tests/routes.json +333 -0
  742. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/assets/index-DRVA5ahH.js +67 -0
  743. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/assets/index-kOnvVBhA.css +1 -0
  744. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/FluentSystemIcons-Filled.woff2 +0 -0
  745. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/FluentSystemIcons-Regular.woff2 +0 -0
  746. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/FluentSystemIcons-Resizable.woff2 +0 -0
  747. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/controlIcons.woff +0 -0
  748. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/segoeui-bold.woff2 +0 -0
  749. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/segoeui-light.woff2 +0 -0
  750. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/segoeui-regular.woff2 +0 -0
  751. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/segoeui-semibold.woff2 +0 -0
  752. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/fonts/segoeui-semilight.woff2 +0 -0
  753. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/bookings.svg +1 -0
  754. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/calendar.svg +35 -0
  755. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/copilot.png +0 -0
  756. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/excel.svg +1 -0
  757. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/mail.svg +32 -0
  758. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/my-day.svg +1 -0
  759. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/newsletters.svg +37 -0
  760. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/no-mail-selected-dark.svg +1 -0
  761. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/no-mail-selected.svg +1 -0
  762. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/onedrive.svg +1 -0
  763. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/onenote.svg +1 -0
  764. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/org-explorer.png +0 -0
  765. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/outlook.svg +1 -0
  766. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/people.svg +34 -0
  767. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/powerpoint.svg +1 -0
  768. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/ribbon-layout.svg +1 -0
  769. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/sharepoint.svg +1 -0
  770. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/teams-chat.svg +1 -0
  771. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/teams.svg +1 -0
  772. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/to-do.png +0 -0
  773. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/viva.svg +1 -0
  774. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/img/word.svg +1 -0
  775. package/runtime/gatewaysdk/environment/schema/connectors/outlook/ui/static/index.html +34 -0
  776. package/runtime/gatewaysdk/environment/schema/connectors/outlook/world.json +686 -0
  777. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/api/handlers.py +447 -0
  778. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/connector.toml +3478 -0
  779. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/handlers.py +695 -616
  780. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/provenance.json +4254 -111
  781. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/instruction.md +8 -0
  782. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/scenario.toml +2 -0
  783. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_account_contact_relations.json +20 -0
  784. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_account_contact_roles.json +16 -0
  785. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_account_partners.json +18 -0
  786. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_account_team_members.json +16 -0
  787. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_accounts.json +38 -0
  788. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_assets.json +35 -0
  789. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_attachments.json +16 -0
  790. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_business_hours.json +16 -0
  791. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_campaign_member_statuses.json +16 -0
  792. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_campaign_members.json +38 -0
  793. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_campaigns.json +35 -0
  794. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_case_comments.json +14 -0
  795. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_case_histories.json +18 -0
  796. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_case_milestones.json +18 -0
  797. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_case_statuses.json +16 -0
  798. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_case_team_members.json +14 -0
  799. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_case_team_roles.json +12 -0
  800. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_cases.json +42 -0
  801. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_collaboration_group_members.json +16 -0
  802. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_collaboration_groups.json +16 -0
  803. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contact_point_addresses.json +14 -0
  804. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contact_point_emails.json +14 -0
  805. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contact_point_phones.json +14 -0
  806. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contacts.json +34 -0
  807. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_content_document_links.json +14 -0
  808. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_content_documents.json +18 -0
  809. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_content_folders.json +13 -0
  810. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_content_notes.json +12 -0
  811. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_content_versions.json +24 -0
  812. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_content_workspaces.json +16 -0
  813. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contract_contact_roles.json +16 -0
  814. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contract_line_items.json +32 -0
  815. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_contracts.json +40 -0
  816. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_dashboards.json +20 -0
  817. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_documents.json +22 -0
  818. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_email_message_relations.json +14 -0
  819. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_email_messages.json +21 -0
  820. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_email_templates.json +24 -0
  821. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_entitlements.json +32 -0
  822. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_events.json +26 -0
  823. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_feed_comments.json +19 -0
  824. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_feed_items.json +24 -0
  825. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_fiscal_year_settings.json +20 -0
  826. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_folders.json +18 -0
  827. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_group_members.json +12 -0
  828. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_groups.json +20 -0
  829. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_holidays.json +16 -0
  830. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_individuals.json +21 -0
  831. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_lead_statuses.json +14 -0
  832. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_leads.json +45 -0
  833. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_list_views.json +16 -0
  834. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_login_histories.json +18 -0
  835. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_milestone_types.json +14 -0
  836. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_notes.json +16 -0
  837. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_object_territory_associations.json +14 -0
  838. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunities.json +48 -0
  839. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_competitors.json +12 -0
  840. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_contact_roles.json +16 -0
  841. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_field_histories.json +18 -0
  842. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_histories.json +20 -0
  843. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_line_items.json +32 -0
  844. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_partners.json +16 -0
  845. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_stages.json +22 -0
  846. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_opportunity_team_members.json +18 -0
  847. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_order_items.json +33 -0
  848. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_orders.json +44 -0
  849. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_organizations.json +18 -0
  850. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_partners.json +18 -0
  851. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_periods.json +18 -0
  852. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_permission_set_assignments.json +16 -0
  853. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_permission_sets.json +18 -0
  854. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_pricebook_entries.json +22 -0
  855. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_pricebooks.json +16 -0
  856. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_products.json +20 -0
  857. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_profiles.json +14 -0
  858. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_queue_sobjects.json +12 -0
  859. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_quote_line_items.json +43 -0
  860. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_quotes.json +40 -0
  861. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_record_actions.json +16 -0
  862. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_record_types.json +18 -0
  863. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_reports.json +18 -0
  864. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_service_contracts.json +32 -0
  865. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_sla_processes.json +18 -0
  866. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_solutions.json +18 -0
  867. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_task_priorities.json +14 -0
  868. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_task_relations.json +14 -0
  869. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_task_statuses.json +16 -0
  870. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_tasks.json +26 -0
  871. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_territories.json +20 -0
  872. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_territory_models.json +16 -0
  873. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_territory_types.json +18 -0
  874. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_topic_assignments.json +12 -0
  875. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_topics.json +14 -0
  876. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_user_roles.json +16 -0
  877. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_user_territory_associations.json +16 -0
  878. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_users.json +57 -0
  879. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_web_links.json +26 -0
  880. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_work_order_line_items.json +42 -0
  881. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scenarios/default/seed/sf_work_orders.json +46 -0
  882. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scope.toml +624 -104
  883. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/tests/tools.json +69 -0
  884. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/world.json +19222 -2654
  885. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/api/handlers.py +630 -0
  886. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/connector.toml +266 -0
  887. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/handlers.py +3 -0
  888. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/provenance.json +245 -0
  889. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/instruction.md +15 -0
  890. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/scenario.toml +1 -0
  891. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/10-snow_users.json +268 -0
  892. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/11-snow_user_groups.json +40 -0
  893. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/20-snow_configuration_items.json +684 -0
  894. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/30-snow_catalog_categories.json +52 -0
  895. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/31-snow_catalog_items.json +334 -0
  896. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/40-snow_incidents.json +3086 -0
  897. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/41-snow_incident_tasks.json +54 -0
  898. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/42-snow_task_slas.json +64 -0
  899. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/43-snow_problems.json +148 -0
  900. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/44-snow_change_requests.json +364 -0
  901. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/45-snow_knowledge_articles.json +214 -0
  902. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/46-snow_journal_entries.json +1612 -0
  903. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/60-snow_ui_current_users.json +19 -0
  904. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/61-snow_ui_navigation_applications.json +187 -0
  905. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/62-snow_ui_home_widgets.json +91 -0
  906. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/63-snow_ui_notifications.json +3 -0
  907. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/64-snow_ui_employee_center_pages.json +74 -0
  908. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/65-snow_ui_list_layouts.json +54 -0
  909. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/66-snow_ui_search_facets.json +29 -0
  910. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/67-snow_ui_activity_entries.json +1076 -0
  911. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scenarios/default/seed/68-snow_ui_instances.json +9 -0
  912. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/scope.toml +166 -0
  913. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/tests/routes.json +272 -0
  914. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/assets/index-5QHcQLCI.css +1 -0
  915. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/assets/index-BzeVnzFt.js +67 -0
  916. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/cabin-400-700-italic.woff2 +0 -0
  917. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/cabin-400-700.woff2 +0 -0
  918. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-0-lato-v17-latin-ext_latin-100.woff2 +0 -0
  919. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-1-lato-v17-latin-ext_latin-100.woff +0 -0
  920. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-10-lato-v17-latin-ext_latin-italic.woff2 +0 -0
  921. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-11-lato-v17-latin-ext_latin-italic.woff +0 -0
  922. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-12-lato-v17-latin-ext_latin-700.woff2 +0 -0
  923. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-13-lato-v17-latin-ext_latin-700.woff +0 -0
  924. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-14-lato-v17-latin-ext_latin-700italic.woff2 +0 -0
  925. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-15-lato-v17-latin-ext_latin-700italic.woff +0 -0
  926. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-16-source-sans-pro-v11-latin-300.woff2 +0 -0
  927. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-17-source-sans-pro-v11-latin-300.woff +0 -0
  928. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-18-source-sans-pro-v11-latin-regular.woff2 +0 -0
  929. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-19-source-sans-pro-v11-latin-regular.woff +0 -0
  930. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-2-lato-v17-latin-ext_latin-100italic.woff2 +0 -0
  931. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-20-source-sans-pro-v11-latin-600.woff2 +0 -0
  932. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-21-source-sans-pro-v11-latin-600.woff +0 -0
  933. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-22-source-sans-pro-v11-latin-700.woff2 +0 -0
  934. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-23-source-sans-pro-v11-latin-700.woff +0 -0
  935. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-3-lato-v17-latin-ext_latin-100italic.woff +0 -0
  936. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-4-lato-v17-latin-ext_latin-300.woff2 +0 -0
  937. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-5-lato-v17-latin-ext_latin-300.woff +0 -0
  938. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-6-lato-v17-latin-ext_latin-300italic.woff2 +0 -0
  939. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-7-lato-v17-latin-ext_latin-300italic.woff +0 -0
  940. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-8-lato-v17-latin-ext_latin-regular.woff2 +0 -0
  941. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/font-9-lato-v17-latin-ext_latin-regular.woff +0 -0
  942. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/index.json +122 -0
  943. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-300.woff2 +0 -0
  944. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-600-italic.woff2 +0 -0
  945. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-600.woff2 +0 -0
  946. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-bold-italic.woff2 +0 -0
  947. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-bold.woff2 +0 -0
  948. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-normal-italic.woff2 +0 -0
  949. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/fonts/lato-normal.woff2 +0 -0
  950. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/appsee-outline.svg +1 -0
  951. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/arrow-up-outline.svg +1 -0
  952. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/available.svg +1 -0
  953. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/bell-outline.svg +1 -0
  954. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/caret-down-fill.svg +1 -0
  955. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/check-fill.svg +1 -0
  956. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/chevron-right-outline.svg +1 -0
  957. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/circle-close-outline.svg +1 -0
  958. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/circle-info-outline.svg +1 -0
  959. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/circle-question-outline.svg +1 -0
  960. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/circleinfooutline.svg +1 -0
  961. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/ellipsis-v-outline.svg +1 -0
  962. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/eye-outline.svg +1 -0
  963. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-bell-fill.svg +1 -0
  964. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-caret-down-fill.svg +1 -0
  965. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-check-square.svg +1 -0
  966. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-chevron-right.svg +1 -0
  967. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-clock-outline.svg +1 -0
  968. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-comment-chat.svg +1 -0
  969. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-external-link.svg +1 -0
  970. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-facebook.svg +1 -0
  971. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-heart-fill.svg +1 -0
  972. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-heart-outline.svg +1 -0
  973. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-home-fill-teal.svg +1 -0
  974. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-home-fill.svg +1 -0
  975. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-linkedin.svg +1 -0
  976. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-list-alt-fill.svg +1 -0
  977. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-pencil-square.svg +1 -0
  978. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-question-circle-fill.svg +1 -0
  979. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-times.svg +1 -0
  980. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/fa-twitter.svg +1 -0
  981. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/filter-outline.svg +1 -0
  982. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/gear-outline.svg +1 -0
  983. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/globe-outline.svg +1 -0
  984. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/home-outline.svg +1 -0
  985. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/icon-2.svg +17 -0
  986. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/icon-3.svg +1 -0
  987. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/icon-4.svg +1 -0
  988. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/icon.svg +45 -0
  989. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/keyboard-outline.svg +1 -0
  990. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/link-icon-associated-to-view-all-adoption-blueprints.svg +1 -0
  991. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/link-icon-associated-to-view-all-applications.svg +1 -0
  992. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/list-fill.svg +1 -0
  993. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/loading-2.svg +1 -0
  994. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/loading.svg +1 -0
  995. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/magnifying-glass-outline.svg +1 -0
  996. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/ongoing-outline.svg +1 -0
  997. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/open-link-right-fill.svg +1 -0
  998. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/open-link-right-outline.svg +1 -0
  999. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/pencil-page-outline.svg +1 -0
  1000. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/plus-fill.svg +1 -0
  1001. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/serverbox-outline.svg +1 -0
  1002. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/servicenow-wordmark.svg +20 -0
  1003. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/signal-live-outline.svg +1 -0
  1004. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/square-arrow-left-outline.svg +1 -0
  1005. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/star-outline.svg +1 -0
  1006. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/sync-outline.svg +1 -0
  1007. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/task-slas-related-list.svg +24 -0
  1008. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/thumbtack-outline.svg +1 -0
  1009. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/trending-downward.svg +1 -0
  1010. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/trending-neutral.svg +1 -0
  1011. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/unpinned-all-menu.svg +1 -0
  1012. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/unpinned-favorites-menu.svg +1 -0
  1013. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/unpinned-history-menu.svg +1 -0
  1014. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/icons/user-outline.svg +1 -0
  1015. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/adoption-blueprints.svg +40 -0
  1016. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/avatar-admin.jpg +0 -0
  1017. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/now-assist-admin.svg +17 -0
  1018. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/quick-link-desk.jpg +0 -0
  1019. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/quick-link-password.jpg +0 -0
  1020. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/quick-link-status.jpg +0 -0
  1021. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-accessories.svg +1 -0
  1022. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-computers.svg +1 -0
  1023. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-developer.svg +1 -0
  1024. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-email.svg +1 -0
  1025. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-phone.svg +1 -0
  1026. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-software-catalog.svg +1 -0
  1027. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-software.svg +1 -0
  1028. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/img/topic-technology.svg +1 -0
  1029. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/ui/static/index.html +36 -0
  1030. package/runtime/gatewaysdk/environment/schema/connectors/servicenow/world.json +2004 -0
  1031. package/runtime/gatewaysdk/environment/schema/connectors/slack/MODEL.md +28 -0
  1032. package/runtime/gatewaysdk/environment/schema/connectors/slack/api/handlers.py +1880 -0
  1033. package/runtime/gatewaysdk/environment/schema/connectors/slack/capabilities.json +19 -2
  1034. package/runtime/gatewaysdk/environment/schema/connectors/slack/connector.toml +892 -0
  1035. package/runtime/gatewaysdk/environment/schema/connectors/slack/provenance.json +65 -10
  1036. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/scenario.toml +1 -0
  1037. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_apps.json +22 -0
  1038. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_bookmarks.json +22 -0
  1039. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_bots.json +19 -0
  1040. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_channels.json +206 -0
  1041. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_conversation_states.json +50 -0
  1042. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_emojis.json +19 -0
  1043. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_ephemeral_message_files.json +12 -0
  1044. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_ephemeral_message_threads.json +11 -0
  1045. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_ephemeral_messages.json +16 -0
  1046. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_file_channel_observations.json +16 -0
  1047. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_file_reaction_summaries.json +10 -0
  1048. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_file_reaction_users.json +10 -0
  1049. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_file_shares.json +29 -0
  1050. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_file_user_states.json +10 -0
  1051. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_files.json +64 -0
  1052. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_memberships.json +79 -0
  1053. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_message_files.json +18 -0
  1054. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_message_threads.json +10 -0
  1055. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_message_user_states.json +14 -0
  1056. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_messages.json +127 -0
  1057. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_pins.json +11 -0
  1058. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_presence.json +35 -0
  1059. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_reaction_summaries.json +25 -0
  1060. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_reaction_users.json +32 -0
  1061. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_scheduled_message_threads.json +10 -0
  1062. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_scheduled_messages.json +15 -0
  1063. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_unavailable_message_files.json +14 -0
  1064. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_user_profile_fields.json +28 -0
  1065. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_usergroup_channels.json +10 -0
  1066. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_usergroup_memberships.json +14 -0
  1067. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_usergroups.json +33 -0
  1068. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_users.json +228 -0
  1069. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_view_state_entries.json +22 -0
  1070. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_views.json +53 -0
  1071. package/runtime/gatewaysdk/environment/schema/connectors/slack/scenarios/default/seed/slack_workspaces.json +37 -0
  1072. package/runtime/gatewaysdk/environment/schema/connectors/slack/scope.toml +6 -2
  1073. package/runtime/gatewaysdk/environment/schema/connectors/slack/tests/api.json +177 -0
  1074. package/runtime/gatewaysdk/environment/schema/connectors/slack/tests/test_threads.py +49 -0
  1075. package/runtime/gatewaysdk/environment/schema/connectors/slack/tests/tools.json +92 -0
  1076. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/assets/index-BSqGskph.css +1 -0
  1077. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/assets/index-CKQh1igo.js +81 -0
  1078. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/README.md +15 -0
  1079. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-black.woff2 +0 -0
  1080. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-bold.woff2 +0 -0
  1081. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-italic-black.woff2 +0 -0
  1082. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-italic-bold.woff2 +0 -0
  1083. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-italic-light.woff2 +0 -0
  1084. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-italic.woff2 +0 -0
  1085. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-light.woff2 +0 -0
  1086. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/lato-regular.woff2 +0 -0
  1087. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/fonts/slack-icons-v2.woff2 +0 -0
  1088. package/runtime/gatewaysdk/environment/schema/connectors/slack/ui/static/index.html +35 -0
  1089. package/runtime/gatewaysdk/environment/schema/connectors/slack/vendor-openapi.json +12515 -0
  1090. package/runtime/gatewaysdk/environment/schema/connectors/slack/world.json +396 -8
  1091. package/runtime/gatewaysdk/environment/schema/connectors/workday/api/handlers.py +175 -0
  1092. package/runtime/gatewaysdk/environment/schema/connectors/workday/connector.toml +610 -0
  1093. package/runtime/gatewaysdk/environment/schema/connectors/workday/parity.json +39 -6
  1094. package/runtime/gatewaysdk/environment/schema/connectors/workday/provenance.json +253 -25
  1095. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/instruction.md +10 -0
  1096. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/scenario.toml +2 -0
  1097. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_compensations.json +219 -0
  1098. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_job_profiles.json +76 -0
  1099. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_locations.json +142 -0
  1100. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_organizations.json +124 -0
  1101. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_positions.json +280 -0
  1102. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_absence_leaves.json +66 -0
  1103. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_business_title_changes.json +44 -0
  1104. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_check_in_topics.json +48 -0
  1105. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_check_ins.json +46 -0
  1106. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_countries.json +28 -0
  1107. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_currencies.json +25 -0
  1108. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_job_change_reasons.json +28 -0
  1109. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_job_families.json +40 -0
  1110. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_job_profiles.json +202 -0
  1111. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_jobs.json +120 -0
  1112. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_organization_types.json +19 -0
  1113. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_organizations.json +24 -0
  1114. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_persons.json +100 -0
  1115. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_scorecard_results.json +57 -0
  1116. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_scorecards.json +68 -0
  1117. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_supervisory_organizations.json +64 -0
  1118. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_time_off_details.json +112 -0
  1119. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_time_off_entries.json +91 -0
  1120. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_worker_history_events.json +58 -0
  1121. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_rest_workers.json +90 -0
  1122. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_time_off_requests.json +181 -0
  1123. package/runtime/gatewaysdk/environment/schema/connectors/workday/scenarios/default/seed/workday_workers.json +492 -0
  1124. package/runtime/gatewaysdk/environment/schema/connectors/workday/scope.toml +178 -14
  1125. package/runtime/gatewaysdk/environment/schema/connectors/workday/tests/tools.json +81 -0
  1126. package/runtime/gatewaysdk/environment/schema/connectors/workday/vendor-openapi.json +10646 -0
  1127. package/runtime/gatewaysdk/environment/schema/connectors/workday/world.json +3787 -407
  1128. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/api/handlers.py +1183 -0
  1129. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/connector.toml +645 -0
  1130. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/handlers.py +377 -0
  1131. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/instruction.md +22 -0
  1132. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/scenario.toml +3 -0
  1133. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_brands.json +25 -0
  1134. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_group_memberships.json +49 -0
  1135. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_groups.json +37 -0
  1136. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_macros.json +154 -0
  1137. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_organizations.json +65 -0
  1138. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_ticket_audits.json +3328 -0
  1139. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_ticket_comments.json +2642 -0
  1140. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_tickets.json +1439 -0
  1141. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_users.json +624 -0
  1142. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_views.json +510 -0
  1143. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/scenarios/default/seed/zendesk_workspace_tabs.json +10 -0
  1144. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/ui/static/assets/index-JWq7XNO5.css +1 -0
  1145. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/ui/static/assets/index-bn8ezNTi.js +67 -0
  1146. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/ui/static/index.html +22 -0
  1147. package/runtime/gatewaysdk/environment/schema/connectors/zendesk/world.json +1707 -0
  1148. package/runtime/gatewaysdk/environment/schema/data.py +349 -35
  1149. package/runtime/gatewaysdk/environment/schema/dependencies.py +235 -0
  1150. package/runtime/gatewaysdk/environment/schema/extract.py +6 -6
  1151. package/runtime/gatewaysdk/environment/schema/host.py +226 -62
  1152. package/runtime/gatewaysdk/environment/schema/host_surfaces.py +62 -17
  1153. package/runtime/gatewaysdk/environment/schema/ingest.py +528 -0
  1154. package/runtime/gatewaysdk/environment/schema/local.py +536 -0
  1155. package/runtime/gatewaysdk/environment/schema/mapping.py +944 -0
  1156. package/runtime/gatewaysdk/environment/schema/platform.py +678 -202
  1157. package/runtime/gatewaysdk/environment/schema/reconcile.py +202 -0
  1158. package/runtime/gatewaysdk/environment/schema/redaction.py +378 -0
  1159. package/runtime/gatewaysdk/environment/schema/scaffold.py +68 -7
  1160. package/runtime/gatewaysdk/environment/schema/skill.py +1 -0
  1161. package/runtime/gatewaysdk/environment/schema/skills/benchmarks-getting-started/SKILL.md +391 -0
  1162. package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/CONNECTORS.md +64 -31
  1163. package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/SKILL.md +86 -36
  1164. package/runtime/gatewaysdk/environment/schema/skills/world-data-ingestion/ROWS.md +20 -0
  1165. package/runtime/gatewaysdk/environment/schema/skills/world-data-ingestion/SKILL.md +178 -11
  1166. package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/SKILL.md +184 -74
  1167. package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/references/cli-mcp-map.md +49 -0
  1168. package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/references/ui-map.md +18 -0
  1169. package/runtime/gatewaysdk/environment/schema/store.py +103 -3
  1170. package/runtime/gatewaysdk/environment/schema/tasks.py +8 -3
  1171. package/runtime/gatewaysdk/environment/schema/tools_world.py +424 -57
  1172. package/runtime/gatewaysdk/environment/schema/transform.py +200 -0
  1173. package/runtime/gatewaysdk/environment/schema/transforms.py +103 -0
  1174. package/runtime/gatewaysdk/environment/schema/ui.py +455 -0
  1175. package/runtime/gatewaysdk/environment/schema/ui_static/app.js +581 -0
  1176. package/runtime/gatewaysdk/environment/schema/ui_static/index.html +72 -0
  1177. package/runtime/gatewaysdk/environment/schema/validation.py +59 -12
  1178. package/runtime/gatewaysdk/environment/schema/world_tests.py +245 -51
  1179. package/skills/benchmarks-getting-started/SKILL.md +391 -0
  1180. package/skills/connector-schema-authoring/CONNECTORS.md +64 -31
  1181. package/skills/connector-schema-authoring/SKILL.md +86 -36
  1182. package/skills/connector-schema-authoring/connector-worlds.md +355 -0
  1183. package/skills/connector-schema-authoring/world-schema.md +620 -0
  1184. package/skills/world-data-ingestion/ROWS.md +20 -0
  1185. package/skills/world-data-ingestion/SKILL.md +178 -11
  1186. package/skills/worlds-getting-started/SKILL.md +184 -74
  1187. package/skills/worlds-getting-started/references/cli-mcp-map.md +49 -0
  1188. package/skills/worlds-getting-started/references/ui-map.md +18 -0
@@ -0,0 +1 @@
1
+ {"openapi":"3.0.1","info":{"title":"Jamf Pro API + Classic API (trimmed to the routes the Gateway jamf world serves)","version":"11.32.0","description":"Union of the OpenAPI fragments embedded in developer.jamf.com's Jamf Pro API and Classic API reference pages (Jamf Pro 11.32.0), trimmed to the path/method pairs connector.toml serves and the components they reference. Pro paths live under the /api server, Classic paths under /JSSResource. See provenance.json for source URLs, hashes and the trimming method."},"servers":[{"url":"https://yourserver.jamfcloud.com/api","description":"Jamf Pro API"},{"url":"https://yourserver.jamfcloud.com/JSSResource","description":"Jamf Classic API"}],"paths":{"/v1/account-groups":{"get":{"tags":["account-groups"],"summary":"Get account groups","description":"Get all account groups with pagination, sorting, and filtering support.\n\n> 📋 **Required privilege:** Read Account Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is\nname:asc. Multiple sort criteria are supported and must be separated with a comma.\nAccepts fields: id, name, siteId, ldapServerId.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["name:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format to filter account groups collection. An empty query returns all results for the requested page.\nSupported fields: id, name, siteId, ldapServerId.\nMultiple conditions can be combined using logical operators.\nThis parameter can be used with paging and sorting parameters.\nExample: name==\"Admins\" and siteId==-1\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Account groups retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountGroupSearchResultsV1"}}}}},"x-required-privileges":["Read Account Groups"],"x-authentication-required":true}},"/v1/account-groups/{id}":{"get":{"tags":["account-groups"],"summary":"Gets the account group.\n","description":"Gets the account group for the given id.\n\n\n> 📋 **Required privilege:** Read Account Groups","parameters":[{"name":"id","in":"path","description":"id of target account group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response - account group retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountGroupV1"}}}},"404":{"description":"Not Found - account group does not exist"}},"x-required-privileges":["Read Account Groups"],"x-authentication-required":true}},"/v1/accounts":{"get":{"tags":["accounts"],"summary":"Get user accounts","description":"Get all user accounts with pagination, sorting, and filtering support.\n\n> 📋 **Required privilege:** Read Accounts","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is\nusername:desc. Multiple sort criteria are supported and must be separated with a comma.\nAccepts fields: id, lastPasswordChange, failedLoginAttempts, username, realname, email, phone, ldapServerId, distinguishedName, siteId, privilegeLevel, changePasswordOnNextLogin, accountStatus. \nIf any other field is passed it will be ignored in sorting operation and/or create unpredictable results.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["username:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format to filter user accounts collection. An empty query returns all results for the requested page.\nSupported fields: id, lastPasswordChange, failedLoginAttempts, username, realname, email, phone, ldapServerId, distinguishedName, siteId, privilegeLevel, changePasswordOnNextLogin, accountStatus.\nMultiple conditions can be combined using logical operators.\nThis parameter can be used with paging and sorting parameters.\nExample: username==\"admin\" and accountStatus==Enabled and failedLoginAttempts==0\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"User accounts retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccountSearchResults"}}}}},"x-required-privileges":["Read Accounts"],"x-authentication-required":true},"post":{"tags":["accounts"],"summary":"Adds new account.\n","description":"Adds the user account provided.\n\n\n> 📋 **Required privilege:** Create Accounts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccount"}}},"required":true},"responses":{"201":{"description":"Successful response - Jamf Pro user account added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccount"}}}}},"x-required-privileges":["Create Accounts"],"x-authentication-required":true,"x-action":true,"x-rate-limit":false}},"/v1/accounts/{id}":{"get":{"tags":["accounts"],"summary":"Gets the user account.\n","description":"Gets the user account for the given id.\n\n\n> 📋 **Required privilege:** Read Accounts","parameters":[{"name":"id","in":"path","description":"id of target account","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response - Jamf Pro user account retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccount"}}}}},"x-required-privileges":["Read Accounts"],"x-authentication-required":true},"delete":{"tags":["accounts"],"summary":"Deletes the user account.\n","description":"Deletes the user account for the given id.\n\n\n> 📋 **Required privilege:** Delete Accounts","parameters":[{"name":"id","in":"path","description":"id of target account","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response - Jamf Pro user account deleted"}},"x-required-privileges":["Delete Accounts"],"x-authentication-required":true},"put":{"tags":["accounts"],"summary":"Updates the user account.\n","description":"Updates the user account for the given id.\n\n\n> 📋 **Required privilege:** Update Accounts","parameters":[{"name":"id","in":"path","description":"id of target account","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccount"}}},"required":true},"responses":{"200":{"description":"Successful response - Jamf Pro user account updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccount"}}}},"400":{"description":"Bad Request - validation failure"},"404":{"description":"Not Found - user account does not exist"}},"x-required-privileges":["Update Accounts"],"x-authentication-required":true,"x-action":true,"x-rate-limit":false}},"/v1/advanced-mobile-device-searches":{"get":{"tags":["advanced-mobile-device-searches"],"summary":"Get Advanced Search objects\n","description":"Gets Advanced Search Objects\n\n\n> 📋 **Required privilege:** Read Advanced Mobile Device Searches","responses":{"200":{"description":"Successful response - Advanced searches retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedSearchSearchResults"}}}}},"x-required-privileges":["Read Advanced Mobile Device Searches"]},"post":{"tags":["advanced-mobile-device-searches"],"summary":"Create Advanced Search object\n","description":"Creates Advanced Search Object\n\n\n> 📋 **Required privilege:** Create Advanced Mobile Device Searches","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedSearch"}}},"required":true},"responses":{"201":{"description":"Successful response - Advanced search created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Advanced Mobile Device Searches"]}},"/v1/advanced-mobile-device-searches/{id}":{"get":{"tags":["advanced-mobile-device-searches"],"summary":"Get specified Advanced Search object\n","description":"Gets Specified Advanced Search Object\n\n\n> 📋 **Required privilege:** Read Advanced Mobile Device Searches","parameters":[{"name":"id","in":"path","description":"id of target Advanced Search","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response - Advanced Search retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedSearch"}}}},"404":{"description":"Target Advanced Search does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Advanced Mobile Device Searches"]},"delete":{"tags":["advanced-mobile-device-searches"],"summary":"Remove specified Advanced Search object\n","description":"Removes specified Advanced Search Object\n\n\n> 📋 **Required privilege:** Delete Advanced Mobile Device Searches","parameters":[{"name":"id","in":"path","description":"instance id of advanced search record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response - Advanced search deleted"},"404":{"description":"Target Advanced Search does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Advanced Mobile Device Searches"]},"put":{"tags":["advanced-mobile-device-searches"],"summary":"Get specified Advanced Search object\n","description":"Gets Specified Advanced Search Object\n\n\n> 📋 **Required privilege:** Update Advanced Mobile Device Searches","parameters":[{"name":"id","in":"path","description":"id of target Advanced Search","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedSearch"}}},"required":true},"responses":{"200":{"description":"Successful response - Advanced Search updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedSearch"}}}},"404":{"description":"Target Advanced Search does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Advanced Mobile Device Searches"]}},"/v1/advanced-user-content-searches":{"get":{"tags":["advanced-user-content-searches"],"summary":"Get All Advanced User Content Search objects\n","description":"Get All Advanced User Content Search Objects\n\n\n> 📋 **Required privilege:** Read Advanced User Content Searches","responses":{"200":{"description":"Successful response - Advanced User Content Searches retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedUserContentSearchSearchResults"}}}}},"x-required-privileges":["Read Advanced User Content Searches"]},"post":{"tags":["advanced-user-content-searches"],"summary":"Create Advanced User Content Search object\n","description":"Creates Advanced User Content Search Object\n\n\n> 📋 **Required privilege:** Create Advanced User Content Searches","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedUserContentSearch"}}},"required":true},"responses":{"201":{"description":"Successful response - Advanced User Content Search created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Advanced User Content Searches"]}},"/v1/advanced-user-content-searches/{id}":{"get":{"tags":["advanced-user-content-searches"],"summary":"Get Specified Advanced User Content Search object\n","description":"Gets Specified Advanced User Content Search Object\n\n\n> 📋 **Required privilege:** Read Advanced User Content Searches","parameters":[{"name":"id","in":"path","description":"id of target Advanced User Content Search","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response - Advanced User Content Search retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedUserContentSearch"}}}},"404":{"description":"Target Advanced User Content Search does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Advanced User Content Searches"]},"delete":{"tags":["advanced-user-content-searches"],"summary":"Remove specified Advanced User Content Search object\n","description":"Removes specified Advanced User Content Search Object\n\n\n> 📋 **Required privilege:** Delete Advanced User Content Searches","parameters":[{"name":"id","in":"path","description":"instance id of Advanced User Content Search record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response - Advanced User Content Search deleted"},"404":{"description":"Target Advanced User Content Search does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Advanced User Content Searches"]},"put":{"tags":["advanced-user-content-searches"],"summary":"Get Specified Advanced User Content Search object\n","description":"Gets Specified Advanced User Content Search Object\n\n\n> 📋 **Required privilege:** Update Advanced User Content Searches","parameters":[{"name":"id","in":"path","description":"id of target Advanced User Content Search","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedUserContentSearch"}}},"required":true},"responses":{"200":{"description":"Successful response - Advanced User Content Search updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedUserContentSearch"}}}},"404":{"description":"Target Advanced User Content Search does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Advanced User Content Searches"]}},"/v1/api-integrations":{"get":{"tags":["api-integrations"],"summary":"Get the current API Integrations","description":"Get Jamf|Pro API Integrations with Search Criteria\n\n> 📋 **Required privilege:** Read API Integrations","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the query: id, displayName. Example: sort=displayName:desc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter app titles collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, displayName. Example: displayName==\"*IntegrationName*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"A list of the current Jamf API Integrations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIntegrationSearchResult"}}}}},"x-required-privileges":["Read API Integrations"]},"post":{"tags":["api-integrations"],"summary":"Create API integration object","description":"Create API integration object\n\n> 📋 **Required privilege:** Create API Integrations","operationId":"postCreateApiIntegration","requestBody":{"description":"api integration object to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIntegrationRequest"}}},"required":true},"responses":{"201":{"description":"Api Integration object was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIntegrationResponse"}}}}},"x-required-privileges":["Create API Integrations"]}},"/v1/api-integrations/{id}":{"get":{"tags":["api-integrations"],"summary":"Get specified API integration object","description":"Gets specified API integration object\n\n> 📋 **Required privilege:** Read API Integrations","operationId":"getOneApiIntegration","parameters":[{"name":"id","in":"path","description":"instance id of api integration object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of api integration object were found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIntegrationResponse"}}}},"404":{"description":"Specified api integration object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read API Integrations"]},"delete":{"tags":["api-integrations"],"summary":"Remove specified API integration","description":"Removes specified API integration\n\n> 📋 **Required privilege:** Delete API Integrations","operationId":"deleteApiIntegration","parameters":[{"name":"id","in":"path","description":"instance id of api integration object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Api Integration was deleted"},"404":{"description":"Specified api integration object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete API Integrations"]},"put":{"tags":["api-integrations"],"summary":"Update specified API integration object","description":"Update specified API integration object\n\n> 📋 **Required privilege:** Update API Integrations","operationId":"putUpdateApiIntegration","parameters":[{"name":"id","in":"path","description":"instance id of api integration object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"api object to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIntegrationRequest"}}},"required":true},"responses":{"200":{"description":"Api Integration updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIntegrationResponse"}}}},"400":{"description":"Api Integration could not be updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified api integration object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update API Integrations"]}},"/v1/api-roles":{"get":{"tags":["api-roles"],"summary":"Get the current Jamf API Roles","description":"Get roles with Search Criteria\n\n> 📋 **Required privilege:** Read API Roles","operationId":"getAllApiRoles","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the query: id, displayName. Example: sort=displayName:desc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter app titles collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, displayName. Example: displayName==\"*myRole*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"A list of the current Jamf API Roles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRoleResult"}}}}},"x-required-privileges":["Read API Roles"]},"post":{"tags":["api-roles"],"summary":"Create a new API role","description":"Post to create new Role\n\n> 📋 **Required privilege:** Create API Roles","operationId":"postCreateApiRole","requestBody":{"description":"API Integrations Role to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRoleRequest"}}},"required":true},"responses":{"200":{"description":"The created Role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRole"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Create API Roles"]}},"/v1/api-roles/{id}":{"get":{"tags":["api-roles"],"summary":"Get the specific Jamf API Role","description":"Get specific Role\n\n> 📋 **Required privilege:** Read API Roles","operationId":"getOneApiRole","parameters":[{"name":"id","in":"path","description":"instance id of API role","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested Jamf API Role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRole"}}}},"404":{"description":"Role not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read API Roles"]},"delete":{"tags":["api-roles"],"summary":"Delete API Integrations Role","description":"Delete specific Role\n\n> 📋 **Required privilege:** Delete API Roles","operationId":"deleteApiRole","parameters":[{"name":"id","in":"path","description":"instance id of API role","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Jamf API Integrations Role deleted"},"404":{"description":"Role not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Role in use by an Integration/Client","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete API Roles"]},"put":{"tags":["api-roles"],"summary":"Update API Integrations Role","description":"Update specific Role\n\n> 📋 **Required privilege:** Update API Roles","operationId":"putUpdateApiRole","parameters":[{"name":"id","in":"path","description":"instance id of API role","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"API Integrations Role to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRoleRequest"}}},"required":true},"responses":{"200":{"description":"Jamf API Integrations Role updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRole"}}}},"400":{"description":"Bad Request, could not parse input.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Role not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update API Roles"]}},"/v1/app-request/form-input-fields":{"get":{"tags":["app-request-preview"],"summary":"Search for Form Input Fields\n","description":"Search for form input fields\n\n> 📋 **Required privilege:** Read App Request Settings","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestFormInputFieldSearchResults"}}}}},"x-required-privileges":["Read App Request Settings"]},"post":{"tags":["app-request-preview"],"summary":"Create Form Input Field record\n","description":"Create form input field record\n\n\n> 📋 **Required privilege:** Update App Request Settings","requestBody":{"description":"form input field object to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestFormInputField"}}},"required":true},"responses":{"201":{"description":"form input field record was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestFormInputField"}}}},"400":{"description":"Invalid data response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update App Request Settings"]}},"/v1/app-request/form-input-fields/{id}":{"get":{"tags":["app-request-preview"],"summary":"Get specified Form Input Field object\n","description":"Gets specified form input field object\n\n\n> 📋 **Required privilege:** Read App Request Settings","parameters":[{"name":"id","in":"path","description":"Instance id of form input field record","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Details of form input field were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestFormInputField"}}}},"404":{"description":"Specified form input field object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read App Request Settings"]},"delete":{"tags":["app-request-preview"],"summary":"Remove specified Form Input Field record\n","description":"Removes specified form input field record\n\n\n> 📋 **Required privilege:** Update App Request Settings","parameters":[{"name":"id","in":"path","description":"Instance id of form input field record","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"204":{"description":"form input field record was deleted"},"404":{"description":"Specified form input field object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update App Request Settings"]},"put":{"tags":["app-request-preview"],"summary":"Update specified Form Input Field object\n","description":"Update specified form input field object\n\n\n> 📋 **Required privilege:** Update App Request Settings","parameters":[{"name":"id","in":"path","description":"Instance id of form input field record","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"requestBody":{"description":"form input field object to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestFormInputField"}}},"required":true},"responses":{"200":{"description":"form input field update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestFormInputField"}}}},"400":{"description":"Invalid data response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified form input field object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update App Request Settings"]}},"/v1/buildings":{"get":{"tags":["buildings"],"summary":"Search for sorted and paged Buildings\n","description":"Search for sorted and paged buildings\n\n> 📋 **Required privilege:** Read Buildings","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter buildings collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: name, streetAddress1, streetAddress2, city, stateProvince, zipPostalCode, country. This param can be combined with paging and sorting. Example: filter=city==\"Chicago\" and name==\"*build*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingSearchResults"}}}}},"x-required-privileges":["Read Buildings"]},"post":{"tags":["buildings"],"summary":"Create Building record\n","description":"Create building record\n\n\n> 📋 **Required privilege:** Create Buildings","requestBody":{"description":"building object to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Building"}}},"required":true},"responses":{"201":{"description":"Building record was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Buildings"]}},"/v1/buildings/{id}":{"get":{"tags":["buildings"],"summary":"Get specified Building object\n","description":"Gets specified Building object\n\n\n> 📋 **Required privilege:** Read Buildings","parameters":[{"name":"id","in":"path","description":"instance id of building record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of building were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Building"}}}},"404":{"description":"Specified building object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Buildings"]},"delete":{"tags":["buildings"],"summary":"Remove specified Building record\n","description":"Removes specified building record\n\n\n> 📋 **Required privilege:** Delete Buildings","parameters":[{"name":"id","in":"path","description":"instance id of building record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Building record was deleted"}},"x-required-privileges":["Delete Buildings"]},"put":{"tags":["buildings"],"summary":"Update specified Building object\n","description":"Update specified building object\n\n\n> 📋 **Required privilege:** Update Buildings","parameters":[{"name":"id","in":"path","description":"instance id of building record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"building object to update. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Building"}}},"required":true},"responses":{"200":{"description":"Building update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Building"}}}}},"x-required-privileges":["Update Buildings"]}},"/v1/categories":{"get":{"tags":["categories"],"summary":"Get Category objects\n","description":"Gets `Category` objects.\n\n\n> 📋 **Required privileges:**\n> - Read Categories\n> - Read Self Service","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter categories collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: name, priority. This param can be combined with paging and sorting. Example: filter=name==\"Apps*\" and priority>=5","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoriesSearchResults"}}}}},"x-required-privileges":["Read Categories","Read Self Service"]},"post":{"tags":["categories"],"summary":"Create Category record\n","description":"Create category record\n\n\n> 📋 **Required privilege:** Create Categories","requestBody":{"description":"category object to create. IDs defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"required":true},"responses":{"201":{"description":"Category record was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Categories"]}},"/v1/categories/{id}":{"get":{"tags":["categories"],"summary":"Get specified Category object\n","description":"Gets specified Category object\n\n\n> 📋 **Required privilege:** Read Categories","parameters":[{"name":"id","in":"path","description":"instance id of category record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of category were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"404":{"description":"Specified category object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Categories"]},"delete":{"tags":["categories"],"summary":"Remove specified Category record\n","description":"Removes specified category record\n\n\n> 📋 **Required privilege:** Delete Categories","parameters":[{"name":"id","in":"path","description":"instance id of category record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Category record was deleted"}},"x-required-privileges":["Delete Categories"]},"put":{"tags":["categories"],"summary":"Update specified Category object\n","description":"Update specified category object\n\n\n> 📋 **Required privilege:** Update Categories","parameters":[{"name":"id","in":"path","description":"instance id of category record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"category object to create. id defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"required":true},"responses":{"200":{"description":"Category record was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}}},"x-required-privileges":["Update Categories"]}},"/v1/cloud-idp":{"get":{"tags":["cloud-idp"],"summary":"Get information about all Cloud Identity Providers configurations.","description":"Returns basic informations about all configured Cloud Identity Provider.\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:desc"]}}],"responses":{"200":{"description":"Cloud Identity Provider configurations informations returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationSearchResults"}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v1/cloud-idp/{id}":{"get":{"tags":["cloud-idp"],"summary":"Get Cloud Identity Provider configuration with given ID.","description":"Get Cloud Identity Provider configuration with given ID.\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Cloud Identity Provider configuration returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudIdPCommon"}}}},"400":{"description":"ID can only be a number.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified Cloud Identity Provider configuration does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v1/computer-extension-attributes":{"get":{"tags":["computer-extension-attributes"],"summary":"Retrieve Computer Extension Attributes.","description":"Retrieves All Computer Extension Attributes Configuration.\n\n> 📋 **Required privilege:** Read Computer Extension Attributes","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc.<br/> Default sort is name:asc.<br/> If using multiple criteria, separate with commas. Allows sort for id and name.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["name.asc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc.<br/> Can be combined with paging and sorting.<br/> Fields allowed in the query: id, name <br/> Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Computer Extension Attribute objects has been fetched successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerExtensionAttributeSearchResults"}}}},"404":{"description":"Computer Extension Attribute objects could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computer Extension Attributes"]},"post":{"tags":["computer-extension-attributes"],"summary":"Create Computer Extension Attribute.","description":"Create Computer Extension Attribute to collect extra inventory information.\n\n> 📋 **Required privilege:** Create Computer Extension Attributes","requestBody":{"description":"Computer Extension Attribute to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerExtensionAttributes"}}},"required":true},"responses":{"201":{"description":"Computer Extension Attribute was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax. Possible reasons are:</br> 1) Required fields are not provided in request body.</br> 2) Fields which are not associated with provided inputType has some value.</br> 3) Any values outside of the allowed range are included in the request body.</br> 4) LDAP is not configured.</br> 5) Error occured during database create operation.</br> 6) Duplicate_Field","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Computer Extension Attributes"],"x-action":true}},"/v1/computer-extension-attributes/{id}":{"get":{"tags":["computer-extension-attributes"],"summary":"Get specified Computer Extension Attribute object.","description":"Gets specified Computer Extension Attribute object.\n\n> 📋 **Required privilege:** Read Computer Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of Computer Extension Attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Computer Extension Attribute object has been fetched successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerExtensionAttributes"}}}},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax. Possible reason can be 'The specified extension attribute id does not include a valid number.'"},"404":{"description":"Specified Computer Extension Attribute object could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computer Extension Attributes"]},"delete":{"tags":["computer-extension-attributes"],"summary":"Remove specified Computer Extension Attribute.","description":"ID of the Computer Extension Attribute to be deleted.\n\n> 📋 **Required privilege:** Delete Computer Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of Computer Extension Attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Computer Extension Attribute deleted successfully."},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax. Possible reason can be 'The specified extension attribute id does not include a valid number.'"},"404":{"description":"Specified Computer Extension Attribute object could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client."}},"x-required-privileges":["Delete Computer Extension Attributes"]},"put":{"tags":["computer-extension-attributes"],"summary":"Update specified Computer Extension Attribute object.","description":"Update specified Computer Extension Attribute object.\n\n> 📋 **Required privilege:** Update Computer Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of Computer Extension Attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Computer Extension Attribute object to be updated. IDs defined in this body will be ignored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerExtensionAttributes"}}},"required":true},"responses":{"202":{"description":"Computer Extension Attribute updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerExtensionAttributes"}}}},"400":{"description":"Bad Request. Specified Computer Extension Attribute could not be updated due to bad request. Possible reasons are:</br> 1) The specified extension attribute id does not include a valid number.</br> 2) Duplicate_Field.</br> 3) Required fields are not provided in request body.</br> 4) Fields which are not associated with provided inputType has some value.</br> 5) Any values outside of the allowed range are included in the request body.</br> 6) LDAP is not configured.</br> 7) Error occured during database update operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified Computer Extension Attribute object does not exist. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Computer Extension Attributes"]}},"/v1/computer-groups":{"get":{"tags":["computer-groups"],"summary":"Returns the list of all computer groups\n","description":"Use it to get the list of all computer groups.\n\n\n> 📋 **Required privileges:**\n> - Read Smart Computer Groups\n> - Read Static Computer Groups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ComputerGroup"}}}}}},"x-required-privileges":["Read Smart Computer Groups","Read Static Computer Groups"]}},"/v1/computers-inventory":{"get":{"tags":["computer-inventory"],"summary":"Return paginated Computer Inventory records","description":"Return paginated Computer Inventory records\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"section","in":"query","description":"section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&amp;section=HARDWARE","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["GENERAL"],"items":{"$ref":"#/components/schemas/ComputerSection"},"default":["GENERAL"]}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: `property:asc/desc`. Default sort\nis `general.name:asc`. Multiple sort criteria are supported and must be separated with\na comma.\n\nFields allowed in the sort: `general.name`, `udid`, `id`, `general.assetTag`,\n`general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`,\n`general.reportDate`,\n`general.mdmCertificateExpiration`, `general.platform`, `general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`,\n`general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`,\n`general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`\n`hardware.make`, `hardware.model`,\n`operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`,\n`userAndLocation.realname`,\n`purchasing.lifeExpectancy`, `purchasing.warrantyDate`\n\nExample: `sort=udid:desc,general.name:asc`.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["general.name:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter computer inventory collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `general.name`, `udid`, `id`, `general.assetTag`, `general.barcode1`, `general.barcode2`,\n`general.enrolledViaAutomatedDeviceEnrollment`, `general.lastIpAddress`, `general.itunesStoreAccountActive`,\n`general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`,\n`general.reportDate`, `general.lastReportedIp`, `general.lastReportedIpV4`, `general.lastReportedIpV6`, `general.managementId`, `general.remoteManagement.managed`,\n`general.mdmCapable.capable`, `general.mdmCertificateExpiration`, `general.platform`, `general.supervised`, `general.userApprovedMdm`, `general.declarativeDeviceManagementEnabled`, \n`general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`,\n`general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`,\n`general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`,\n`hardware.bleCapable`, `hardware.macAddress`, `hardware.make`, `hardware.model`, `hardware.modelIdentifier`, `hardware.serialNumber`,\n`hardware.supportsIosAppInstalls`,`hardware.appleSilicon`, `operatingSystem.activeDirectoryStatus`, `operatingSystem.fileVault2Status`,\n`operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`, `security.activationLockEnabled`,\n`security.recoveryLockEnabled`,`security.firewallEnabled`,`userAndLocation.buildingId`, `userAndLocation.departmentId`, `userAndLocation.email`, `userAndLocation.realname`,\n`userAndLocation.phone`, `userAndLocation.position`,`userAndLocation.room`, `userAndLocation.username`, `diskEncryption.fileVault2Enabled`,\n`purchasing.appleCareId`, `purchasing.lifeExpectancy`, `purchasing.purchased`, `purchasing.leased`, `purchasing.vendor`, `purchasing.warrantyDate`,\n\nThis param can be combined with paging and sorting.\nExample: `filter=general.name==\"Orchard\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventorySearchResults"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Read Computers"]},"post":{"tags":["computer-inventory"],"summary":"Create Computer Inventory record","description":"Creates Computer Inventory record\n\n> 📋 **Required privilege:** Create Computers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryCreateRequest"}}},"required":true},"responses":{"201":{"description":"Successful response - Computer Inventory record created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Create Computers"]}},"/v1/computers-inventory-detail/{id}":{"get":{"tags":["computer-inventory"],"summary":"Return all sections of a computer","description":"Return all sections of a computer\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of computer were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventory"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Read Computers"]},"patch":{"tags":["computer-inventory"],"summary":"Update specific fields on a computer","description":"Update specific fields on a computer, then return the updated computer object.\n\n> 📋 **Required privilege:** Update Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Details of computer were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventory"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Update Computers"]}},"/v1/computers-inventory/{id}":{"get":{"tags":["computer-inventory"],"summary":"Return General section of a Computer","description":"Return General section of a Computer\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"section","in":"query","description":"section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=general&amp;section=hardware","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["GENERAL"],"items":{"$ref":"#/components/schemas/ComputerSection"},"default":["GENERAL"]}}],"responses":{"200":{"description":"Details of computer were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventory"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Read Computers"]},"delete":{"tags":["computer-inventory"],"summary":"Remove specified Computer record","description":"Remove specified Computer record\n\n> 📋 **Required privilege:** Delete Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Computer record successfully removed"},"404":{"description":"Specified computer object id does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Delete Computers"]}},"/v1/departments":{"get":{"tags":["departments"],"summary":"Search for Departments\n","description":"Search for Departments\n\n\n> 📋 **Required privilege:** Read Departments","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter department collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. Example: name==\"*department*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentsSearchResults"}}}}},"x-required-privileges":["Read Departments"]},"post":{"tags":["departments"],"summary":"Create department record\n","description":"Create department record\n\n\n> 📋 **Required privilege:** Create Departments","requestBody":{"description":"department object to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Department"}}},"required":true},"responses":{"201":{"description":"Department record was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Departments"]}},"/v1/departments/{id}":{"get":{"tags":["departments"],"summary":"Get specified Department object\n","description":"Gets specified Department object\n\n\n> 📋 **Required privilege:** Read Departments","parameters":[{"name":"id","in":"path","description":"instance id of department record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of department were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Department"}}}},"404":{"description":"Specified department object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Departments"]},"delete":{"tags":["departments"],"summary":"Remove specified department record\n","description":"Removes specified department record\n\n\n> 📋 **Required privilege:** Delete Departments","parameters":[{"name":"id","in":"path","description":"instance id of department record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Department record was deleted"}},"x-required-privileges":["Delete Departments"]},"put":{"tags":["departments"],"summary":"Update specified department object\n","description":"Update specified department object\n\n\n> 📋 **Required privilege:** Update Departments","parameters":[{"name":"id","in":"path","description":"instance id of department record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"department object to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Department"}}},"required":true},"responses":{"200":{"description":"Department update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Department"}}}}},"x-required-privileges":["Update Departments"]}},"/v1/device-enrollments":{"get":{"tags":["device-enrollments"],"summary":"Read all sorted and paged Device Enrollment instances\n","description":"Search for sorted and paged device enrollment instances\n\n> 📋 **Required privilege:** Read Device Enrollment Program Instances","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentInstanceSearchResults"}}}}},"x-required-privileges":["Read Device Enrollment Program Instances"]}},"/v1/device-enrollments/{id}":{"get":{"tags":["device-enrollments"],"summary":"Retrieve a Device Enrollment Instance with the supplied id\n","description":"Retrieves a Device Enrollment Instance with the supplied id\n\n> 📋 **Required privilege:** Read Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentInstance"}}}},"404":{"description":"Device Enrollment Instance with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Device Enrollment Program Instances"]},"delete":{"tags":["device-enrollments"],"summary":"Delete a Device Enrollment Instance with the supplied id\n","description":"Deletes a Device Enrollment Instance with the supplied id\n\n> 📋 **Required privilege:** Delete Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Device Enrollment Instance with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Device Enrollment Program Instances"]},"put":{"tags":["device-enrollments"],"summary":"Update a Device Enrollment Instance with the supplied id\n","description":"Updates a Device Enrollment Instance with the supplied id\n\n> 📋 **Required privilege:** Update Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentInstance"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentInstance"}}}},"404":{"description":"Device Enrollment Instance with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Device Enrollment Program Instances"]}},"/v1/device-enrollments/{id}/devices":{"get":{"tags":["device-enrollments-devices"],"summary":"Retrieve a list of Devices assigned to the supplied id\n","description":"Retrieves a list of devices assigned to the supplied id\n\n> 📋 **Required privilege:** Read Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentDeviceSearchResults"}}}}},"x-required-privileges":["Read Device Enrollment Program Instances"]}},"/v1/dock-items":{"post":{"tags":["dock-items"],"summary":"Create a DockItem\n","description":"Creates a DockItem\n\n> 📋 **Required privilege:** Create Dock Items","requestBody":{"description":"new DockItem to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DockItem"}}},"required":true},"responses":{"201":{"description":"DockItem created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"409":{"description":"Duplicate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Dock Items"]}},"/v1/dock-items/{id}":{"get":{"tags":["dock-items"],"summary":"Retrieve a full dockItem object\n","description":"Retrieves a full dockItem object\n\n> 📋 **Required privilege:** Read Dock Items","parameters":[{"name":"id","in":"path","description":"DockItem object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DockItem"}}}},"404":{"description":"Dockitem with that ID does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Dock Items"]},"delete":{"tags":["dock-items"],"summary":"Delete a DockItem at the specified id\n","description":"Deletes a dockItem at the specified id\n\n> 📋 **Required privilege:** Delete Dock Items","parameters":[{"name":"id","in":"path","description":"DockItem object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response"},"404":{"description":"DockItem with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Dock Items"]}},"/v1/ebooks":{"get":{"tags":["ebooks"],"summary":"Get Ebook object\n","description":"Gets ebook object\n\n> 📋 **Required privilege:** Read eBooks","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["name:asc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EbookSearchResults"}}}}},"x-required-privileges":["Read eBooks"]}},"/v1/ebooks/{id}":{"get":{"tags":["ebooks"],"summary":"Get specified Ebook object\n","description":"Gets specified Ebook object\n\n\n> 📋 **Required privilege:** Read eBooks","parameters":[{"name":"id","in":"path","description":"instance id of ebook record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details about ebook were found for given id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ebook"}}}},"404":{"description":"Specified ebook object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read eBooks"]}},"/v1/ldap/servers":{"get":{"tags":["ldap"],"summary":"Retrieve all Servers including LDAP and Cloud Identity Providers.\n","description":"Retrieve all active Servers including LDAP and Cloud Identity Providers.\n\n> 📋 **Required privilege:** Read LDAP Servers","responses":{"200":{"description":"Successfully completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LdapServer"}}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v1/managed-software-updates/plans":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve Managed Software Update Plans","description":"Retrieve Managed Software Update Plans\n\n\n> 📋 **Required privileges:**\n> - Read Managed Software Updates\n> - Read Computers\n> - Read Mobile Devices","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is planUuid:asc. Multiple sort criteria are supported and must be separated with a comma.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["planUuid:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Managed Software Updates collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: planUuid, device.deviceId, device.objectType, updateAction, versionType, specificVersion, maxDeferrals, recipeId, forceInstallLocalDateTime, state.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlans"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Managed Software Updates","Read Computers","Read Mobile Devices"]}},"/v1/managed-software-updates/plans/{id}":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve a Managed Software Update Plan","description":"Retrieves a Managed Software Update Plan\n\n\n> 📋 **Required privileges:**\n> - Read Managed Software Updates\n> - Read Computers\n> - Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"Managed Software Update Plan Uuid","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlan"}}}},"404":{"description":"Managed Software Update Plan with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Managed Software Updates","Read Computers","Read Mobile Devices"]}},"/v1/mdm/commands":{"get":{"tags":["mdm"],"summary":"Get information about mdm commands made by Jamf Pro.","description":"Get information about mdm commands made by Jamf Pro.\n\n> 📋 **Required privilege:** View MDM command information in Jamf Pro API","parameters":[{"name":"uuids","in":"query","description":"A list of the UUIDs of the commands being searched for. Limited to 40 UUIDs in length. Choose one of two parameters, but not both.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"client-management-id","in":"query","description":"The client management id used to search for a list of commands. Choose one of two parameters, but not both.","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"fd68c371-5921-436e-b16b-8a3c1bf90ee5"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MdmCommand"}}}}},"414":{"description":"Too many UUIDs were provided in the path. The limit is set at a strict 40 UUIDs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-required-privileges":["View MDM command information in Jamf Pro API"],"x-deprecation-date":"2023-10-16"}},"/v1/mobile-device-extension-attributes":{"get":{"tags":["mobile-device-extension-attributes"],"summary":"Retrieve Mobile Device Extension Attributes.","description":"Retrieves all mobile device extension attributes configuration.\n\n> 📋 **Required privilege:** Read Mobile Device Extension Attributes","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc.<br/> Default sort is name:asc.<br/> If using multiple criteria, separate with commas. Allows sort for id and name.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["name.asc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc.<br/> Can be combined with paging and sorting.<br/> Fields allowed in the query: id, name <br/> Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Mobile Device Extension Attribute objects has been fetched successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceExtensionAttributeSearchResults"}}}},"404":{"description":"Mobile Device Extension Attribute objects could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Device Extension Attributes"]},"post":{"tags":["mobile-device-extension-attributes"],"summary":"Create Mobile Device Extension Attribute.","description":"Create Mobile Device Extension Attribute to collect extra inventory information.\n\n> 📋 **Required privilege:** Create Mobile Device Extension Attributes","requestBody":{"description":"Mobile Device Extension Attribute to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceExtensionAttributes"}}},"required":true},"responses":{"201":{"description":"Mobile Device Extension Attribute was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax. Possible reasons are:</br> 1) Required fields are not provided in request body.</br> 2) Fields which are not associated with provided inputType has some value.</br> 3) Any values outside of the allowed range are included in the request body.</br> 4) LDAP is not configured.</br> 5) Error occurred during database create operation.</br> 6) Duplicate name is provided.</br>","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Mobile Device Extension Attributes"],"x-action":true}},"/v1/mobile-device-extension-attributes/{id}":{"get":{"tags":["mobile-device-extension-attributes"],"summary":"Get specified Mobile Device Extension Attribute object.","description":"Gets specified Mobile Device Extension Attribute object.\n\n> 📋 **Required privilege:** Read Mobile Device Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of Mobile Device Extension Attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Mobile Device Extension Attribute object has been fetched successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceExtensionAttributes"}}}},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax. Possible reason can be 'The specified extension attribute id does not include a valid number.'"},"404":{"description":"Specified Mobile Device Extension Attribute object could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Device Extension Attributes"]},"delete":{"tags":["mobile-device-extension-attributes"],"summary":"Delete a Mobile Device Extension Attribute by ID.","description":"Deletes the Mobile Device Extension Attribute identified by the provided ID.<\\br>\nIn addition to removing the attribute itself, this operation will also delete any related dependent data, including:<\\br>\n - Associated popup menu choices.<\\br>\n - Fields used in saved search displays.<\\br>\n - User preferences that reference the attribute.\n\n\n> 📋 **Required privilege:** Delete Mobile Device Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of Mobile Device Extension Attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"The Mobile Device Extension was successfully deleted."},"400":{"description":"Bad Request. The server could not process the request due to invalid input. Possible reasons are:</br> - The specified extension attribute ID is not a valid number. - The ID is missing or improperly formatted."},"404":{"description":"Not Found. The specified Mobile Device Extension Attribute does not exist. This may indicate that the resource is missing, or the client is not authorized to access it."}},"x-required-privileges":["Delete Mobile Device Extension Attributes"]},"put":{"tags":["mobile-device-extension-attributes"],"summary":"Update specified Mobile Device Extension Attribute object.","description":"Update specified Mobile Device Extension Attribute object.\n\n> 📋 **Required privilege:** Update Mobile Device Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of Mobile Device Extension Attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Mobile Device Extension Attribute object to be updated. IDs defined in this body will be ignored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceExtensionAttributes"}}},"required":true},"responses":{"202":{"description":"Mobile Device Extension Attribute updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceExtensionAttributes"}}}},"400":{"description":"Bad Request. Specified Mobile Device Extension Attribute could not be updated due to bad request. Possible reasons are:</br> 1) The specified extension attribute id does not include a valid number.</br> 2) Duplicate name is provided.</br> 3) Required fields are not provided in request body.</br> 4) Fields which are not associated with provided inputType has some value.</br> 5) Any values outside of the allowed range are included in the request body.</br> 6) LDAP is not configured.</br> 7) Error occurred during database update operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified Mobile Device Extension Attribute object does not exist. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Mobile Device Extension Attributes"]}},"/v1/packages":{"get":{"tags":["packages"],"summary":"Retrieve Packages","description":"Retrieves packages\n\n> 📋 **Required privilege:** Read Packages","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Fields allowed in the query: id, fileName, packageName, categoryId, info, notes, manifestFileName, cloudTransferStatus. Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackagesSearchResults"}}}}},"x-required-privileges":["Read Packages"]},"post":{"tags":["packages"],"summary":"Create package","description":"Create package\n\n> 📋 **Required privilege:** Create Packages","requestBody":{"description":"Package to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Package"}}},"required":true},"responses":{"201":{"description":"Package was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Packages"]}},"/v1/packages/{id}":{"get":{"tags":["packages"],"summary":"Get specified Package object\n","description":"Gets specified Package object\n\n\n> 📋 **Required privilege:** Read Packages","parameters":[{"name":"id","in":"path","description":"instance id of package","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Package details found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Package"}}}},"404":{"description":"Specified package object could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Packages"]},"delete":{"tags":["packages"],"summary":"Remove specified package\n","description":"Removes specified package\n\n\n> 📋 **Required privilege:** Delete Packages","parameters":[{"name":"id","in":"path","description":"Instance ID of package","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Package deleted successfully"}},"x-required-privileges":["Delete Packages"]},"put":{"tags":["packages"],"summary":"Update specified package object\n","description":"Update specified package object\n\n\n> 📋 **Required privilege:** Update Packages","parameters":[{"name":"id","in":"path","description":"Instance ID of package","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Package object to update. IDs defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Package"}}},"required":true},"responses":{"200":{"description":"Package update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Package"}}}}},"x-required-privileges":["Update Packages"]}},"/v1/return-to-service":{"get":{"tags":["return-to-service"],"summary":"Get all Return to Service Configurations\n","description":"Gets all return to service configurations.\n\n> 📋 **Required privilege:** View Return To Service Configurations","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnToServiceConfigurationSearchResults"}}}}},"x-required-privileges":["View Return To Service Configurations"]},"post":{"tags":["return-to-service"],"summary":"Create a Return to Service Configuration\n","description":"Create a return to service configuration\n\n> 📋 **Required privilege:** Edit Return To Service Configurations","requestBody":{"description":"Return to Service Configuration to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnToServiceConfigurationRequest"}}},"required":true},"responses":{"201":{"description":"Return to Service Configuration was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Edit Return To Service Configurations"]}},"/v1/return-to-service/{id}":{"get":{"tags":["return-to-service"],"summary":"Retrieve a Return to Service Configuration with the supplied id\n","description":"Retrieves a Return to Service Configuration with the supplied id\n\n> 📋 **Required privilege:** View Return To Service Configurations","parameters":[{"name":"id","in":"path","description":"Return to Service Configuration identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnToServiceConfiguration"}}}},"404":{"description":"Return to Service Configuration with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Return To Service Configurations"]},"delete":{"tags":["return-to-service"],"summary":"Delete a Return To Service Configuration with the supplied id\n","description":"Deletes a Return To Service Configuration with the supplied id\n\n> 📋 **Required privilege:** Delete Return To Service Configurations","parameters":[{"name":"id","in":"path","description":"Return To Service Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Return to Service Configuration with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Return To Service Configurations"]},"put":{"tags":["return-to-service"],"summary":"Update a Return to Service Configuration\n","description":"Updates a Return to Service Configuration\n\n> 📋 **Required privilege:** Edit Return To Service Configurations","parameters":[{"name":"id","in":"path","description":"Return to Service Configuration identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Return to Service Configuration to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnToServiceConfigurationRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnToServiceConfiguration"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Return to Service Configuration with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The Return to Service Configuration was modified by another process. Read the Return to Service Configuration again for updated changes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Edit Return To Service Configurations"]}},"/v1/scripts":{"get":{"tags":["scripts"],"summary":"Search for sorted and paged Scripts\n","description":"Search for sorted and paged scripts\n\n> 📋 **Required privilege:** Read Scripts","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the query: `id`, `name`, `info`, `notes`, `priority`, `categoryId`, `categoryName`, `parameter4` up to `parameter11`, `osRequirements`, `scriptContents`. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["name:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter scripts collection. Default search is empty query - returning all results for the requested page. Fields allowed in the query: `id`, `name`, `info`, `notes`, `priority`, `categoryId`, `categoryName`, `parameter4` up to `parameter11`, `osRequirements`, `scriptContents`. This param can be combined with paging and sorting. Example: filter=categoryName==\"Category\" and name==\"*script name*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Found scripts matching search params.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptsSearchResults"}}}}},"x-required-privileges":["Read Scripts"]},"post":{"tags":["scripts"],"summary":"Create a Script\n","description":"Creates a script\n\n> 📋 **Required privilege:** Create Scripts","requestBody":{"description":"new script to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Script"}}},"required":true},"responses":{"201":{"description":"Script created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Scripts"]}},"/v1/scripts/{id}":{"get":{"tags":["scripts"],"summary":"Retrieve a full script object\n","description":"Retrieves a full script object\n\n> 📋 **Required privilege:** Read Scripts","parameters":[{"name":"id","in":"path","description":"Script object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Script"}}}},"404":{"description":"Script with that ID does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Scripts"]},"delete":{"tags":["scripts"],"summary":"Delete a Script at the specified id\n","description":"Deletes a script at the specified id\n\n> 📋 **Required privilege:** Delete Scripts","parameters":[{"name":"id","in":"path","description":"Script object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response"}},"x-required-privileges":["Delete Scripts"]},"put":{"tags":["scripts"],"summary":"Replace the script at the id with the supplied information\n","description":"Replaces the script at the id with the supplied information\n\n> 📋 **Required privilege:** Update Scripts","parameters":[{"name":"id","in":"path","description":"Script object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"new script to upload to existing id. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Script"}}},"required":true},"responses":{"200":{"description":"Script at id was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Script"}}}},"404":{"description":"Script with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Scripts"]}},"/v1/self-service/branding/ios":{"get":{"tags":["self-service-branding-ios"],"summary":"Search for sorted and paged iOS branding configurations\n","description":"Search for sorted and paged iOS branding configurations\n\n> 📋 **Required privilege:** Read Self Service Branding Configuration","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,brandingName:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IosBrandingSearchResults"}}}}},"x-required-privileges":["Read Self Service Branding Configuration"]},"post":{"tags":["self-service-branding-ios"],"summary":"Create a Self Service iOS branding configuration with the supplied\n","description":"Create a Self Service iOS branding configuration with the supplied details\n\n> 📋 **Required privilege:** Create Self Service Branding Configuration","requestBody":{"description":"The iOS branding configuration to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IosBrandingConfiguration"}}},"required":false},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Self Service Branding Configuration"]}},"/v1/self-service/branding/ios/{id}":{"get":{"tags":["self-service-branding-ios"],"summary":"Read a single Self Service iOS branding configuration indicated by the provided id\n","description":"Read a single Self Service iOS branding configuration indicated by the provided id.\n\n> 📋 **Required privilege:** Read Self Service Branding Configuration","parameters":[{"name":"id","in":"path","description":"id of iOS branding configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IosBrandingConfiguration"}}}}},"x-required-privileges":["Read Self Service Branding Configuration"]},"delete":{"tags":["self-service-branding-ios"],"summary":"Delete the Self Service iOS branding configuration indicated by the provided id\n","description":"Delete the Self Service iOS branding configuration indicated by the provided id.\n\n> 📋 **Required privilege:** Delete Self Service Branding Configuration","parameters":[{"name":"id","in":"path","description":"id of iOS branding configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response"},"404":{"description":"Invalid id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Self Service Branding Configuration"]},"put":{"tags":["self-service-branding-ios"],"summary":"Update a Self Service iOS branding configuration with the supplied details\n","description":"Update a Self Service iOS branding configuration with the supplied details\n\n> 📋 **Required privilege:** Update Self Service Branding Configuration","parameters":[{"name":"id","in":"path","description":"id of iOS branding configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"The iOS branding configuration values to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IosBrandingConfiguration"}}},"required":false},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IosBrandingConfiguration"}}}},"404":{"description":"Invalid id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Self Service Branding Configuration"]}},"/v1/self-service/branding/macos":{"get":{"tags":["self-service-branding-macos"],"summary":"Search for sorted and paged macOS branding configurations\n","description":"Search for sorted and paged macOS branding configurations\n\n> 📋 **Required privileges:**\n> - Read Self Service Branding Configuration\n> - Read Self Service","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,brandingName:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacOsBrandingSearchResults"}}}}},"x-required-privileges":["Read Self Service Branding Configuration","Read Self Service"]},"post":{"tags":["self-service-branding-macos"],"summary":"Create a Self Service macOS branding configuration with the supplied\n","description":"Create a Self Service macOS branding configuration with the supplied details\n\n> 📋 **Required privilege:** Create Self Service Branding Configuration","requestBody":{"description":"The macOS branding configuration to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacOsBrandingConfiguration"}}},"required":false},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Self Service Branding Configuration"]}},"/v1/self-service/branding/macos/{id}":{"get":{"tags":["self-service-branding-macos"],"summary":"Read a single Self Service macOS branding configuration indicated by the provided id\n","description":"Read a single Self Service macOS branding configuration indicated by the provided id.\n\n> 📋 **Required privilege:** Read Self Service Branding Configuration","parameters":[{"name":"id","in":"path","description":"id of macOS branding configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacOsBrandingConfiguration"}}}}},"x-required-privileges":["Read Self Service Branding Configuration"]},"delete":{"tags":["self-service-branding-macos"],"summary":"Delete the Self Service macOS branding configuration indicated by the provided id\n","description":"Delete the Self Service macOS branding configuration indicated by the provided id.\n\n> 📋 **Required privilege:** Delete Self Service Branding Configuration","parameters":[{"name":"id","in":"path","description":"id of macOS branding configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response"},"404":{"description":"Invalid id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Self Service Branding Configuration"]},"put":{"tags":["self-service-branding-macos"],"summary":"Update a Self Service macOS branding configuration with the supplied details\n","description":"Update a Self Service macOS branding configuration with the supplied details\n\n> 📋 **Required privilege:** Update Self Service Branding Configuration","parameters":[{"name":"id","in":"path","description":"id of macOS branding configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"The macOS branding configuration values to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacOsBrandingConfiguration"}}},"required":false},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacOsBrandingConfiguration"}}}},"404":{"description":"Invalid id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Self Service Branding Configuration"]}},"/v1/sites":{"get":{"tags":["sites"],"summary":"Find all sites\n","description":"Find all sites\n\n\n> 📋 **Required privilege:** Read Sites","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1Site"}}}}}},"security":[{"Bearer":[]}],"x-required-privileges":["Read Sites"]}},"/v1/supervision-identities":{"get":{"tags":["supervision-identities-preview"],"summary":"Search for sorted and paged Supervision Identities\n","description":"Search for sorted and paged supervision identities\n\n> 📋 **Required privilege:** Read Apple Configurator Enrollment","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/pagesize"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"id:asc"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentitySearchResults"}}}}},"x-required-privileges":["Read Apple Configurator Enrollment"]},"post":{"tags":["supervision-identities-preview"],"summary":"Create a Supervision Identity for the supplied information\n","description":"Creates a Supervision Identity for the supplied information\n\n> 📋 **Required privilege:** Update Apple Configurator Enrollment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentityCreate"}}},"required":true},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentity"}}}},"500":{"description":"Something went wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Apple Configurator Enrollment"]}},"/v1/supervision-identities/{id}":{"get":{"tags":["supervision-identities-preview"],"summary":"Retrieve a Supervision Identity with the supplied id\n","description":"Retrieves a Supervision Identity with the supplied id\n\n> 📋 **Required privilege:** Read Apple Configurator Enrollment","parameters":[{"name":"id","in":"path","description":"Supervision Identity identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentity"}}}},"404":{"description":"Supervision Identity with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Apple Configurator Enrollment"]},"delete":{"tags":["supervision-identities-preview"],"summary":"Delete a Supervision Identity with the supplied id\n","description":"Deletes a Supervision Identity with the supplied id\n\n> 📋 **Required privilege:** Update Apple Configurator Enrollment","parameters":[{"name":"id","in":"path","description":"Supervision Identity identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Supervision Identity with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Apple Configurator Enrollment"]},"put":{"tags":["supervision-identities-preview"],"summary":"Update a Supervision Identity with the supplied information\n","description":"Updates a Supervision Identity with the supplied information\n\n> 📋 **Required privilege:** Update Apple Configurator Enrollment","parameters":[{"name":"id","in":"path","description":"Supervision Identity identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentityUpdate"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentity"}}}},"404":{"description":"Supervision Identity with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Something went wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Apple Configurator Enrollment"]}},"/v1/users":{"get":{"tags":["users"],"summary":"Retrieve users with pagination and filtering","description":"Retrieves a paginated list of users with optional filtering and sorting.\n\n> 📋 **Required privilege:** Read User","parameters":[{"name":"page","in":"query","description":"Page to display. Uses zero-based indexing.","required":false,"style":"form","explode":true,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"page-size","in":"query","description":"Number of results per page. Maximum of 1000.","required":false,"style":"form","explode":true,"schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(:asc|desc). Default sort order is ascending.\nMultiple sort criteria are supported.\n\nExamples:\n- sort=username\n- sort=username:asc\n- sort=username:asc,realname:desc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"RSQL filter to limit results. Supports all user fields.\n\nExamples:\n- filter=username==\"john*\"\n- filter=realname==\"John Smith\"\n- filter=email==\"*@jamf.com\"\n- filter=position==\"Manager\";id!=\"1\"\n- filter=id=in=(123,456,789)","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}},{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Users retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedUserResults"}}}},"400":{"description":"Invalid request parameters"},"500":{"description":"Internal server error"}},"x-required-privileges":["Read User"],"x-authentication-required":true},"post":{"tags":["users"],"summary":"Create a new user in inventory","description":"Creates a new user in the inventory.\n\n> 📋 **Required privilege:** Create User","parameters":[{"name":"platform","in":"query","description":"Internal platform request indicator","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false},"x-internal":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInventory"}}},"required":true},"responses":{"201":{"description":"User successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Invalid user data provided"},"500":{"description":"Internal server error"}},"x-required-privileges":["Create User"],"x-authentication-required":true}},"/v1/users/{id}":{"get":{"tags":["users"],"summary":"Retrieve a user by ID","description":"Retrieves a single user by their ID.\n\n> 📋 **Required privilege:** Read User","parameters":[{"name":"id","in":"path","description":"ID of the user to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"User retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"404":{"description":"User with specified ID not found"},"500":{"description":"Internal server error"}},"x-required-privileges":["Read User"],"x-authentication-required":true},"delete":{"tags":["users"],"summary":"Delete a user from inventory","description":"Deletes a user from the inventory by ID.\n\n> 📋 **Required privilege:** Delete User","parameters":[{"name":"id","in":"path","description":"ID of the user to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"1"}}],"responses":{"204":{"description":"User successfully deleted"},"404":{"description":"User with specified ID not found"},"500":{"description":"Internal server error"}},"x-required-privileges":["Delete User"],"x-authentication-required":true},"put":{"tags":["users"],"summary":"Update a user in inventory","description":"Updates an existing user in the inventory by ID.\n\n> 📋 **Required privilege:** Update User","parameters":[{"name":"id","in":"path","description":"ID of the user to update","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"1"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInventory"}}},"required":true},"responses":{"204":{"description":"User successfully updated"},"400":{"description":"Invalid user data provided"},"404":{"description":"User with specified ID not found"},"500":{"description":"Internal server error"}},"x-required-privileges":["Update User"],"x-authentication-required":true}},"/v1/volume-purchasing-locations":{"get":{"tags":["volume-purchasing-locations"],"summary":"Retrieve Volume Purchasing Locations","description":"Retrieves Volume Purchasing Locations\n\n> 📋 **Required privilege:** Read Volume Purchasing Locations","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Volume Purchasing Location collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, appleId, email, organizationName, tokenExpiration, countryCode, locationName, automaticallyPopulatePurchasedContent, sendNotificationWhenNoLongerAssigned, siteId and siteName. This param can be combined with paging and sorting.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingLocations"}}}}},"x-required-privileges":["Read Volume Purchasing Locations"]},"post":{"tags":["volume-purchasing-locations"],"summary":"Create a Volume Purchasing Location","description":"Creates a Volume Purchasing Location using an sToken\n\n> 📋 **Required privilege:** Create Volume Purchasing Locations","requestBody":{"description":"Volume Purchasing Location to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingLocationPost"}}},"required":true},"responses":{"201":{"description":"Volume Purchasing Location was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Volume Purchasing Locations"]}},"/v1/volume-purchasing-locations/{id}":{"get":{"tags":["volume-purchasing-locations"],"summary":"Retrieve a Volume Purchasing Location with the supplied id","description":"Retrieves a Volume Purchasing Location with the supplied id\n\n> 📋 **Required privilege:** Read Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Location identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingLocation"}}}},"404":{"description":"Volume Purchasing Location with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Volume Purchasing Locations"]},"patch":{"tags":["volume-purchasing-locations"],"summary":"Update a Volume Purchasing Location","description":"Updates a Volume Purchasing Location\n\n> 📋 **Required privilege:** Update Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Location identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Volume Purchasing Location to update","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingLocationPatch"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingLocation"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Volume Purchasing Location with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"There was an error applying the patch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Volume Purchasing Locations"]},"delete":{"tags":["volume-purchasing-locations"],"summary":"Delete a Volume Purchasing Location with the supplied id","description":"Deletes a Volume Purchasing Location with the supplied id\n\n> 📋 **Required privilege:** Delete Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Location identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Specified Volume Purchasing Location object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Volume Purchasing Locations"]}},"/v1/volume-purchasing-subscriptions":{"get":{"tags":["volume-purchasing-subscriptions"],"summary":"Retrieve Volume Purchasing Subscriptions","description":"Retrieves Volume Purchasing Subscriptions\n\n> 📋 **Required privilege:** Read Volume Purchasing Locations","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Allowable properties are id, name, and enabled.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingSubscriptions"}}}}},"x-required-privileges":["Read Volume Purchasing Locations"]},"post":{"tags":["volume-purchasing-subscriptions"],"summary":"Create a Volume Purchasing Subscription","description":"Creates a Volume Purchasing Subscription\n\n> 📋 **Required privilege:** Create Volume Purchasing Locations","requestBody":{"description":"Volume Purchasing Subscription to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingSubscriptionBase"}}},"required":true},"responses":{"201":{"description":"Volume Purchasing Subscription was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failed to create volume purchasing subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Volume Purchasing Locations"]}},"/v1/volume-purchasing-subscriptions/{id}":{"get":{"tags":["volume-purchasing-subscriptions"],"summary":"Retrieve a Volume Purchasing Subscription with the supplied id","description":"Retrieves a Volume Purchasing Subscription with the supplied id\n\n> 📋 **Required privilege:** Read Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Subscription identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingSubscription"}}}},"404":{"description":"Volume Purchasing Subscription with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Volume Purchasing Locations"]},"delete":{"tags":["volume-purchasing-subscriptions"],"summary":"Delete a Volume Purchasing Subscription with the supplied id","description":"Deletes a Volume Purchasing Subscription with the supplied id\n\n> 📋 **Required privilege:** Delete Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Subscription identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"VPP Subscription with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Volume Purchasing Locations"]},"put":{"tags":["volume-purchasing-subscriptions"],"summary":"Update a Volume Purchasing Subscription","description":"Updates a Volume Purchasing Subscription\n\n> 📋 **Required privilege:** Update Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Subscription identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Volume Purchasing Subscription to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingSubscriptionBase"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingSubscription"}}}},"404":{"description":"Volume Purchasing Subscription with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failed to update volume purchasing subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Volume Purchasing Locations"]}},"/v2/enrollment-customizations":{"get":{"tags":["enrollment-customization"],"summary":"Retrieve sorted and paged Enrollment Customizations\n","description":"Retrieves sorted and paged Enrollment Customizations\n\n> 📋 **Required privilege:** Read Enrollment Customizations","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationSearchResultsV2"}}}}},"x-required-privileges":["Read Enrollment Customizations"]},"post":{"tags":["enrollment-customization"],"summary":"Create an Enrollment Customization\n","description":"Create an enrollment customization\n\n> 📋 **Required privilege:** Create Enrollment Customizations","requestBody":{"description":"Enrollment customization to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationV2"}}},"required":true},"responses":{"201":{"description":"Enrollment customization was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Enrollment Customizations"]}},"/v2/enrollment-customizations/{id}":{"get":{"tags":["enrollment-customization"],"summary":"Retrieve an Enrollment Customization with the supplied id\n","description":"Retrieves an Enrollment Customization with the supplied id\n\n> 📋 **Required privilege:** Read Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationV2"}}}},"404":{"description":"Enrollment Customization with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Enrollment Customizations"]},"delete":{"tags":["enrollment-customization"],"summary":"Delete an Enrollment Customization with the supplied id\n","description":"Deletes an Enrollment Customization with the supplied id\n\n> 📋 **Required privileges:**\n> - Delete Enrollment Customizations\n> - Read Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"}},"x-required-privileges":["Delete Enrollment Customizations","Read Enrollment Customizations"]},"put":{"tags":["enrollment-customization"],"summary":"Update an Enrollment Customization\n","description":"Updates an Enrollment Customization\n\n> 📋 **Required privilege:** Update Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Enrollment Customization to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationV2"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationV2"}}}},"404":{"description":"Enrollment Customization with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Enrollment Customizations"]}},"/v2/inventory-preload/records":{"get":{"tags":["inventory-preload"],"summary":"Return all Inventory Preload records","description":"Returns all Inventory Preload records.\n\n> 📋 **Required privilege:** Read Inventory Preload Records","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: `property:asc/desc`. Default sort\nis `id:asc`. Multiple sort criteria are supported and must be separated with\na comma. All inventory preload fields are supported, however fields added by\nextension attributes are not supported. If sorting by deviceType, use `0` for\nComputer and `1` for Mobile Device.\n\nExample: `sort=date:desc,name:asc`.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Allowing to filter inventory preload records.\nDefault search is empty query - returning all results for the requested page.\nAll inventory preload fields are supported, however fields added by extension\nattributes are not supported. If filtering by deviceType, use `0` for Computer\nand `1` for Mobile Device.\n\nQuery in the RSQL format, allowing `==`, `!=`, `>`, `<`, and `=in=`.\n\nExample: `filter=categoryName==\"Category\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadRecordSearchResultsV2"}}}}},"x-required-privileges":["Read Inventory Preload Records"]},"post":{"tags":["inventory-preload"],"summary":"Create a new Inventory Preload record using JSON","description":"Create a new Inventory Preload record using JSON.\n\n> 📋 **Required privilege:** Create Inventory Preload Records","requestBody":{"description":"Inventory Preload record to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadRecordV2"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Inventory Preload Records"]}},"/v2/inventory-preload/records/{id}":{"get":{"tags":["inventory-preload"],"summary":"Get an Inventory Preload record","description":"Retrieves an Inventory Preload record.\n\n> 📋 **Required privilege:** Read Inventory Preload Records","parameters":[{"name":"id","in":"path","description":"Inventory Preload identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadRecordV2"}}}},"404":{"description":"Inventory Preload record with specified id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Inventory Preload Records"]},"delete":{"tags":["inventory-preload"],"summary":"Delete an Inventory Preload record\n","description":"Deletes an Inventory Preload record.\n\n> 📋 **Required privilege:** Delete Inventory Preload Records","parameters":[{"name":"id","in":"path","description":"Inventory Preload identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK"},"404":{"description":"Inventory Preload record with specified id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Inventory Preload Records"]},"put":{"tags":["inventory-preload"],"summary":"Update an Inventory Preload record","description":"Updates an Inventory Preload record.\n\n> 📋 **Required privilege:** Update Inventory Preload Records","parameters":[{"name":"id","in":"path","description":"Inventory Preload identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Inventory Preload record to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadRecordV2"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadRecordV2"}}}},"404":{"description":"Inventory Preload record with specified id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Inventory Preload Records"]}},"/v2/mobile-device-groups":{"get":{"tags":["mobile-device-groups"],"summary":"Return the list of all Mobile Device Groups\n","description":"Returns the list of all mobile device groups filtered by site and permissions.\n\n\n> 📋 **Required privileges:**\n> - Read Smart Mobile Device Groups\n> - Read Static Mobile Device Groups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceGroup"}}}}}},"x-required-privileges":["Read Smart Mobile Device Groups","Read Static Mobile Device Groups"]}},"/v2/mobile-device-groups/smart-groups":{"get":{"tags":["mobile-device-groups"],"summary":"Get Smart Groups\n","description":"Get Smart Groups with pagination, sorting, and filtering support.\n\n\n> 📋 **Required privilege:** Read Smart Mobile Device Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is groupId:asc. Available criteria to sort on: groupId, groupName, siteId.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["groupId:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter smart group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: groupId, groupName, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. This param can be combined with paging and sorting. Example: groupName==\"smartGroup1\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupSearchResults"}}}}},"x-required-privileges":["Read Smart Mobile Device Groups"]},"post":{"tags":["mobile-device-groups"],"summary":"Create a smart group\n","description":"Create a smart group with strict andOr enum validation.\n\n\n> 📋 **Required privilege:** Create Smart Mobile Device Groups","parameters":[{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupAssignmentV2"}}},"required":true},"responses":{"201":{"description":"Smart mobile device group created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Could not save smart group due to validation errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Smart Mobile Device Groups"]}},"/v2/mobile-device-groups/smart-groups/{id}":{"get":{"tags":["mobile-device-groups"],"summary":"Get Smart Group by Id\n","description":"Get Smart Group by Id\n\n\n> 📋 **Required privilege:** Read Smart Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of smart-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupDetailV2"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Smart Mobile Device Groups"]},"delete":{"tags":["mobile-device-groups"],"summary":"Remove Smart Group by Id\n","description":"Remove Smart Group by Id. Returns 422 if the group has dependencies.\n\n\n> 📋 **Required privilege:** Delete Smart Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of smart-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Smart Group successfully removed"},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Cannot delete smart group due to dependencies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Smart Mobile Device Groups"]},"put":{"tags":["mobile-device-groups"],"summary":"Update a smart group\n","description":"Update a smart group with strict andOr enum validation.\n\n\n> 📋 **Required privilege:** Update Smart Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of a smart group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupAssignmentV2"}}},"required":true},"responses":{"202":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupAssignmentV2"}}}},"400":{"description":"Could not update smart group due to validation errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Smart Mobile Device Groups"]}},"/v2/mobile-device-groups/static-group-membership/{id}":{"get":{"tags":["mobile-device-groups"],"summary":"Get Static Group Membership by Id\n","description":"Get Static Group Membership by Id\n\n\n> 📋 **Required privileges:**\n> - Read Static Mobile Device Groups\n> - Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"instance id of static-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort\nis mobileDeviceId:asc. Multiple sort criteria are supported and must be separated with\na comma.\n\nFields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`,\n`batteryLevel`, `batteryHealth`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`,\n`lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`,\n`devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`,\n`enrollmentSessionTokenValid`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`,\n`osRapidSecurityResponse`, `osSupplementalBuildVersion`, `osVersion`, `ipAddress`, `itunesStoreAccountActive`,\n`mobileDeviceId`, `managementId`, `languages`, `lastBackupDate`, `lastEnrolledDate`, `lastCloudBackupDate`,\n`lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`,\n`managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`,\n`modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`,\n`serialNumber`, `sharedIpad`, `supervised`, `tethered`,\n`timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`,\n`deviceOwnershipType`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`,\n`poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`,\n`purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`,\n`activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`,\n`hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`,\n`passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`,\n`cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`,\n`dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`,\n`homeMobileNetworkCode`, `iccid`, `imei`, `imei2`,\n`meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`,\n`lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`\n\nExtension attributes can be sorted by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`\n\nExample: `sort=displayName:desc,username:asc`\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["displayName:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter mobile device collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`,\n`batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`,\n`declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`,\n`diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `exchangeDeviceId`,\n`cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`,\n`itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastInventoryUpdateDate`, `locales`,\n`locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `model`,\n`modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`,\n`residentUsers`, `serialNumber`, `sharedIpad`, `supervised`,\n`tethered`, `timeZone`, `udid`, `usedSpacePercentage`,\n`wifiMacAddress`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`,\n`purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`,\n`vendor`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`,\n`fileEncryptionCapable`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`,\n`passcodePresent`, `carrierSettingsVersion`, `currentCarrierNetwork`,\n`currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`,\n`network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`,\n`imei`, `imei2`, `meid`, `personalHotspotEnabled`,\n`roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`,\n`lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`\n\nExtension attributes can be filtered by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`\n\nThis param can be combined with paging and sorting.\nExample: `filter=displayName==\"iPad\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryListMobileDeviceSearchResults"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Static Mobile Device Groups","Read Mobile Devices"]}},"/v2/mobile-device-groups/static-groups":{"get":{"tags":["mobile-device-groups"],"summary":"Get Static Groups\n","description":"Get Static Groups with pagination, sorting, and filtering support.\n\n\n> 📋 **Required privilege:** Read Static Mobile Device Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is groupId:asc. Available criteria to sort on: groupId, groupName, siteId.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["groupId:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter static group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: groupId, groupName, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. This param can be combined with paging and sorting. Example: groupName==\"staticGroup1\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroupSearchResults"}}}}},"x-required-privileges":["Read Static Mobile Device Groups"]},"post":{"tags":["mobile-device-groups"],"summary":"Create a static group\n","description":"Create a static group\n\n\n> 📋 **Required privilege:** Create Static Mobile Device Groups","parameters":[{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroupAssignment"}}},"required":true},"responses":{"201":{"description":"Static mobile device group created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Could not save static group due to validation errors or invalid device IDs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Static Mobile Device Groups"]}},"/v2/mobile-device-groups/static-groups/{id}":{"get":{"tags":["mobile-device-groups"],"summary":"Get Static Group by Id\n","description":"Get Static Group by Id\n\n\n> 📋 **Required privilege:** Read Static Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of static-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroup"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Static Mobile Device Groups"]},"patch":{"tags":["mobile-device-groups"],"summary":"Update a static group\n","description":"Partially update a static group. Only provided fields will be updated.\n\n\n> 📋 **Required privilege:** Update Static Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of static-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroupAssignment"}}},"required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroupAssignment"}}}},"400":{"description":"Could not update static group due to validation errors (e.g., invalid device IDs, name too long)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Static Mobile Device Groups"]},"delete":{"tags":["mobile-device-groups"],"summary":"Remove Static Group by Id\n","description":"Remove Static Group by Id. Returns 422 if the group has dependencies.\n\n\n> 📋 **Required privilege:** Delete Static Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of static-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Static Group successfully removed"},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Cannot delete static group due to dependencies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Static Mobile Device Groups"]}},"/v2/mobile-device-prestages":{"get":{"tags":["mobile-device-prestages"],"summary":"Get sorted and paged Mobile Device Prestages\n","description":"Gets sorted and paged mobile device prestages\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:desc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDevicePrestageSearchResultsV2"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Read Mobile Device PreStage Enrollments"]},"post":{"tags":["mobile-device-prestages"],"summary":"Create a Mobile Device Prestage\n","description":"Create a mobile device prestage\n\n> 📋 **Required privilege:** Create Mobile Device PreStage Enrollments","requestBody":{"description":"Mobile Device Prestage to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDevicePrestageV2"}}},"required":true},"responses":{"201":{"description":"Mobile Device Prestage was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Create Mobile Device PreStage Enrollments"]}},"/v2/mobile-device-prestages/{id}":{"get":{"tags":["mobile-device-prestages"],"summary":"Retrieve a Mobile Device Prestage with the supplied id\n","description":"Retrieves a Mobile Device Prestage with the supplied id\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMobileDevicePrestageV2"}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Read Mobile Device PreStage Enrollments"]},"delete":{"tags":["mobile-device-prestages"],"summary":"Delete a Mobile Device Prestage with the supplied id\n","description":"Deletes a Mobile Device Prestage with the supplied id\n\n> 📋 **Required privilege:** Delete Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Delete Mobile Device PreStage Enrollments"]},"put":{"tags":["mobile-device-prestages"],"summary":"Update a Mobile Device Prestage\n","description":"Updates a Mobile Device Prestage\n\n> 📋 **Required privilege:** Update Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Mobile Device Prestage to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutMobileDevicePrestageV2"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMobileDevicePrestageV2"}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The Mobile Device Prestage was modified by another process. Read the Mobile Device Prestage again for updated changes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Update Mobile Device PreStage Enrollments"]}},"/v2/mobile-devices":{"get":{"tags":["mobile-devices"],"summary":"Get Mobile Device objects\n","description":"Gets Mobile Device objects.\n\n\n> 📋 **Required privilege:** Read Mobile Devices","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceSearchResultsV2"}}}}},"x-required-privileges":["Read Mobile Devices"]}},"/v2/mobile-devices/{id}":{"get":{"tags":["mobile-devices"],"summary":"Get Mobile Device\n","description":"Get MobileDevice\n\n> 📋 **Required privilege:** Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"instance id of mobile device record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceV2"}}}},"404":{"description":"Specified mobile device object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Devices"]},"patch":{"tags":["mobile-devices"],"summary":"Update fields on a mobile device that are allowed to be modified by users\n","description":"Updates fields on a mobile device that are allowed to be modified by users.\n\n> 📋 **Required privilege:** Update Mobile Devices","parameters":[{"name":"id","in":"path","description":"instance id of mobile device record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMobileDeviceV2"}}},"required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceDetailsV2"}}}},"403":{"description":"Account not allowed to modify device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified mobile device object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Mobile Devices"]}},"/v2/mobile-devices/{id}/detail":{"get":{"tags":["mobile-devices"],"summary":"Get Mobile Device\n","description":"Get MobileDevice\n\n> 📋 **Required privilege:** Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"instance id of mobile device record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceDetailsGetV2"}}}},"404":{"description":"Specified mobile device object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Devices"]}},"/v2/patch-software-title-configurations":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve Patch Software Title Configurations","description":"Retrieves patch software title configurations\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitleConfiguration"}}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"]},"post":{"tags":["patch-software-title-configurations"],"summary":"Create Patch Software Title Configurations","description":"Creates Patch Software Title Configurations using sToken\n\n> 📋 **Required privilege:** Create Patch Management Software Titles","requestBody":{"description":"Software title configurations to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationBase"}}},"required":true},"responses":{"201":{"description":"Patch Software Title Configurations were created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Create Patch Management Software Titles"]}},"/v2/patch-software-title-configurations/{id}":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve Patch Software Title Configurations with the supplied id","description":"Retrieves Patch Software Title Configurations with the supplied id\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfiguration"}}}},"404":{"description":"Patch Software Title Configurations with that id do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"]},"patch":{"tags":["patch-software-title-configurations"],"summary":"Update Patch Software Title Configurations","description":"Updates Patch Software Title Configurations\n\n> 📋 **Required privilege:** Update Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Patch Software Title Configurations to update","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationPatch"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfiguration"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Software Title Configurations with that id do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"There was an error applying the patch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Update Patch Management Software Titles"]},"delete":{"tags":["patch-software-title-configurations"],"summary":"Delete Patch Software Title Configurations with the supplied id","description":"Deletes Patch Software Title Configurations with the supplied id\n\n> 📋 **Required privilege:** Delete Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Specified Patch Software Title Configurations object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Delete Patch Management Software Titles"]}},"/v3/computer-groups/smart-group-membership/{id}":{"get":{"tags":["computer-groups"],"summary":"Get the membership of a Smart Computer Group\n","description":"Gets the membership of a Smart Computer Group\n\n\n> 📋 **Required privilege:** Read Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"id of the Smart Computer Group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response - Smart Computer Group membership retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupMembership"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Smart Computer Groups"]}},"/v3/computer-groups/smart-groups":{"get":{"tags":["computer-groups"],"summary":"Search for Smart Computer Groups\n","description":"Search for Smart Computer Groups\n\n\n> 📋 **Required privilege:** Read Smart Computer Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=name:asc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter smart computer group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. Example: name==\"*group*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupSearchResult"}}}}},"x-required-privileges":["Read Smart Computer Groups"]},"post":{"tags":["computer-groups"],"summary":"Create a Smart Computer Group\n","description":"Creates a Smart Computer Group with strict andOr enum validation.\n\n\n> 📋 **Required privilege:** Create Smart Computer Groups","parameters":[{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartComputerGroupV3"}}},"required":true},"responses":{"201":{"description":"Successful response - Smart Computer Group created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Could not save smart computer group due to validation errors. Common causes include:\n- Invalid priority order in criteria\n- Invalid field values (e.g., andOr must be \"and\" or \"or\")\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Smart Computer Groups"]}},"/v3/computer-groups/smart-groups/{id}":{"get":{"tags":["computer-groups"],"summary":"Get Smart Computer Group by Id\n","description":"Get Smart Computer Group by Id\n\n\n> 📋 **Required privilege:** Read Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"instance id of smart computer group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartComputerGroupV3"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Smart Computer Groups"]},"delete":{"tags":["computer-groups"],"summary":"Remove specified Smart Computer Group\n","description":"Remove specified Smart Computer Group. Returns 422 if the group has dependencies.\n\n\n> 📋 **Required privilege:** Delete Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"id of target Smart Computer Group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response - Smart Computer Group removed"},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Cannot delete smart computer group due to dependencies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Smart Computer Groups"]},"put":{"tags":["computer-groups"],"summary":"Update a Smart Computer Group\n","description":"Updates a Smart Computer Group with strict andOr enum validation.\n\n\n> 📋 **Required privilege:** Update Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"id of target Smart Computer Group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartComputerGroupV3"}}},"required":true},"responses":{"202":{"description":"Successful response - Smart Computer Group updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartComputerGroupV3"}}}},"400":{"description":"Could not update smart computer group due to validation errors. Common causes include:\n- Invalid priority order in criteria\n- Invalid field values (e.g., andOr must be \"and\" or \"or\")\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Smart Computer Groups"]}},"/v3/computer-groups/static-groups":{"get":{"tags":["computer-groups"],"summary":"Search for Static Computer Groups\n","description":"Search for Static Computer Groups\n\n\n> 📋 **Required privilege:** Read Static Computer Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=name:asc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter static computer group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. Example: name==\"*group*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroupSearchResults"}}}}},"x-required-privileges":["Read Static Computer Groups"]},"post":{"tags":["computer-groups"],"summary":"Create membership of a static computer group.\n","description":"Create membership of a static computer group.\n\n\n> 📋 **Required privilege:** Create Static Computer Groups","parameters":[{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroupAssignment"}}},"required":true},"responses":{"201":{"description":"Static computer group created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Could not save static computer group (e.g., invalid device IDs).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Static Computer Groups"]}},"/v3/computer-groups/static-groups/{id}":{"get":{"tags":["computer-groups"],"summary":"Get Static Computer Group by Id\n","description":"Get Static Computer Group by Id\n\n\n> 📋 **Required privilege:** Read Static Computer Groups","parameters":[{"name":"id","in":"path","description":"instance id of static computer group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroup"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Static Computer Groups"]},"delete":{"tags":["computer-groups"],"summary":"Remove Static Computer Group by Id\n","description":"Remove Static Computer Group by Id. Returns 422 if the group has dependencies.\n\n\n> 📋 **Required privilege:** Delete Static Computer Groups","parameters":[{"name":"id","in":"path","description":"instance id of static computer group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Static Computer Group successfully removed"},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Cannot delete static computer group due to dependencies.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Static Computer Groups"]},"put":{"tags":["computer-groups"],"summary":"Update membership of a static computer group.\n","description":"Update membership of a static computer group.\n\n\n> 📋 **Required privilege:** Update Static Computer Groups","parameters":[{"name":"id","in":"path","description":"instance id of a static computer group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroupAssignment"}}},"required":true},"responses":{"202":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroupAssignment"}}}},"400":{"description":"Invalid device IDs provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Static Computer Groups"]}},"/v3/computer-prestages":{"get":{"tags":["computer-prestages"],"summary":"Get sorted and paged Computer Prestages\n","description":"Gets sorted and paged computer prestages\n\n> 📋 **Required privilege:** Read Computer PreStage Enrollments","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:desc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerPrestageSearchResultsV3"}}}}},"x-required-privileges":["Read Computer PreStage Enrollments"]},"post":{"tags":["computer-prestages"],"summary":"Create a Computer Prestage\n","description":"Create a computer prestage\n\n> 📋 **Required privilege:** Create Computer PreStage Enrollments","requestBody":{"description":"Computer Prestage to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostComputerPrestageV3"}}},"required":true},"responses":{"201":{"description":"Computer Prestage was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Computer PreStage Enrollments"]}},"/v3/computer-prestages/{id}":{"get":{"tags":["computer-prestages"],"summary":"Retrieve a Computer Prestage with the supplied id\n","description":"Retrieves a Computer Prestage with the supplied id\n\n> 📋 **Required privilege:** Read Computer PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Computer Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetComputerPrestageV3"}}}},"404":{"description":"Computer Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computer PreStage Enrollments"]},"delete":{"tags":["computer-prestages"],"summary":"Delete a Computer Prestage with the supplied id\n","description":"Deletes a Computer Prestage with the supplied id\n\n> 📋 **Required privilege:** Delete Computer PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Computer Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"}},"x-required-privileges":["Delete Computer PreStage Enrollments"]},"put":{"tags":["computer-prestages"],"summary":"Update a Computer Prestage\n","description":"Updates a Computer Prestage\n\n> 📋 **Required privilege:** Update Computer PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Computer Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Computer Prestage to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutComputerPrestageV3"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetComputerPrestageV3"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Computer Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The Computer Prestage was modified by another process. Read the Computer Prestage again for updated changes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Computer PreStage Enrollments"]}},"/advancedcomputersearches":{"get":{"tags":["advancedcomputersearches"],"summary":"Finds all advanced computer searches","operationId":"findAdvancedComputerSearches","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/advanced_computer_searches"}},"application/json":{"schema":{"$ref":"#/components/schemas/advanced_computer_searches"}}}},"401":{"description":"Unauthorized"}}}},"/advancedcomputersearches/id/{id}":{"get":{"tags":["advancedcomputersearches"],"summary":"Finds computer searches by ID","description":"Additional display fields are returned within the `Computer` object","operationId":"findAdvancedComputerSearchesById","parameters":[{"description":"ID value to filter by","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/advanced_computer_search"}},"application/json":{"schema":{"$ref":"#/components/schemas/advanced_computer_search"}}}}}},"delete":{"tags":["advancedcomputersearches"],"summary":"Deletes a computer search by ID","operationId":"deleteAdvancedComputerSearchById","parameters":[{"description":"ID value to filter by","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/advancedcomputersearches/name/{name}":{"get":{"tags":["advancedcomputersearches"],"summary":"Finds advanced computer searches by name","description":"Additional display fields are returned within the `Computer` object","operationId":"findAdvancedComputerSearchesByName","parameters":[{"description":"Name to filter by","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/advanced_computer_search"}},"application/json":{"schema":{"$ref":"#/components/schemas/advanced_computer_search"}}}}}},"delete":{"tags":["advancedcomputersearches"],"summary":"Deletes a computer search by name","operationId":"deleteAdvancedComputerSearchByName","parameters":[{"description":"Name to filter by","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/advancedusersearches":{"get":{"tags":["advancedusersearches"],"summary":"Finds all advanced user searches","operationId":"findAdvancedUserSearches","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/advanced_user_searches"}},"application/json":{"schema":{"$ref":"#/components/schemas/advanced_user_searches"}}}}}}},"/advancedusersearches/id/{id}":{"get":{"tags":["advancedusersearches"],"summary":"Finds user searches by ID","operationId":"findAdvancedUserSearchesById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/advanced_user_search"}},"application/json":{"schema":{"$ref":"#/components/schemas/advanced_user_search"}}}}}},"delete":{"tags":["advancedusersearches"],"summary":"Deletes a user search by ID","operationId":"deleteAdvancedUserSearchById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/advancedusersearches/name/{name}":{"get":{"tags":["advancedusersearches"],"summary":"Finds user searches by name","operationId":"findUserSearchesByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/advanced_user_search"}},"application/json":{"schema":{"$ref":"#/components/schemas/advanced_user_search"}}}}}},"delete":{"tags":["advancedusersearches"],"summary":"Deletes a user search by Name","operationId":"deleteAdvancedUserSearchByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/byoprofiles":{"get":{"tags":["byoprofiles"],"summary":"Finds all personal device profiles","operationId":"findBYOProfiles","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/byoprofiles"}},"application/json":{"schema":{"$ref":"#/components/schemas/byoprofiles"}}}}}}},"/byoprofiles/id/{id}":{"get":{"tags":["byoprofiles"],"summary":"Finds personal device profile by ID","operationId":"findBYOProfilesById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/byoprofile"}},"application/json":{"schema":{"$ref":"#/components/schemas/byoprofile"}}}}}},"delete":{"tags":["byoprofiles"],"summary":"Deletes a personal device profile by ID","operationId":"deleteBYOProfilesById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/byoprofiles/name/{name}":{"get":{"tags":["byoprofiles"],"summary":"Finds a personal device profile by name","operationId":"findBYOProfilesByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/byoprofile"}},"application/json":{"schema":{"$ref":"#/components/schemas/byoprofile"}}}}}},"delete":{"tags":["byoprofiles"],"summary":"Deletes a personal device profile by name","operationId":"deleteBYOProfilesByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/classes":{"get":{"tags":["classes"],"summary":"Finds all classes","operationId":"findClasses","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/classes"}},"application/json":{"schema":{"$ref":"#/components/schemas/classes"}}}}}}},"/classes/id/{id}":{"get":{"tags":["classes"],"summary":"Finds classes by ID","operationId":"findClassesById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/class"}},"application/json":{"schema":{"$ref":"#/components/schemas/class"}}}}}},"delete":{"tags":["classes"],"summary":"Deletes a class by ID","operationId":"deleteClassById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/classes/name/{name}":{"get":{"tags":["classes"],"summary":"Finds classes by name","operationId":"findClassesByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/class"}},"application/json":{"schema":{"$ref":"#/components/schemas/class"}}}}}},"delete":{"tags":["classes"],"summary":"Deletes a class by name","operationId":"deleteClassByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/computerinvitations":{"get":{"tags":["computerinvitations"],"summary":"Finds all computer invitations","operationId":"findComputerInvitations","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/computer_invitations"}},"application/json":{"schema":{"$ref":"#/components/schemas/computer_invitations"}}}}}}},"/computerinvitations/id/{id}":{"get":{"tags":["computerinvitations"],"summary":"Finds computer invitations by id","operationId":"findComputerInvitationsById","parameters":[{"description":"ID value to filter by","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/computer_invitation"}},"application/json":{"schema":{"$ref":"#/components/schemas/computer_invitation"}}}}}},"delete":{"tags":["computerinvitations"],"summary":"Deletes a computer invitation by id","operationId":"deleteComputerInvitationById","parameters":[{"description":"ID value to filter by","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/directorybindings":{"get":{"tags":["directorybindings"],"summary":"Finds all directory bindings","operationId":"findDirectoryBindings","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/directory_bindings"}},"application/json":{"schema":{"$ref":"#/components/schemas/directory_bindings"}}}}}}},"/directorybindings/id/{id}":{"get":{"tags":["directorybindings"],"summary":"Finds directory bindings by ID","operationId":"findDirectoryBindingsById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/directory_binding"}},"application/json":{"schema":{"$ref":"#/components/schemas/directory_binding"}}}}}},"delete":{"tags":["directorybindings"],"summary":"Deletes a directory binding by ID","operationId":"deleteDirectoryBindingById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/directorybindings/name/{name}":{"get":{"tags":["directorybindings"],"summary":"Finds directory bindings by name","operationId":"findDirectoryBindingsByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/directory_binding"}},"application/json":{"schema":{"$ref":"#/components/schemas/directory_binding"}}}}}},"delete":{"tags":["directorybindings"],"summary":"Deletes a directory binding by name","operationId":"deleteDirectoryBindingByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/diskencryptionconfigurations":{"get":{"tags":["diskencryptionconfigurations"],"summary":"Finds all disk encryption configurations","operationId":"findDiskEncryptionConfigurations","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/disk_encryption_configurations"}},"application/json":{"schema":{"$ref":"#/components/schemas/disk_encryption_configurations"}}}}}}},"/diskencryptionconfigurations/id/{id}":{"get":{"tags":["diskencryptionconfigurations"],"summary":"Finds disk encryption configurations by ID","operationId":"findDiskEncryptionConfigurationsById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/disk_encryption_configuration"}},"application/json":{"schema":{"$ref":"#/components/schemas/disk_encryption_configuration"}}}}}},"delete":{"tags":["diskencryptionconfigurations"],"summary":"Deletes a disk encryption configuration by ID","operationId":"deleteDiskEncryptionConfigurationById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/diskencryptionconfigurations/name/{name}":{"get":{"tags":["diskencryptionconfigurations"],"summary":"Finds disk encryption configurations by name","operationId":"findDiskEncryptionConfigurationsByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/disk_encryption_configuration"}},"application/json":{"schema":{"$ref":"#/components/schemas/disk_encryption_configuration"}}}}}},"delete":{"tags":["diskencryptionconfigurations"],"summary":"Deletes a disk encryption configuration by name","operationId":"deleteDiskEncryptionConfigurationByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/distributionpoints":{"get":{"tags":["distributionpoints"],"summary":"Finds all distribution points","operationId":"findDistributionPoints","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/distribution_points"}},"application/json":{"schema":{"$ref":"#/components/schemas/distribution_points"}}}}}}},"/distributionpoints/id/{id}":{"get":{"tags":["distributionpoints"],"summary":"Finds distribution points by ID","operationId":"findDistributionPointsById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/distribution_point"}},"application/json":{"schema":{"$ref":"#/components/schemas/distribution_point"}}}}}},"delete":{"tags":["distributionpoints"],"summary":"Deletes a distribution point by ID","operationId":"deleteDistributionPointById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/distributionpoints/name/{name}":{"get":{"tags":["distributionpoints"],"summary":"Finds distribution points by name","operationId":"findDistributionPointsByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/distribution_point"}},"application/json":{"schema":{"$ref":"#/components/schemas/distribution_point"}}}}}},"delete":{"tags":["distributionpoints"],"summary":"Deletes a distribution point by name","operationId":"deleteDistributionPointByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/ibeacons":{"get":{"tags":["ibeacons"],"summary":"Finds all iBeacon regions","operationId":"findIBeacons","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/ibeacons"}},"application/json":{"schema":{"$ref":"#/components/schemas/ibeacons"}}}}}}},"/ibeacons/id/{id}":{"get":{"tags":["ibeacons"],"summary":"Finds iBeacon regions by ID","operationId":"findIBeaconsById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/ibeacon"}},"application/json":{"schema":{"$ref":"#/components/schemas/ibeacon"}}}}}},"delete":{"tags":["ibeacons"],"summary":"Deletes an iBeacon region by ID","operationId":"deleteIBeaconById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/ibeacons/name/{name}":{"get":{"tags":["ibeacons"],"summary":"Finds iBeacon regions by name","operationId":"findIBeaconsByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/ibeacon"}},"application/json":{"schema":{"$ref":"#/components/schemas/ibeacon"}}}}}},"delete":{"tags":["ibeacons"],"summary":"Deletes an iBeacon region by name","operationId":"deleteIBeaconByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/licensedsoftware":{"get":{"tags":["licensedsoftware"],"summary":"Finds all licensed software","operationId":"findLicensedSoftware","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/licensed_software_all"}},"application/json":{"schema":{"$ref":"#/components/schemas/licensed_software_all"}}}}}}},"/licensedsoftware/id/{id}":{"get":{"tags":["licensedsoftware"],"summary":"Finds licensed software by ID","operationId":"findLicensedSoftwareById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/licensed_software"}},"application/json":{"schema":{"$ref":"#/components/schemas/licensed_software"}}}}}},"delete":{"tags":["licensedsoftware"],"summary":"Deletes licensed software by ID","operationId":"deleteLicensedSoftwareById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/licensedsoftware/name/{name}":{"get":{"tags":["licensedsoftware"],"summary":"Finds licensed software by name","operationId":"findLicensedSoftwareByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/licensed_software"}},"application/json":{"schema":{"$ref":"#/components/schemas/licensed_software"}}}}}},"delete":{"tags":["licensedsoftware"],"summary":"Deletes licensed software by name","operationId":"deleteLicensedSoftwareByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/macapplications":{"get":{"tags":["macapplications"],"summary":"Finds all mac applications","operationId":"findMacapps","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mac_applications"}},"application/json":{"schema":{"$ref":"#/components/schemas/mac_applications"}}}}}}},"/macapplications/id/{id}":{"get":{"tags":["macapplications"],"summary":"Finds mac applications by ID","operationId":"findMacappsById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mac_application"}},"application/json":{"schema":{"$ref":"#/components/schemas/mac_application"}}}}}},"delete":{"tags":["macapplications"],"summary":"Deletes a mac application by ID","operationId":"deleteMacappById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/macapplications/name/{name}":{"get":{"tags":["macapplications"],"summary":"Finds mac applications by name","operationId":"findMacappsByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mac_application"}},"application/json":{"schema":{"$ref":"#/components/schemas/mac_application"}}}}}},"delete":{"tags":["macapplications"],"summary":"Deletes a mac application by name","operationId":"deleteMacappByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/mobiledeviceapplications":{"get":{"tags":["mobiledeviceapplications"],"summary":"Finds all mobile device applications","operationId":"findMobileDeviceApplications","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mobile_device_applications"}},"application/json":{"schema":{"$ref":"#/components/schemas/mobile_device_applications"}}}}}}},"/mobiledeviceapplications/id/{id}":{"get":{"tags":["mobiledeviceapplications"],"summary":"Finds mobile device applications by ID","operationId":"findMobileDeviceApplicationsById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mobile_device_application"}},"application/json":{"schema":{"$ref":"#/components/schemas/mobile_device_application"}}}}}},"delete":{"tags":["mobiledeviceapplications"],"summary":"Deletes a mobile device application by ID","operationId":"deleteMobileDeviceApplicationById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/mobiledeviceapplications/name/{name}":{"get":{"tags":["mobiledeviceapplications"],"summary":"Finds mobile device applications by name","operationId":"findMobileDeviceApplicationsByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mobile_device_application"}},"application/json":{"schema":{"$ref":"#/components/schemas/mobile_device_application"}}}}}},"delete":{"tags":["mobiledeviceapplications"],"summary":"Deletes a mobile device application by name","operationId":"deleteMobileDeviceApplicationByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/mobiledeviceconfigurationprofiles":{"get":{"tags":["mobiledeviceconfigurationprofiles"],"summary":"Finds all mobile device configuration profiles","operationId":"findMobileDeviceConfigurationProfiles","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mobile_device_configuration_profiles"}},"application/json":{"schema":{"$ref":"#/components/schemas/mobile_device_configuration_profiles"}}}}}}},"/mobiledeviceconfigurationprofiles/id/{id}":{"get":{"tags":["mobiledeviceconfigurationprofiles"],"summary":"Finds mobile device configuration profiles by ID","operationId":"findMobileDeviceConfigurationProfilesById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mobile_device_configuration_profile"}},"application/json":{"schema":{"$ref":"#/components/schemas/mobile_device_configuration_profile"}}}}}},"delete":{"tags":["mobiledeviceconfigurationprofiles"],"summary":"Deletes a mobile device configuration profile by ID","operationId":"deleteMobileDeviceConfigurationProfileById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/mobiledeviceconfigurationprofiles/name/{name}":{"get":{"tags":["mobiledeviceconfigurationprofiles"],"summary":"Finds mobile device configuration profiles by name","operationId":"findMobileDeviceConfigurationProfilesByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mobile_device_configuration_profile"}},"application/json":{"schema":{"$ref":"#/components/schemas/mobile_device_configuration_profile"}}}}}},"delete":{"tags":["mobiledeviceconfigurationprofiles"],"summary":"Deletes a mobile device configuration profile by name","operationId":"deleteMobileDeviceConfigurationProfileByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/mobiledeviceenrollmentprofiles":{"get":{"tags":["mobiledeviceenrollmentprofiles"],"summary":"Finds all mobile device enrollment profiles","operationId":"findMobileDeviceEnrollmentProfiles","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mobile_device_enrollment_profiles"}},"application/json":{"schema":{"$ref":"#/components/schemas/mobile_device_enrollment_profiles"}}}}}}},"/mobiledeviceenrollmentprofiles/id/{id}":{"get":{"tags":["mobiledeviceenrollmentprofiles"],"summary":"Finds mobile device enrollment profiles by ID","operationId":"findMobileDeviceEnrollmentProfilesById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mobile_device_enrollment_profile"}},"application/json":{"schema":{"$ref":"#/components/schemas/mobile_device_enrollment_profile"}}}}}},"delete":{"tags":["mobiledeviceenrollmentprofiles"],"summary":"Deletes a mobile device enrollment profile by ID","operationId":"deleteMobileDeviceEnrollmentProfileById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/mobiledeviceenrollmentprofiles/name/{name}":{"get":{"tags":["mobiledeviceenrollmentprofiles"],"summary":"Finds mobile device enrollment profiles by name","operationId":"findMobileDeviceEnrollmentProfilesByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mobile_device_enrollment_profile"}},"application/json":{"schema":{"$ref":"#/components/schemas/mobile_device_enrollment_profile"}}}}}},"delete":{"tags":["mobiledeviceenrollmentprofiles"],"summary":"Deletes a mobile device enrollment profile by name","operationId":"deleteMobileDeviceEnrollmentProfileByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/mobiledeviceprovisioningprofiles":{"get":{"tags":["mobiledeviceprovisioningprofiles"],"summary":"Finds all mobile device provisioning profiles","operationId":"findMobileDeviceProvisioningProfiles","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mobile_device_provisioning_profiles"}},"application/json":{"schema":{"$ref":"#/components/schemas/mobile_device_provisioning_profiles"}}}}}}},"/mobiledeviceprovisioningprofiles/id/{id}":{"get":{"tags":["mobiledeviceprovisioningprofiles"],"summary":"Finds a mobile device provisioning profiles by id","operationId":"findMobileDeviceProvisioningProfilesById","parameters":[{"description":"Id value to filter by","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mobile_device_provisioning_profile"}},"application/json":{"schema":{"$ref":"#/components/schemas/mobile_device_provisioning_profile"}}}}}},"delete":{"tags":["mobiledeviceprovisioningprofiles"],"summary":"Deletes a mobile device provisioning profiles by id","operationId":"deleteMobileDeviceProvisioningProfilesById","parameters":[{"description":"Id value to filter by","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/mobiledeviceprovisioningprofiles/name/{name}":{"get":{"tags":["mobiledeviceprovisioningprofiles"],"summary":"Finds a mobile device provisioning profiles by name","operationId":"findMobileDeviceProvisioningProfilesByName","parameters":[{"description":"Name value to filter by","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/mobile_device_provisioning_profile"}},"application/json":{"schema":{"$ref":"#/components/schemas/mobile_device_provisioning_profile"}}}}}},"delete":{"tags":["mobiledeviceprovisioningprofiles"],"summary":"Deletes a mobile device provisioning profiles by name","operationId":"deleteMobileDeviceProvisioningProfilesByName","parameters":[{"description":"Name value to filter by","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/networksegments":{"get":{"tags":["networksegments"],"summary":"Finds all network segments","operationId":"findNetworkSegments","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/network_segments"}},"application/json":{"schema":{"$ref":"#/components/schemas/network_segments"}}}}}}},"/networksegments/id/{id}":{"get":{"tags":["networksegments"],"summary":"Finds network segments by ID","operationId":"findNetworkSegmentsById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/network_segment"}},"application/json":{"schema":{"$ref":"#/components/schemas/network_segment"}}}}}},"delete":{"tags":["networksegments"],"summary":"Deletes a network segment by ID","operationId":"deleteNetworkSegmentById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/networksegments/name/{name}":{"get":{"tags":["networksegments"],"summary":"Finds network segments by name","operationId":"findNetworkSegmentsByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/network_segment"}},"application/json":{"schema":{"$ref":"#/components/schemas/network_segment"}}}}}},"delete":{"tags":["networksegments"],"summary":"Deletes a network segment by name","operationId":"deleteNetworkSegmentByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/osxconfigurationprofiles":{"get":{"tags":["osxconfigurationprofiles"],"summary":"Finds all OS X configuration profiles","operationId":"findOsxConfigurationProfiles","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/os_x_configuration_profiles"}},"application/json":{"schema":{"$ref":"#/components/schemas/os_x_configuration_profiles"}}}}}}},"/osxconfigurationprofiles/id/{id}":{"get":{"tags":["osxconfigurationprofiles"],"summary":"Finds OS X configuration profiles by ID","operationId":"findOsxConfigurationProfilesById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/os_x_configuration_profile"}},"application/json":{"schema":{"$ref":"#/components/schemas/os_x_configuration_profile"}}}}}},"delete":{"tags":["osxconfigurationprofiles"],"summary":"Deletes a OS X configuration profile by ID","operationId":"deleteOsxConfigurationProfileById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/osxconfigurationprofiles/name/{name}":{"get":{"tags":["osxconfigurationprofiles"],"summary":"Finds OS X configuration profiles by name","operationId":"findOsxConfigurationProfilesByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/os_x_configuration_profile"}},"application/json":{"schema":{"$ref":"#/components/schemas/os_x_configuration_profile"}}}}}},"delete":{"tags":["osxconfigurationprofiles"],"summary":"Deletes a OS X configuration profile by name","operationId":"deleteOsxConfigurationProfileByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/policies":{"get":{"tags":["policies"],"summary":"Finds all policies","operationId":"findPolicies","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/policies"}},"application/json":{"schema":{"$ref":"#/components/schemas/policies"}}}}}}},"/policies/category/{category}":{"get":{"tags":["policies"],"summary":"Finds all policies by category","description":"Category may be specified by id or name, or 'None' for policies with no category.","operationId":"findPoliciesByCategory","parameters":[{"name":"category","in":"path","required":true,"description":"Category to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/policies/id/{id}":{"get":{"tags":["policies"],"summary":"Finds policies by ID","operationId":"findPoliciesById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/policy"}},"application/json":{"schema":{"$ref":"#/components/schemas/policy"}}}}}},"delete":{"tags":["policies"],"summary":"Deletes a policy by ID","operationId":"deletePolicyById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/policies/name/{name}":{"get":{"tags":["policies"],"summary":"Finds policies by name","operationId":"findPoliciesByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/policy"}},"application/json":{"schema":{"$ref":"#/components/schemas/policy"}}}}}},"delete":{"tags":["policies"],"summary":"Deletes a policy by name","operationId":"deletePolicyByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/printers":{"get":{"tags":["printers"],"summary":"Finds all printers","operationId":"findPrinters","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/printers"}},"application/json":{"schema":{"$ref":"#/components/schemas/printers"}}}}}}},"/printers/id/{id}":{"get":{"tags":["printers"],"summary":"Finds printers by ID","operationId":"findPrintersById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/printer"}},"application/json":{"schema":{"$ref":"#/components/schemas/printer"}}}}}},"delete":{"tags":["printers"],"summary":"Deletes a printer by ID","operationId":"deletePrinterById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/printers/name/{name}":{"get":{"tags":["printers"],"summary":"Finds printers by name","operationId":"findPrintersByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/printer"}},"application/json":{"schema":{"$ref":"#/components/schemas/printer"}}}}}},"delete":{"tags":["printers"],"summary":"Deletes a printer by name","operationId":"deletePrinterByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/removablemacaddresses":{"get":{"tags":["removablemacaddresses"],"summary":"Finds all removable Mac addresses","operationId":"findRemovableMacAddresses","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/removable_mac_addresses"}},"application/json":{"schema":{"$ref":"#/components/schemas/removable_mac_addresses"}}}}}}},"/removablemacaddresses/id/{id}":{"get":{"tags":["removablemacaddresses"],"summary":"Finds removable Mac addresses by ID","operationId":"findRemovableMacAddressesById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/removable_mac_address"}},"application/json":{"schema":{"$ref":"#/components/schemas/removable_mac_address"}}}}}},"delete":{"tags":["removablemacaddresses"],"summary":"Deletes a removable Mac address by ID","operationId":"deleteRemovableMacAddressById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/removablemacaddresses/name/{name}":{"get":{"tags":["removablemacaddresses"],"summary":"Finds removable Mac addresses by name","operationId":"findRemovableMacAddressesByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/removable_mac_address"}},"application/json":{"schema":{"$ref":"#/components/schemas/removable_mac_address"}}}}}},"delete":{"tags":["removablemacaddresses"],"summary":"Deletes a removable Mac address by name","operationId":"deleteRemovableMacAddressByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/restrictedsoftware":{"get":{"tags":["restrictedsoftware"],"summary":"Finds all restricted software","operationId":"findRestrictedSoftware","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/restricted_software_all"}},"application/json":{"schema":{"$ref":"#/components/schemas/restricted_software_all"}}}}}}},"/restrictedsoftware/id/{id}":{"get":{"tags":["restrictedsoftware"],"summary":"Finds restricted software by ID","operationId":"findRestrictedSoftwareById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/restricted_software"}},"application/json":{"schema":{"$ref":"#/components/schemas/restricted_software"}}}}}},"delete":{"tags":["restrictedsoftware"],"summary":"Deletes a restricted software by ID","operationId":"deleteRestrictedSoftwareById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/restrictedsoftware/name/{name}":{"get":{"tags":["restrictedsoftware"],"summary":"Finds restricted software by name","operationId":"findRestrictedSoftwareByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/restricted_software"}},"application/json":{"schema":{"$ref":"#/components/schemas/restricted_software"}}}}}},"delete":{"tags":["restrictedsoftware"],"summary":"Deletes a restricted software by name","operationId":"deleteRestrictedSoftwareByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/softwareupdateservers":{"get":{"tags":["softwareupdateservers"],"summary":"Finds all software update servers","operationId":"findSoftwareUpdateServers","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/software_update_servers"}},"application/json":{"schema":{"$ref":"#/components/schemas/software_update_servers"}}}}}}},"/softwareupdateservers/id/{id}":{"get":{"tags":["softwareupdateservers"],"summary":"Finds software update servers by ID","operationId":"findSoftwareUpdateServersById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/software_update_server"}},"application/json":{"schema":{"$ref":"#/components/schemas/software_update_server"}}}}}},"delete":{"tags":["softwareupdateservers"],"summary":"Deletes a software update server by ID","operationId":"deleteSoftwareUpdateServerById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/softwareupdateservers/name/{name}":{"get":{"tags":["softwareupdateservers"],"summary":"Finds software update servers by name","operationId":"findSoftwareUpdateServersByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/software_update_server"}},"application/json":{"schema":{"$ref":"#/components/schemas/software_update_server"}}}}}},"delete":{"tags":["softwareupdateservers"],"summary":"Deletes a software update server by name","operationId":"deleteSoftwareUpdateServerByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/userextensionattributes":{"get":{"tags":["userextensionattributes"],"summary":"Finds all user extension attributes","operationId":"findUserextensionattributes","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/user_extension_attributes"}},"application/json":{"schema":{"$ref":"#/components/schemas/user_extension_attributes"}}}}}}},"/userextensionattributes/id/{id}":{"get":{"tags":["userextensionattributes"],"summary":"Finds user extension attributes by ID","operationId":"findUserextensionattributesById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/user_extension_attribute"}},"application/json":{"schema":{"$ref":"#/components/schemas/user_extension_attribute"}}}}}},"delete":{"tags":["userextensionattributes"],"summary":"Deletes a user extension attribute by ID","operationId":"deleteUserextensionattributeById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/userextensionattributes/name/{name}":{"get":{"tags":["userextensionattributes"],"summary":"Finds user extension attributes by name","operationId":"findUserextensionattributesByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/user_extension_attribute"}},"application/json":{"schema":{"$ref":"#/components/schemas/user_extension_attribute"}}}}}},"delete":{"tags":["userextensionattributes"],"summary":"Deletes a user extension attribute by name","operationId":"deleteUserextensionattributeByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/usergroups":{"get":{"tags":["usergroups"],"summary":"Finds all user groups","operationId":"findUserGroups","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/user_groups"}},"application/json":{"schema":{"$ref":"#/components/schemas/user_groups"}}}}}}},"/usergroups/id/{id}":{"get":{"tags":["usergroups"],"summary":"Finds user groups by ID","operationId":"findUserGroupsById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/user_group"}},"application/json":{"schema":{"$ref":"#/components/schemas/user_group"}}}}}},"delete":{"tags":["usergroups"],"summary":"Deletes user groups by ID","operationId":"deleteUserGroupsById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/usergroups/name/{name}":{"get":{"tags":["usergroups"],"summary":"Finds user groups by name","operationId":"findUserGroupsByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/user_group"}},"application/json":{"schema":{"$ref":"#/components/schemas/user_group"}}}}}},"delete":{"tags":["usergroups"],"summary":"Deletes user groups by name","operationId":"deleteUserGroupsByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/webhooks":{"get":{"tags":["webhooks"],"summary":"Finds all webhooks","operationId":"findWebhooks","responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/webhooks"}},"application/json":{"schema":{"$ref":"#/components/schemas/webhooks"}}}}}}},"/webhooks/id/{id}":{"get":{"tags":["webhooks"],"summary":"Finds webhooks by ID","operationId":"findWebhooksById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/webhook"}},"application/json":{"schema":{"$ref":"#/components/schemas/webhook"}}}}}},"delete":{"tags":["webhooks"],"summary":"Deletes a webhook by ID","operationId":"deleteWebhookById","parameters":[{"name":"id","in":"path","required":true,"description":"ID value to filter by","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}},"/webhooks/name/{name}":{"get":{"tags":["webhooks"],"summary":"Finds webhooks by name","operationId":"findWebhooksByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/webhook"}},"application/json":{"schema":{"$ref":"#/components/schemas/webhook"}}}}}},"delete":{"tags":["webhooks"],"summary":"Deletes a webhook by name","operationId":"deleteWebhookByName","parameters":[{"name":"name","in":"path","required":true,"description":"Name value to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}}},"components":{"parameters":{"page":{"name":"page","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","default":0}},"page-size":{"name":"page-size","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","default":100}},"pagesize":{"name":"pagesize","in":"query","required":false,"deprecated":true,"style":"form","explode":true,"schema":{"type":"integer","default":100}},"size":{"name":"size","in":"query","required":false,"deprecated":true,"style":"form","explode":true,"schema":{"type":"integer","default":100}}},"schemas":{"AccountGroupSearchResultsV1":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","description":"Total number of account groups matching the filter criteria","example":1},"results":{"minItems":0,"type":"array","description":"The collection of account groups for the requested page","items":{"$ref":"#/components/schemas/AccountGroupV1"}}}},"AccountGroupV1":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"minLength":1,"type":"string","example":"Admin"},"accessLevel":{"type":"string","description":"Access level for the account group","enum":["FullAccess","SiteAccess","GroupBasedAccess"],"default":"FullAccess"},"privilegeLevel":{"type":"string","description":"Privilege level for the account group","enum":["ADMINISTRATOR","AUDITOR","ENROLLMENT","CUSTOM"],"default":"ADMINISTRATOR"},"siteId":{"type":"string","example":"-1"},"ldapServerId":{"type":"string","example":"-1"},"directoryGroupId":{"type":"string","example":""},"members":{"type":"array","description":"Members of this account group","items":{"required":["id"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"username":{"type":"string","nullable":true,"example":"admin"},"realname":{"type":"string","nullable":true,"example":"Admin User"},"email":{"type":"string","nullable":true,"example":"admin@jamf.com"}}}},"privileges":{"type":"array","description":"List of privilege strings assigned to this group","example":["Read Computers","Update Computers"],"items":{"type":"string"}}}},"AccountSettingsRequest":{"type":"object","properties":{"id":{"type":"string","description":"id of Account Settings","nullable":false,"example":"1"},"payloadConfigured":{"type":"boolean","nullable":false,"example":true,"default":false},"localAdminAccountEnabled":{"type":"boolean","nullable":false,"example":true,"default":false},"adminUsername":{"minLength":0,"type":"string","nullable":false,"example":"admin","default":""},"adminPassword":{"minLength":0,"type":"string","nullable":false,"writeOnly":true,"example":"password","default":""},"hiddenAdminAccount":{"type":"boolean","nullable":false,"example":false,"default":false},"localUserManaged":{"type":"boolean","nullable":false,"example":true,"default":false},"userAccountType":{"type":"string","nullable":false,"enum":["ADMINISTRATOR","STANDARD","SKIP"],"default":"STANDARD"},"versionLock":{"type":"integer","nullable":false,"example":4,"default":0},"prefillPrimaryAccountInfoFeatureEnabled":{"type":"boolean","nullable":false,"example":true,"default":false},"prefillType":{"type":"string","description":"Values accepted are only CUSTOM and DEVICE_OWNER","nullable":false,"example":"DEVICE_OWNER","default":"CUSTOM"},"prefillAccountFullName":{"minLength":0,"type":"string","nullable":false,"example":"TestUser FullName","default":""},"prefillAccountUserName":{"minLength":0,"type":"string","nullable":false,"example":"UserName","default":""},"preventPrefillInfoFromModification":{"type":"boolean","nullable":false,"example":false,"default":false}}},"AccountSettingsResponse":{"type":"object","properties":{"id":{"type":"string","description":"id of Account Settings","nullable":false,"example":"1"},"payloadConfigured":{"type":"boolean","nullable":false,"example":true,"default":false},"localAdminAccountEnabled":{"type":"boolean","nullable":false,"example":true,"default":false},"adminUsername":{"minLength":0,"type":"string","nullable":false,"example":"admin","default":""},"hiddenAdminAccount":{"type":"boolean","nullable":false,"example":false,"default":false},"localUserManaged":{"type":"boolean","nullable":false,"example":true,"default":false},"userAccountType":{"type":"string","nullable":false,"enum":["ADMINISTRATOR","STANDARD","SKIP"],"default":"STANDARD"},"versionLock":{"minimum":0,"type":"integer","nullable":false,"example":4,"default":0},"prefillPrimaryAccountInfoFeatureEnabled":{"type":"boolean","nullable":false,"example":true,"default":false},"prefillType":{"type":"string","description":"Values accepted are only CUSTOM and DEVICE_OWNER","nullable":false,"example":"DEVICE_OWNER","default":"CUSTOM"},"prefillAccountFullName":{"minLength":0,"type":"string","nullable":false,"example":"TestUser FullName","default":""},"prefillAccountUserName":{"minLength":0,"type":"string","nullable":false,"example":"UserName","default":""},"preventPrefillInfoFromModification":{"type":"boolean","nullable":false,"example":false,"default":false}}},"AdvancedSearch":{"required":["name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Andy's Search"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/SmartSearchCriterion"}},"displayFields":{"type":"array","example":["AirPlay Password","App Analytics Enabled"],"items":{"type":"string"}},"siteId":{"type":"string","nullable":true,"example":"-1"}}},"AdvancedSearchSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/AdvancedSearch"}}}},"AdvancedUserContentSearch":{"required":["name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Andy's Search"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/SmartSearchCriterion"}},"displayFields":{"type":"array","example":["Content Name","Price"],"items":{"type":"string"}},"siteId":{"type":"string","nullable":true,"example":"-1"}}},"AdvancedUserContentSearchSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/AdvancedUserContentSearch"}}}},"ApiError":{"type":"object","properties":{"httpStatus":{"type":"integer","description":"HTTP status of the response","example":400},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiErrorCause"}}}},"ApiErrorCause":{"required":["field"],"type":"object","properties":{"code":{"type":"string","description":"Error-specific code that can be used to identify localization string, etc.","example":"8675309"},"field":{"type":"string","description":"Name of the field that caused the error.","example":"Name"},"description":{"type":"string","description":"A general description of error for troubleshooting/debugging. Generally this text should not be displayed to a user; instead refer to errorCode and it's localized text","example":"I've just picked up a fault in the AE35 unit. It's going to go 100% failure in 72 hours"},"id":{"type":"string","description":"id of object with error. Optional.","nullable":true,"example":"3"}}},"ApiIntegrationRequest":{"required":["authorizationScopes","displayName"],"type":"object","properties":{"authorizationScopes":{"type":"array","description":"API Role display names.\n","example":["Tootsie Roal","Jamf Reset"],"items":{"type":"string"}},"displayName":{"type":"string","example":"My API Integration"},"enabled":{"type":"boolean","example":true},"accessTokenLifetimeSeconds":{"type":"integer","example":300}}},"ApiIntegrationResponse":{"required":["appType","authorizationScopes","clientId","displayName","enabled","id"],"type":"object","properties":{"id":{"type":"integer","example":1},"authorizationScopes":{"type":"array","example":["Tootsie Roal","Jamf Reset"],"items":{"type":"string"}},"displayName":{"type":"string","example":"My API Integration"},"enabled":{"type":"boolean","example":true},"accessTokenLifetimeSeconds":{"type":"integer","example":300},"appType":{"type":"string","description":"Type of API Client:\n * `CLIENT_CREDENTIALS` - A client ID and secret have been generated for this integration.\n * `NATIVE_APP_OAUTH` - A native app (i.e., Jamf Reset) has been linked to this integration for auth code grant type via Managed App Config.\n * `NONE` - No client is currently associated with this integration.\n","readOnly":true,"example":"CLIENT_CREDENTIALS","enum":["CLIENT_CREDENTIALS","NATIVE_APP_OAUTH","NONE"]},"clientId":{"type":"string","readOnly":true,"example":"538878d4-9744-43ed-8732-3df99d502bd6"}}},"ApiIntegrationSearchResult":{"required":["results","totalCount"],"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","readOnly":true,"example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ApiIntegrationResponse"}}}},"ApiRole":{"required":["displayName","id","privileges"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"displayName":{"type":"string","example":"One Role to Rule them all"},"privileges":{"minItems":0,"type":"array","items":{"type":"string","example":"View License Serial Numbers"}}}},"ApiRoleRequest":{"required":["displayName","privileges"],"type":"object","properties":{"displayName":{"type":"string","example":"One Role to Rule them all"},"privileges":{"minItems":0,"type":"array","items":{"type":"string","example":"View License Serial Numbers"}}}},"ApiRoleResult":{"required":["results","totalCount"],"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","readOnly":true,"example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ApiRole"}}}},"AppRequestFormInputField":{"required":["priority","title"],"type":"object","properties":{"id":{"type":"integer","readOnly":true,"example":1},"title":{"minLength":1,"type":"string","example":"Quantity"},"description":{"type":"string","nullable":true,"example":"How many of these would you like?"},"priority":{"maximum":255,"minimum":1,"type":"integer","description":"Highest priority is 1, lowest is 255","example":1}}},"AppRequestFormInputFieldSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/AppRequestFormInputField"}}}},"AssignRemoveProfileResponseSyncState":{"type":"object","properties":{"id":{"type":"integer","example":1},"serialNumber":{"type":"string","example":"R7QFDE2YCFN4"},"profileUUID":{"type":"string","example":"9164E5F7C74C2A4C4BE90BB15E549F14"},"syncStatus":{"type":"string","example":"ASSIGN_SUCCESS"},"failureCount":{"type":"integer","example":0},"timestamp":{"type":"integer","example":1583855813080}}},"Assignment":{"type":"object","properties":{"mobileDeviceId":{"type":"string","example":"5"},"selected":{"type":"boolean","description":"If true the device should be added to the group, if false should be removed from the group","example":true}}},"Building":{"required":["name"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Apple Park"},"streetAddress1":{"type":"string","nullable":true,"example":"The McIntosh Tree"},"streetAddress2":{"type":"string","nullable":true,"example":"One Apple Park Way"},"city":{"type":"string","nullable":true,"example":"Cupertino"},"stateProvince":{"type":"string","nullable":true,"example":"California"},"zipPostalCode":{"type":"string","nullable":true,"example":"95014"},"country":{"type":"string","nullable":true,"example":"The United States of America"}}},"BuildingSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/Building"}}}},"CategoriesSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Category"}}}},"Category":{"required":["name","priority"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"The Best"},"priority":{"type":"integer","format":"int32","example":9}}},"CloudIdPCommon":{"required":["displayName","id","providerName"],"type":"object","properties":{"id":{"type":"string","example":"1001"},"displayName":{"type":"string","example":"Cloud Identity Provider"},"providerName":{"type":"string","example":"PROVIDER","enum":["GOOGLE","AZURE"]}},"description":"A Cloud Identity Provider information"},"CloudIdPCommonResponse":{"type":"object","properties":{"id":{"minimum":1001,"type":"string","example":"1001"},"displayName":{"type":"string","example":"Cloud Identity Provider"},"enabled":{"type":"boolean","example":true},"providerName":{"type":"string","example":"PROVIDER","enum":["GOOGLE","AZURE"]},"providerDescription":{"type":"string","example":"Entra ID"}},"description":"A Cloud Identity Provider information for responses"},"ComputerApplication":{"type":"object","properties":{"name":{"type":"string","example":"Microsoft Word"},"path":{"type":"string","example":"/usr/local/app"},"version":{"type":"string","example":"1.0.0"},"macAppStore":{"type":"boolean","example":true},"sizeMegabytes":{"type":"integer","example":25},"bundleId":{"type":"string","example":"1"},"updateAvailable":{"type":"boolean","example":false},"externalVersionId":{"type":"string","description":"The app's external version ID. It can be used in the iTunes Search API to decide if the app needs to be updated","example":"1"}}},"ComputerApplicationCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Microsoft Word"},"path":{"type":"string","nullable":true,"example":"/usr/local/app"},"version":{"type":"string","nullable":true,"example":"1.0.0"}}},"ComputerAttachment":{"type":"object","properties":{"id":{"type":"string","example":"1"},"name":{"type":"string","example":"Attachment.pdf"},"fileType":{"type":"string","example":"application/pdf"},"sizeBytes":{"type":"integer","description":"File size in bytes","format":"int64","example":1024}}},"ComputerCertificate":{"type":"object","properties":{"commonName":{"type":"string","example":"jamf.com"},"identity":{"type":"boolean","example":true},"expirationDate":{"type":"string","format":"date-time","example":"2030-10-31T18:04:13Z"},"username":{"type":"string","example":"test"},"lifecycleStatus":{"type":"string","example":"ACTIVE","enum":["ACTIVE","INACTIVE"]},"certificateStatus":{"type":"string","example":"ISSUED","enum":["EXPIRING","EXPIRED","REVOKED","PENDING_REVOKE","ISSUED"]},"subjectName":{"type":"string","example":"CN=jamf.com"},"serialNumber":{"type":"string","example":"40f3d9fb"},"sha1Fingerprint":{"type":"string","example":"ed361458724d06082b2314acdb82e1f586f085f5"},"issuedDate":{"type":"string","example":"2022-05-23T14:54:10Z"}}},"ComputerCertificateCreate":{"type":"object","properties":{"commonName":{"type":"string","nullable":true,"example":"jamf.com"},"identity":{"type":"boolean","nullable":true,"example":true},"username":{"type":"string","nullable":true,"example":"test"}}},"ComputerConfigurationProfile":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"username":{"type":"string","readOnly":true,"example":"username"},"lastInstalled":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"removable":{"type":"boolean","readOnly":true,"example":true},"displayName":{"type":"string","readOnly":true,"example":"Displayed profile"},"profileIdentifier":{"type":"string","readOnly":true,"example":"0ae590fe-9b30-11ea-bb37-0242ac130002"},"uuid":{"type":"string","nullable":true,"readOnly":true,"example":"0ae590fe-9b30-11ea-bb37-0242ac130002"}}},"ComputerConfigurationProfileCreate":{"type":"object","properties":{"id":{"type":"string","nullable":true,"example":"1"},"username":{"type":"string","nullable":true,"example":"username"},"lastInstalled":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"removable":{"type":"boolean","nullable":true,"example":true},"displayName":{"type":"string","nullable":true,"example":"Displayed profile"},"profileIdentifier":{"type":"string","nullable":true,"example":"0ae590fe-9b30-11ea-bb37-0242ac130002"}}},"ComputerContentCaching":{"type":"object","properties":{"computerContentCachingInformationId":{"type":"string","readOnly":true,"example":"1"},"parents":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ComputerContentCachingParent"}},"alerts":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ComputerContentCachingAlert"}},"activated":{"type":"boolean","readOnly":true,"example":false},"active":{"type":"boolean","readOnly":true,"example":false},"actualCacheBytesUsed":{"type":"integer","format":"int64","readOnly":true,"example":0},"cacheDetails":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ComputerContentCachingCacheDetail"}},"cacheBytesFree":{"type":"integer","format":"int64","readOnly":true,"example":23353884672},"cacheBytesLimit":{"type":"integer","format":"int64","readOnly":true,"example":0},"cacheStatus":{"type":"string","readOnly":true,"example":"OK"},"cacheBytesUsed":{"type":"integer","format":"int64","readOnly":true,"example":0},"dataMigrationCompleted":{"type":"boolean","readOnly":true,"example":false},"dataMigrationProgressPercentage":{"type":"integer","readOnly":true,"example":0},"dataMigrationError":{"$ref":"#/components/schemas/ComputerContentCachingDataMigrationError"},"maxCachePressureLast1HourPercentage":{"type":"integer","readOnly":true,"example":0},"personalCacheBytesFree":{"type":"integer","format":"int64","readOnly":true,"example":23353884672},"personalCacheBytesLimit":{"type":"integer","format":"int64","readOnly":true,"example":0},"personalCacheBytesUsed":{"type":"integer","format":"int64","readOnly":true,"example":0},"port":{"type":"integer","format":"int64","readOnly":true,"example":0},"publicAddress":{"type":"string","readOnly":true,"example":"SomeAddress"},"registrationError":{"type":"string","readOnly":true,"example":"NOT_ACTIVATED"},"registrationResponseCode":{"type":"integer","format":"int64","readOnly":true,"example":403},"registrationStarted":{"type":"string","format":"date-time","readOnly":true,"example":"2018-10-31T18:04:13Z"},"registrationStatus":{"type":"string","readOnly":true,"example":"CONTENT_CACHING_FAILED","enum":["CONTENT_CACHING_FAILED","CONTENT_CACHING_PENDING","CONTENT_CACHING_SUCCEEDED"]},"restrictedMedia":{"type":"boolean","readOnly":true,"example":false},"serverGuid":{"type":"string","readOnly":true,"example":"CD1E1291-4AF9-4468-B5D5-0F780C13DB2F"},"startupStatus":{"type":"string","readOnly":true,"example":"FAILED"},"tetheratorStatus":{"type":"string","readOnly":true,"example":"CONTENT_CACHING_DISABLED","enum":["CONTENT_CACHING_UNKNOWN","CONTENT_CACHING_DISABLED","CONTENT_CACHING_ENABLED"]},"totalBytesAreSince":{"type":"string","format":"date-time","readOnly":true,"example":"2018-10-31T18:04:13Z"},"totalBytesDropped":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesImported":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesReturnedToChildren":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesReturnedToClients":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesReturnedToPeers":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesStoredFromOrigin":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesStoredFromParents":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesStoredFromPeers":{"type":"integer","format":"int64","readOnly":true,"example":0}}},"ComputerContentCachingAlert":{"type":"object","properties":{"cacheBytesLimit":{"type":"integer","format":"int64","readOnly":true,"example":0},"className":{"type":"string","readOnly":true,"example":"SomeClass"},"pathPreventingAccess":{"type":"string","readOnly":true,"example":"/some/path"},"postDate":{"type":"string","format":"date-time","readOnly":true,"example":"2018-10-31T18:04:13Z"},"reservedVolumeBytes":{"type":"integer","format":"int64","readOnly":true,"example":0},"resource":{"type":"string","readOnly":true,"example":"SomeResource"}}},"ComputerContentCachingCacheDetail":{"type":"object","properties":{"computerContentCachingCacheDetailsId":{"type":"string","readOnly":true,"example":"1"},"categoryName":{"type":"string","readOnly":true,"example":"SomeCategory"},"diskSpaceBytesUsed":{"type":"integer","format":"int64","readOnly":true,"example":0}}},"ComputerContentCachingDataMigrationError":{"type":"object","properties":{"code":{"type":"integer","format":"int64","readOnly":true,"example":0},"domain":{"type":"string","readOnly":true,"example":"SomeDomain"},"userInfo":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ComputerContentCachingDataMigrationErrorUserInfo"}}}},"ComputerContentCachingDataMigrationErrorUserInfo":{"type":"object","properties":{"key":{"type":"string","readOnly":true,"example":"foo"},"value":{"type":"string","readOnly":true,"example":"bar"}}},"ComputerContentCachingParent":{"type":"object","properties":{"contentCachingParentId":{"type":"string","readOnly":true,"example":"1"},"address":{"type":"string","readOnly":true,"example":"SomeAddress"},"alerts":{"$ref":"#/components/schemas/ComputerContentCachingParentAlert"},"details":{"$ref":"#/components/schemas/ComputerContentCachingParentDetails"},"guid":{"type":"string","readOnly":true,"example":"CD1E1291-4AF9-4468-B5D5-0F780C13DB2F"},"healthy":{"type":"boolean","readOnly":true,"example":true},"port":{"type":"integer","format":"int64","readOnly":true,"example":0},"version":{"type":"string","readOnly":true,"example":"1"}}},"ComputerContentCachingParentAlert":{"type":"object","properties":{"contentCachingParentAlertId":{"type":"string","readOnly":true,"example":"1"},"addresses":{"type":"array","readOnly":true,"example":[],"items":{"type":"string"}},"className":{"type":"string","readOnly":true,"example":"SomeClass"},"postDate":{"type":"string","format":"date-time","readOnly":true,"example":"2018-10-31T18:04:13Z"}}},"ComputerContentCachingParentCapabilities":{"type":"object","properties":{"contentCachingParentCapabilitiesId":{"type":"string","readOnly":true,"example":"1"},"imports":{"type":"boolean","readOnly":true,"example":true},"namespaces":{"type":"boolean","readOnly":true,"example":true},"personalContent":{"type":"boolean","readOnly":true,"example":true},"queryParameters":{"type":"boolean","readOnly":true,"example":true},"sharedContent":{"type":"boolean","readOnly":true,"example":true},"prioritization":{"type":"boolean","readOnly":true,"example":true}}},"ComputerContentCachingParentDetails":{"type":"object","properties":{"contentCachingParentDetailsId":{"type":"string","readOnly":true,"example":"1"},"acPower":{"type":"boolean","readOnly":true,"example":true},"cacheSizeBytes":{"type":"integer","format":"int64","readOnly":true,"example":0},"capabilities":{"$ref":"#/components/schemas/ComputerContentCachingParentCapabilities"},"portable":{"type":"boolean","readOnly":true,"example":true},"localNetwork":{"type":"array","items":{"$ref":"#/components/schemas/ComputerContentCachingParentLocalNetwork"}}}},"ComputerContentCachingParentLocalNetwork":{"type":"object","properties":{"contentCachingParentLocalNetworkId":{"type":"string","readOnly":true,"example":"1"},"speed":{"type":"integer","format":"int64","readOnly":true,"example":5000},"wired":{"type":"boolean","readOnly":true,"example":true}}},"ComputerDisk":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"170"},"device":{"type":"string","readOnly":true,"example":"disk0"},"model":{"type":"string","readOnly":true,"example":"APPLE HDD TOSHIBA MK5065GSXF"},"revision":{"type":"string","readOnly":true,"example":"5"},"serialNumber":{"type":"string","readOnly":true,"example":"a8598f013366"},"sizeMegabytes":{"type":"integer","description":"Disk Size in MB.","format":"int64","readOnly":true,"example":262144},"smartStatus":{"type":"string","description":"S.M.A.R.T Status","readOnly":true,"example":"OK"},"type":{"type":"string","description":"Connection type attribute.","readOnly":true,"example":"false"},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/ComputerPartition"}}}},"ComputerDiskCreate":{"type":"object","properties":{"device":{"type":"string","nullable":true,"example":"disk0"},"model":{"type":"string","nullable":true,"example":"APPLE HDD TOSHIBA MK5065GSXF"},"revision":{"type":"string","nullable":true,"example":"5"},"serialNumber":{"type":"string","nullable":true,"example":"a8598f013366"},"sizeMegabytes":{"type":"integer","description":"Disk Size in MB.","format":"int64","nullable":true,"example":262144},"smartStatus":{"type":"string","description":"S.M.A.R.T Status","nullable":true,"example":"OK"},"type":{"type":"string","description":"Connection type attribute.","nullable":true,"example":"false"},"partitions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerPartitionCreate"}}}},"ComputerDiskEncryption":{"type":"object","properties":{"bootPartitionEncryptionDetails":{"$ref":"#/components/schemas/ComputerPartitionEncryption"},"individualRecoveryKeyValidityStatus":{"type":"string","example":"VALID","enum":["VALID","INVALID","UNKNOWN","NOT_APPLICABLE"]},"institutionalRecoveryKeyPresent":{"type":"boolean","example":true},"diskEncryptionConfigurationName":{"type":"string","example":"Test configuration"},"fileVault2Enabled":{"type":"boolean","readOnly":true,"example":true},"fileVault2EnabledUserNames":{"type":"array","example":["admin"],"items":{"type":"string"}},"fileVault2EligibilityMessage":{"type":"string","example":"Not a boot partition"}}},"ComputerExtensionAttribute":{"type":"object","properties":{"definitionId":{"type":"string","description":"An identifier of extension attribute definition.","nullable":false,"example":"23"},"name":{"type":"string","description":"A human-readable name by which attribute can be referred to.","nullable":false,"readOnly":true,"example":"Some Attribute"},"description":{"type":"string","description":"An additional explanation of exact attribute meaning, possible values, etc.","nullable":true,"readOnly":true,"example":"Some Attribute defines how much Foo impacts Bar."},"enabled":{"type":"boolean","nullable":false,"readOnly":true,"example":true},"multiValue":{"type":"boolean","nullable":false,"readOnly":true,"example":true},"values":{"type":"array","description":"A value of extension attribute, in some rare cases there may be multiple values present, hence the array.\n","nullable":true,"readOnly":false,"example":["foo","bar"],"items":{"type":"string"}},"dataType":{"type":"string","description":"A data type of extension attribute.","nullable":true,"readOnly":true,"example":"STRING","enum":["STRING","INTEGER","DATE_TIME"]},"options":{"type":"array","description":"A closed list of possible values (applies to `popup` input type).\n","nullable":true,"readOnly":true,"example":["foo","bar"],"items":{"type":"string"}},"inputType":{"type":"string","description":"The input method. `text` is most common and means simply free text, `popup` i a closed list of values from\nwhich one or many can be selected and `script` value is calculated and can never be set directly.\n","nullable":true,"readOnly":true,"example":"TEXT","enum":["TEXT","POPUP","SCRIPT","LDAP"]}}},"ComputerExtensionAttributeSearchResults":{"required":["totalCount"],"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttributes"}}}},"ComputerExtensionAttributes":{"allOf":[{"$ref":"#/components/schemas/ExtensionAttributes"},{"required":["inputType","inventoryDisplayType"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled by default, but for inputType Script we can disable it as well. <br/> Possible values are:<br/> false <br/> true","example":true,"default":true},"inventoryDisplayType":{"type":"string","description":"Category in which to display the extension attribute in Jamf Pro.","example":"GENERAL","enum":["GENERAL","HARDWARE","OPERATING_SYSTEM","USER_AND_LOCATION","PURCHASING","EXTENSION_ATTRIBUTES"],"default":"GENERAL"},"inputType":{"type":"string","description":"Extension attributes collect inventory data by using an input type.The type of the Input used to populate the extension attribute.","enum":["SCRIPT","TEXT","POPUP","DIRECTORY_SERVICE_ATTRIBUTE_MAPPING"],"default":"TEXT"},"scriptContents":{"type":"string","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'.","nullable":true,"example":"scriptContent"},"popupMenuChoices":{"minItems":0,"type":"array","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'.","example":["Test","Popup"],"items":{"type":"string","description":"Popup Menu choices."}},"ldapAttributeMapping":{"type":"string","description":"Directory Service attribute use to populate the extension attribute. <br/> Required when inputType is \"DIRECTORY_SERVICE_ATTRIBUTE_MAPPING\"","example":"ldapAttributeMapping"},"ldapExtensionAttributeAllowed":{"type":"boolean","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/>","example":false,"default":false},"manageExistingData":{"type":"string","description":"It is used to specify to either delete or retain the extension attributes values when inputType is Script and enabled is false.","example":"RETAIN","enum":["RETAIN","DELETE"]}}}]},"ComputerFont":{"type":"object","properties":{"name":{"type":"string","example":"font name"},"version":{"type":"string","example":"1.02"},"path":{"type":"string","example":"/Applications/"}}},"ComputerFontCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"font name"},"version":{"type":"string","nullable":true,"example":"1.02"},"path":{"type":"string","nullable":true,"example":"/Applications/"}}},"ComputerGeneral":{"type":"object","properties":{"name":{"minLength":1,"type":"string","example":"Boalime"},"lastIpAddress":{"type":"string","example":"247.185.82.186"},"lastReportedIp":{"type":"string","description":"Last reported IPv4 address (Deprecated. Use lastReportedIpV4 instead.)","example":"247.185.82.186","deprecated":true},"lastReportedIpV4":{"type":"string","description":"Last reported IPv4 address","example":"247.185.82.186"},"lastReportedIpV6":{"type":"string","example":"2001:0db8:85a3:0000:0000:8a2e:0370:7335"},"jamfBinaryVersion":{"type":"string","example":"9.27"},"platform":{"type":"string","example":"Mac"},"barcode1":{"type":"string","example":"5 12345 678900"},"barcode2":{"type":"string","example":"5 12345 678900"},"assetTag":{"type":"string","example":"304822"},"remoteManagement":{"$ref":"#/components/schemas/ComputerRemoteManagement"},"supervised":{"type":"boolean","example":true},"mdmCapable":{"$ref":"#/components/schemas/ComputerMdmCapability"},"reportDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastContactTime":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastCloudBackupDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastEnrolledDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"mdmProfileExpiration":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"initialEntryDate":{"type":"string","format":"date","example":"2018-10-31"},"distributionPoint":{"type":"string","example":"distribution point name"},"enrollmentMethod":{"$ref":"#/components/schemas/EnrollmentMethod"},"site":{"$ref":"#/components/schemas/ComputerSite"},"itunesStoreAccountActive":{"type":"boolean","example":true},"enrolledViaAutomatedDeviceEnrollment":{"type":"boolean","example":true},"userApprovedMdm":{"type":"boolean","example":true},"declarativeDeviceManagementEnabled":{"type":"boolean","example":true},"appleEnrollmentType":{"type":"string","description":"The enrollment type reported by Apple.","example":"supervised","enum":["none","supervised","device","user","unknown"]},"awaitingConfiguration":{"type":"boolean","description":"Whether the device is awaiting configuration.","example":false},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}},"managementId":{"type":"string","readOnly":true,"example":"73226fb6-61df-4c10-9552-eb9bc353d507"},"lastLoggedInUsernameSelfService":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameSelfServiceTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"lastLoggedInUsernameBinary":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameBinaryTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"lastLoggedInUsernameMdm":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameMdmTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"}}},"ComputerGeneralCreate":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","example":"Boalime"},"lastIpAddress":{"type":"string","example":"247.185.82.186"},"lastReportedIp":{"type":"string","example":"247.185.82.186"},"jamfBinaryVersion":{"type":"string","example":"9.27"},"platform":{"type":"string","example":"MAC","enum":["WINDOWS","MAC","NONE"]},"barcode1":{"type":"string","example":"5 12345 678900"},"barcode2":{"type":"string","example":"5 12345 678900"},"assetTag":{"type":"string","example":"304822"},"remoteManagement":{"$ref":"#/components/schemas/ComputerRemoteManagementCreate"},"supervised":{"type":"boolean","example":true},"mdmCapable":{"type":"boolean","example":true},"reportDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastContactTime":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastCloudBackupDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastEnrolledDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"distributionPointId":{"type":"string","example":"1"},"siteId":{"type":"string","example":"1"},"itunesStoreAccountActive":{"type":"boolean","example":true},"enrolledViaAutomatedDeviceEnrollment":{"type":"boolean","example":true},"userApprovedMdm":{"type":"boolean","example":true},"declarativeDeviceManagementEnabled":{"type":"boolean","example":true}}},"ComputerGeneralUpdate":{"type":"object","properties":{"name":{"type":"string","example":"Boalime"},"lastIpAddress":{"type":"string","example":"247.185.82.186"},"barcode1":{"type":"string","example":"5 12345 678900"},"barcode2":{"type":"string","example":"5 12345 678900"},"assetTag":{"type":"string","example":"304822"},"managed":{"type":"boolean","example":true},"siteId":{"type":"string","example":"1"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerGroup":{"type":"object","properties":{"id":{"minLength":1,"type":"string","example":"1"},"name":{"type":"string","example":"All Managed Computers"},"description":{"type":"string","example":"A group containing all managed computers"},"smartGroup":{"type":"boolean","example":true}}},"ComputerHardware":{"type":"object","properties":{"make":{"type":"string","readOnly":true,"example":"Apple"},"model":{"type":"string","readOnly":true,"example":"13-inch MacBook Pro (Mid 2012)"},"modelIdentifier":{"type":"string","readOnly":true,"example":"MacBookPro9,2"},"serialNumber":{"type":"string","readOnly":true,"example":"C02ZC2QYLVDL"},"processorSpeedMhz":{"type":"integer","description":"Processor Speed in MHz.","format":"int64","readOnly":true,"example":2100},"processorCount":{"type":"integer","readOnly":true,"example":2},"coreCount":{"type":"integer","readOnly":true,"example":2},"processorType":{"type":"string","readOnly":true,"example":"Intel Core i5"},"processorArchitecture":{"type":"string","readOnly":true,"example":"i386"},"busSpeedMhz":{"type":"integer","format":"int64","readOnly":true,"example":2133},"cacheSizeKilobytes":{"type":"integer","description":"Cache Size in KB.","format":"int64","readOnly":true,"example":3072},"networkAdapterType":{"type":"string","example":"Foo"},"macAddress":{"type":"string","example":"6A:2C:4B:B7:65:B5"},"altNetworkAdapterType":{"type":"string","example":"Bar"},"altMacAddress":{"type":"string","example":"82:45:58:44:dc:01"},"totalRamMegabytes":{"type":"integer","description":"Total RAM Size in MB.","format":"int64","readOnly":true,"example":4096},"openRamSlots":{"type":"integer","description":"Available RAM slots.","readOnly":true,"example":0},"batteryCapacityPercent":{"maximum":100,"minimum":0,"type":"integer","description":"Remaining percentage of battery power.","readOnly":true,"example":85},"batteryHealth":{"type":"string","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","readOnly":true,"enum":["NON_GENUINE","NORMAL","SERVICE_RECOMMENDED","UNKNOWN","UNSUPPORTED"],"default":"UNKNOWN"},"smcVersion":{"type":"string","readOnly":true,"example":"2.2f38"},"nicSpeed":{"type":"string","readOnly":true,"example":"N/A"},"opticalDrive":{"type":"string","readOnly":true,"example":"MATSHITA DVD-R UJ-8A8"},"bootRom":{"type":"string","readOnly":true,"example":"MBP91.00D3.B08"},"bleCapable":{"type":"boolean","readOnly":true,"example":false},"supportsIosAppInstalls":{"type":"boolean","readOnly":true,"example":false},"appleSilicon":{"type":"boolean","readOnly":true,"example":false},"provisioningUdid":{"type":"string","readOnly":true,"example":"00000AAA888-IH866799UUJD991"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerHardwareCreate":{"type":"object","properties":{"make":{"type":"string","example":"Apple"},"model":{"type":"string","example":"13-inch MacBook Pro (Mid 2012)"},"modelIdentifier":{"type":"string","example":"MacBookPro9,2"},"serialNumber":{"type":"string","example":"C02ZC2QYLVDL"},"processorSpeedMhz":{"type":"integer","description":"Processor Speed in MHz.","format":"int64","example":2100},"processorCount":{"type":"integer","example":2},"coreCount":{"type":"integer","example":2},"processorType":{"type":"string","example":"Intel Core i5"},"processorArchitecture":{"type":"string","example":"i386"},"busSpeedMhz":{"type":"integer","format":"int64","example":2133},"cacheSizeKilobytes":{"type":"integer","description":"Cache Size in KB.","format":"int64","example":3072},"networkAdapterType":{"type":"string","example":"Foo"},"macAddress":{"type":"string","example":"6A:2C:4B:B7:65:B5"},"altNetworkAdapterType":{"type":"string","example":"Bar"},"altMacAddress":{"type":"string","example":"82:45:58:44:dc:01"},"totalRamMegabytes":{"type":"integer","description":"Total RAM Size in MB.","format":"int64","example":4096},"openRamSlots":{"type":"integer","description":"Available RAM slots.","example":0},"batteryCapacityPercent":{"maximum":100,"minimum":0,"type":"integer","description":"Remaining percentage of battery power.","example":85},"batteryHealth":{"type":"string","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","enum":["NON_GENUINE","NORMAL","SERVICE_RECOMMENDED","UNKNOWN","UNSUPPORTED"],"default":"UNKNOWN"},"smcVersion":{"type":"string","example":"2.2f38"},"nicSpeed":{"type":"string","example":"N/A"},"opticalDrive":{"type":"string","example":"MATSHITA DVD-R UJ-8A8"},"bootRom":{"type":"string","example":"MBP91.00D3.B08"},"bleCapable":{"type":"boolean","example":false},"supportsIosAppInstalls":{"type":"boolean","example":false},"appleSilicon":{"type":"boolean","example":false}}},"ComputerHardwareUpdate":{"type":"object","properties":{"networkAdapterType":{"type":"string","example":"Foo"},"macAddress":{"type":"string","example":"6A:2C:4B:B7:65:B5"},"altNetworkAdapterType":{"type":"string","example":"Bar"},"altMacAddress":{"type":"string","example":"82:45:58:44:dc:01"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerIbeacon":{"type":"object","properties":{"name":{"type":"string","example":"room A"}}},"ComputerInventory":{"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"udid":{"type":"string","example":"123"},"general":{"$ref":"#/components/schemas/ComputerGeneral"},"diskEncryption":{"$ref":"#/components/schemas/ComputerDiskEncryption"},"purchasing":{"$ref":"#/components/schemas/ComputerPurchase"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/ComputerApplication"}},"storage":{"$ref":"#/components/schemas/ComputerStorage"},"userAndLocation":{"$ref":"#/components/schemas/ComputerUserAndLocation"},"configurationProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ComputerConfigurationProfile"}},"printers":{"type":"array","items":{"$ref":"#/components/schemas/ComputerPrinter"}},"services":{"type":"array","items":{"$ref":"#/components/schemas/ComputerService"}},"hardware":{"$ref":"#/components/schemas/ComputerHardware"},"localUserAccounts":{"type":"array","items":{"$ref":"#/components/schemas/ComputerLocalUserAccount"}},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/ComputerCertificate"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ComputerAttachment"}},"plugins":{"type":"array","items":{"type":"object"}},"packageReceipts":{"$ref":"#/components/schemas/ComputerPackageReceipts"},"fonts":{"type":"array","items":{"$ref":"#/components/schemas/ComputerFont"}},"security":{"$ref":"#/components/schemas/ComputerSecurity"},"operatingSystem":{"$ref":"#/components/schemas/ComputerOperatingSystem"},"licensedSoftware":{"type":"array","items":{"$ref":"#/components/schemas/ComputerLicensedSoftware"}},"ibeacons":{"type":"array","items":{"$ref":"#/components/schemas/ComputerIbeacon"}},"softwareUpdates":{"type":"array","items":{"$ref":"#/components/schemas/ComputerSoftwareUpdate"}},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}},"contentCaching":{"$ref":"#/components/schemas/ComputerContentCaching"},"groupMemberships":{"type":"array","items":{"$ref":"#/components/schemas/GroupMembership"}}}},"ComputerInventoryCreateRequest":{"type":"object","properties":{"udid":{"type":"string","nullable":true,"example":"45436edf-864e-4364-982a-330b01d39e65"},"general":{"$ref":"#/components/schemas/ComputerGeneralCreate"},"applications":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerApplicationCreate"}},"storage":{"$ref":"#/components/schemas/ComputerStorageCreate"},"configurationProfiles":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerConfigurationProfileCreate"}},"printers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerPrinterCreate"}},"services":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerServiceCreate"}},"localUserAccounts":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerLocalUserAccountCreate"}},"certificates":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerCertificateCreate"}},"plugins":{"type":"array","nullable":true,"example":[],"items":{"type":"object"}},"packageReceipts":{"$ref":"#/components/schemas/ComputerPackageReceiptsCreate"},"fonts":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerFontCreate"}},"security":{"$ref":"#/components/schemas/ComputerSecurityCreate"},"softwareUpdates":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerSoftwareUpdateCreate"}},"purchasing":{"$ref":"#/components/schemas/ComputerPurchaseCreate"},"userAndLocation":{"$ref":"#/components/schemas/ComputerUserAndLocationCreate"},"hardware":{"$ref":"#/components/schemas/ComputerHardwareCreate"},"operatingSystem":{"$ref":"#/components/schemas/ComputerOperatingSystemCreate"}}},"ComputerInventorySearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/ComputerInventory"}}}},"ComputerInventoryUpdateRequest":{"type":"object","properties":{"udid":{"type":"string","example":"45436edf-864e-4364-982a-330b01d39e65"},"general":{"$ref":"#/components/schemas/ComputerGeneralUpdate"},"purchasing":{"$ref":"#/components/schemas/ComputerPurchase"},"userAndLocation":{"$ref":"#/components/schemas/ComputerUserAndLocation"},"hardware":{"$ref":"#/components/schemas/ComputerHardwareUpdate"},"operatingSystem":{"$ref":"#/components/schemas/ComputerOperatingSystemUpdate"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerLicensedSoftware":{"type":"object","properties":{"id":{"type":"string","example":"1"},"name":{"type":"string","example":"Microsoft Word"}}},"ComputerLocalUserAccount":{"type":"object","properties":{"uid":{"type":"string","example":"501"},"userGuid":{"type":"string","readOnly":true,"example":"844F1177-0CF5-40C6-901F-38EDD9969C1C"},"username":{"type":"string","example":"jamf"},"fullName":{"type":"string","example":"John Jamf"},"admin":{"type":"boolean","example":true},"homeDirectory":{"type":"string","example":"/Users/jamf"},"homeDirectorySizeMb":{"type":"integer","description":"Home directory size in MB.","format":"int64","readOnly":true,"example":131072},"fileVault2Enabled":{"type":"boolean","example":true},"userAccountType":{"type":"string","example":"LOCAL","enum":["LOCAL","MOBILE","UNKNOWN"]},"passwordMinLength":{"type":"integer","example":4},"passwordMaxAge":{"type":"integer","example":5},"passwordMinComplexCharacters":{"type":"integer","example":5},"passwordHistoryDepth":{"type":"integer","example":5},"passwordRequireAlphanumeric":{"type":"boolean","example":true},"computerAzureActiveDirectoryId":{"type":"string","example":"1"},"userAzureActiveDirectoryId":{"type":"string","example":"1"},"azureActiveDirectoryId":{"type":"string","example":"ACTIVATED","enum":["ACTIVATED","DEACTIVATED","UNRESPONSIVE","UNKNOWN"]}}},"ComputerLocalUserAccountCreate":{"type":"object","properties":{"uid":{"type":"string","nullable":true,"example":"501"},"userGuid":{"type":"string","nullable":true,"example":"844F1177-0CF5-40C6-901F-38EDD9969C1C"},"username":{"type":"string","nullable":true,"example":"jamf"},"fullName":{"type":"string","nullable":true,"example":"John Jamf"},"admin":{"type":"boolean","nullable":true,"example":true},"homeDirectory":{"type":"string","nullable":true,"example":"/Users/jamf"},"homeDirectorySizeMb":{"type":"integer","description":"Home directory size in MB.","format":"int64","nullable":true,"example":131072},"fileVault2Enabled":{"type":"boolean","nullable":true,"example":true},"userAccountType":{"type":"string","nullable":true,"example":"LOCAL","enum":["LOCAL","MOBILE","UNKNOWN"]},"passwordMinLength":{"type":"integer","nullable":true,"example":4},"passwordMaxAge":{"type":"integer","nullable":true,"example":5},"passwordMinComplexCharacters":{"type":"integer","nullable":true,"example":5},"passwordHistoryDepth":{"type":"integer","nullable":true,"example":5},"passwordRequireAlphanumeric":{"type":"boolean","nullable":true,"example":true},"computerAzureActiveDirectoryId":{"type":"string","nullable":true,"example":"1"},"userAzureActiveDirectoryId":{"type":"string","nullable":true,"example":"1"}}},"ComputerMdmCapability":{"type":"object","properties":{"capable":{"type":"boolean","example":true},"capableUsers":{"type":"array","description":"Deprecated. Use userManagementInfo instead.","example":["admin","rootadmin"],"deprecated":true,"items":{"type":"string"}},"userManagementInfo":{"type":"array","items":{"$ref":"#/components/schemas/ComputerUserManagementInfo"}}}},"ComputerOperatingSystem":{"type":"object","properties":{"name":{"type":"string","readOnly":true,"example":"Mac OS X"},"version":{"type":"string","readOnly":true,"example":"10.9.5"},"build":{"type":"string","readOnly":true,"example":"13A603"},"supplementalBuildVersion":{"type":"string","description":"Collected for macOS 13.0 or later","readOnly":true,"example":"13A953"},"rapidSecurityResponse":{"type":"string","description":"Collected for macOS 13.0 or later","readOnly":true,"example":"(a)"},"activeDirectoryStatus":{"type":"string","readOnly":true,"example":"Not Bound"},"fileVault2Status":{"type":"string","example":"ALL_ENCRYPTED","enum":["NOT_APPLICABLE","NOT_ENCRYPTED","BOOT_ENCRYPTED","SOME_ENCRYPTED","ALL_ENCRYPTED"]},"softwareUpdateDeviceId":{"type":"string","readOnly":true,"example":"J132AP"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerOperatingSystemCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Mac OS X"},"version":{"type":"string","nullable":true,"example":"10.9.5"},"build":{"type":"string","nullable":true,"example":"13A603"},"supplementalBuildVersion":{"type":"string","nullable":true,"example":"13A953"},"rapidSecurityResponse":{"type":"string","nullable":true,"example":"(a)"},"activeDirectoryStatus":{"type":"string","nullable":true,"example":"Not Bound"},"softwareUpdateDeviceId":{"type":"string","nullable":true,"example":"J132AP"}}},"ComputerOperatingSystemUpdate":{"type":"object","properties":{"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerPackageReceipts":{"type":"object","properties":{"installedByJamfPro":{"type":"array","items":{"type":"string","example":"com.jamf.protect.JamfProtect"}},"installedByInstallerSwu":{"type":"array","items":{"type":"string","example":"com.apple.pkg.Core"}},"cached":{"type":"array","items":{"type":"string","example":"com.jamf.protect.JamfProtect"}}},"description":"All package receipts are listed by their package name"},"ComputerPackageReceiptsCreate":{"type":"object","properties":{"installedByJamfPro":{"type":"array","nullable":true,"items":{"type":"string","example":"com.jamf.protect.JamfProtect"}},"installedByInstallerSwu":{"type":"array","nullable":true,"items":{"type":"string","example":"com.apple.pkg.Core"}},"cached":{"type":"array","nullable":true,"items":{"type":"string","example":"com.jamf.protect.JamfProtect"}}},"description":"All package receipts are listed by their package name"},"ComputerPartition":{"type":"object","properties":{"name":{"type":"string","readOnly":true,"example":"Foo"},"sizeMegabytes":{"type":"integer","description":"Partition Size in MB.","format":"int64","readOnly":true,"example":262144},"availableMegabytes":{"type":"integer","description":"Available space in MB.","format":"int64","readOnly":true,"example":131072},"partitionType":{"type":"string","readOnly":true,"example":"BOOT","enum":["BOOT","RECOVERY","OTHER"]},"percentUsed":{"maximum":100,"minimum":0,"type":"integer","description":"Percentage of space used.","readOnly":true,"example":25},"fileVault2State":{"$ref":"#/components/schemas/ComputerPartitionFileVault2State"},"fileVault2ProgressPercent":{"type":"integer","description":"Percentage progress of current FileVault 2 operation.","nullable":true,"example":45},"lvmManaged":{"type":"boolean","readOnly":true,"example":true}}},"ComputerPartitionCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Foo"},"sizeMegabytes":{"type":"integer","description":"Partition Size in MB.","format":"int64","nullable":true,"example":262144},"availableMegabytes":{"type":"integer","description":"Available space in MB.","format":"int64","nullable":true,"example":131072},"partitionType":{"type":"string","nullable":true,"example":"BOOT","enum":["BOOT","RECOVERY","OTHER"]},"percentUsed":{"maximum":100,"minimum":0,"type":"integer","description":"Percentage of space used.","nullable":true,"example":25},"fileVault2State":{"$ref":"#/components/schemas/ComputerPartitionFileVault2State"},"fileVault2ProgressPercent":{"type":"integer","description":"Percentage progress of current FileVault 2 operation.","nullable":true,"example":45},"lvmManaged":{"type":"boolean","nullable":true,"example":true}}},"ComputerPartitionEncryption":{"type":"object","properties":{"partitionName":{"type":"string","example":"main"},"partitionFileVault2State":{"$ref":"#/components/schemas/ComputerPartitionFileVault2State"},"partitionFileVault2Percent":{"type":"integer","example":100}}},"ComputerPartitionFileVault2State":{"type":"string","example":"ENCRYPTING","enum":["UNKNOWN","UNENCRYPTED","INELIGIBLE","DECRYPTED","DECRYPTING","ENCRYPTED","ENCRYPTING","RESTART_NEEDED","OPTIMIZING","DECRYPTING_PAUSED","ENCRYPTING_PAUSED"]},"ComputerPrestageSearchResultsV3":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/GetComputerPrestageV3"}}}},"ComputerPrestageV3":{"allOf":[{"$ref":"#/components/schemas/DeviceEnrollmentPrestageV2"},{"required":["customPackageDistributionPointId","customPackageIds","installProfilesDuringSetup","prestageInstalledProfileIds"],"type":"object","properties":{"installProfilesDuringSetup":{"type":"boolean","nullable":false,"example":true},"prestageInstalledProfileIds":{"type":"array","items":{"type":"string","example":"1"}},"customPackageIds":{"type":"array","items":{"type":"string","example":"1"}},"customPackageDistributionPointId":{"type":"string","example":"1"},"enableRecoveryLock":{"type":"boolean","nullable":false,"example":true},"recoveryLockPasswordType":{"type":"string","nullable":false,"example":"MANUAL","enum":["MANUAL","RANDOM"]},"rotateRecoveryLockPassword":{"type":"boolean","nullable":false,"example":true},"prestageMinimumOsTargetVersionType":{"type":"string","nullable":false,"example":"MINIMUM_OS_LATEST_VERSION","enum":["NO_ENFORCEMENT","MINIMUM_OS_LATEST_VERSION","MINIMUM_OS_LATEST_MAJOR_VERSION","MINIMUM_OS_LATEST_MINOR_VERSION","MINIMUM_OS_SPECIFIC_VERSION"]},"minimumOsSpecificVersion":{"minLength":0,"type":"string","nullable":false,"example":"17.1"},"pssoEnabled":{"type":"boolean","description":"Indicates whether Platform SSO (PSSO) is enabled for this computer prestage, regardless of Device first or Identity first workflows. When enabled, the PSSO application will be deployed to devices during the setup process to facilitate single sign-on (SSO) for users.","example":true,"default":false},"platformSsoAppBundleId":{"type":"string","description":"The bundle identifier for the Platform SSO (PSSO) application Device first workflow. This identifier is used to specify which PSSO app should be deployed to devices during the setup process.","example":"com.okta.mobile"},"profileUrl":{"type":"string","description":"The URL to the configuration profile for the Platform SSO (PSSO) application Identity first workflow. This URL is used when deploying the PSSO app to devices during the setup process. Users should use either profileUrl or populate pssoConfigProfileId, but not both.","nullable":true,"example":"https://mdmserver.example.com/psso.mobileconfig"},"pssoConfigProfileId":{"type":"string","description":"The identifier for the configuration profile associated with the Platform SSO (PSSO) application Identity first workflow. This ID is used to specify which configuration profile should be applied to devices during the setup process when PSSO is enabled. Users should use either pssoConfigProfileId or populate profileUrl, but not both.","nullable":true,"example":"1"},"manifestUrl":{"type":"string","description":"The URL to the manifest file for the Platform SSO (PSSO) application Identity first workflow. This URL is used when deploying the PSSO app to devices during the setup process.","nullable":true,"example":"https://mdmserver.example.com/psso-app.plist"}}}]},"ComputerPrinter":{"type":"object","properties":{"name":{"type":"string","example":"My Printer"},"type":{"type":"string","example":"XYZ 1122"},"uri":{"type":"string","example":"ipp://10.0.0.5"},"location":{"type":"string","example":"7th floor"}}},"ComputerPrinterCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"My Printer"},"type":{"type":"string","nullable":true,"example":"XYZ 1122"},"uri":{"type":"string","nullable":true,"example":"ipp://10.0.0.5"},"location":{"type":"string","nullable":true,"example":"7th floor"}}},"ComputerPurchase":{"type":"object","properties":{"leased":{"type":"boolean","example":true},"purchased":{"type":"boolean","example":true},"poNumber":{"type":"string","example":"53-1"},"poDate":{"type":"string","format":"date","example":"2019-01-01"},"vendor":{"type":"string","example":"Example Vendor"},"warrantyDate":{"type":"string","format":"date","example":"2019-01-01"},"appleCareId":{"type":"string","example":"abcd"},"leaseDate":{"type":"string","format":"date","example":"2019-01-01"},"purchasePrice":{"type":"string","example":"$500"},"lifeExpectancy":{"type":"integer","example":5},"purchasingAccount":{"type":"string","example":"admin"},"purchasingContact":{"type":"string","example":"true"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerPurchaseCreate":{"type":"object","properties":{"leased":{"type":"boolean","nullable":true,"example":true},"purchased":{"type":"boolean","nullable":true,"example":true},"poNumber":{"type":"string","nullable":true,"example":"53-1"},"poDate":{"type":"string","format":"date","nullable":true,"example":"2019-01-01"},"vendor":{"type":"string","nullable":true,"example":"Example Vendor"},"warrantyDate":{"type":"string","format":"date","nullable":true,"example":"2019-01-01"},"appleCareId":{"type":"string","nullable":true,"example":"abcd"},"leaseDate":{"type":"string","format":"date","nullable":true,"example":"2019-01-01"},"purchasePrice":{"type":"string","nullable":true,"example":"$500"},"lifeExpectancy":{"type":"integer","nullable":true,"example":5},"purchasingAccount":{"type":"string","nullable":true,"example":"admin"},"purchasingContact":{"type":"string","nullable":true,"example":"true"}}},"ComputerRemoteManagement":{"type":"object","properties":{"managed":{"type":"boolean","example":true},"managementUsername":{"type":"string","description":"This field always returns null, please use /local-admin-password/ endpoint instead.","example":"rootname","deprecated":true}}},"ComputerRemoteManagementCreate":{"type":"object","properties":{"managed":{"type":"boolean","nullable":true,"example":true}}},"ComputerSection":{"type":"string","example":"general","enum":["GENERAL","DISK_ENCRYPTION","PURCHASING","APPLICATIONS","STORAGE","USER_AND_LOCATION","CONFIGURATION_PROFILES","PRINTERS","SERVICES","HARDWARE","LOCAL_USER_ACCOUNTS","CERTIFICATES","ATTACHMENTS","PLUGINS","PACKAGE_RECEIPTS","FONTS","SECURITY","OPERATING_SYSTEM","LICENSED_SOFTWARE","IBEACONS","SOFTWARE_UPDATES","EXTENSION_ATTRIBUTES","CONTENT_CACHING","GROUP_MEMBERSHIPS"]},"ComputerSecurity":{"type":"object","properties":{"sipStatus":{"type":"string","example":"ENABLED","enum":["NOT_COLLECTED","NOT_AVAILABLE","DISABLED","ENABLED"]},"gatekeeperStatus":{"type":"string","example":"APP_STORE_AND_IDENTIFIED_DEVELOPERS","enum":["NOT_COLLECTED","DISABLED","APP_STORE_AND_IDENTIFIED_DEVELOPERS","APP_STORE"]},"xprotectVersion":{"type":"string","example":"1.2.3"},"autoLoginDisabled":{"type":"boolean","example":false},"remoteDesktopEnabled":{"type":"boolean","description":"Collected for macOS 10.14.4 or later","example":true},"activationLockEnabled":{"type":"boolean","description":"Collected for macOS 10.15.0 or later","example":true},"recoveryLockEnabled":{"type":"boolean","example":true},"firewallEnabled":{"type":"boolean","example":true},"secureBootLevel":{"type":"string","description":"Collected for macOS 10.15.0 or later","example":"FULL_SECURITY","enum":["NO_SECURITY","MEDIUM_SECURITY","FULL_SECURITY","NOT_SUPPORTED","UNKNOWN"]},"externalBootLevel":{"type":"string","description":"Collected for macOS 10.15.0 or later","example":"ALLOW_BOOTING_FROM_EXTERNAL_MEDIA","enum":["ALLOW_BOOTING_FROM_EXTERNAL_MEDIA","DISALLOW_BOOTING_FROM_EXTERNAL_MEDIA","NOT_SUPPORTED","UNKNOWN"]},"bootstrapTokenAllowed":{"type":"boolean","description":"Collected for macOS 11 or later","example":true},"bootstrapTokenEscrowedStatus":{"type":"string","description":"Collected for macOS 11 or later","example":"ESCROWED","enum":["ESCROWED","NOT_ESCROWED","NOT_SUPPORTED"]},"lastAttestationAttempt":{"type":"string","readOnly":true,"example":"1970-01-01T00:00:00Z"},"lastSuccessfulAttestation":{"type":"string","readOnly":true,"example":"1970-01-01T00:00:00Z"},"attestationStatus":{"type":"string","readOnly":true,"example":"PENDING","enum":["PENDING","SUCCESS","CERTIFICATE_INVALID","DEVICE_PROPERTIES_MISMATCH","MDA_UNSUPPORTED_DUE_TO_HARDWARE","MDA_UNSUPPORTED_DUE_TO_SOFTWARE"]},"lockdownModeEnabled":{"type":"boolean","description":"Whether Lockdown Mode is enabled.","example":false}}},"ComputerSecurityCreate":{"type":"object","properties":{"sipStatus":{"type":"string","nullable":true,"example":"ENABLED","enum":["NOT_COLLECTED","NOT_AVAILABLE","DISABLED","ENABLED"]},"gatekeeperStatus":{"type":"string","nullable":true,"example":"APP_STORE_AND_IDENTIFIED_DEVELOPERS","enum":["NOT_COLLECTED","DISABLED","APP_STORE_AND_IDENTIFIED_DEVELOPERS","APP_STORE"]},"xprotectVersion":{"type":"string","nullable":true,"example":"1.2.3"},"activationLockEnabled":{"type":"boolean","nullable":true,"example":true},"recoveryLockEnabled":{"type":"boolean","nullable":true,"example":true},"firewallEnabled":{"type":"boolean","nullable":true,"example":true},"secureBootLevel":{"type":"string","nullable":true,"example":"FULL_SECURITY","enum":["NO_SECURITY","MEDIUM_SECURITY","FULL_SECURITY","NOT_SUPPORTED","UNKNOWN"]},"externalBootLevel":{"type":"string","nullable":true,"example":"ALLOW_BOOTING_FROM_EXTERNAL_MEDIA","enum":["ALLOW_BOOTING_FROM_EXTERNAL_MEDIA","DISALLOW_BOOTING_FROM_EXTERNAL_MEDIA","NOT_SUPPORTED","UNKNOWN"]}}},"ComputerService":{"type":"object","properties":{"name":{"type":"string","example":"SomeService"}}},"ComputerServiceCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"SomeService"}}},"ComputerSite":{"type":"object","properties":{"id":{"type":"string","nullable":false,"example":"1"},"name":{"type":"string","nullable":false,"example":"Eau Claire"}}},"ComputerSmartGroupCriteriaV2":{"required":["andOr","name","priority","searchType","value"],"type":"object","properties":{"name":{"maxLength":255,"type":"string","description":"The field to search on (e.g., Operating System Version, Computer Name, etc.)","example":"Model"},"priority":{"type":"integer","description":"The priority order of this criterion (must start at 0 and increment by 1 per new criteria)","example":0},"andOr":{"type":"string","description":"Whether this criterion should be ANDed or ORed with the previous criterion. Must be exactly \"AND\" or \"OR\" (case-insensitive input accepted, stored as lowercase).","example":"and","enum":["and","or"]},"searchType":{"type":"string","description":"The type of search to perform (e.g., is, is not, like, greater than or equal, etc.)","example":"greater than or equal"},"value":{"maxLength":255,"type":"string","description":"The value to search for","example":"14.0"},"openingParen":{"type":"boolean","description":"Whether to add an opening parenthesis before this criterion","example":false},"closingParen":{"type":"boolean","description":"Whether to add a closing parenthesis after this criterion","example":false}}},"ComputerSoftwareUpdate":{"type":"object","properties":{"name":{"type":"string","example":"BEdit"},"version":{"type":"string","example":"1.15.2"},"packageName":{"type":"string","example":"com.apple.pkg.AdditionalEssentials"}}},"ComputerSoftwareUpdateCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"BEdit"},"version":{"type":"string","nullable":true,"example":"1.15.2"},"packageName":{"type":"string","nullable":true,"example":"com.apple.pkg.AdditionalEssentials"}}},"ComputerStorage":{"type":"object","properties":{"bootDriveAvailableSpaceMegabytes":{"type":"integer","format":"int64","readOnly":true,"example":3072},"disks":{"type":"array","items":{"$ref":"#/components/schemas/ComputerDisk"}}}},"ComputerStorageCreate":{"type":"object","properties":{"disks":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerDiskCreate"}}}},"ComputerUserAndLocation":{"type":"object","properties":{"username":{"type":"string","example":"Madison Anderson"},"realname":{"type":"string","example":"13-inch MacBook"},"email":{"type":"string","example":"email@com.pl"},"position":{"type":"string","example":"IT Team Lead"},"phone":{"type":"string","example":"123-456-789"},"departmentId":{"type":"string","example":"1"},"buildingId":{"type":"string","example":"1"},"room":{"type":"string","example":"5"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerUserAndLocationCreate":{"type":"object","properties":{"username":{"type":"string","nullable":true,"example":"Madison Anderson"},"realname":{"type":"string","nullable":true,"example":"13-inch MacBook"},"email":{"type":"string","nullable":true,"example":"email@com.pl"},"position":{"type":"string","nullable":true,"example":"IT Team Lead"},"phone":{"type":"string","nullable":true,"example":"123-456-789"},"departmentId":{"type":"string","nullable":true,"example":"1"},"buildingId":{"type":"string","nullable":true,"example":"1"},"room":{"type":"string","nullable":true,"example":"5"}}},"ComputerUserManagementInfo":{"required":["capableUser","managementId"],"type":"object","properties":{"capableUser":{"type":"string","example":"admin"},"managementId":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000"}},"example":[{"capableUser":"admin","managementId":"123e4567-e89b-42d3-a456-426614174000"},{"capableUser":"rootadmin","managementId":"123e4567-e89b-42d3-a456-426614174001"}]},"ConfigurationProfile":{"type":"object","properties":{"displayName":{"type":"string","example":"Test WiFi"},"version":{"type":"string","example":"1"},"uuid":{"type":"string","example":"D29DD9FB-0D5B-422F-A3A2-ABBC5848E949"},"identifier":{"type":"string","example":"ac2-server4.D0EFAC2D-326C-4BB6-87E6-2BCB88490AAA"}}},"ConfigurationSearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/CloudIdPCommonResponse"}}},"description":"A list with Cloud Identity Providers informations about configurations"},"Department":{"required":["name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"maxLength":225,"minLength":1,"type":"string","example":"Department of Redundancy Department"}}},"DepartmentsSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Department"}}}},"DetailsV2":{"type":"object","properties":{"model":{"type":"string","example":"iPad 5th Generation (Wi-Fi)"},"modelIdentifier":{"type":"string","example":"ipad6,11"},"modelNumber":{"type":"string","example":"MP2F2LL"},"supervised":{"type":"boolean","example":true},"batteryLevel":{"type":"integer","example":100},"batteryHealth":{"type":"string","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","enum":["NON_GENUINE","NORMAL","SERVICE_RECOMMENDED","UNKNOWN","UNSUPPORTED"],"default":"UNKNOWN"},"lastBackupTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56Z"},"capacityMb":{"type":"integer","example":27503},"availableMb":{"type":"integer","example":26646},"percentageUsed":{"type":"integer","example":3},"shared":{"type":"boolean","example":false},"deviceLocatorServiceEnabled":{"type":"boolean","example":false},"doNotDisturbEnabled":{"type":"boolean","example":false},"cloudBackupEnabled":{"type":"boolean","example":false},"lastCloudBackupTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56.307Z"},"locationServicesEnabled":{"type":"boolean","example":false},"iTunesStoreAccountActive":{"type":"boolean","example":false},"bleCapable":{"type":"boolean","example":false},"unlockToken":{"type":"string","example":"VU5MT0NLVE9LRU4="},"returnToServiceEnabled":{"type":"boolean","description":"Whether Return to Service is enabled.","example":false},"systemHealth":{"$ref":"#/components/schemas/SystemHealthV2"},"computer":{"$ref":"#/components/schemas/IdAndNameV2"},"purchasing":{"$ref":"#/components/schemas/PurchasingV2"},"security":{"$ref":"#/components/schemas/SecurityV2"},"network":{"$ref":"#/components/schemas/NetworkV2"},"serviceSubscriptions":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceServiceSubscriptions"}},"applications":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceApplication"}},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceCertificateV2"}},"ebooks":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceEbook"}},"mdmCapableUsers":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceMdmCapableUser"}},"configurationProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ConfigurationProfile"}},"provisioningProfiles":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceProvisioningProfiles"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceAttachmentV2"}}},"description":"will be populated if the type is ios or visionos."},"DeviceEnrollmentDevice":{"type":"object","properties":{"id":{"type":"string","example":"1"},"deviceEnrollmentProgramInstanceId":{"type":"string","example":"1"},"prestageId":{"type":"string","example":"1"},"serialNumber":{"type":"string","example":"R7QFDE2YCFN4"},"description":{"type":"string","example":"MBP 15.4"},"model":{"type":"string","example":"Macbook Pro 15 Retina"},"color":{"type":"string","example":"BLACK"},"assetTag":{"type":"string","example":"ACME-1234"},"profileStatus":{"type":"string","example":"ASSIGNED","enum":["EMPTY","ASSIGNED","PUSHED","REMOVED"]},"syncState":{"$ref":"#/components/schemas/AssignRemoveProfileResponseSyncState"},"profileAssignTime":{"type":"string","example":"2000-10-30T18:00:00-00:00"},"profilePushTime":{"type":"string","example":"2000-10-30T18:00:00-00:00"},"deviceAssignedDate":{"type":"string","example":"2000-10-30T18:00:00-00:00"}}},"DeviceEnrollmentDeviceSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeviceEnrollmentDevice"}}}},"DeviceEnrollmentInstance":{"required":["name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Example Device Enrollment Instance"},"supervisionIdentityId":{"type":"string","example":"1"},"siteId":{"type":"string","example":"-1"},"serverName":{"type":"string","readOnly":true,"example":"Acme ASM"},"serverUuid":{"type":"string","readOnly":true,"example":"BASD08C11F3C455"},"adminId":{"type":"string","readOnly":true,"example":"admin1234"},"orgName":{"type":"string","readOnly":true,"example":"Acme Enterprises"},"orgEmail":{"type":"string","readOnly":true,"example":"admin@test.com"},"orgPhone":{"type":"string","readOnly":true,"example":"555-0123"},"orgAddress":{"type":"string","readOnly":true,"example":"124 Conch Street, Bikini Bottom, Pacific Ocean"},"tokenExpirationDate":{"type":"string","readOnly":true,"example":"2000-10-30"}}},"DeviceEnrollmentInstanceSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/DeviceEnrollmentInstance"}}}},"DeviceEnrollmentPrestageV2":{"required":["authenticationPrompt","autoAdvanceSetup","defaultPrestage","department","deviceEnrollmentProgramInstanceId","displayName","enableDeviceBasedActivationLock","enrollmentSiteId","keepExistingLocationInformation","keepExistingSiteMembership","locationInformation","mandatory","mdmRemovable","preventActivationLock","purchasingInformation","requireAuthentication","supportEmailAddress","supportPhoneNumber"],"type":"object","properties":{"displayName":{"type":"string","example":"Example Mobile Prestage Name"},"mandatory":{"type":"boolean","example":false},"mdmRemovable":{"type":"boolean","example":true},"supportPhoneNumber":{"type":"string","example":"5555555555"},"supportEmailAddress":{"type":"string","example":"example@example.com"},"department":{"type":"string","example":"Oxbow"},"defaultPrestage":{"type":"boolean","example":false},"enrollmentSiteId":{"type":"string","example":"-1"},"keepExistingSiteMembership":{"type":"boolean","example":true},"keepExistingLocationInformation":{"type":"boolean","example":true},"requireAuthentication":{"type":"boolean","example":true},"authenticationPrompt":{"type":"string","example":"LDAP authentication prompt"},"preventActivationLock":{"type":"boolean","example":true},"enableDeviceBasedActivationLock":{"type":"boolean","example":true},"deviceEnrollmentProgramInstanceId":{"type":"string","example":"5"},"skipSetupItems":{"type":"object","additionalProperties":{"type":"boolean"},"example":{"Location":true,"Privacy":false}},"locationInformation":{"$ref":"#/components/schemas/LocationInformationV2"},"purchasingInformation":{"$ref":"#/components/schemas/PrestagePurchasingInformationV2"},"anchorCertificates":{"type":"array","description":"The Base64 encoded PEM Certificate","items":{"type":"string","example":"xNE5HRgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="}},"enrollmentCustomizationId":{"type":"string","example":"2"},"language":{"type":"string","example":"en"},"region":{"type":"string","example":"US"},"autoAdvanceSetup":{"type":"boolean","example":true}}},"DockItem":{"required":["name","path","type"],"type":"object","properties":{"id":{"minimum":1,"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"DockItem Name"},"type":{"type":"string","example":"FILE","enum":["APP","FILE","FOLDER"]},"path":{"type":"string","example":"file://localhost/Applications/iTunes.app"},"contents":{"type":"string","readOnly":true,"example":"<dict><key>GUID</key><integer>-91117049</integer><key>tile-data</key><dict><key>file-data</key><dict><key>_CFURLString</key><string>file://localhost/Applications/iTunes.app</string><key>_CFURLStringType</key><integer>15</integer></dict><key>file-label</key><string>MyDockItem2</string></dict><key>tile-type</key><string>directory-tile</string></dict>"}}},"Ebook":{"type":"object","properties":{"id":{"type":"string","example":"1"},"name":{"type":"string","example":"The Neverending API"},"kind":{"type":"string","example":"IBOOKS","enum":["UNKNOWN","PDF","EPUB","IBOOKS"]},"url":{"type":"string","example":"https://jamf.com/ibooks/the_neverending_api.just_kidding"},"free":{"type":"boolean","example":true},"version":{"type":"string","example":"10.9.0"},"author":{"type":"string","example":"IT Bob"},"deployAsManaged":{"type":"boolean","description":"If true, it will be automatically installed","example":false},"installAutomatically":{"type":"boolean","example":false},"categoryId":{"type":"string","example":"-1"},"siteId":{"type":"string","example":"-1"}}},"EbookSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/Ebook"}}}},"EnrollmentCustomizationBrandingSettings":{"required":["backgroundColor","buttonColor","buttonTextColor","iconUrl","textColor"],"type":"object","properties":{"textColor":{"type":"string","example":"0000FF"},"buttonColor":{"type":"string","example":"0000FF"},"buttonTextColor":{"type":"string","example":"0000FF"},"backgroundColor":{"type":"string","example":"0000FF"},"iconUrl":{"type":"string","example":"https://jamfUrl/api/v2/enrollment-customizations/images/1"}}},"EnrollmentCustomizationSearchResultsV2":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/EnrollmentCustomizationV2"}}}},"EnrollmentCustomizationV2":{"required":["description","displayName","enrollmentCustomizationBrandingSettings","siteId"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"siteId":{"type":"string","example":"2"},"displayName":{"type":"string","example":"Example"},"description":{"type":"string","example":"Example description"},"enrollmentCustomizationBrandingSettings":{"$ref":"#/components/schemas/EnrollmentCustomizationBrandingSettings"}}},"EnrollmentMethod":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"objectName":{"type":"string","readOnly":true,"example":"user@domain.com"},"objectType":{"type":"string","readOnly":true,"example":"User-initiated - no invitation"}}},"ExtensionAttributeV2":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Example EA"},"type":{"type":"string","example":"STRING","enum":["STRING","INTEGER","DATE"]},"value":{"type":"array","items":{"type":"string","example":"EA Value"}},"extensionAttributeCollectionAllowed":{"type":"boolean","example":false}}},"ExtensionAttributeValue":{"type":"object","properties":{"displayName":{"type":"string","nullable":false,"example":"EA Name"},"value":{"type":"string","nullable":true,"example":"EA Value"}}},"ExtensionAttributes":{"required":["dataType","name"],"type":"object","properties":{"id":{"type":"string","description":"Unique Id for Mobile Device Extension Attribute.","readOnly":true,"example":"1"},"name":{"type":"string","description":"Display name for the extension attribute.","example":"MobileDeviceExtensionAttribute"},"description":{"type":"string","description":"Description for the extension attribute.","example":"Mobile Device Extension Attribute"},"dataType":{"type":"string","description":"Type of data being collected.","enum":["INTEGER","STRING","DATE"],"default":"STRING"}}},"ExternalRecipient":{"required":["email","name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","example":"Bob Exampleman"},"email":{"minLength":1,"type":"string","example":"bob@example.com"}}},"GetComputerPrestageV3":{"allOf":[{"$ref":"#/components/schemas/ComputerPrestageV3"},{"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"profileUuid":{"type":"string","example":"29d-a8d8f-b8sdjndf-dsa9"},"siteId":{"type":"string","example":"5"},"versionLock":{"minimum":0,"type":"integer","example":0},"accountSettings":{"$ref":"#/components/schemas/AccountSettingsResponse"}}}]},"GetMobileDevicePrestageV2":{"allOf":[{"$ref":"#/components/schemas/MobileDevicePrestageV2"},{"type":"object","properties":{"id":{"type":"string","example":"1"},"profileUuid":{"type":"string","example":"29d-a8d8f-b8sdjndf-dsa9"},"siteId":{"type":"string","example":"5"},"versionLock":{"type":"integer","example":0}}}]},"GroupMembership":{"type":"object","properties":{"groupId":{"type":"string","example":"1"},"groupName":{"type":"string","example":"groupOne"},"groupDescription":{"type":"string","example":"groupOne description"},"smartGroup":{"type":"boolean","description":"Indicates that group is smart group","example":true}}},"HrefResponse":{"type":"object","properties":{"id":{"minLength":1,"type":"string","example":"1"},"href":{"type":"string","example":"https://yourJamfProUrl.jamf/api/v1/resource/1"}}},"IdAndNameV2":{"type":"object","properties":{"id":{"type":"string","example":"1"},"name":{"type":"string","example":"A name"}}},"InternalRecipient":{"required":["accountId"],"type":"object","properties":{"accountId":{"pattern":"^\\d+$","type":"string","example":"1"},"frequency":{"type":"string","example":"DAILY","enum":["DAILY"],"default":"DAILY"}}},"InventoryListMobileDevice":{"type":"object","properties":{"mobileDeviceId":{"minLength":1,"type":"string","example":"1"},"udid":{"type":"string","example":"0dad565fb40b010a9e490440188063a378721069"},"airPlayPassword":{"type":"string","format":"password","example":"1234"},"appAnalyticsEnabled":{"type":"boolean","example":false},"assetTag":{"type":"string","example":"8675309"},"availableSpaceMb":{"type":"integer","example":26646},"batteryLevel":{"type":"integer","example":100},"batteryHealth":{"type":"string","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","enum":["NON_GENUINE","NORMAL","SERVICE_RECOMMENDED","UNKNOWN","UNSUPPORTED"],"default":"UNKNOWN"},"bluetoothLowEnergyCapable":{"type":"boolean","example":false},"bluetoothMacAddress":{"type":"string","example":"ee:00:7c:f0:e5:aa"},"capacityMb":{"type":"integer","example":27503},"lostModeEnabledDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"declarativeDeviceManagementEnabled":{"type":"boolean","example":false},"appleEnrollmentType":{"type":"string","description":"The enrollment type reported by Apple.","example":"supervised","enum":["none","supervised","device","user","unknown"]},"awaitingConfiguration":{"type":"boolean","description":"Whether the device is awaiting configuration.","example":false},"returnToServiceEnabled":{"type":"boolean","description":"Whether Return to Service is enabled.","example":false},"lockdownModeEnabled":{"type":"boolean","description":"Whether Lockdown Mode is enabled.","example":false},"deviceId":{"type":"string","example":"1"},"deviceLocatorServiceEnabled":{"type":"boolean","example":false},"deviceOwnershipType":{"type":"string","example":"institutional"},"devicePhoneNumber":{"type":"string","example":"555-555-5555"},"diagnosticAndUsageReportingEnabled":{"type":"boolean","example":false},"displayName":{"type":"string","example":"iPad"},"doNotDisturbEnabled":{"type":"boolean","example":false},"enrollmentSessionTokenValid":{"type":"boolean","example":false},"exchangeDeviceId":{"type":"string","example":"TH3YE2RI4D234IS2B6U6IGH95D"},"cloudBackupEnabled":{"type":"boolean","example":false},"osBuild":{"type":"string","example":"15F79"},"osSupplementalBuildVersion":{"type":"string","example":"22A103310o"},"osRapidSecurityResponse":{"type":"string","example":"(a)"},"osVersion":{"type":"string","example":"11.4"},"ipAddress":{"type":"string","example":"10.0.0.1"},"itunesStoreAccountActive":{"type":"boolean","example":false},"jamfParentPairings":{"type":"integer","example":1},"languages":{"type":"string","example":"Polish"},"lastBackupDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lastContactDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lastEnrolledDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lastCloudBackupDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lastInventoryUpdateDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"locales":{"type":"string","example":"null"},"locationServicesForSelfServiceMobileEnabled":{"type":"boolean","example":false},"lostModeEnabled":{"type":"boolean","example":false},"managed":{"type":"boolean","example":true},"managementId":{"type":"string","example":"73226fb6-61df-4c10-9552-eb9bc353d507"},"mdmProfileExpirationDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"model":{"type":"string","example":"iPad 7th Generation (Wi-Fi)"},"modelIdentifier":{"type":"string","example":"iPad7,11"},"modelNumber":{"type":"string","example":"MW742LL"},"modemFirmwareVersion":{"type":"string","example":"5.70.01"},"pairedDevices":{"type":"integer","example":1},"quotaSize":{"type":"integer","example":1024},"residentUsers":{"type":"integer","example":0},"serialNumber":{"type":"string","example":"5c28fdae"},"sharedIpad":{"type":"boolean","example":false},"supervised":{"type":"boolean","example":true},"tethered":{"type":"boolean","example":false},"timeZone":{"type":"string","example":"Europe/Warsaw"},"usedSpacePercentage":{"type":"integer","example":3},"wifiMacAddress":{"type":"string","example":"C4:84:66:92:78:00"},"building":{"type":"string","example":"Eau Claire"},"department":{"type":"string","example":"Support"},"emailAddress":{"type":"string","example":"support@jamf.com"},"fullName":{"type":"string","example":"John Smith"},"position":{"type":"string","example":"IT Team Lead"},"room":{"type":"string","example":"4th Floor - Quad 3"},"userPhoneNumber":{"type":"string","example":"555-555-5555"},"username":{"type":"string","example":"admin"},"appleCareId":{"type":"string","example":"9546567.0"},"leaseExpirationDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lifeExpectancyYears":{"type":"integer","example":7},"poDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"poNumber":{"type":"string","example":"8675309"},"purchasePrice":{"type":"string","example":"$399"},"purchasedOrLeased":{"type":"boolean","example":true},"purchasingAccount":{"type":"string","example":"IT Budget"},"purchasingContact":{"type":"string","example":"Nick in IT"},"vendor":{"type":"string","example":"Apple"},"warrantyExpirationDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"activationLockEnabled":{"type":"boolean","example":true},"blockEncryptionCapable":{"type":"boolean","example":false},"dataProtection":{"type":"boolean","example":false},"fileEncryptionCapable":{"type":"boolean","example":false},"hardwareEncryptionSupported":{"type":"boolean","example":false},"jailbreakStatus":{"type":"string","example":"Compromised"},"passcodeCompliant":{"type":"boolean","example":true},"passcodeCompliantWithProfile":{"type":"boolean","example":true},"passcodeLockGracePeriodEnforcedSeconds":{"type":"integer","example":9819083},"passcodePresent":{"type":"boolean","example":true},"personalDeviceProfileCurrent":{"type":"boolean","description":"**Deprecated as of 11.25.** This field always returns false.\n","readOnly":true,"deprecated":true,"default":false},"carrierSettingsVersion":{"type":"string","example":"33.1"},"cellularTechnology":{"type":"string","example":"Both"},"currentCarrierNetwork":{"type":"string","example":"Verizon Wireless"},"currentMobileCountryCode":{"type":"string","example":"311"},"currentMobileNetworkCode":{"type":"string","example":"480"},"dataRoamingEnabled":{"type":"boolean","example":true},"eid":{"type":"string","example":"89049032007008882600085727376656"},"homeCarrierNetwork":{"type":"string","example":"Verizon"},"homeMobileCountryCode":{"type":"string","example":"US"},"homeMobileNetworkCode":{"type":"string","example":"480"},"iccid":{"type":"string","example":"8991101200003204514"},"imei":{"type":"string","example":"35 882334 083223 0"},"imei2":{"type":"string","example":"35 585308 072899 3"},"meid":{"type":"string","example":"35882334083223"},"personalHotspotEnabled":{"type":"boolean","example":false},"preferredVoiceNumber":{"type":"string","example":"555-555-5555"},"roaming":{"type":"boolean","example":false},"voiceRoamingEnabled":{"type":"string","example":"Enabled"},"lastLoggedInUsernameSelfService":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameSelfServiceTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"lastLoggedInUsernameMdm":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameMdmTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"extensionAttributeValueList":{"minLength":0,"type":"array","items":{"$ref":"#/components/schemas/ExtensionAttributeValue"}}}},"InventoryListMobileDeviceSearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","nullable":false,"example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/InventoryListMobileDevice"}}}},"InventoryPreloadExtensionAttribute":{"required":["name"],"type":"object","properties":{"name":{"type":"string","example":"foo"},"value":{"type":"string","example":"42"}}},"InventoryPreloadRecordSearchResultsV2":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":10},"results":{"type":"array","items":{"$ref":"#/components/schemas/InventoryPreloadRecordV2"}}}},"InventoryPreloadRecordV2":{"required":["deviceType","serialNumber"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"serialNumber":{"type":"string","example":"C02L29ECF8J1"},"deviceType":{"type":"string","example":"Computer","enum":["Computer","Mobile Device","Unknown"]},"username":{"type":"string","nullable":true,"example":"admin"},"fullName":{"type":"string","nullable":true,"example":"Name"},"emailAddress":{"type":"string","nullable":true,"example":"ITBob@jamf.com"},"phoneNumber":{"type":"string","nullable":true,"example":"555-555-5555"},"position":{"type":"string","nullable":true,"example":"IT Team Lead"},"department":{"type":"string","nullable":true,"example":"IT"},"building":{"type":"string","nullable":true,"example":"Eau Claire"},"room":{"type":"string","nullable":true,"example":"4th Floor - Quad 3"},"poNumber":{"type":"string","nullable":true,"example":"8675309"},"poDate":{"type":"string","nullable":true,"example":"2019-02-04T21:09:31.661Z"},"warrantyExpiration":{"type":"string","nullable":true,"example":"2012-07-21"},"appleCareId":{"type":"string","nullable":true,"example":"5678"},"lifeExpectancy":{"type":"string","nullable":true,"example":"5 years"},"purchasePrice":{"type":"string","nullable":true,"example":"$399"},"purchasingContact":{"type":"string","nullable":true,"example":"Nick in IT"},"purchasingAccount":{"type":"string","nullable":true,"example":"IT Budget"},"leaseExpiration":{"type":"string","nullable":true,"example":"2015-06-19"},"barCode1":{"type":"string","nullable":true,"example":"123456789"},"barCode2":{"type":"string","nullable":true,"example":"123456789"},"assetTag":{"type":"string","nullable":true,"example":"ABCDEFG12345"},"vendor":{"type":"string","nullable":true,"example":"Apple"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/InventoryPreloadExtensionAttribute"}}}},"IosBrandingConfiguration":{"required":["brandingName","brandingNameColorCode","headerBackgroundColorCode","menuIconColorCode","statusBarTextColor"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"brandingName":{"type":"string","example":"Self Service"},"iconId":{"type":"integer","example":1},"headerBackgroundColorCode":{"type":"string","example":"FFFFFF"},"menuIconColorCode":{"type":"string","example":"000001"},"brandingNameColorCode":{"type":"string","example":"000000"},"statusBarTextColor":{"type":"string","example":"dark"}}},"IosBrandingSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/IosBrandingConfiguration"}}}},"LdapServer":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Server name"}},"description":"An LDAP Server."},"LocationInformationV2":{"required":["buildingId","departmentId","email","id","phone","position","realname","room","username","versionLock"],"type":"object","properties":{"username":{"type":"string","example":"name"},"realname":{"type":"string","example":"realName"},"phone":{"type":"string","example":"123-456-7890"},"email":{"type":"string","example":"test@jamf.com"},"room":{"type":"string","example":"room"},"position":{"type":"string","example":"postion"},"departmentId":{"type":"string","example":"1"},"buildingId":{"type":"string","example":"1"},"id":{"type":"string","example":"-1"},"versionLock":{"type":"integer","example":1}}},"LocationV2":{"type":"object","properties":{"username":{"type":"string","example":"admin"},"realName":{"type":"string","example":"IT Bob"},"emailAddress":{"type":"string","example":"ITBob@jamf.com"},"position":{"type":"string","example":"IT Team Lead"},"phoneNumber":{"type":"string","example":"555-555-5555"},"departmentId":{"type":"string","example":"1"},"buildingId":{"type":"string","example":"1"},"room":{"type":"string","example":"4th Floor - Quad 3"}}},"MacOsBrandingConfiguration":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"applicationName":{"type":"string","example":"Self Service"},"brandingName":{"type":"string","example":"Self Service"},"brandingNameSecondary":{"type":"string","example":"Self Service"},"iconId":{"type":"integer","example":1},"brandingHeaderImageId":{"type":"integer","example":1},"homeHeading":{"type":"string","example":"Welcome to Self Service"},"homeSubheading":{"type":"string","example":"We help organizations succeed with Apple"}}},"MacOsBrandingSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/MacOsBrandingConfiguration"}}}},"ManagedSoftwareUpdatePlan":{"required":["device","maxDeferrals","planUuid","status","updateAction","versionType"],"type":"object","properties":{"planUuid":{"minLength":1,"type":"string","readOnly":true,"example":"6E47EF55-5318-494F-A09E-70F613E0AFD1"},"device":{"$ref":"#/components/schemas/PlanDevice"},"updateAction":{"type":"string","nullable":false,"readOnly":true,"example":"DOWNLOAD_INSTALL","enum":["DOWNLOAD_ONLY","DOWNLOAD_INSTALL","DOWNLOAD_INSTALL_ALLOW_DEFERRAL","DOWNLOAD_INSTALL_RESTART","DOWNLOAD_INSTALL_SCHEDULE","UNKNOWN"]},"versionType":{"type":"string","nullable":false,"readOnly":true,"example":"SPECIFIC_VERSION","enum":["LATEST_MAJOR","LATEST_MINOR","LATEST_ANY","SPECIFIC_VERSION","CUSTOM_VERSION","UNKNOWN"]},"specificVersion":{"type":"string","description":"Optional. Indicates the specific version to update to. Only available when the version type is set to specific version or custom version, otherwise defaults to NO_SPECIFIC_VERSION.","readOnly":true,"example":"12.6.1","default":"NO_SPECIFIC_VERSION"},"buildVersion":{"type":"string","description":"Optional. Indicates the build version to update to. Only available when the version type is set to custom version.","nullable":true,"readOnly":true,"example":"21F79"},"maxDeferrals":{"minimum":0,"type":"integer","description":"Not applicable to all managed software update plans","readOnly":true,"example":5},"forceInstallLocalDateTime":{"type":"string","description":"Optional. Indicates the local date and time of the device to force update by.","nullable":true,"example":"2023-12-25T21:09:31"},"recipeId":{"type":"string","description":"The id of the recipe that was used to generate the plan.","readOnly":true,"example":"1","default":"-1"},"status":{"$ref":"#/components/schemas/PlanStatus"}}},"ManagedSoftwareUpdatePlans":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"minItems":0,"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlan"}}}},"MdmClientType":{"type":"string","example":"MOBILE_DEVICE","enum":["MOBILE_DEVICE","TV","VISION_PRO","WATCH","COMPUTER","COMPUTER_USER","MOBILE_DEVICE_USER","UNKNOWN"]},"MdmCommand":{"type":"object","properties":{"uuid":{"type":"string","example":"aaaaaaaa-3f1e-4b3a-a5b3-ca0cd7430937"},"dateSent":{"type":"string","format":"date-time","example":"2019-05-16T20:43:43.945Z"},"dateCompleted":{"type":"string","format":"date-time","example":"2019-05-16T20:43:43.945Z"},"client":{"$ref":"#/components/schemas/MdmCommandClient"},"commandState":{"$ref":"#/components/schemas/MdmCommandState"},"commandType":{"$ref":"#/components/schemas/MdmCommandType"},"commandError":{"$ref":"#/components/schemas/MdmCommandError"},"profileId":{"type":"integer","example":1}}},"MdmCommandClient":{"type":"object","properties":{"managementId":{"type":"string","example":"aaaaaaaa-3f1e-4b3a-a5b3-ca0cd7430937"},"clientType":{"$ref":"#/components/schemas/MdmClientType"}}},"MdmCommandError":{"type":"object","properties":{"errorCode":{"type":"integer","example":1234},"errorDomain":{"type":"string","example":"An error occurred while processing the command."},"errorLocalizedDescription":{"type":"string","example":"An error occurred while processing the command."},"errorEnglishDescription":{"type":"string","example":"An error occurred while processing the command."}}},"MdmCommandState":{"type":"string","example":"PENDING","enum":["PENDING","ACKNOWLEDGED","NOT_NOW","ERROR","COMMAND_FORMAT_ERROR"]},"MdmCommandType":{"type":"string","example":"ENABLE_LOST_MODE","enum":["APPLY_REDEMPTION_CODE","CANCEL_ENHANCED_LOG_COLLECTION","CERTIFICATE_LIST","CLEAR_PASSCODE","CLEAR_RESTRICTIONS_PASSWORD","DECLARATIVE_MANAGEMENT","DELETE_USER","DEVICE_INFORMATION","DEVICE_LOCATION","DEVICE_LOCK","DISABLE_LOST_MODE","DISABLE_REMOTE_DESKTOP","ENABLE_LOST_MODE","ENABLE_REMOTE_DESKTOP","ERASE_DEVICE","INSTALLED_APPLICATION_LIST","LOG_OUT_USER","MANAGED_APPLICATION_LIST","MANAGED_MEDIA_LIST","REFRESH_CELLULAR_PLANS","PLAY_LOST_MODE_SOUND","PROFILE_LIST","PROVISIONING_PROFILE_LIST","RESTART_DEVICE","REQUEST_MIRRORING","SECURITY_INFO","SETTINGS","SET_AUTO_ADMIN_PASSWORD","SET_RECOVERY_LOCK","SHUT_DOWN_DEVICE","STOP_MIRRORING","TRIGGER_ENHANCED_LOG_COLLECTION","UNLOCK_USER_ACCOUNT","VALIDATE_APPLICATIONS","VERIFY_RECOVERY_LOCK"]},"MobileDeviceApplication":{"type":"object","properties":{"identifier":{"type":"string","example":"com.apple.airport.mobileairportutility"},"name":{"type":"string","example":"AirPort Utility"},"version":{"type":"string","example":"135.24"},"shortVersion":{"type":"string","example":"7.0"}}},"MobileDeviceAttachmentV2":{"type":"object","properties":{"name":{"type":"string","example":"Bob's Attachment"},"id":{"type":"string","readOnly":true,"example":"1"}}},"MobileDeviceCertificateV2":{"type":"object","properties":{"commonName":{"type":"string","example":"3B259E4B-FAD5-4860-B1DD-336ADA786EBA"},"identity":{"type":"boolean","example":false},"expirationDateEpoch":{"type":"string","format":"date-time","example":"2030-10-31T18:04:13Z"},"subjectName":{"type":"string","example":"CN=Fleet Docker Jamf Pro JSS Built-in Certificate Authority"},"serialNumber":{"type":"string","example":"5c28fdae"},"sha1Fingerprint":{"type":"string","example":"050cfe8ec9d170be7bf8f1a3cac2c52f3c6ddb20"},"issuedDateEpoch":{"type":"string","example":"2022-05-23T14:54:10Z"},"certificateStatus":{"type":"string","example":"ISSUED","enum":["EXPIRING","EXPIRED","REVOKED","PENDING_REVOKE","ISSUED"]},"lifecycleStatus":{"type":"string","example":"ACTIVE","enum":["ACTIVE","INACTIVE"]}}},"MobileDeviceDetailsGetV2":{"allOf":[{"$ref":"#/components/schemas/MobileDeviceDetailsV2"},{"type":"object","properties":{"managementId":{"type":"string","readOnly":true,"example":"73226fb6-61df-4c10-9552-eb9bc353d507"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceInventoryGroup"}}}}]},"MobileDeviceDetailsV2":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","description":"Mobile device name.","example":"Jon's iPad"},"enforceName":{"type":"boolean","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.","example":false},"assetTag":{"type":"string","example":"12345"},"lastInventoryUpdateTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56Z"},"lastContactTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56Z"},"osVersion":{"type":"string","example":"11.4"},"osBuild":{"type":"string","example":"15F79"},"osSupplementalBuildVersion":{"type":"string","description":"Collected for iOS 16 and iPadOS 16.1 or later","example":"20B101"},"osRapidSecurityResponse":{"type":"string","description":"Collected for iOS 16 and iPadOS 16.1 or later","example":"(a)"},"softwareUpdateDeviceId":{"type":"string","example":"J132AP"},"serialNumber":{"type":"string","example":"DMQVGC0DHLF0"},"udid":{"type":"string","example":"0dad565fb40b010a9e490440188063a378721069"},"ipAddress":{"type":"string","example":"10.0.0.1"},"wifiMacAddress":{"type":"string","example":"ee:00:7c:f0:e5:ff"},"bluetoothMacAddress":{"type":"string","example":"ee:00:7c:f0:e5:aa"},"managed":{"type":"boolean","example":true},"timeZone":{"type":"string","example":"Europe/Warsaw"},"initialEntryTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56.307Z"},"lastEnrollmentTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56.307Z"},"mdmProfileExpirationTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56.307Z"},"deviceOwnershipLevel":{"type":"string","example":"institutional"},"enrollmentMethod":{"type":"string","example":"User-initiated - no invitation"},"enrollmentSessionTokenValid":{"type":"boolean","example":false},"declarativeDeviceManagementEnabled":{"type":"boolean","example":true},"appleEnrollmentType":{"type":"string","description":"The enrollment type reported by Apple.","example":"supervised","enum":["none","supervised","device","user","unknown"]},"awaitingConfiguration":{"type":"boolean","description":"Whether the device is awaiting configuration.","example":false},"site":{"$ref":"#/components/schemas/V1SiteBase"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ExtensionAttributeV2"}},"location":{"$ref":"#/components/schemas/LocationV2"},"type":{"type":"string","description":"Based on the value of this either iOS, tvOS, watch or visionOS objects will be populated.","example":"ios","enum":["ios","tvos","watchos","visionos","unknown"]},"ios":{"$ref":"#/components/schemas/DetailsV2"},"tvos":{"$ref":"#/components/schemas/TvOsDetails"},"watchos":{"$ref":"#/components/schemas/WatchOsDetailsV2"},"visionos":{"$ref":"#/components/schemas/DetailsV2"}}},"MobileDeviceEbook":{"type":"object","properties":{"author":{"type":"string","example":"Homer J Simpson"},"title":{"type":"string","example":"The Odyssey"},"version":{"type":"string","example":"0.1"}}},"MobileDeviceExtensionAttributeSearchResults":{"required":["totalCount"],"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceExtensionAttributes"}}}},"MobileDeviceExtensionAttributes":{"allOf":[{"$ref":"#/components/schemas/ExtensionAttributes"},{"required":["inputType","inventoryDisplayType"],"type":"object","properties":{"inventoryDisplayType":{"type":"string","description":"Category in which to display the extension attribute in Jamf Pro.","example":"GENERAL","enum":["GENERAL","HARDWARE","USER_AND_LOCATION","PURCHASING","EXTENSION_ATTRIBUTES"],"default":"GENERAL"},"inputType":{"type":"string","description":"Extension attributes collect inventory data by using an input type.The type of the Input used to populate the extension attribute.","enum":["TEXT","POPUP","DIRECTORY_SERVICE_ATTRIBUTE_MAPPING"],"default":"TEXT"},"popupMenuChoices":{"minItems":0,"type":"array","description":"When added with list of choices while creating mobile device 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 mobile device any time using Jamf Pro. Provide popupMenuChoices only when inputType is 'POPUP'.","example":["Test","Popup"],"items":{"type":"string","description":"Popup Menu choices."}},"ldapAttributeMapping":{"type":"string","description":"Directory Service attribute use to populate the extension attribute. <br/> Required when inputType is \"DIRECTORY_SERVICE_ATTRIBUTE_MAPPING\"","example":"ldapAttributeMapping"},"ldapExtensionAttributeAllowed":{"type":"boolean","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/>","example":false,"default":false}}}]},"MobileDeviceGroup":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"All Managed iPads"},"description":{"type":"string","example":"A group containing all managed iPads"},"isSmartGroup":{"type":"boolean","example":true}}},"MobileDeviceInventoryGroup":{"type":"object","properties":{"groupId":{"type":"string","example":"1"},"groupName":{"minLength":1,"type":"string","example":"Test Group"},"groupDescription":{"minLength":0,"type":"string","example":"Test Group Description"},"smart":{"type":"boolean","example":false}}},"MobileDeviceMdmCapableUser":{"type":"object","properties":{"userShortName":{"type":"string","example":"testUser"},"managementId":{"type":"string","example":"8835fe1c-eb9d-42e5-8277-f708ae011a9d"}}},"MobileDevicePrestageNameV2":{"type":"object","properties":{"id":{"type":"string","example":"1"},"deviceName":{"type":"string","example":"iPad"},"used":{"type":"boolean","example":false}}},"MobileDevicePrestageNamesV2":{"type":"object","properties":{"assignNamesUsing":{"type":"string","example":"List of Names"},"prestageDeviceNames":{"type":"array","items":{"$ref":"#/components/schemas/MobileDevicePrestageNameV2"}},"deviceNamePrefix":{"type":"string","example":"prefix"},"deviceNameSuffix":{"type":"string","example":"suffix"},"singleDeviceName":{"type":"string","example":"name"},"manageNames":{"type":"boolean","example":true},"deviceNamingConfigured":{"type":"boolean","example":true}}},"MobileDevicePrestageSearchResultsV2":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/GetMobileDevicePrestageV2"}}}},"MobileDevicePrestageV2":{"allOf":[{"$ref":"#/components/schemas/DeviceEnrollmentPrestageV2"},{"required":["allowPairing","configureDeviceBeforeSetupAssistant","maximumSharedAccounts","multiUser","sendTimezone","storageQuotaSizeMegabytes","supervised","timezone","useStorageQuotaSize"],"type":"object","properties":{"allowPairing":{"type":"boolean","example":true},"multiUser":{"type":"boolean","example":true},"supervised":{"type":"boolean","example":true},"maximumSharedAccounts":{"type":"integer","example":10},"configureDeviceBeforeSetupAssistant":{"type":"boolean","example":true},"names":{"$ref":"#/components/schemas/MobileDevicePrestageNamesV2"},"sendTimezone":{"type":"boolean","example":true},"timezone":{"type":"string","example":"America/Chicago"},"storageQuotaSizeMegabytes":{"type":"integer","example":4096},"useStorageQuotaSize":{"type":"boolean","example":true},"temporarySessionOnly":{"type":"boolean","example":false},"enforceTemporarySessionTimeout":{"type":"boolean","example":false},"temporarySessionTimeout":{"type":"integer","example":30},"enforceUserSessionTimeout":{"type":"boolean","example":false},"userSessionTimeout":{"type":"integer","example":30},"prestageMinimumOsTargetVersionTypeIos":{"type":"string","nullable":false,"example":"MINIMUM_OS_LATEST_VERSION","enum":["NO_ENFORCEMENT","MINIMUM_OS_LATEST_VERSION","MINIMUM_OS_LATEST_MAJOR_VERSION","MINIMUM_OS_LATEST_MINOR_VERSION","MINIMUM_OS_SPECIFIC_VERSION"]},"minimumOsSpecificVersionIos":{"minLength":0,"type":"string","nullable":false,"example":"17.1"},"prestageMinimumOsTargetVersionTypeIpad":{"type":"string","nullable":false,"example":"MINIMUM_OS_LATEST_VERSION","enum":["NO_ENFORCEMENT","MINIMUM_OS_LATEST_VERSION","MINIMUM_OS_LATEST_MAJOR_VERSION","MINIMUM_OS_LATEST_MINOR_VERSION","MINIMUM_OS_SPECIFIC_VERSION"]},"minimumOsSpecificVersionIpad":{"minLength":0,"type":"string","nullable":false,"example":"17.1"},"rtsEnabled":{"type":"boolean","example":false},"rtsConfigProfileId":{"type":"string","example":"1"}}}]},"MobileDeviceProvisioningProfiles":{"type":"object","properties":{"displayName":{"type":"string","example":"jamfnation"},"uuid":{"type":"string","example":"89AF33FC-123C-1231-AEFD-9C3ED123AFCC"},"expirationDate":{"type":"string","format":"date-time","example":"2018-10-24T21:57:37Z"}}},"MobileDeviceSearchResultsV2":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceV2"}}}},"MobileDeviceServiceSubscriptions":{"type":"object","properties":{"carrierSettingsVersion":{"type":"string","example":"47.1"},"currentCarrierNetwork":{"type":"string","example":"T-Mobile Wi-Fi"},"currentMobileCountryCode":{"type":"string","example":"310"},"currentMobileNetworkCode":{"type":"string","example":"260"},"subscriberCarrierNetwork":{"type":"string","example":"T-Mobile Wi-Fi"},"eid":{"type":"string","example":"89049032007008882600085727376656"},"iccid":{"type":"string","example":"8901 2605 7071 8002 130"},"imei":{"type":"string","example":"35 882334 083223 0"},"dataPreferred":{"type":"boolean","example":true},"roaming":{"type":"boolean","example":true},"voicePreferred":{"type":"boolean","example":true},"label":{"type":"string","example":"Primary"},"labelId":{"type":"string","description":"The unique identifier for this subscription.","example":"D1F4AEC5-2FCD-4A6D-A09E-A940F60F856B"},"meid":{"type":"string","example":"35882334083223"},"phoneNumber":{"type":"string","example":"+15128145868"},"slot":{"type":"string","description":"The description of the slot that contains the SIM representing this subscription.","example":"CTSubscriptionSlotOne"}}},"MobileDeviceSmartGroupCriteriaV2":{"required":["andOr","name","priority","searchType","value"],"type":"object","properties":{"name":{"maxLength":255,"type":"string","description":"The field to search on (e.g., Model, OS Version, etc.)","example":"Model"},"priority":{"type":"integer","description":"The priority order of this criterion (must start at 0 and increment by 1)","example":0},"andOr":{"type":"string","description":"Whether this criterion should be ANDed or ORed with the previous criterion. Must be exactly \"and\" or \"or\" (case-insensitive).","example":"and","enum":["and","or"]},"searchType":{"type":"string","description":"The type of search to perform (e.g., is, is not, like, etc.)","example":"is"},"value":{"maxLength":255,"type":"string","description":"The value to search for","example":"iPad"},"openingParen":{"type":"boolean","description":"Whether to add an opening parenthesis before this criterion","example":false},"closingParen":{"type":"boolean","description":"Whether to add a closing parenthesis after this criterion","example":false}}},"MobileDeviceV2":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"iPad"},"serialNumber":{"type":"string","example":"DMQVGC0DHLA0"},"wifiMacAddress":{"type":"string","example":"C4:84:66:92:78:00"},"udid":{"type":"string","example":"0dad565fb40b010a9e490440188063a378721069"},"phoneNumber":{"type":"string","example":"651-555-5555 Ext111"},"model":{"type":"string","example":"iPad 5th Generation (Wi-Fi)"},"modelIdentifier":{"type":"string","example":"iPad6,11"},"username":{"type":"string","example":"admin"},"type":{"type":"string","example":"ios","enum":["ios","tvos","watchos","visionos","unknown"]},"managementId":{"type":"string","readOnly":true,"example":"73226fb6-61df-4c10-9552-eb9bc353d507"},"softwareUpdateDeviceId":{"type":"string","example":"J132AP"}}},"NetworkV2":{"type":"object","properties":{"cellularTechnology":{"type":"string","example":"Unknown"},"voiceRoamingEnabled":{"type":"boolean","example":false},"imei":{"type":"string","example":"59 105109 176278 3"},"iccid":{"type":"string","example":"8991101200003204514"},"meid":{"type":"string","example":"15302309236898"},"eid":{"type":"string","description":"EID or \"embedded identity document\" is a number associated with the eSIM on a device","readOnly":true,"example":"12547444452496388545569920380795"},"carrierSettingsVersion":{"type":"string","example":"33.1"},"currentCarrierNetwork":{"type":"string","example":"Verizon Wireless"},"currentMobileCountryCode":{"type":"string","example":"311"},"currentMobileNetworkCode":{"type":"string","example":"480"},"homeCarrierNetwork":{"type":"string","example":"Verizon"},"homeMobileCountryCode":{"type":"string","example":"US"},"homeMobileNetworkCode":{"type":"string","example":"480"},"dataRoamingEnabled":{"type":"boolean","example":true},"roaming":{"type":"boolean","example":false},"personalHotspotEnabled":{"type":"boolean","example":false},"phoneNumber":{"type":"string","example":"555-555-5555 ext 5"},"preferredVoiceNumber":{"type":"string","example":"555-555-5555"}}},"Package":{"required":["categoryId","fileName","fillUserTemplate","osInstall","packageName","priority","rebootRequired","suppressEula","suppressFromDock","suppressRegistration","suppressUpdates"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"packageName":{"type":"string","example":"Google Chrome"},"fileName":{"type":"string","example":"my-package.pkg"},"categoryId":{"type":"string","example":"-1"},"info":{"type":"string","nullable":true,"example":"A package that is important to my organization."},"notes":{"type":"string","nullable":true,"example":"Some notes."},"priority":{"type":"integer","example":3},"osRequirements":{"type":"string","nullable":true,"example":"10.6.8, 10.7.x"},"fillUserTemplate":{"type":"boolean","example":false},"indexed":{"type":"boolean","readOnly":true,"example":false},"fillExistingUsers":{"type":"boolean","example":false},"swu":{"type":"boolean","example":false},"rebootRequired":{"type":"boolean","example":false},"selfHealNotify":{"type":"boolean","example":false},"selfHealingAction":{"type":"string","nullable":true,"example":"nothing"},"osInstall":{"type":"boolean","example":false},"serialNumber":{"type":"string","nullable":true,"example":"1234"},"parentPackageId":{"type":"string","nullable":true,"example":"3"},"basePath":{"type":"string","nullable":true,"example":"my/path"},"suppressUpdates":{"type":"boolean","example":false},"cloudTransferStatus":{"type":"string","readOnly":true,"example":"READY"},"ignoreConflicts":{"type":"boolean","example":false},"suppressFromDock":{"type":"boolean","example":false},"suppressEula":{"type":"boolean","example":false},"suppressRegistration":{"type":"boolean","example":false},"installLanguage":{"type":"string","nullable":true,"example":"en_US"},"md5":{"type":"string","nullable":true,"example":"0cc175b9c0f1b6a831c399e269772661"},"sha256":{"type":"string","nullable":true,"example":"61be55a8e2f6b4e172338bddf184d6dbee29c98853e0a0485ecee7f27b9af0b4"},"sha3512":{"type":"string","nullable":true,"example":"a51a01e63f76c4601a2989575280e2a1c1e83191382277906b0f92a251c53bbbd1d9804dd30edd304cffe75d1c6455440b0c39081ca94c68f149d1f719e15092"},"hashType":{"type":"string","nullable":true,"example":"MD5"},"hashValue":{"type":"string","nullable":true,"example":"0cc175b9c0f1b6a831c399e269772661"},"size":{"type":"string","nullable":true,"readOnly":true,"example":"234KB"},"osInstallerVersion":{"type":"string","nullable":true,"example":"10.3.x"},"manifest":{"type":"string","nullable":true,"example":"manifest"},"manifestFileName":{"type":"string","nullable":true,"example":"manifest.plist"},"format":{"type":"string","nullable":true,"example":"format"}}},"PackagesSearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Package"}}}},"PagedUserResults":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number (zero-based)","format":"int32","nullable":false,"example":0},"pageSize":{"type":"integer","description":"Number of results per page","format":"int32","example":100},"totalCount":{"type":"integer","description":"Total number of users matching the search criteria","format":"int64","example":150},"totalPages":{"type":"integer","description":"Total number of pages available","format":"int64","example":2},"hasNext":{"type":"boolean","description":"True if there are more pages after the current page","example":true},"hasPrevious":{"type":"boolean","description":"True if there are pages before the current page","example":false},"results":{"type":"array","description":"List of users in the current page","items":{"$ref":"#/components/schemas/User"}}}},"PatchSoftwareTitleConfiguration":{"allOf":[{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationBase"},{"type":"object","properties":{"id":{"type":"string","nullable":false,"example":"1"},"packages":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitlePackages"}}}}]},"PatchSoftwareTitleConfigurationBase":{"required":["displayName","softwareTitleId"],"type":"object","properties":{"displayName":{"type":"string","nullable":false,"example":"Google Chrome"},"categoryId":{"type":"string","example":"-1","default":"-1"},"siteId":{"type":"string","example":"-1","default":"-1"},"uiNotifications":{"type":"boolean","example":false,"default":false},"emailNotifications":{"type":"boolean","example":false,"default":false},"softwareTitleId":{"type":"string","nullable":false,"example":"1"},"jamfOfficial":{"type":"boolean","readOnly":true,"example":false},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationExtensionAttributes"}},"softwareTitleName":{"type":"string","readOnly":true,"example":"Safari"},"softwareTitleNameId":{"type":"string","readOnly":true,"example":"AppleSafari"},"softwareTitlePublisher":{"type":"string","readOnly":true,"example":"Apple"},"patchSourceName":{"type":"string","readOnly":true,"example":"Jamf"},"patchSourceEnabled":{"type":"boolean","readOnly":true,"example":true}}},"PatchSoftwareTitleConfigurationExtensionAttributes":{"type":"object","properties":{"accepted":{"type":"boolean","description":"Once an extension attribute is accepted, it cannot be reverted.","example":false,"default":false},"eaId":{"type":"string","nullable":false,"example":"google-chrome-ea"}}},"PatchSoftwareTitleConfigurationPatch":{"type":"object","properties":{"displayName":{"type":"string","example":"Google Chrome"},"categoryId":{"type":"string","example":"-1"},"siteId":{"type":"string","example":"-1"},"uiNotifications":{"type":"boolean","example":false},"emailNotifications":{"type":"boolean","example":false},"softwareTitleId":{"type":"string","example":"1"},"packages":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitlePackages"}},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationExtensionAttributes"}}}},"PatchSoftwareTitlePackages":{"type":"object","properties":{"packageId":{"type":"string","nullable":false,"example":"1"},"version":{"type":"string","nullable":false,"example":"1"},"displayName":{"type":"string","readOnly":true,"example":"Firefox.pkg"}}},"PlanDevice":{"type":"object","properties":{"deviceId":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"objectType":{"type":"string","nullable":false,"readOnly":true,"example":"COMPUTER","enum":["COMPUTER","MOBILE_DEVICE","APPLE_TV"]},"href":{"type":"string","nullable":false,"readOnly":true,"example":"/v1/computers-inventory/1"}}},"PlanStatus":{"type":"object","properties":{"state":{"type":"string","nullable":false,"readOnly":true,"example":"SchedulingScanForOSUpdates","enum":["Init","PendingPlanValidation","AcceptingPlan","RejectingPlan","ProcessingPlanType","ProcessingPlanTypeMdm","StartingPlan","PlanFailed","SchedulingScanForOSUpdates","ProcessingScheduleOSUpdateScanResponse","WaitingForScheduledOSUpdateScanToComplete","CollectingAvailableOSUpdates","ProcessingAvailableOSUpdatesResponse","ProcessingSchedulingType","SchedulingDDM","DDMPlanScheduled","WaitingToStartDDMUpdate","ProcessingDDMStatusResponse","CollectingDDMStatus","SchedulingMDM","MDMPlanScheduled","SchedulingOSUpdate","ProcessingScheduleOSUpdateResponse","CollectingOSUpdateStatus","ProcessingOSUpdateStatusResponse","WaitingToCollectOSUpdateStatus","VerifyingInstallation","ProcessingInstallationVerification","PlanCompleted","PlanCanceled","PlanException","Unknown"]},"errorReasons":{"type":"array","nullable":true,"readOnly":true,"example":["NO_UPDATES_AVAILABLE","NOT_SUPERVISED"],"items":{"type":"string","enum":["APPLE_SILICON_NO_ESCROW_KEY","NOT_SUPERVISED","NOT_MANAGED","NO_DISK_SPACE","NO_UPDATES_AVAILABLE","SPECIFIC_VERSION_UNAVAILABLE","SPECIFIC_VERSION_UNAVAILABLE_FOR_DEVICE_MODEL","ACTION_NOT_SUPPORTED_FOR_DEVICE_TYPE","DECLARATIVE_DEVICE_MANAGEMENT_SOFTWARE_UPDATES_NOT_SUPPORTED_FOR_DEVICE_OS_VERSION","DECLARATIVE_DEVICE_MANAGEMENT_SOFTWARE_UPDATES_NOT_SUPPORTED_FOR_DEVICE_TYPE","PLAN_NOT_FOUND","APPLE_SOFTWARE_LOOKUP_SERVICE_ERROR","EXISTING_PLAN_FOR_DEVICE_IN_PROGRESS","DOWNGRADE_NOT_SUPPORTED","DECLARATIVE_SERVICE_ERROR","UNABLE_TO_FIND_UPDATES_AND_OUT_OF_RETRIES","DATA_INTEGRITY_VIOLATION_EXCEPTION","ILLEGAL_ARGUMENT_EXCEPTION","MDM_EXCEPTION","INSTALL_REASON_UNKNOWN","ACCEPT_PLAN_FAILURE","SCHEDULE_PLAN_FAILURE","REJECT_PLAN_FAILURE","START_PLAN_FAILURE","QUEUE_SCHEDULED_OS_UPDATE_SCAN_FAILURE","SCAN_WAIT_FINISHED_FAILURE","QUEUE_AVAILABLE_OS_UPDATE_COMMAND_FAILURE","MDM_CLIENT_EXCEPTION","QUEUE_SCHEDULE_OS_UPDATE_FAILURE","QUEUE_OS_UPDATE_STATUS_COMMAND_FAILURE","STILL_IN_PROGRESS_FAILURE","WAIT_TO_COLLECT_OS_UPDATE_STATUS_FAILURE","IS_DOWNLOADED_AND_NEEDS_INSTALL_FAILURE","IS_INSTALLED_FAILURE","IS_DOWNLOAD_ONLY_AND_DOWNLOADED_FAILURE","VERIFY_INSTALLATION_FAILURE","IS_MAC_OS_UPDATE_FAILURE","IS_LATEST_FAILURE","IS_SPECIFIC_VERSION_FAILURE","HANDLE_COMMAND_QUEUE_FAILURE","INVALID_CONFIGURATION_DECLARATION","DECLARATIVE_DEVICE_MANAGEMENT_STATUS_RESPONSE_FAILURE_REASON_RECEIVED","NO_DEVICE_STATUS_BY_GRACE_PERIOD","UNKNOWN"]}}}},"PostComputerPrestageV3":{"allOf":[{"$ref":"#/components/schemas/ComputerPrestageV3"},{"type":"object","properties":{"accountSettings":{"$ref":"#/components/schemas/AccountSettingsRequest"},"recoveryLockPassword":{"minLength":1,"type":"string","format":"password","writeOnly":true,"example":"password123"}}}]},"PrestagePurchasingInformationV2":{"required":["appleCareId","id","leaseDate","leased","lifeExpectancy","poDate","poNumber","purchasePrice","purchased","purchasingAccount","purchasingContact","vendor","versionLock","warrantyDate"],"type":"object","properties":{"id":{"type":"string","example":"-1"},"leased":{"type":"boolean","example":true},"purchased":{"type":"boolean","example":true},"appleCareId":{"type":"string","example":"abcd"},"poNumber":{"type":"string","example":"53-1"},"vendor":{"type":"string","example":"Example Vendor"},"purchasePrice":{"type":"string","example":"$500"},"lifeExpectancy":{"type":"integer","example":5},"purchasingAccount":{"type":"string","example":"admin"},"purchasingContact":{"type":"string","example":"true"},"leaseDate":{"type":"string","example":"2019-01-01"},"poDate":{"type":"string","example":"2019-01-01"},"warrantyDate":{"type":"string","example":"2019-01-01"},"versionLock":{"type":"integer","example":1}}},"PurchasingV2":{"type":"object","properties":{"purchased":{"type":"boolean","example":true},"leased":{"type":"boolean","example":false},"poNumber":{"type":"string","example":"8675309"},"vendor":{"type":"string","example":"Apple"},"appleCareId":{"type":"string","example":"9546567.0"},"purchasePrice":{"type":"string","example":"$399"},"purchasingAccount":{"type":"string","example":"IT Budget"},"poDate":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"},"warrantyExpiresDate":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"},"leaseExpiresDate":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"},"lifeExpectancy":{"type":"integer","example":7},"purchasingContact":{"type":"string","example":"Nick in IT"}}},"PutComputerPrestageV3":{"allOf":[{"$ref":"#/components/schemas/ComputerPrestageV3"},{"type":"object","properties":{"accountSettings":{"$ref":"#/components/schemas/AccountSettingsRequest"},"recoveryLockPassword":{"minLength":1,"type":"string","format":"password","writeOnly":true,"example":"password123"},"versionLock":{"minimum":0,"type":"integer","example":0}}}]},"PutMobileDevicePrestageV2":{"allOf":[{"$ref":"#/components/schemas/MobileDevicePrestageV2"},{"type":"object","properties":{"versionLock":{"type":"integer","example":0}}}]},"ReturnToServiceConfiguration":{"type":"object","properties":{"id":{"minimum":1,"type":"string","description":"Id of the Return to Service Configuration.","nullable":false,"example":"1"},"displayName":{"type":"string","nullable":false,"example":"displayName","default":"false"},"wifiProfileId":{"type":"string","description":"Id of the wifi profile that is associated with the return to service configuration.","nullable":false,"example":"1"}}},"ReturnToServiceConfigurationRequest":{"type":"object","properties":{"displayName":{"type":"string","description":"Display name of the Return to Service Configuration.","nullable":false,"example":"displayName","default":"false"},"wifiProfileId":{"type":"string","description":"Id of the wifi profile that is associated with the return to service configuration.","nullable":false,"example":"1"}}},"ReturnToServiceConfigurationSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ReturnToServiceConfiguration"}}}},"Script":{"required":["name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Install Developer Utils Script"},"info":{"type":"string","example":"Installs utilities for developers"},"notes":{"type":"string","example":"Should be able to be re-run without problem."},"priority":{"type":"string","example":"AFTER","enum":["BEFORE","AFTER","AT_REBOOT"]},"categoryId":{"type":"string","example":"1"},"categoryName":{"type":"string","example":"Developer Tools"},"parameter4":{"type":"string","example":"1"},"parameter5":{"type":"string","example":"2"},"parameter6":{"type":"string","example":"3"},"parameter7":{"type":"string","example":"4"},"parameter8":{"type":"string","example":"5"},"parameter9":{"type":"string","example":"6"},"parameter10":{"type":"string","example":"7"},"parameter11":{"type":"string","example":"8"},"osRequirements":{"type":"string","example":"10.10.x"},"scriptContents":{"type":"string","example":"echo \"Trivial script.\""}}},"ScriptsSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Script"}}}},"SecurityV2":{"type":"object","properties":{"dataProtected":{"type":"boolean","example":false},"blockLevelEncryptionCapable":{"type":"boolean","example":true},"fileLevelEncryptionCapable":{"type":"boolean","example":true},"passcodePresent":{"type":"boolean","example":false},"passcodeCompliant":{"type":"boolean","example":true},"passcodeCompliantWithProfile":{"type":"boolean","example":true},"hardwareEncryption":{"type":"integer","example":3},"activationLockEnabled":{"type":"boolean","example":false},"jailBreakDetected":{"type":"boolean","example":false},"attestationStatus":{"type":"string","readOnly":true,"example":"SUCCESS","enum":["PENDING","SUCCESS","CERTIFICATE_INVALID","DEVICE_PROPERTIES_MISMATCH","MDA_UNSUPPORTED_DUE_TO_HARDWARE","MDA_UNSUPPORTED_DUE_TO_SOFTWARE"]},"lastAttestationAttemptDate":{"type":"string","format":"date-time","readOnly":true,"example":"2019-02-04T21:09:31.661Z"},"lastSuccessfulAttestationDate":{"type":"string","format":"date-time","readOnly":true,"example":"2019-02-04T21:09:31.661Z"},"bootstrapToken":{"type":"string","description":"The bootstrap token for the device","readOnly":true,"example":"dGVzdCB0b2tlbg=="},"bootstrapTokenEscrowed":{"type":"string","description":"Indicates the bootstrap token escrow status for the device","example":"NOT_SUPPORTED","enum":["ESCROWED","NOT_ESCROWED","NOT_SUPPORTED"]},"lockdownModeEnabled":{"type":"boolean","description":"Whether Lockdown Mode is enabled.","example":false}}},"SmartComputerGroupSearch":{"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"siteId":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"minLength":1,"type":"string","example":"My computer group"},"description":{"minLength":0,"type":"string","example":"My computer group description"},"membershipCount":{"type":"integer","example":231}}},"SmartComputerGroupV3":{"required":["name"],"type":"object","properties":{"name":{"maxLength":255,"type":"string","example":"New Group Name"},"description":{"type":"string","example":"New Group Description"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/ComputerSmartGroupCriteriaV2"}},"siteId":{"type":"string","nullable":true,"example":"-1"}}},"SmartGroup":{"type":"object","properties":{"groupId":{"type":"string","example":"1"},"groupName":{"type":"string","example":"Smart iPad Group"},"groupDescription":{"type":"string","example":"A smart group containing iPads meeting certain criteria"},"siteId":{"type":"string","example":"-1"},"count":{"minimum":0,"type":"integer","description":"membership count","example":25}}},"SmartGroupAssignmentV2":{"required":["groupName"],"type":"object","properties":{"groupId":{"minLength":1,"type":"string","description":"The unique identifier of the smart group","readOnly":true,"example":"7"},"groupName":{"maxLength":255,"minLength":1,"type":"string","example":"Smart iPads Group"},"groupDescription":{"type":"string","example":"Smart iPads that meet certain criteria"},"siteId":{"type":"string","example":"-1"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceSmartGroupCriteriaV2"}}}},"SmartGroupDetailV2":{"allOf":[{"$ref":"#/components/schemas/SmartGroup"},{"type":"object","properties":{"criteria":{"minLength":0,"type":"array","description":"The criteria used to define the smart group","items":{"$ref":"#/components/schemas/MobileDeviceSmartGroupCriteriaV2"}}}}]},"SmartGroupMembership":{"type":"object","properties":{"members":{"minLength":0,"type":"array","example":[1,2,3],"items":{"type":"integer"}}},"description":"the ids of the computers that are members of the smart group"},"SmartGroupSearchResult":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/SmartComputerGroupSearch"}}}},"SmartGroupSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":2},"results":{"type":"array","items":{"$ref":"#/components/schemas/SmartGroup"}}}},"SmartSearchCriterion":{"required":["andOr","name","searchType","value"],"type":"object","properties":{"name":{"type":"string","example":"Account"},"priority":{"type":"integer","example":0},"andOr":{"type":"string","example":"and"},"searchType":{"type":"string","example":"is"},"value":{"type":"string","example":"test"},"openingParen":{"type":"boolean","example":false},"closingParen":{"type":"boolean","example":false}}},"StaticComputerGroup":{"required":["id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","example":"1"},"name":{"minLength":1,"type":"string","example":"Test Static Computer Group"},"description":{"type":"string","nullable":true,"example":"A test static computer group"},"siteId":{"type":"string","nullable":true,"example":"-1"}}},"StaticComputerGroupAssignment":{"required":["name"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"maxLength":255,"minLength":1,"type":"string","example":"Test Static Computer Group"},"description":{"type":"string","nullable":true,"example":"A test static computer group"},"siteId":{"type":"string","nullable":true,"example":"-1"},"assignments":{"uniqueItems":true,"type":"array","description":"Set of computer IDs to assign to the static group","items":{"minLength":1,"type":"string","example":"1"}}}},"StaticComputerGroupSearchResults":{"required":["results","totalCount"],"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":2},"results":{"type":"array","items":{"$ref":"#/components/schemas/StaticComputerGroupSummary"}}}},"StaticComputerGroupSummary":{"required":["id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","example":"1"},"name":{"minLength":1,"type":"string","example":"Test Static Computer Group"},"description":{"type":"string","nullable":true,"example":"A test static computer group"},"siteId":{"type":"string","nullable":true,"example":"-1"},"count":{"minimum":0,"type":"integer","example":5}}},"StaticGroup":{"type":"object","properties":{"groupId":{"type":"string","example":"6"},"groupName":{"type":"string","example":"Static iPad Group"},"groupDescription":{"type":"string","example":"A static group containing only iPads"},"siteId":{"type":"string","example":"-1"},"count":{"minimum":0,"type":"integer","description":"membership count","example":15}}},"StaticGroupAssignment":{"required":["groupName"],"type":"object","properties":{"groupId":{"minLength":1,"type":"string","readOnly":true,"example":"7"},"groupName":{"maxLength":255,"minLength":1,"type":"string","example":"Static iPads"},"groupDescription":{"type":"string","example":"Static iPads"},"siteId":{"type":"string","example":"-1"},"assignments":{"type":"array","items":{"$ref":"#/components/schemas/Assignment"}}}},"StaticGroupSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/StaticGroup"}}}},"SupervisionIdentity":{"type":"object","properties":{"id":{"type":"integer","example":1},"displayName":{"type":"string","example":"Supervision Identity"},"commonName":{"type":"string","example":"Jamf Identity - Supervision Identity"},"expirationDate":{"type":"string","example":"2000-10-31"}}},"SupervisionIdentityCreate":{"required":["displayName","password"],"type":"object","properties":{"displayName":{"type":"string","example":"Supervision Identity"},"password":{"type":"string","format":"password","example":"jamf1234"}}},"SupervisionIdentitySearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/SupervisionIdentity"}}}},"SupervisionIdentityUpdate":{"required":["displayName"],"type":"object","properties":{"displayName":{"type":"string","example":"Supervision Identity"}}},"SystemHealthV2":{"type":"object","properties":{"baseband":{"maxLength":255,"type":"string","example":"ok"},"camera":{"maxLength":255,"type":"string","example":"ok"},"display":{"maxLength":255,"type":"string","example":"ok"},"faceId":{"maxLength":255,"type":"string","example":"ok"},"touchId":{"maxLength":255,"type":"string","example":"ok"},"nfc":{"maxLength":255,"type":"string","example":"ok"},"ultraWideband":{"maxLength":255,"type":"string","example":"ok"}},"description":"System health status for device components. Reported for iOS devices."},"TvOsDetails":{"type":"object","properties":{"model":{"type":"string","example":"Apple TV 3rd Generation Rev 2"},"modelIdentifier":{"type":"string","example":"AppleTV3,2"},"modelNumber":{"type":"string","example":"MD199LL"},"supervised":{"type":"boolean","example":true},"airplayPassword":{"type":"string","format":"password","example":"1234"},"deviceId":{"type":"string","example":"1"},"locales":{"type":"string","example":"null"},"purchasing":{"$ref":"#/components/schemas/PurchasingV2"},"configurationProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ConfigurationProfile"}},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceCertificateV2"}},"applications":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceApplication"}}},"description":"will be populated if the type is appleTv."},"UpdateIosV2":{"type":"object","properties":{"purchasing":{"$ref":"#/components/schemas/PurchasingV2"}}},"UpdateMobileDeviceV2":{"type":"object","properties":{"name":{"type":"string","description":"Mobile Device Name. When updated, Jamf Pro sends an MDM settings command to the device (device must be supervised).","example":"Jan's Mobile Device"},"enforceName":{"type":"boolean","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.","example":true},"assetTag":{"type":"string","example":"8675309"},"siteId":{"type":"string","example":"1"},"timeZone":{"type":"string","description":"IANA time zone database name","example":"Europe/Warsaw"},"location":{"$ref":"#/components/schemas/LocationV2"},"updatedExtensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ExtensionAttributeV2"}},"ios":{"$ref":"#/components/schemas/UpdateIosV2"},"tvos":{"$ref":"#/components/schemas/UpdateTvOs"}}},"UpdateTvOs":{"type":"object","properties":{"airplayPassword":{"type":"string","format":"password","example":"12345"},"purchasing":{"$ref":"#/components/schemas/PurchasingV2"}}},"User":{"allOf":[{"$ref":"#/components/schemas/UserInventory"},{"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"}}}]},"UserAccount":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"plainPassword":{"type":"string","format":"password","writeOnly":true,"example":"testpassword4321"},"username":{"type":"string","example":"testusername"},"realname":{"type":"string","example":"Bob Jones"},"email":{"type":"string","example":"bob@jamf.com"},"phone":{"type":"string","example":"715-999-9999"},"ldapServerId":{"type":"integer","example":-1,"default":-1},"distinguishedName":{"type":"string","example":""},"siteId":{"type":"integer","example":-1,"default":-1},"accessLevel":{"type":"string","description":"Access level for the account","enum":["FullAccess","SiteAccess","GroupBasedAccess"],"default":"FullAccess"},"privilegeLevel":{"type":"string","description":"Privilege level for the account","enum":["ADMINISTRATOR","AUDITOR","ENROLLMENT","CUSTOM"],"default":"ADMINISTRATOR"},"lastPasswordChange":{"type":"string","format":"date-time","readOnly":true,"example":"2017-07-21T17:32:28Z"},"changePasswordOnNextLogin":{"type":"boolean","example":true},"failedLoginAttempts":{"type":"integer","readOnly":true,"example":0},"accountStatus":{"type":"string","description":"Status of the account","enum":["Enabled","Disabled"],"default":"Enabled"},"accountType":{"type":"string","description":"Type of the account","enum":["DEFAULT","FEDERATED","MIGRATED"],"default":"DEFAULT"}}},"UserAccountSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","description":"Total number of user accounts matching the filter criteria","example":1},"results":{"minItems":0,"type":"array","description":"The collection of user accounts for the requested page","items":{"$ref":"#/components/schemas/UserAccount"}}}},"UserInventory":{"type":"object","properties":{"username":{"type":"string","example":"jsmith"},"realname":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@example.com"},"phone":{"type":"string","nullable":true,"example":"555-123-4567"},"position":{"type":"string","nullable":true,"example":"IT Manager"},"enableCustomPhotoUrl":{"type":"boolean","example":false},"customPhotoUrl":{"type":"string","example":"https://example.com/photo.jpg"},"managedAppleId":{"type":"string","example":"john@example.com"}}},"V1Site":{"type":"object","properties":{"id":{"type":"string","example":"1"},"divisionId":{"type":"string","description":"Platform division identifier (UUID) for this site.","nullable":true,"example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"Eau Claire"}}},"V1SiteBase":{"type":"object","properties":{"id":{"type":"string","example":"1"},"divisionId":{"type":"string","description":"Platform division identifier (UUID) for this site.","nullable":true,"example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"Eau Claire"}}},"VolumePurchasingContent":{"type":"object","properties":{"name":{"type":"string","readOnly":true,"example":"Example Content"},"licenseCountTotal":{"type":"integer","readOnly":true,"example":1},"licenseCountInUse":{"type":"integer","readOnly":true,"example":1},"licenseCountReported":{"type":"integer","readOnly":true,"example":1},"iconUrl":{"type":"string","readOnly":true,"example":"https://is4-ssl.mzstatic.com/image/thumb/Purple113/v4/73/d4/73/73d47332-fefc-d350-2984-5b4a4755a502/AppIcon-0-1x_U007emarketing-0-0-GLES2_U002c0-512MB-sRGB-0-0-0-85-220-0-0-0-6.png/360x216bb.png"},"deviceTypes":{"type":"array","readOnly":true,"items":{"type":"string","example":"IOS","enum":["IOS","MACOS","TVOS"]}},"contentType":{"type":"string","readOnly":true,"example":"IOS_APP","enum":["IOS_APP","MAC_APP","BOOK","UNKNOWN"]},"pricingParam":{"type":"string","readOnly":true,"example":"STDQ","enum":["STDQ","PLUS","Unknown"]},"adamId":{"type":"string","readOnly":true,"example":"748057890"}}},"VolumePurchasingLocation":{"allOf":[{"$ref":"#/components/schemas/VolumePurchasingLocationListView"},{"type":"object","properties":{"content":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/VolumePurchasingContent"}}}}]},"VolumePurchasingLocationListView":{"type":"object","properties":{"name":{"type":"string","example":"Example Location"},"totalPurchasedLicenses":{"type":"integer","readOnly":true,"example":1},"totalUsedLicenses":{"type":"integer","readOnly":true,"example":1},"id":{"type":"string","readOnly":true,"example":"1"},"appleId":{"type":"string","readOnly":true,"example":"testUser@appleId.com"},"email":{"type":"string","readOnly":true,"example":"testUser@email.com"},"organizationName":{"type":"string","readOnly":true,"example":"Jamf"},"tokenExpiration":{"type":"string","readOnly":true,"example":"2022-04-25T21:09:31.661Z"},"countryCode":{"type":"string","description":"The two-letter ISO 3166-1 code that designates the country where the Volume Purchasing account is located.","readOnly":true,"example":"US"},"locationName":{"type":"string","readOnly":true,"example":"Example Location"},"clientContextMismatch":{"type":"boolean","description":"If this is \"true\", the clientContext used by this server does not match the clientContext returned by the Volume Purchasing API.","readOnly":true,"example":false},"automaticallyPopulatePurchasedContent":{"type":"boolean","example":false},"sendNotificationWhenNoLongerAssigned":{"type":"boolean","example":false},"autoRegisterManagedUsers":{"type":"boolean","example":false},"siteId":{"type":"string","example":"1"},"siteName":{"type":"string","example":"Example Name"},"lastSyncTime":{"type":"string","readOnly":true,"example":"2022-09-25T21:09:31.661Z"}}},"VolumePurchasingLocationPatch":{"type":"object","properties":{"name":{"type":"string","nullable":false,"example":"Example Location"},"automaticallyPopulatePurchasedContent":{"type":"boolean","nullable":false,"example":false},"sendNotificationWhenNoLongerAssigned":{"type":"boolean","nullable":false,"example":false},"autoRegisterManagedUsers":{"type":"boolean","example":false,"default":false},"siteId":{"type":"string","nullable":false,"example":"1"},"serviceToken":{"type":"string","nullable":false,"example":"eyJleHBEYXRlIjoiMjAyMi0wMy0yOVQxNTozNjoyNiswMDAwIiwidG9rZW4iOiJWR2hwY3lCcGN5QnViM1FnWVNCMGIydGxiaTRnU0c5d1pXWjFiR3g1SUdsMElHeHZiMnR6SUd4cGEyVWdZU0IwYjJ0bGJpd2dZblYwSUdsMEozTWdibTkwTGc9PSIsIm9yZ05hbWUiOiJFeGFtcGxlIE9yZyJ9"}}},"VolumePurchasingLocationPost":{"required":["serviceToken"],"type":"object","properties":{"name":{"type":"string","description":"If no value is provided when creating a VolumePurchasingLocation object, the 'name' will default to the 'locationName' value","example":"Example Location"},"automaticallyPopulatePurchasedContent":{"type":"boolean","example":false,"default":false},"sendNotificationWhenNoLongerAssigned":{"type":"boolean","example":false,"default":false},"autoRegisterManagedUsers":{"type":"boolean","example":false,"default":false},"siteId":{"type":"string","example":"1","default":"-1"},"serviceToken":{"type":"string","example":"eyJleHBEYXRlIjoiMjAyMi0wMy0yOVQxNTozNjoyNiswMDAwIiwidG9rZW4iOiJWR2hwY3lCcGN5QnViM1FnWVNCMGIydGxiaTRnU0c5d1pXWjFiR3g1SUdsMElHeHZiMnR6SUd4cGEyVWdZU0IwYjJ0bGJpd2dZblYwSUdsMEozTWdibTkwTGc9PSIsIm9yZ05hbWUiOiJFeGFtcGxlIE9yZyJ9"}}},"VolumePurchasingLocations":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/VolumePurchasingLocationListView"}}}},"VolumePurchasingSubscription":{"allOf":[{"$ref":"#/components/schemas/VolumePurchasingSubscriptionBase"},{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"}}}]},"VolumePurchasingSubscriptionBase":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","example":"Example"},"enabled":{"type":"boolean","example":true,"default":true},"triggers":{"type":"array","items":{"type":"string","example":"NO_MORE_LICENSES","enum":["NO_MORE_LICENSES","REMOVED_FROM_APP_STORE"]}},"locationIds":{"type":"array","items":{"pattern":"^\\d+$","type":"string","example":"1"}},"internalRecipients":{"type":"array","items":{"$ref":"#/components/schemas/InternalRecipient"}},"externalRecipients":{"type":"array","items":{"$ref":"#/components/schemas/ExternalRecipient"}},"siteId":{"type":"string","example":"1","default":"-1"}}},"VolumePurchasingSubscriptions":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/VolumePurchasingSubscription"}}}},"WatchOsDetailsV2":{"type":"object","properties":{"model":{"type":"string","example":"Apple Watch Ultra"},"modelIdentifier":{"type":"string","example":"Watch6,18"},"modelNumber":{"type":"string","example":"A2622"},"supervised":{"type":"boolean","example":true},"batteryLevel":{"type":"integer","example":100},"capacityMb":{"type":"integer","example":27503},"availableMb":{"type":"integer","example":26646},"percentageUsed":{"type":"integer","example":3},"deviceLocatorServiceEnabled":{"type":"boolean","example":false},"doNotDisturbEnabled":{"type":"boolean","example":false},"lastCloudBackupTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56.307Z"},"iTunesStoreAccountActive":{"type":"boolean","example":false},"bleCapable":{"type":"boolean","example":false},"unlockToken":{"type":"string","example":"VU5MT0NLVE9LRU4="},"security":{"$ref":"#/components/schemas/SecurityV2"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceApplication"}},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceCertificateV2"}},"configurationProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ConfigurationProfile"}},"provisioningProfiles":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceProvisioningProfiles"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceAttachmentV2"}}},"description":"will be populated if the type is watchos."},"advanced_computer_search":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"description":"Name of the advanced computer search","type":"string","example":"Advanced Search Name"},"view_as":{"type":"string","example":"Standard Web Page"},"sort_1":{"type":"string"},"sort_2":{"type":"string"},"sort_3":{"type":"string"},"criteria":{"type":"array","items":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"criterion":{"$ref":"#/components/schemas/criterion"}}}},"display_fields":{"type":"array","items":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"display_field":{"type":"object","properties":{"name":{"type":"string","example":"IP Address","description":"Name of the display field"}}}}}},"computers":{"type":"array","items":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"computer":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string","example":"Joes iMac","description":"Name of the computer"},"udid":{"type":"string","example":"55900BDC-347C-58B1-D249-F32244B11D30"},"Computer_Name":{"type":"string","example":"Joes iMac"}}}}}},"site":{"$ref":"#/components/schemas/site_object"}},"required":["name"]},"advanced_computer_searches":{"type":"array","items":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"advanced_computer_search":{"$ref":"#/components/schemas/id_name"}}}},"advanced_user_search":{"title":"advanced_user_search","type":"object","properties":{"id":{"type":"integer","example":1},"name":{"description":"Name of the advanced user search","type":"string","example":"Advanced Search Name"},"criteria":{"type":"array","items":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"criterion":{"type":"object","properties":{"name":{"type":"string","example":"Email Address","description":"Name of the criteria"},"priority":{"type":"integer"},"and_or":{"type":"string","enum":["and","or"]},"search_type":{"type":"string","example":"like","description":"Operator"},"value":{"type":"string","example":"company.com"},"opening_paren":{"type":"boolean","default":false},"closing_paren":{"type":"boolean","default":false}}}}}},"users":{"type":"array","items":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"user":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Ted Johnson","description":"Name of the user"},"Username":{"type":"string","example":"Ted Johnson"}}}}}},"display_fields":{"type":"array","items":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"display_field":{"type":"object","properties":{"name":{"type":"string","example":"Email Address","description":"Name of the display field"}}}}}},"site":{"$ref":"#/components/schemas/site_object"}},"required":["name"]},"advanced_user_searches":{"type":"array","items":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"advanced_user_search":{"$ref":"#/components/schemas/id_name"}}}},"attachment":{"type":"object","properties":{"id":{"type":"integer","example":1},"filename":{"type":"string","example":"icon.png"},"uri":{"type":"string","example":"https://example.jamfcloud/attachment.html?id=1&amp;o=r"}}},"byoprofile":{"type":"object","properties":{"general":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Personal Device Profile","description":"Name of the BYO profile"},"site":{"$ref":"#/components/schemas/site_object"},"enabled":{"type":"boolean"},"description":{"type":"string","example":"Used for Android or iOS BYO device enrollments"}},"required":["name"]}}},"byoprofiles":{"type":"array","items":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"byoprofile":{"$ref":"#/components/schemas/id_name"}}}},"category":{"title":"category","type":"object","properties":{"id":{"type":"integer","example":1},"name":{"description":"Name of the category","type":"string","example":"Applications"},"priority":{"type":"integer","default":9}},"required":["name"]},"category_object":{"title":"category","type":"object","properties":{"id":{"type":"integer","default":-1},"name":{"description":"Name of the category","type":"string","default":"Unknown"}},"required":["name"]},"class":{"title":"class","type":"object","properties":{"id":{"type":"integer","example":1},"source":{"type":"string","example":"N/A"},"name":{"description":"Name of the class","type":"string","example":"Math 101"},"description":{"type":"string"},"site":{"$ref":"#/components/schemas/site_object"},"mobile_device_group":{"$ref":"#/components/schemas/id_name"},"students":{"type":"array","items":{"type":"object","properties":{"student":{"type":"string","example":"Joey","description":"Name of the student"}}}},"teachers":{"type":"array","items":{"type":"object","properties":{"teacher":{"type":"string","example":"Mr. Smith","description":"Name of the teacher"}}}},"teacher_ids":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"}}}},"student_group_ids":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"}}}},"teacher_group_ids":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"}}}},"mobile_devices":{"type":"array","items":{"type":"object","properties":{"mobile_device":{"type":"object","properties":{"name":{"type":"string","example":"Tinas iPad","description":"Name of the device"},"udid":{"type":"string","example":"270aae10800b6e61a2ee2bbc285eb967050b5984"},"wifi_mac_address":{"type":"string","example":"E0:AC:CB:97:36:G4"}}}}}},"mobile_device_group_id":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1}}}},"meeting_times":{"type":"object","properties":{"meeting_time":{"type":"object","properties":{"days":{"type":"string","enum":["M","T","W","Th","F","Sa","Su"],"example":"M W F"},"start_time":{"type":"integer","example":1300},"end_time":{"type":"integer","example":1345}}}}},"apple_tvs":{"type":"array","items":{"type":"object","properties":{"apple_tv":{"type":"object","properties":{"name":{"type":"string","example":"Apple TV"},"udid":{"type":"string","example":"3e8c9775cb3302ed9e645adf632cfa533adc3aa8"},"wifi_mac_address":{"type":"string","example":"E0:AC:CB:97:36:G4"},"device_id":{"type":"string","example":"E0:AC:CB:97:36:g5"},"airplay_password":{"type":"string","example":"password"}}}}}}},"required":["name"]},"classes":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"class":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Biology 101","description":"Name of the class"},"description":{"type":"string"}}}}}},"computer_invitation":{"type":"object","properties":{"id":{"type":"integer","example":1},"invitation":{"type":"integer","example":7.249663721735319e+37,"readOnly":true},"invitation_status":{"type":"string","example":"INVITATION_EXPIRED","readOnly":true},"invitation_type":{"type":"string","example":"USER_INITATIED_EMAIL"},"expiration_date":{"type":"string","description":"Use 'Unlimited' to specify no expiration date","example":"2012-05-07 11:13:35"},"expiration_date_utc":{"type":"string","example":"2012-05-07T11:13:35.609-0500","readOnly":true},"expiration_date_epoch":{"type":"integer","example":1336407215609,"readOnly":true},"ssh_username":{"type":"string","example":"jamfadmin"},"ssh_password":{"type":"string","example":"accountpassword"},"multiple_users_allowed":{"type":"boolean","default":false},"times_used":{"type":"integer","example":0,"readOnly":true},"create_account_if_does_not_exist":{"type":"boolean","default":false},"hide_account":{"type":"boolean","default":false},"lock_down_ssh":{"type":"boolean","default":false},"invited_user_uuid":{"type":"string","example":"B87E9AA8-C3DE-4034-821E-1B7D51FD4956","readOnly":true},"enroll_into_site":{"type":"object","properties":{"id":{"type":"integer","default":-1},"name":{"type":"string","default":"None"}}},"keep_existing_site_membership":{"type":"boolean","default":false},"site":{"$ref":"#/components/schemas/site_object"}}},"computer_invitations":{"type":"array","items":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"computer_invitation":{"type":"object","properties":{"id":{"type":"integer","example":1},"invitation":{"type":"integer","example":7.249663721735319e+37},"invitation_type":{"type":"string","example":"USER_INITATIED_EMAIL"},"expiration_date":{"type":"string","example":"2012-05-07 11:13:35"},"expiration_date_utc":{"type":"string","example":"2012-05-07T11:13:35.609-0500"},"expiration_date_epoch":{"type":"integer","example":1336407215609}}}}}},"criterion":{"type":"object","properties":{"name":{"type":"string","example":"Last Inventory Update","description":"Name of the criteria"},"priority":{"type":"integer"},"and_or":{"type":"string","enum":["and","or"]},"search_type":{"type":"string","example":"more than x days ago","description":"Operator"},"value":{"type":"string","example":7},"opening_paren":{"type":"boolean","default":false},"closing_paren":{"type":"boolean","default":false}}},"directory_binding":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"AD Binding","description":"Name of the binding"},"priority":{"type":"integer","example":1},"domain":{"type":"string","example":"ad.company.com"},"username":{"type":"string","example":"AD\\Administrator","description":"Network administrator account to bind with"},"password":{"type":"string","description":"Password for the network administrator account"},"computer_ou":{"type":"string","example":"CN=Computers,DC=ad,DC=company,DC=com","description":"OU to bind computers to"},"type":{"type":"string","example":"Active Directory"}},"required":["name"]},"directory_bindings":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"directory_binding":{"$ref":"#/components/schemas/id_name"}}}},"disk_encryption_configuration":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Corporate Encryption","description":"Name of the disk encryption configuration"},"key_type":{"type":"string","enum":["Individual","Institutional","Individual And Institutional"],"default":"Individual"},"file_vault_enabled_users":{"type":"string","enum":["Current or Next User","Management Account"],"default":"Management Account"}},"required":["name"]},"disk_encryption_configurations":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"disk_encryption_configuration":{"$ref":"#/components/schemas/id_name"}}}},"distribution_point":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"New York Share","description":"Name of the distribution point"},"ip_address":{"type":"string","example":"ny.company.com","description":"IP address or hostname of distribution point"},"is_master":{"type":"boolean","default":false,"description":"Only one share can be set as master"},"failover_point":{"type":"string"},"failover_point_url":{"type":"string"},"enable_load_balancing":{"type":"boolean","default":false},"local_path":{"type":"string"},"ssh_username":{"type":"string","example":"username"},"password":{"type":"string","example":"password"},"connection_type":{"type":"string","enum":["SMB","AFP"]},"share_name":{"type":"string","example":"Caspershare","description":"Name of the share"},"workgroup_or_domain":{"type":"string","description":"Workgroup or domain of the accounts that have access to the share (SMB only)","example":"COMPANY"},"share_port":{"type":"integer","example":139},"read_only_username":{"type":"string","example":"casperinstall","description":"Account with read only privileges to the share"},"read_only_password":{"type":"string","example":"password","description":"Password for the read only account"},"read_write_username":{"type":"string","example":"casperwrite","description":"Account with read/write privileges to the share"},"read_write_password":{"type":"string","example":"password","description":"Password for the read/write account"},"http_downloads_enabled":{"type":"boolean","example":true,"default":false},"http_url":{"type":"string","example":"http://ny.company.com/CasperShare","description":"URL to download packages from"},"context":{"type":"string","example":"CasperShare","description":"Path to the share"},"protocol":{"type":"string","enum":["http","https"]},"port":{"type":"integer","example":80},"no_authentication_required":{"type":"boolean","default":true},"username_password_required":{"type":"boolean","default":false},"http_username":{"type":"string","example":"casperinstall","description":"Username to authenticate with for basic authentication"},"http_password":{"type":"string","description":"Password for basic authentication"}},"required":["name","share_name","read_only_username","read_write_username"]},"distribution_points":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"distribution_point":{"$ref":"#/components/schemas/id_name"}}}},"ibeacon":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Room 123 Beacon","description":"Name of the ibeacon"},"uuid":{"type":"string","example":"55900BDC-347C-58B1-D249-F32244B11D30"},"major":{"type":"string","example":-1},"minor":{"type":"string","example":-1}},"required":["name","uuid"]},"ibeacons":{"type":"array","items":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"ibeacon":{"$ref":"#/components/schemas/ibeacon"}}}},"id_name":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string"}}},"licensed_software":{"type":"object","properties":{"general":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Adobe Creative Suite","description":"Name of the licensed software"},"publisher":{"type":"string","example":"Adobe Systems Incorporated"},"platform":{"type":"string","example":"Mac"},"send_email_on_violation":{"type":"boolean"},"remove_titles_from_inventory_reports":{"type":"boolean"},"exclude_titles_purchased_from_app_store":{"type":"boolean"},"notes":{"type":"string"},"site":{"$ref":"#/components/schemas/site_object"}},"required":["name"]},"software_definitions":{"type":"array","items":{"properties":{"definition":{"$ref":"#/components/schemas/licensed_software_defintion"}}}},"font_definitions":{"type":"array","items":{"properties":{"definition":{"$ref":"#/components/schemas/licensed_software_defintion"}}}},"plugin_definitions":{"type":"array","items":{"properties":{"definition":{"$ref":"#/components/schemas/licensed_software_defintion"}}}},"licenses":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"license":{"type":"object","properties":{"serial_number_1":{"type":"string"},"serial_number_2":{"type":"string"},"organization_name":{"type":"string"},"registered_to":{"type":"string"},"license_type":{"type":"string","enum":["Standard","Concurrent","Site License"]},"license_count":{"type":"integer","example":500},"notes":{"type":"string"},"purchasing":{"type":"object","properties":{"is_perpetual":{"type":"boolean","default":true},"is_annual":{"type":"boolean","default":false},"po_number":{"type":"string"},"vendor":{"type":"string"},"purchase_price":{"type":"string"},"purchasing_account":{"type":"string"},"po_date":{"type":"string"},"po_date_epoch":{"type":"integer"},"po_date_utc":{"type":"string"},"license_expires":{"type":"string"},"license_expires_epoch":{"type":"integer"},"license_expires_utc":{"type":"string"},"life_expectancy":{"type":"integer"},"purchasing_contact":{"type":"string"}}},"attachments":{"type":"array","items":{"properties":{"attachment":{"$ref":"#/components/schemas/attachment"}}}}}}}}}}},"licensed_software_all":{"xml":{"name":"licensed_software"},"type":"array","items":{"properties":{"licensed_software":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Adobe Creative Suite","description":"Name of the licensed software"}}}}}},"licensed_software_defintion":{"xml":{"name":"definition"},"type":"object","properties":{"compare_type":{"type":"string","enum":["like","is"]},"name":{"type":"string"},"version":{"type":"string","example":14}}},"location":{"type":"object","properties":{"username":{"type":"string","example":"JBetty"},"realname":{"type":"string","example":"Betty Jackson"},"real_name":{"type":"string","example":"Betty Jackson"},"email_address":{"type":"string","example":"jbetty@company.com"},"position":{"type":"string","example":"Systems Engineer"},"phone":{"type":"string","example":"123-555-6789"},"phone_number":{"type":"string","example":"123-555-6789"},"department":{"type":"string","example":"Sales Staff"},"building":{"type":"string","example":"New York Office"},"room":{"type":"string","example":1159}}},"mac_application":{"type":"object","properties":{"general":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"TextWrangler.app","description":"Name of the application"},"version":{"type":"string","example":"5.5.2"},"is_free":{"type":"boolean"},"bundle_id":{"type":"string","example":"com.barebones.textwrangler"},"url":{"type":"string","example":"https://itunes.apple.com/us/app/textwrangler/id404010395?mt=12&amp;uo=4"},"category":{"$ref":"#/components/schemas/category_object"},"site":{"$ref":"#/components/schemas/site_object"}},"required":["name","version","bundle_id","url"]},"scope":{"type":"object","properties":{"all_computers":{"type":"boolean","default":false},"all_jss_users":{"type":"boolean","default":false},"buildings":{"type":"array","items":{"type":"object","properties":{"building":{"$ref":"#/components/schemas/id_name"}}}},"departments":{"type":"array","items":{"type":"object","properties":{"department":{"$ref":"#/components/schemas/id_name"}}}},"computers":{"type":"array","items":{"type":"object","properties":{"computer":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Admins MacBook Pro","description":"Name of the computer"},"udid":{"type":"string","example":"55900BDC-347C-58B1-D249-F32244B11D30"}}}}}},"computer_groups":{"type":"array","items":{"type":"object","properties":{"computer_group":{"$ref":"#/components/schemas/id_name"}}}},"jss_users":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/id_name"}}}},"jss_user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}},"limitations":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/id_name"}}}},"user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}},"network_segments":{"type":"array","items":{"type":"object","properties":{"network_segment":{"$ref":"#/components/schemas/id_name"}}}}}},"exclusions":{"type":"object","properties":{"buildings":{"type":"array","items":{"type":"object","properties":{"building":{"$ref":"#/components/schemas/id_name"}}}},"departments":{"type":"array","items":{"type":"object","properties":{"department":{"$ref":"#/components/schemas/id_name"}}}},"users":{"type":"array","items":{"type":"object","properties":{"user":{"type":"object","properties":{"name":{"type":"string","example":"Adam"}}}}}},"user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}},"network_segments":{"type":"array","items":{"type":"object","properties":{"network_segment":{"type":"object","properties":{"id":{"type":"integer","example":1},"uid":{"type":"string"},"name":{"type":"string","example":"New York","description":"Name of the network segment"}}}}}},"computers":{"type":"array","items":{"type":"object","properties":{"computer":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Johns iMac","description":"Name of the computer"},"udid":{"type":"string","example":"55900BDC-347C-58B1-D249-F32244B11D30"}}}}}},"computer_groups":{"type":"array","items":{"type":"object","properties":{"computer_group":{"$ref":"#/components/schemas/id_name"}}}},"jss_users":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/id_name"}}}},"jss_user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}}}}}},"self_service":{"type":"object","properties":{"install_button_text":{"type":"string","example":"Install"},"self_service_description":{"type":"string","example":"Installs the TextWrangler application"},"force_users_to_view_description":{"type":"boolean"},"self_service_icon":{"type":"object","properties":{"id":{"type":"integer","example":1},"uri":{"type":"string","example":"https://company.jamfcloud.com/iconservlet/?id=1"},"data":{"type":"string"}}},"feature_on_main_page":{"type":"boolean"},"self_service_categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Applications"},"display_in":{"type":"boolean","example":true},"feature_in":{"type":"boolean","example":false}}}}}},"notification":{"type":"string"},"notification_subject":{"type":"string","example":"TextWrangler is Available to Install"},"notification_message":{"type":"string","example":"You can install TextWrangler by clicking this link or going to Self Service"},"vpp":{"type":"object","properties":{"assign_vpp_device_based_licenses":{"type":"boolean","default":false},"vpp_admin_account_id":{"type":"integer","default":-1}}}}}}},"mac_applications":{"type":"array","items":{"properties":{"mac_application":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"TextWrangler.app","description":"Name of the application"}}}}}},"mobile_device_application":{"type":"object","properties":{"general":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Self Service Mobile"},"display_name":{"type":"string","example":"Self Service Mobile"},"description":{"type":"string"},"bundle_id":{"type":"string","example":"com.jamfsoftware.selfservice"},"version":{"type":"string","example":9.98},"internal_app":{"type":"boolean"},"category":{"$ref":"#/components/schemas/category_object"},"ipa":{"type":"object","properties":{"name":{"type":"string","example":"Self Service Mobile.ipa"},"uri":{"type":"string"},"data":{"type":"string"}}},"icon":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"1024x1024bb.png"},"uri":{"type":"string","example":"https://company.jamfcloud.com/iconservlet/?id=1018&amp;scale=1"},"data":{"type":"string","description":"base64 encoded"}}},"mobile_device_provisioning_profile":{"type":"integer"},"itunes_store_url":{"type":"string"},"make_available_after_install":{"type":"boolean"},"itunes_country_region":{"type":"string"},"itunes_sync_time":{"type":"integer"},"deployment_type":{"type":"string","enum":["Make Available in Self Service","Install Automatically/Prompt Users to Install"]},"deploy_automatically":{"type":"boolean"},"deploy_as_managed_app":{"type":"boolean"},"remove_app_when_mdm_profile_is_removed":{"type":"boolean"},"prevent_backup_of_app_data":{"type":"boolean"},"keep_description_and_icon_up_to_date":{"type":"boolean"},"free":{"type":"boolean"},"take_over_management":{"type":"boolean"},"host_externally":{"type":"boolean"},"external_url":{"type":"string","example":"https://itunes.apple.com/us/app/self-service-mobile/id718509958?mt=8&amp;uo=4"},"site":{"$ref":"#/components/schemas/site_object"}},"required":["name","bundle_id","version"]},"scope":{"type":"object","properties":{"all_mobile_devices":{"type":"boolean"},"all_jss_users":{"type":"boolean"},"mobile_devices":{"type":"array","items":{"type":"object","properties":{"mobile_device":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Admins iPad","description":"Name of the device"},"udid":{"type":"string","example":"270aae10800b6e61a2ee2bbc285eb967050b5984"},"wifi_mac_address":{"type":"string","example":"E0:AC:CB:97:36:G4"}}}}}},"buildings":{"type":"array","items":{"type":"object","properties":{"building":{"$ref":"#/components/schemas/id_name"}}}},"departments":{"type":"array","items":{"type":"object","properties":{"department":{"$ref":"#/components/schemas/id_name"}}}},"mobile_device_groups":{"type":"array","items":{"type":"object","properties":{"mobile_device_group":{"$ref":"#/components/schemas/id_name"}}}},"jss_users":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/id_name"}}}},"jss_user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}},"limitations":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/id_name"}}}},"user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}},"network_segments":{"type":"array","items":{"type":"object","properties":{"network_segment":{"$ref":"#/components/schemas/id_name"}}}}}},"exclusions":{"type":"object","properties":{"mobile_devices":{"type":"array","items":{"type":"object","properties":{"mobile_device":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Johns iPad","description":"Name of the device"},"udid":{"type":"string","example":"270aae10800b6e61a2ee2bbc285eb967050b5984"},"wifi_mac_address":{"type":"string","example":"E0:AC:CB:97:36:G4"}}}}}},"buildings":{"type":"array","items":{"type":"object","properties":{"building":{"$ref":"#/components/schemas/id_name"}}}},"departments":{"type":"array","items":{"type":"object","properties":{"department":{"$ref":"#/components/schemas/id_name"}}}},"mobile_device_groups":{"type":"array","items":{"type":"object","properties":{"mobile_device_group":{"$ref":"#/components/schemas/id_name"}}}},"users":{"type":"array","items":{"type":"object","properties":{"user":{"type":"object","properties":{"name":{"type":"string","example":"Adam"}}}}}},"user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}},"network_segments":{"type":"array","items":{"type":"object","properties":{"network_segment":{"type":"object","properties":{"id":{"type":"integer","example":1},"uid":{"type":"string"},"name":{"type":"string","example":"New York","description":"Name of the network segment"}}}}}},"jss_users":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/id_name"}}}},"jss_user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}}}}}},"self_service":{"type":"object","properties":{"self_service_description":{"type":"string"},"self_service_icon":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"1024x1024bb.png"},"uri":{"type":"string","example":"https://company.jamfcloud.com/iconservlet/?id=1018&amp;scale=1"},"data":{"type":"string","description":"base64 encoded"}}},"feature_on_main_page":{"type":"boolean"},"self_service_categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Education Tools"},"display_in":{"type":"boolean","default":true}}}}}},"notification":{"type":"boolean"},"notification_subject":{"type":"string","example":"New App Avaialble"},"notification_message":{"type":"string","example":"Click here to open Self Service and install this new application!"}}},"vpp":{"type":"object","properties":{"assign_vpp_device_based_licenses":{"type":"boolean","default":false},"vpp_admin_account_id":{"type":"integer","example":-1}}},"app_configuration":{"type":"object","properties":{"preferences":{"type":"string"}}}}},"mobile_device_applications":{"type":"array","items":{"properties":{"mobile_device_application":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Self Service Mobile"},"display_name":{"type":"string","example":"Self Service Mobile"},"bundle_id":{"type":"string","example":"com.jamfsoftware.selfservice"},"version":{"type":"string","example":9.98},"internal_app":{"type":"boolean"}}}}}},"mobile_device_configuration_profile":{"type":"object","xml":{"name":"configuration_profile"},"properties":{"general":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Corporate Wireless","description":"Name of the configuration profile"},"description":{"type":"string"},"level":{"type":"string","enum":["System","User"],"description":"Level of the configuration profile","default":"System"},"site":{"$ref":"#/components/schemas/site_object"},"category":{"$ref":"#/components/schemas/category_object"},"uuid":{"type":"string","example":"55900BDC-347C-58B1-D249-F32244B11D30"},"deployment_method":{"type":"string","enum":["Install Automatically","Make Available in Self Service"]},"redeploy_on_update":{"type":"string","example":"Newly Assigned"},"redeploy_Dayss_before_certificate_expires":{"type":"integer"},"payloads":{"type":"string"}},"required":["name"]},"scope":{"type":"object","properties":{"all_mobile_devices":{"type":"boolean"},"all_jss_users":{"type":"boolean"},"mobile_devices":{"type":"array","items":{"type":"object","properties":{"mobile_device":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Admins iPad","description":"Name of the device"},"udid":{"type":"string","example":"270aae10800b6e61a2ee2bbc285eb967050b5984"},"wifi_mac_address":{"type":"string","example":"E0:AC:CB:97:36:G4"}}}}}},"buildings":{"type":"array","items":{"type":"object","properties":{"building":{"$ref":"#/components/schemas/id_name"}}}},"departments":{"type":"array","items":{"type":"object","properties":{"department":{"$ref":"#/components/schemas/id_name"}}}},"mobile_device_groups":{"type":"array","items":{"type":"object","properties":{"mobile_device_group":{"$ref":"#/components/schemas/id_name"}}}},"jss_users":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/id_name"}}}},"jss_user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}},"limitations":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/id_name"}}}},"user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}},"network_segments":{"type":"array","items":{"type":"object","properties":{"network_segment":{"$ref":"#/components/schemas/id_name"}}}},"ibeacons":{"type":"array","items":{"type":"object","properties":{"ibeacon":{"$ref":"#/components/schemas/id_name"}}}}}},"exclusions":{"type":"object","properties":{"mobile_devices":{"type":"array","items":{"type":"object","properties":{"mobile_device":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Johns iPad","description":"Name of the device"},"udid":{"type":"string","example":"270aae10800b6e61a2ee2bbc285eb967050b5984"},"wifi_mac_address":{"type":"string","example":"E0:AC:CB:97:36:G4"}}}}}},"buildings":{"type":"array","items":{"type":"object","properties":{"building":{"$ref":"#/components/schemas/id_name"}}}},"departments":{"type":"array","items":{"type":"object","properties":{"department":{"$ref":"#/components/schemas/id_name"}}}},"mobile_device_groups":{"type":"array","items":{"type":"object","properties":{"mobile_device_group":{"$ref":"#/components/schemas/id_name"}}}},"users":{"type":"array","items":{"type":"object","properties":{"user":{"type":"object","properties":{"name":{"type":"string","example":"Adam"}}}}}},"user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}},"network_segments":{"type":"array","items":{"type":"object","properties":{"network_segment":{"type":"object","properties":{"id":{"type":"integer","example":1},"uid":{"type":"string"},"name":{"type":"string","example":"New York","description":"Name of the network segment"}}}}}},"ibeacons":{"type":"array","items":{"type":"object","properties":{"ibeacon":{"$ref":"#/components/schemas/id_name"}}}},"jss_users":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/id_name"}}}},"jss_user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}}}}}},"self_service":{"type":"object","properties":{"self_service_description":{"type":"string","example":"Install this profile to access resources on the corporate network"},"security_name":{"xml":{"name":"security"},"type":"object","properties":{"removal_disallowed":{"type":"string","example":"Never"}}},"self_service_icon":{"type":"object","properties":{"filename":{"type":"string","example":"WiFi.png"},"uri":{"type":"string","example":"https://company.jamfcloud.com/iconservelet/?id=1"},"data":{"type":"string"}}},"feature_on_main_page":{"type":"boolean"},"self_service_categories":{"type":"array","items":{"properties":{"category":{"$ref":"#/components/schemas/category"}}}}}}}},"mobile_device_configuration_profiles":{"xml":{"name":"configuration_profiles"},"type":"array","items":{"properties":{"configuration_profile":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Corporate Wireless","description":"Name of the configuration profile"}}}}}},"mobile_device_enrollment_profile":{"type":"object","properties":{"general":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Configurator Enrollment Profile","description":"Name of the enrollment profile"},"invitation":{"type":"string","example":2.0938027893325487e+38},"udid":{"type":"string","example":"55900BDC-347C-58B1-D249-F32244B11D30"},"description":{"type":"string"}},"required":["name"]},"location":{"$ref":"#/components/schemas/location"},"purchasing":{"$ref":"#/components/schemas/purchasing"},"attachments":{"type":"array","items":{"properties":{"attachment":{"$ref":"#/components/schemas/attachment"}}}}}},"mobile_device_enrollment_profiles":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"mobile_device_enrollment_profile":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Configurator Enrollment Profile","description":"Name of the enrollment profile"},"invitation":{"type":"string","example":2.0938027893325487e+38}}}}}},"mobile_device_provisioning_profile":{"type":"object","properties":{"general":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"in-house app profile"},"display_name":{"type":"string","example":"in-house app profile"},"uuid":{"type":"string","example":"116AF1E6-7EB5-4335-B598-276CDE5E015B"}}}}},"mobile_device_provisioning_profiles":{"type":"array","items":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"mobile_device_provisioning_profile":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"in-house app profile"},"display_name":{"type":"string","example":"in-house app profile"},"uuid":{"type":"string","example":"116AF1E6-7EB5-4335-B598-276CDE5E015B"}}}}}},"network_segment":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Amsterdam Office","description":"Name of the network segment"},"starting_address":{"type":"string","example":"10.1.1.1"},"ending_address":{"type":"string","example":"10.10.1.1"},"distribution_server":{"type":"string"},"distribution_point":{"type":"string"},"url":{"type":"string"},"swu_server":{"type":"string"},"building":{"type":"string"},"department":{"type":"string"},"override_buildings":{"type":"boolean","default":false},"override_departments":{"type":"boolean","default":false}},"required":["name","starting_address","ending_address"]},"network_segments":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"network_segment":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Amsterdam Office","description":"Name of the network segment"},"starting_address":{"type":"string","example":"10.1.1.1"},"ending_address":{"type":"string","example":"10.10.1.1"}}}}}},"os_x_configuration_profile":{"type":"object","properties":{"general":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Corporate Wireless","description":"Name of the configuration profile"},"description":{"type":"string"},"site":{"$ref":"#/components/schemas/site_object"},"category":{"$ref":"#/components/schemas/category_object"},"distribution_method":{"type":"string","enum":["Install Automatically","Make Available in Self Service"]},"user_removable":{"type":"boolean"},"level":{"type":"string","enum":["computer","user"]},"uuid":{"type":"string","example":"88F8C1DB-D92A-4D10-95FB-CE7EDE82B93E"},"redeploy_on_update":{"type":"string","example":"Newly Assigned"},"payloads":{"type":"string"}},"required":["name"]},"scope":{"type":"object","properties":{"all_computers":{"type":"boolean","default":false},"all_jss_users":{"type":"boolean","default":false},"computers":{"type":"array","items":{"type":"object","properties":{"computer":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Admins MacBook Pro","description":"Name of the computer"},"udid":{"type":"string","example":"55900BDC-347C-58B1-D249-F32244B11D30"}}}}}},"buildings":{"type":"array","items":{"type":"object","properties":{"building":{"$ref":"#/components/schemas/id_name"}}}},"departments":{"type":"array","items":{"type":"object","properties":{"department":{"$ref":"#/components/schemas/id_name"}}}},"computer_groups":{"type":"array","items":{"type":"object","properties":{"computer_group":{"$ref":"#/components/schemas/id_name"}}}},"jss_users":{"type":"array","items":{"type":"object","properties":{"users":{"$ref":"#/components/schemas/id_name"}}}},"jss_user_groups":{"type":"array","items":{"type":"object","properties":{"jss_user_group":{"$ref":"#/components/schemas/id_name"}}}},"limitations":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/id_name"}}}},"user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}},"network_segments":{"type":"array","items":{"type":"object","properties":{"network_segment":{"$ref":"#/components/schemas/id_name"}}}},"ibeacons":{"type":"array","items":{"type":"object","properties":{"ibeacon":{"$ref":"#/components/schemas/id_name"}}}}}},"exclusions":{"type":"object","properties":{"computers":{"type":"array","items":{"type":"object","properties":{"computer":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Johns iMac","description":"Name of the computer"},"udid":{"type":"string","example":"55900BDC-347C-58B1-D249-F32244B11D30"}}}}}},"buildings":{"type":"array","items":{"type":"object","properties":{"building":{"$ref":"#/components/schemas/id_name"}}}},"departments":{"type":"array","items":{"type":"object","properties":{"department":{"$ref":"#/components/schemas/id_name"}}}},"computer_groups":{"type":"array","items":{"type":"object","properties":{"computer_group":{"$ref":"#/components/schemas/id_name"}}}},"users":{"type":"array","items":{"type":"object","properties":{"user":{"type":"object","properties":{"name":{"type":"string","example":"Adam"}}}}}},"user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}},"network_segments":{"type":"array","items":{"type":"object","properties":{"network_segment":{"type":"object","properties":{"id":{"type":"integer","example":1},"uid":{"type":"string"},"name":{"type":"string","example":"New York","description":"Name of the network segment"}}}}}},"ibeacons":{"type":"array","items":{"type":"object","properties":{"ibeacon":{"$ref":"#/components/schemas/id_name"}}}},"jss_users":{"type":"array","items":{"type":"object","properties":{"jss_user":{"$ref":"#/components/schemas/id_name"}}}},"jss_user_groups":{"type":"array","items":{"type":"object","properties":{"jss_user_group":{"$ref":"#/components/schemas/id_name"}}}}}}}},"self_service":{"type":"object","properties":{"install_button_text":{"type":"string","example":"Install"},"self_service_description":{"type":"string"},"force_users_to_view_description":{"type":"boolean"},"self_service_icon":{"type":"object","properties":{"id":{"type":"integer","example":1},"uri":{"type":"string","example":"https://company.jamfcloud.com/iconservlet/?id=1"},"data":{"type":"string"}}},"feature_on_main_page":{"type":"boolean"},"self_service_categories":{"type":"object","properties":{"category":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Compliance"},"display_in":{"type":"boolean","default":true},"feature_in":{"type":"boolean","default":false}}}}},"notification":{"type":"string"},"notification_subject":{"type":"string","example":"Install Me!!!"},"notification_message":{"type":"string","example":"You need access to corporate resources. Install this profile to get the premium WiFis."}}}}},"os_x_configuration_profiles":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"os_x_configuration_profile":{"$ref":"#/components/schemas/id_name"}}}},"policies":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"policy":{"$ref":"#/components/schemas/id_name"}}}},"policy":{"type":"object","properties":{"general":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Disk Encryption"},"enabled":{"type":"boolean"},"trigger":{"type":"string"},"trigger_checkin":{"type":"boolean","default":false},"trigger_enrollment_complete":{"type":"boolean","default":false},"trigger_login":{"type":"boolean","default":false},"trigger_logout":{"type":"boolean","default":false},"trigger_network_state_changed":{"type":"boolean","default":false},"trigger_startup":{"type":"boolean","default":false},"trigger_other":{"type":"string"},"frequency":{"type":"string","enum":["Once per computer","Once per user per computer","Once per user","Once every day","Once every week","Once every month","Ongoing"]},"retry_event":{"type":"string","enum":["none","trigger","check-in"],"default":"none"},"retry_attempts":{"type":"integer","default":-1},"notify_on_each_failed_retry":{"type":"boolean","default":false},"location_user_only":{"type":"boolean"},"target_drive":{"type":"string","example":"/"},"offline":{"type":"boolean"},"category":{"$ref":"#/components/schemas/category_object"},"date_time_limitations":{"type":"object","properties":{"activation_date":{"type":"string","example":"2017-07-07 18:37:04"},"activation_date_epoch":{"type":"integer","example":1499470624555},"activation_date_utc":{"type":"string","example":"2017-07-07T18:37:04.555-0500"},"expiration_date":{"type":"string","example":"2017-07-07 18:37:04"},"expiration_date_epoch":{"type":"integer","example":1499470624555},"expiration_date_utc":{"type":"string","example":"2017-07-07T18:37:04.555-0500"},"no_execute_on":{"type":"object","properties":{"day":{"type":"string","enum":["Sun","Mon","Tue","Wed","Thu","Fri","Sat"]}}},"no_execute_start":{"type":"string","example":"2:00 AM"},"no_execute_end":{"type":"string","example":"4:00 AM"}}},"network_limitations":{"type":"object","properties":{"minimum_network_connection":{"type":"string","enum":["No Minimum","Ethernet"]},"any_ip_address":{"type":"boolean"}}},"override_default_settings":{"type":"object","properties":{"target_drive":{"type":"string"},"distribution_point":{"type":"string"},"force_afp_smb":{"type":"boolean"},"sus":{"type":"string"}}},"network_requirements":{"type":"string","enum":["Any","Ethernet"]},"site":{"$ref":"#/components/schemas/site_object"}},"required":["name"]},"scope":{"type":"object","properties":{"all_computers":{"type":"boolean","default":false},"computers":{"type":"array","items":{"type":"object","properties":{"computer":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Admins MacBook Pro","description":"Name of the computer"},"udid":{"type":"string","example":"55900BDC-347C-58B1-D249-F32244B11D30"}}}}}},"computer_groups":{"type":"array","items":{"type":"object","properties":{"computer_group":{"$ref":"#/components/schemas/id_name"}}}},"buildings":{"type":"array","items":{"type":"object","properties":{"building":{"$ref":"#/components/schemas/id_name"}}}},"departments":{"type":"array","items":{"type":"object","properties":{"department":{"$ref":"#/components/schemas/id_name"}}}},"limit_to_users":{"type":"object","properties":{"user_groups":{"type":"array","items":{"properties":{"user_group":{"type":"string","example":"Teachers"}}}}}},"limitations":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/id_name"}}}},"user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}},"network_segments":{"type":"array","items":{"type":"object","properties":{"network_segment":{"$ref":"#/components/schemas/id_name"}}}},"ibeacons":{"type":"array","items":{"type":"object","properties":{"ibeacon":{"$ref":"#/components/schemas/id_name"}}}}}},"exclusions":{"type":"object","properties":{"computers":{"type":"array","items":{"type":"object","properties":{"computer":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Johns iMac","description":"Name of the computer"},"udid":{"type":"string","example":"55900BDC-347C-58B1-D249-F32244B11D30"}}}}}},"computer_groups":{"type":"array","items":{"type":"object","properties":{"computer_group":{"$ref":"#/components/schemas/id_name"}}}},"buildings":{"type":"array","items":{"type":"object","properties":{"building":{"$ref":"#/components/schemas/id_name"}}}},"departments":{"type":"array","items":{"type":"object","properties":{"department":{"$ref":"#/components/schemas/id_name"}}}},"users":{"type":"array","items":{"type":"object","properties":{"user":{"type":"object","properties":{"name":{"type":"string","example":"Adam"}}}}}},"user_groups":{"type":"array","items":{"type":"object","properties":{"user_group":{"$ref":"#/components/schemas/id_name"}}}},"network_segments":{"type":"array","items":{"type":"object","properties":{"network_segment":{"type":"object","properties":{"id":{"type":"integer"},"uid":{"type":"string"},"name":{"type":"string","example":"New York","description":"Name of the network segment"}}}}}},"ibeacons":{"type":"array","items":{"type":"object","properties":{"ibeacon":{"$ref":"#/components/schemas/id_name"}}}}}}}},"self_service":{"type":"object","properties":{"use_for_self_service":{"type":"boolean","default":false},"self_service_display_name":{"type":"string","example":"Disk Encryption"},"install_button_text":{"type":"string","example":"Encrypt"},"re-install_button_text":{"type":"string","example":"Re-encrypt"},"self_service_description":{"type":"string","example":"Encrypt the boot drive of this device"},"force_users_to_view_description":{"type":"boolean","default":false},"self_service_icon":{"type":"object","properties":{"id":{"type":"integer","example":1},"filename":{"type":"string","example":"Encryption.png"},"uri":{"type":"string","example":"https://jssURL.jamfcloud.com/iconservlet/?id=1"}}},"feature_on_main_page":{"type":"boolean","default":false},"self_service_categories":{"type":"object","properties":{"category":{"type":"object","properties":{"id":{"type":"integer","example":2},"name":{"type":"string","example":"Compliance"},"display_in":{"type":"boolean","default":true},"feature_in":{"type":"boolean","default":false}}}}}}},"package_configuration":{"type":"object","properties":{"packages":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"package":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Firefox.dmg"},"action":{"type":"string","enum":["Install","Cache","Install Cached"]},"fut":{"type":"boolean"},"feu":{"type":"boolean"},"update_autorun":{"type":"boolean"}}}}}}}},"scripts":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"script":{"type":"array","items":{"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"mountNetworkShare.sh"},"priority":{"type":"string","enum":["Before","After"]},"parameter4":{"type":"string"},"parameter5":{"type":"string"},"parameter6":{"type":"string"},"parameter7":{"type":"string"},"parameter8":{"type":"string"},"parameter9":{"type":"string"},"parameter10":{"type":"string"},"parameter11":{"type":"string"}}}}}},"printers":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"leave_existing_default":{"type":"string"},"printer":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Kyocera"},"action":{"type":"string","enum":["install","uninstall"]},"make_default":{"type":"boolean"}}}}}},"dock_items":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"dock_item":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Safari"},"action":{"type":"string","enum":["Add To Beginning","Add To End","Remove"]}}}}}},"account_maintenance":{"type":"object","properties":{"accounts":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"account":{"type":"object","properties":{"action":{"type":"string","enum":["Create","Reset","Delete","DisableFileVault"]},"username":{"type":"string","example":"admin"},"realname":{"type":"string","example":"Administrator"},"password":{"type":"string"},"archive_home_directory":{"type":"boolean"},"archive_home_directory_to":{"type":"string","example":"/Users/Deleted Users/admin.dmg"},"home":{"type":"string","example":"/Users/admin"},"picture":{"type":"string","example":"/Library/User Pictures/Animals/Eagle.tif"},"admin":{"type":"boolean"},"filevault_enabled":{"type":"boolean"}}}}}},"directory_bindings":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"binding":{"$ref":"#/components/schemas/id_name"}}}},"management_account":{"type":"object","properties":{"action":{"type":"string","enum":["rotate","doNotChange"]},"managed_password":{"type":"string"},"managed_password_length":{"type":"integer","example":8,"description":"Only necessary when utilizing the random action"}}},"open_firmware_efi_password":{"type":"object","properties":{"of_mode":{"type":"string","enum":["command","none"]},"of_password":{"type":"string"}}}}},"maintenance":{"type":"object","properties":{"recon":{"type":"boolean"},"reset_name":{"type":"boolean"},"install_all_cached_packages":{"type":"boolean"},"heal":{"type":"boolean"},"prebindings":{"type":"boolean"},"permissions":{"type":"boolean"},"byhost":{"type":"boolean"},"system_cache":{"type":"boolean"},"user_cache":{"type":"boolean"},"verify":{"type":"boolean"}}},"files_processes":{"type":"object","properties":{"search_by_path":{"type":"string","example":"/Applications/appName.app"},"delete_file":{"type":"boolean"},"locate_file":{"type":"string","example":"/Library/Fonts/testFont.ttc"},"update_locate_database":{"type":"boolean"},"spotlight_search":{"type":"string","example":"Screenshot.pdf"},"search_for_process":{"type":"string","example":"processName"},"kill_process":{"type":"boolean"},"run_command":{"type":"string","example":"echo \"foobar\""}}},"user_interaction":{"type":"object","properties":{"message_start":{"type":"string","example":"Policy is begining execution"},"allow_user_to_defer":{"type":"boolean"},"allow_deferral_until_utc":{"type":"string","example":"2019-01-01T01:00:00.000-0600"},"allow_deferral_minutes":{"type":"integer","example":0},"message_finish":{"type":"string","example":"Policy completed"}}},"disk_encryption":{"type":"object","properties":{"action":{"type":"string","enum":["apply","remediate"]},"disk_encryption_configuration_id":{"type":"integer","example":1},"auth_restart":{"type":"boolean"},"remediate_key_type":{"type":"string","enum":["Individual","Institutional","Individual And Institutional"]},"remediate_disk_encryption_configuration_id":{"type":"integer","example":1,"description":"disk encryption ID to utilize for remediating institutional recovery key types."}}}}},"printer":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"HP 9th Floor","description":"Name of the printer"},"category":{"type":"string","example":"Printers"},"uri":{"type":"string","example":"lpd://10.1.20.204/"},"CUPS_name":{"type":"string","example":"HP_9th_Floor"},"location":{"type":"string"},"model":{"type":"string","example":"HP LaserJet 500 color MFP M575"},"info":{"type":"string"},"notes":{"type":"string"},"make_default":{"type":"boolean"},"use_generic":{"type":"boolean","default":true},"ppd":{"type":"string","example":"9th_Floor_HP.ppd"},"ppd_path":{"type":"string","example":"/System/Library/Frameworks/ApplicationServices.framework/Versions/A/Frameworks/PrintCore.framework/Resources/Generic.ppd"},"ppd_contents":{"type":"string"}},"required":["name"]},"printers":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"printer":{"$ref":"#/components/schemas/id_name"}}}},"purchasing":{"type":"object","properties":{"is_purchased":{"type":"boolean"},"is_leased":{"type":"boolean"},"po_number":{"type":"string"},"vendor":{"type":"string"},"applecare_id":{"type":"string"},"purchase_price":{"type":"string"},"purchasing_account":{"type":"string"},"po_date":{"type":"string"},"po_date_epoch":{"type":"integer"},"po_date_utc":{"type":"string"},"warranty_expires":{"type":"string"},"warranty_expires_epoch":{"type":"integer"},"warranty_expires_utc":{"type":"string"},"lease_expires":{"type":"string"},"lease_expires_epoch":{"type":"integer"},"lease_expires_utc":{"type":"string"},"life_expectancy":{"type":"integer"},"purchasing_contact":{"type":"string"}}},"removable_mac_address":{"properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"E0:AC:CB:97:36:G4","description":"MAC address to ignore when identifying computers"}}},"removable_mac_addresses":{"type":"array","items":{"properties":{"removable_mac_address":{"$ref":"#/components/schemas/removable_mac_address"}}}},"restricted_software":{"type":"object","properties":{"general":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Restrict High Sierra","description":"Name of the restricted software"},"process_name":{"type":"string","example":"Install macOS High Sierra.app"},"match_exact_process_name":{"type":"boolean"},"send_notification":{"type":"boolean"},"kill_process":{"type":"boolean"},"delete_executable":{"type":"boolean"},"display_message":{"type":"string","example":"High Sierra is not yet supported, check Self Service after public release."},"site":{"$ref":"#/components/schemas/site_object"}},"required":["name","process_name"]},"scope":{"type":"object","properties":{"all_computers":{"type":"boolean"},"computers":{"type":"array","items":{"properties":{"computer":{"$ref":"#/components/schemas/id_name"}}}},"computer_groups":{"type":"array","items":{"properties":{"computer_group":{"$ref":"#/components/schemas/id_name"}}}},"buildings":{"type":"array","items":{"properties":{"building":{"$ref":"#/components/schemas/id_name"}}}},"departments":{"type":"array","items":{"properties":{"department":{"$ref":"#/components/schemas/id_name"}}}},"exclusions":{"type":"object","properties":{"computers":{"type":"array","items":{"properties":{"computer":{"$ref":"#/components/schemas/id_name"}}}},"computer_groups":{"type":"array","items":{"properties":{"computer_group":{"$ref":"#/components/schemas/id_name"}}}},"buildings":{"type":"array","items":{"properties":{"building":{"$ref":"#/components/schemas/id_name"}}}},"departments":{"type":"array","items":{"properties":{"department":{"$ref":"#/components/schemas/id_name"}}}},"users":{"type":"array","items":{"properties":{"user":{"$ref":"#/components/schemas/id_name"}}}}}}}}}},"restricted_software_all":{"xml":{"name":"restricted_software"},"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"restricted_software_title":{"$ref":"#/components/schemas/id_name"}}}},"site_object":{"type":"object","xml":{"name":"site"},"properties":{"id":{"type":"integer","default":-1},"name":{"type":"string","example":"None","description":"Name of the site"}},"required":["name"]},"size":{"type":"integer","example":1},"software_update_server":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"New York SUS","description":"Name of the software update server"},"ip_address":{"type":"string","example":"10.10.51.248"},"port":{"type":"integer","example":8088},"set_system_wide":{"type":"boolean"}},"required":["name","ip_address"]},"software_update_servers":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"software_update_server":{"$ref":"#/components/schemas/id_name"}}}},"user_extension_attribute":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"User Attributes","description":"Name of the user extension attribute"},"description":{"type":"string","example":"Text field for logging custom data"},"data_type":{"type":"string","enum":["String","Integer","Date"]},"input_type":{"type":"object","properties":{"type":{"type":"string","enum":["Text Field","Pop-up Menu"],"default":"Text Field"}}}},"required":["name"]},"user_extension_attributes":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"user_extension_attribute":{"$ref":"#/components/schemas/id_name"}}}},"user_group":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Teachers","description":"Name of the user group"},"is_smart":{"type":"boolean"},"is_notify_on_change":{"type":"boolean"},"site":{"$ref":"#/components/schemas/site_object"},"criteria":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"criterion":{"type":"object","properties":{"name":{"type":"string","example":"Email Address","description":"Name of the criteria"},"priority":{"type":"integer"},"and_or":{"type":"string","enum":["and","or"]},"search_type":{"type":"string","example":"like","description":"Operator"},"value":{"type":"string","example":"company.com"},"opening_paren":{"type":"boolean","default":false},"closing_paren":{"type":"boolean","default":false}}}}}},"users":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"user":{"type":"object","properties":{"id":{"type":"integer","example":1},"username":{"type":"string","example":"AHarrison"},"full_name":{"type":"string","example":"Ashley Harrison"},"phone_number":{"type":"string","example":"123-555-6789"},"email_address":{"type":"string","example":"aharrison@company.com"}}}}}}},"required":["name","is_smart"]},"user_groups":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"user_group":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Teachers","description":"Name of the user group"},"is_smart":{"type":"boolean"},"is_notify_on_change":{"type":"boolean"}}}}}},"webhook":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Computer Enrolled Hook"},"enabled":{"type":"boolean"},"url":{"type":"string","example":"https://requestb.in/wsfasfws"},"content_type":{"type":"string","enum":["text/xml","application/json"],"default":"text/xml"},"event":{"type":"string","enum":["ComputerAdded","ComputerCheckIn","ComputerInventoryCompleted","ComputerPolicyFinished","ComputerPushCapabilityChanged","JSSShutdown","JSSStartup","MobileDeviceCheckIn","MobileDeviceCommandCompleted","MobileDeviceEnrolled","MobileDevicePushSent","MobileDeviceUnEnrolled","PatchSoftwareTitleUpdated","PushSent","RestAPIOperation","SCEPChallenge","SmartGroupComputerMembershipChange","SmartGroupMobileDeviceMembershipChange"]},"connection_timeout":{"type":"integer","default":5,"description":"Number of seconds to attempt to connect to the webhooks host server"},"read_timeout":{"type":"integer","default":2,"description":"Number of seconds to wait for a response from the webhooks host server after sending a request"},"authentication_type":{"type":"string","enum":["NONE","BASIC"],"default":"NONE"},"username":{"type":"string","example":"webhook_admin"},"password":{"type":"string"},"enable_display_fields_for_group_object":{"type":"boolean","default":false},"display_fields":{"type":"array","items":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/size"},"display_field":{"type":"object","properties":{"name":{"type":"string","example":"IP Address","description":"Name of the display field to include for smart group based webhook events"}}}}}}},"required":["name","event","url"]},"webhooks":{"type":"array","items":{"properties":{"size":{"$ref":"#/components/schemas/size"},"webhook":{"$ref":"#/components/schemas/id_name"}}}}},"securitySchemes":{"ApiClient":{"type":"oauth2","description":"Jamf Pro API Roles and Clients provide a client ID and secret for obtaining access tokens using the OAuth2 client_credentials grant type","flows":{"clientCredentials":{"tokenUrl":"/api/v1/oauth/token","scopes":{}}}},"BasicAuth":{"type":"http","description":"Basic auth is used only for obtaining bearer tokens from the /v1/auth/token endpoint","scheme":"basic"},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"basicAuth":{"type":"http","scheme":"basic"}}}}