losant_rest 2.0.0 → 2.1.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 (350) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +140925 -67028
  3. data/docs/application.md +27 -27
  4. data/docs/applicationApiToken.md +1 -1
  5. data/docs/applicationApiTokens.md +1 -1
  6. data/docs/applicationCertificate.md +3 -3
  7. data/docs/applicationCertificateAuthorities.md +2 -2
  8. data/docs/applicationCertificateAuthority.md +3 -3
  9. data/docs/applicationCertificates.md +5 -4
  10. data/docs/applicationDashboard.md +5 -5
  11. data/docs/applicationDashboards.md +2 -2
  12. data/docs/applicationJobLog.md +1 -1
  13. data/docs/applicationJobLogs.md +1 -1
  14. data/docs/applicationKey.md +3 -3
  15. data/docs/applicationKeys.md +2 -2
  16. data/docs/applicationTemplate.md +1 -1
  17. data/docs/applicationTemplates.md +3 -3
  18. data/docs/applications.md +5 -5
  19. data/docs/auditLog.md +1 -1
  20. data/docs/auditLogs.md +1 -1
  21. data/docs/auth.md +1 -1
  22. data/docs/credential.md +4 -4
  23. data/docs/credentials.md +2 -2
  24. data/docs/dashboard.md +4 -4
  25. data/docs/dashboards.md +3 -2
  26. data/docs/data.md +3 -3
  27. data/docs/dataTable.md +5 -5
  28. data/docs/dataTableRow.md +4 -4
  29. data/docs/dataTableRows.md +9 -9
  30. data/docs/dataTables.md +2 -2
  31. data/docs/device.md +15 -15
  32. data/docs/deviceAttribute.md +3 -3
  33. data/docs/deviceAttributes.md +2 -2
  34. data/docs/deviceRecipe.md +4 -4
  35. data/docs/deviceRecipes.md +2 -2
  36. data/docs/devices.md +14 -14
  37. data/docs/edgeDeployment.md +1 -1
  38. data/docs/edgeDeployments.md +7 -7
  39. data/docs/embeddedDeployment.md +1 -1
  40. data/docs/embeddedDeployments.md +8 -8
  41. data/docs/event.md +3 -3
  42. data/docs/events.md +6 -6
  43. data/docs/experience.md +3 -3
  44. data/docs/experienceDomain.md +3 -3
  45. data/docs/experienceDomains.md +2 -2
  46. data/docs/experienceEndpoint.md +4 -4
  47. data/docs/experienceEndpoints.md +3 -3
  48. data/docs/experienceGroup.md +3 -3
  49. data/docs/experienceGroups.md +2 -2
  50. data/docs/experienceSlug.md +3 -3
  51. data/docs/experienceSlugs.md +2 -2
  52. data/docs/experienceUser.md +3 -3
  53. data/docs/experienceUsers.md +2 -2
  54. data/docs/experienceVersion.md +3 -3
  55. data/docs/experienceVersions.md +2 -2
  56. data/docs/experienceView.md +4 -4
  57. data/docs/experienceViews.md +2 -2
  58. data/docs/file.md +9 -9
  59. data/docs/files.md +3 -3
  60. data/docs/flow.md +11 -11
  61. data/docs/flowVersion.md +6 -6
  62. data/docs/flowVersions.md +4 -4
  63. data/docs/flows.md +5 -5
  64. data/docs/instance.md +8 -8
  65. data/docs/instanceApiToken.md +1 -1
  66. data/docs/instanceApiTokens.md +2 -2
  67. data/docs/instanceAuditLog.md +1 -1
  68. data/docs/instanceAuditLogs.md +1 -1
  69. data/docs/instanceCustomNode.md +5 -5
  70. data/docs/instanceCustomNodes.md +2 -2
  71. data/docs/instanceMember.md +2 -2
  72. data/docs/instanceMembers.md +1 -1
  73. data/docs/instanceNotificationRule.md +5 -5
  74. data/docs/instanceNotificationRules.md +2 -2
  75. data/docs/instanceOrg.md +8 -8
  76. data/docs/instanceOrgInvite.md +3 -3
  77. data/docs/instanceOrgInvites.md +2 -2
  78. data/docs/instanceOrgMember.md +1 -1
  79. data/docs/instanceOrgMembers.md +3 -2
  80. data/docs/instanceOrgs.md +3 -3
  81. data/docs/instanceSandbox.md +7 -7
  82. data/docs/instanceSandboxes.md +1 -1
  83. data/docs/instances.md +1 -1
  84. data/docs/integration.md +3 -3
  85. data/docs/integrations.md +2 -2
  86. data/docs/me.md +21 -21
  87. data/docs/notebook.md +10 -10
  88. data/docs/notebooks.md +2 -2
  89. data/docs/org.md +14 -14
  90. data/docs/orgs.md +2 -2
  91. data/docs/privateFile.md +9 -9
  92. data/docs/privateFiles.md +3 -3
  93. data/docs/resourceJob.md +8 -8
  94. data/docs/resourceJobs.md +2 -2
  95. data/docs/userApiToken.md +3 -3
  96. data/docs/userApiTokens.md +4 -4
  97. data/docs/userOauthToken.md +125 -0
  98. data/docs/userOauthTokens.md +87 -0
  99. data/docs/webhook.md +3 -3
  100. data/docs/webhooks.md +2 -2
  101. data/lib/platform_rest/application.rb +21 -21
  102. data/lib/platform_rest/application_api_token.rb +1 -1
  103. data/lib/platform_rest/application_api_tokens.rb +1 -1
  104. data/lib/platform_rest/application_certificate.rb +3 -3
  105. data/lib/platform_rest/application_certificate_authorities.rb +2 -2
  106. data/lib/platform_rest/application_certificate_authority.rb +3 -3
  107. data/lib/platform_rest/application_certificates.rb +7 -4
  108. data/lib/platform_rest/application_dashboard.rb +5 -5
  109. data/lib/platform_rest/application_dashboards.rb +2 -2
  110. data/lib/platform_rest/application_job_log.rb +1 -1
  111. data/lib/platform_rest/application_job_logs.rb +1 -1
  112. data/lib/platform_rest/application_key.rb +3 -3
  113. data/lib/platform_rest/application_keys.rb +2 -2
  114. data/lib/platform_rest/application_template.rb +1 -1
  115. data/lib/platform_rest/application_templates.rb +3 -3
  116. data/lib/platform_rest/applications.rb +3 -3
  117. data/lib/platform_rest/audit_log.rb +1 -1
  118. data/lib/platform_rest/audit_logs.rb +1 -1
  119. data/lib/platform_rest/client.rb +10 -2
  120. data/lib/platform_rest/credential.rb +4 -4
  121. data/lib/platform_rest/credentials.rb +2 -2
  122. data/lib/platform_rest/dashboard.rb +4 -4
  123. data/lib/platform_rest/dashboards.rb +3 -2
  124. data/lib/platform_rest/data.rb +3 -3
  125. data/lib/platform_rest/data_table.rb +5 -5
  126. data/lib/platform_rest/data_table_row.rb +4 -4
  127. data/lib/platform_rest/data_table_rows.rb +9 -9
  128. data/lib/platform_rest/data_tables.rb +2 -2
  129. data/lib/platform_rest/device.rb +15 -15
  130. data/lib/platform_rest/device_attribute.rb +3 -3
  131. data/lib/platform_rest/device_attributes.rb +2 -2
  132. data/lib/platform_rest/device_recipe.rb +4 -4
  133. data/lib/platform_rest/device_recipes.rb +2 -2
  134. data/lib/platform_rest/devices.rb +14 -14
  135. data/lib/platform_rest/edge_deployment.rb +1 -1
  136. data/lib/platform_rest/edge_deployments.rb +7 -7
  137. data/lib/platform_rest/embedded_deployment.rb +1 -1
  138. data/lib/platform_rest/embedded_deployments.rb +8 -8
  139. data/lib/platform_rest/event.rb +3 -3
  140. data/lib/platform_rest/events.rb +6 -6
  141. data/lib/platform_rest/experience.rb +3 -3
  142. data/lib/platform_rest/experience_domain.rb +3 -3
  143. data/lib/platform_rest/experience_domains.rb +2 -2
  144. data/lib/platform_rest/experience_endpoint.rb +4 -4
  145. data/lib/platform_rest/experience_endpoints.rb +3 -3
  146. data/lib/platform_rest/experience_group.rb +3 -3
  147. data/lib/platform_rest/experience_groups.rb +2 -2
  148. data/lib/platform_rest/experience_slug.rb +3 -3
  149. data/lib/platform_rest/experience_slugs.rb +2 -2
  150. data/lib/platform_rest/experience_user.rb +3 -3
  151. data/lib/platform_rest/experience_users.rb +2 -2
  152. data/lib/platform_rest/experience_version.rb +3 -3
  153. data/lib/platform_rest/experience_versions.rb +2 -2
  154. data/lib/platform_rest/experience_view.rb +4 -4
  155. data/lib/platform_rest/experience_views.rb +2 -2
  156. data/lib/platform_rest/file.rb +6 -6
  157. data/lib/platform_rest/files.rb +2 -2
  158. data/lib/platform_rest/flow.rb +11 -11
  159. data/lib/platform_rest/flow_version.rb +6 -6
  160. data/lib/platform_rest/flow_versions.rb +3 -3
  161. data/lib/platform_rest/flows.rb +5 -5
  162. data/lib/platform_rest/instance.rb +8 -8
  163. data/lib/platform_rest/instance_api_token.rb +1 -1
  164. data/lib/platform_rest/instance_api_tokens.rb +2 -2
  165. data/lib/platform_rest/instance_audit_log.rb +1 -1
  166. data/lib/platform_rest/instance_audit_logs.rb +1 -1
  167. data/lib/platform_rest/instance_custom_node.rb +5 -5
  168. data/lib/platform_rest/instance_custom_nodes.rb +2 -2
  169. data/lib/platform_rest/instance_member.rb +2 -2
  170. data/lib/platform_rest/instance_members.rb +1 -1
  171. data/lib/platform_rest/instance_notification_rule.rb +5 -5
  172. data/lib/platform_rest/instance_notification_rules.rb +2 -2
  173. data/lib/platform_rest/instance_org.rb +8 -8
  174. data/lib/platform_rest/instance_org_invite.rb +3 -3
  175. data/lib/platform_rest/instance_org_invites.rb +3 -3
  176. data/lib/platform_rest/instance_org_member.rb +1 -1
  177. data/lib/platform_rest/instance_org_members.rb +3 -2
  178. data/lib/platform_rest/instance_orgs.rb +3 -3
  179. data/lib/platform_rest/instance_sandbox.rb +7 -7
  180. data/lib/platform_rest/instance_sandboxes.rb +1 -1
  181. data/lib/platform_rest/instances.rb +1 -1
  182. data/lib/platform_rest/integration.rb +3 -3
  183. data/lib/platform_rest/integrations.rb +2 -2
  184. data/lib/platform_rest/me.rb +21 -21
  185. data/lib/platform_rest/notebook.rb +9 -9
  186. data/lib/platform_rest/notebooks.rb +2 -2
  187. data/lib/platform_rest/org.rb +14 -14
  188. data/lib/platform_rest/orgs.rb +2 -2
  189. data/lib/platform_rest/private_file.rb +6 -6
  190. data/lib/platform_rest/private_files.rb +2 -2
  191. data/lib/platform_rest/resource_job.rb +8 -8
  192. data/lib/platform_rest/resource_jobs.rb +2 -2
  193. data/lib/platform_rest/user_api_token.rb +3 -3
  194. data/lib/platform_rest/user_api_tokens.rb +4 -4
  195. data/lib/platform_rest/user_oauth_token.rb +170 -0
  196. data/lib/platform_rest/user_oauth_tokens.rb +132 -0
  197. data/lib/platform_rest/version.rb +1 -1
  198. data/lib/platform_rest/webhook.rb +3 -3
  199. data/lib/platform_rest/webhooks.rb +2 -2
  200. data/lib/platform_rest.rb +2 -0
  201. data/schemas/advancedApplicationCertQuery.json +1885 -0
  202. data/schemas/advancedApplicationKeyQuery.json +763 -763
  203. data/schemas/apiToken.json +110 -1
  204. data/schemas/apiTokenPatch.json +100 -0
  205. data/schemas/apiTokenPost.json +118 -0
  206. data/schemas/apiTokens.json +120 -2
  207. data/schemas/application.json +15 -2
  208. data/schemas/applicationCertificate.json +90 -58
  209. data/schemas/applicationCertificateAuthorities.json +24 -0
  210. data/schemas/applicationCertificateAuthority.json +24 -0
  211. data/schemas/applicationCertificatePatch.json +32 -4
  212. data/schemas/applicationCertificatePost.json +28 -30
  213. data/schemas/applicationCertificates.json +90 -58
  214. data/schemas/applicationCreationByTemplateResult.json +15 -2
  215. data/schemas/applicationDashboardPost.json +183 -128
  216. data/schemas/applicationImportExecutions.json +3 -5
  217. data/schemas/applicationImportResult.json +674 -0
  218. data/schemas/applicationJobLog.json +129 -123
  219. data/schemas/applicationJobLogs.json +129 -123
  220. data/schemas/applicationKey.json +41 -41
  221. data/schemas/applicationKeyPatch.json +4 -4
  222. data/schemas/applicationKeyPost.json +36 -29
  223. data/schemas/applicationKeys.json +41 -41
  224. data/schemas/applicationSearchResult.json +10 -10
  225. data/schemas/applicationTemplates.json +9 -2
  226. data/schemas/applications.json +15 -2
  227. data/schemas/auditLog.json +2 -6
  228. data/schemas/auditLogs.json +2 -6
  229. data/schemas/authedDevice.json +3 -0
  230. data/schemas/credential.json +7 -0
  231. data/schemas/credentialLinkedResources.json +19724 -344
  232. data/schemas/credentialPatch.json +3 -0
  233. data/schemas/credentialPost.json +3 -0
  234. data/schemas/credentials.json +7 -0
  235. data/schemas/dashboard.json +203 -128
  236. data/schemas/dashboardBlockSuggestCodePost.json +19 -0
  237. data/schemas/dashboardPatch.json +183 -128
  238. data/schemas/dashboardPost.json +183 -128
  239. data/schemas/dashboardUpdateEventsResult.json +266 -0
  240. data/schemas/dashboards.json +203 -128
  241. data/schemas/dataTable.json +11 -0
  242. data/schemas/dataTableRowPatch.json +16 -0
  243. data/schemas/dataTableRowPost.json +39 -0
  244. data/schemas/dataTableRowPostResult.json +54 -0
  245. data/schemas/dataTables.json +11 -0
  246. data/schemas/device.json +259 -107
  247. data/schemas/deviceConnectionStatus.json +4 -0
  248. data/schemas/deviceLog.json +3 -0
  249. data/schemas/deviceRecipe.json +259 -108
  250. data/schemas/deviceRecipes.json +259 -108
  251. data/schemas/devices.json +287 -116
  252. data/schemas/edgeDeploymentRelease.json +4252 -39
  253. data/schemas/edgeDeployments.json +28 -0
  254. data/schemas/embeddedDeploymentRelease.json +2073 -0
  255. data/schemas/embeddedDeployments.json +25 -0
  256. data/schemas/error.json +14 -0
  257. data/schemas/event.json +4 -1
  258. data/schemas/eventPlusNewCount.json +4 -1
  259. data/schemas/events.json +4 -1
  260. data/schemas/experienceDomains.json +19 -0
  261. data/schemas/experienceEndpoint.json +19 -0
  262. data/schemas/experienceEndpoints.json +24 -0
  263. data/schemas/experienceLinkedResources.json +19728 -313
  264. data/schemas/experienceSlugs.json +19 -0
  265. data/schemas/experienceUsers.json +16 -2
  266. data/schemas/experienceVersions.json +25 -0
  267. data/schemas/experienceView.json +5 -0
  268. data/schemas/experienceViews.json +10 -0
  269. data/schemas/fileUploadPostResponse.json +92 -103
  270. data/schemas/files.json +5 -1
  271. data/schemas/flow.json +211 -46
  272. data/schemas/flowPatch.json +199 -46
  273. data/schemas/flowPost.json +199 -46
  274. data/schemas/flowStorageMetadata.json +2 -2
  275. data/schemas/flowVersion.json +450 -101
  276. data/schemas/flowVersionPost.json +199 -46
  277. data/schemas/flowVersions.json +9903 -113
  278. data/schemas/flows.json +9637 -46
  279. data/schemas/flowsImportPost.json +398 -92
  280. data/schemas/flowsImportResult.json +661 -147
  281. data/schemas/githubLogin.json +18 -0
  282. data/schemas/historicalSummaries.json +3 -2
  283. data/schemas/historicalSummary.json +3 -2
  284. data/schemas/instanceAuditLog.json +2 -6
  285. data/schemas/instanceAuditLogs.json +90 -1
  286. data/schemas/instanceCustomNode.json +41 -2
  287. data/schemas/instanceCustomNodePatch.json +59 -6
  288. data/schemas/instanceCustomNodePost.json +59 -6
  289. data/schemas/instanceCustomNodes.json +41 -2
  290. data/schemas/instanceOrg.json +4 -1
  291. data/schemas/instanceOrgInvite.json +102 -0
  292. data/schemas/instanceOrgInviteSent.json +12 -0
  293. data/schemas/instanceOrgInvites.json +145 -0
  294. data/schemas/instanceOrgMember.json +52 -0
  295. data/schemas/instanceOrgMemberPatch.json +2 -2
  296. data/schemas/instanceOrgMemberPost.json +4 -4
  297. data/schemas/instanceOrgMembers.json +105 -1
  298. data/schemas/instanceOrgPost.json +5 -5
  299. data/schemas/instanceOrgs.json +5 -2
  300. data/schemas/instanceSandbox.json +5 -1
  301. data/schemas/instanceSandboxes.json +9 -1
  302. data/schemas/integration.json +38 -39
  303. data/schemas/integrationPatch.json +8 -8
  304. data/schemas/integrationPost.json +8 -8
  305. data/schemas/integrations.json +38 -39
  306. data/schemas/jobEnqueuedResult.json +1 -1
  307. data/schemas/me.json +685 -88
  308. data/schemas/notebook.json +33 -21
  309. data/schemas/notebookExecutionLogs.json +20 -0
  310. data/schemas/notebookMinuteCounts.json +1 -1
  311. data/schemas/notebookPatch.json +29 -21
  312. data/schemas/notebookPost.json +29 -21
  313. data/schemas/notebooks.json +33 -21
  314. data/schemas/notificationRule.json +4 -0
  315. data/schemas/notificationRules.json +8 -0
  316. data/schemas/oauthClient.json +107 -0
  317. data/schemas/oauthClientPost.json +89 -0
  318. data/schemas/oauthDcrError.json +23 -0
  319. data/schemas/oauthError.json +31 -0
  320. data/schemas/org.json +16 -3
  321. data/schemas/orgInvite.json +2 -2
  322. data/schemas/orgInviteCollection.json +2 -2
  323. data/schemas/orgInvitePost.json +2 -2
  324. data/schemas/orgInvites.json +77 -82
  325. data/schemas/orgInvitesUser.json +44 -47
  326. data/schemas/orgMemberPatch.json +2 -2
  327. data/schemas/orgRoleInfo.json +2 -2
  328. data/schemas/orgs.json +16 -3
  329. data/schemas/paletteResponse.json +372 -364
  330. data/schemas/periodSummaries.json +1 -1
  331. data/schemas/recentItemList.json +226 -27
  332. data/schemas/resourceJob.json +33 -9
  333. data/schemas/resourceJobExecutionLogs.json +34 -20
  334. data/schemas/resourceJobExecutionOptions.json +1 -1
  335. data/schemas/resourceJobPatch.json +9 -9
  336. data/schemas/resourceJobPost.json +9 -9
  337. data/schemas/resourceJobs.json +33 -9
  338. data/schemas/samlResponse.json +18 -0
  339. data/schemas/tagValuesResponse.json +1 -2
  340. data/schemas/templateKeywords.json +1 -0
  341. data/schemas/timeSeriesData.json +36 -4
  342. data/schemas/userCredentials.json +18 -0
  343. data/schemas/userOauthToken.json +210 -0
  344. data/schemas/userOauthTokenPatch.json +123 -0
  345. data/schemas/userOauthTokenPost.json +197 -0
  346. data/schemas/userOauthTokens.json +251 -0
  347. data/schemas/userPost.json +18 -0
  348. data/schemas/validateContextError.json +71 -24
  349. data/schemas/validateContextSuccess.json +71 -24
  350. metadata +22 -1
data/schemas/timeSeriesData.json CHANGED
@@ -18,6 +18,9 @@
18
18
  },
19
19
  "aggregation": {
20
20
  "oneOf": [
21
+ {
22
+ "type": "null"
23
+ },
21
24
  {
22
25
  "oneOf": [
23
26
  {
@@ -171,10 +174,39 @@
171
174
  "type": "object",
172
175
  "patternProperties": {
173
176
  "^[0-9a-zA-Z_-]{1,255}$": {
174
- "type": [
175
- "number",
176
- "string",
177
- "boolean"
177
+ "oneOf": [
178
+ {
179
+ "type": [
180
+ "number",
181
+ "string",
182
+ "boolean"
183
+ ]
184
+ },
185
+ {
186
+ "type": "object",
187
+ "properties": {
188
+ "value": {
189
+ "type": [
190
+ "number",
191
+ "string",
192
+ "boolean"
193
+ ]
194
+ },
195
+ "sum": {
196
+ "type": "number"
197
+ },
198
+ "count": {
199
+ "type": "number"
200
+ },
201
+ "average": {
202
+ "type": "number"
203
+ },
204
+ "variance": {
205
+ "type": "number"
206
+ }
207
+ },
208
+ "additionalProperties": false
209
+ }
178
210
  ]
179
211
  }
180
212
  },
data/schemas/userCredentials.json CHANGED
@@ -27,6 +27,7 @@
27
27
  "type": "string",
28
28
  "enum": [
29
29
  "all.Application",
30
+ "all.Application.bounded",
30
31
  "all.Application.read",
31
32
  "all.Application.cli",
32
33
  "all.Device",
@@ -353,7 +354,11 @@
353
354
  "type": "string",
354
355
  "enum": [
355
356
  "all.Organization",
357
+ "all.Organization.bounded",
356
358
  "all.Organization.read",
359
+ "only.Organization",
360
+ "only.Organization.bounded",
361
+ "only.Organization.read",
357
362
  "applications.*",
358
363
  "auditLog.*",
359
364
  "auditLogs.*",
@@ -396,6 +401,7 @@
396
401
  "type": "string",
397
402
  "enum": [
398
403
  "all.Instance",
404
+ "all.Instance.bounded",
399
405
  "all.Instance.read",
400
406
  "instance.*",
401
407
  "instance.get",
@@ -484,8 +490,12 @@
484
490
  "type": "string",
485
491
  "enum": [
486
492
  "all.User",
493
+ "all.User.bounded",
487
494
  "all.User.read",
488
495
  "all.User.cli",
496
+ "only.User",
497
+ "only.User.bounded",
498
+ "only.User.read",
489
499
  "userApiToken.*",
490
500
  "userApiToken.get",
491
501
  "userApiToken.patch",
@@ -493,6 +503,13 @@
493
503
  "userApiTokens.*",
494
504
  "userApiTokens.get",
495
505
  "userApiTokens.post",
506
+ "userOauthToken.*",
507
+ "userOauthToken.get",
508
+ "userOauthToken.patch",
509
+ "userOauthToken.delete",
510
+ "userOauthTokens.*",
511
+ "userOauthTokens.get",
512
+ "userOauthTokens.post",
496
513
  "applicationTemplate.*",
497
514
  "applicationTemplate.get",
498
515
  "applicationTemplates.*",
@@ -522,6 +539,7 @@
522
539
  "me.invite",
523
540
  "me.invites",
524
541
  "me.respondToInvite",
542
+ "me.refreshToken",
525
543
  "orgs.*",
526
544
  "orgs.get",
527
545
  "orgs.post"
data/schemas/userOauthToken.json ADDED
@@ -0,0 +1,210 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "id": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "oauthTokenId": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
13
+ "name": {
14
+ "type": "string",
15
+ "minLength": 1,
16
+ "maxLength": 255
17
+ },
18
+ "description": {
19
+ "type": "string",
20
+ "maxLength": 32767
21
+ },
22
+ "creationDate": {
23
+ "type": "string",
24
+ "format": "date-time"
25
+ },
26
+ "lastUpdated": {
27
+ "type": "string",
28
+ "format": "date-time"
29
+ },
30
+ "expirationDate": {
31
+ "type": "string",
32
+ "format": "date-time"
33
+ },
34
+ "defaultRole": {
35
+ "type": "string",
36
+ "enum": [
37
+ "admin",
38
+ "edit",
39
+ "collaborate",
40
+ "view",
41
+ "none"
42
+ ]
43
+ },
44
+ "orgRoles": {
45
+ "type": "array",
46
+ "items": {
47
+ "type": "object",
48
+ "properties": {
49
+ "orgId": {
50
+ "oneOf": [
51
+ {
52
+ "type": "string",
53
+ "pattern": "^[A-Fa-f\\d]{24}$"
54
+ },
55
+ {
56
+ "type": "string",
57
+ "enum": [
58
+ "sandbox"
59
+ ]
60
+ }
61
+ ]
62
+ },
63
+ "role": {
64
+ "type": "string",
65
+ "enum": [
66
+ "admin",
67
+ "edit",
68
+ "collaborate",
69
+ "view",
70
+ "none"
71
+ ]
72
+ },
73
+ "applicationRoles": {
74
+ "type": "array",
75
+ "items": {
76
+ "type": "object",
77
+ "properties": {
78
+ "resourceId": {
79
+ "type": "string",
80
+ "pattern": "^[A-Fa-f\\d]{24}$"
81
+ },
82
+ "role": {
83
+ "type": "string",
84
+ "enum": [
85
+ "collaborate",
86
+ "view",
87
+ "none"
88
+ ]
89
+ }
90
+ },
91
+ "required": [
92
+ "resourceId",
93
+ "role"
94
+ ],
95
+ "additionalProperties": false
96
+ },
97
+ "maxItems": 100
98
+ },
99
+ "dashboardRoles": {
100
+ "type": "array",
101
+ "items": {
102
+ "type": "object",
103
+ "properties": {
104
+ "resourceId": {
105
+ "type": "string",
106
+ "pattern": "^[A-Fa-f\\d]{24}$"
107
+ },
108
+ "role": {
109
+ "type": "string",
110
+ "enum": [
111
+ "collaborate",
112
+ "view",
113
+ "none"
114
+ ]
115
+ }
116
+ },
117
+ "required": [
118
+ "resourceId",
119
+ "role"
120
+ ],
121
+ "additionalProperties": false
122
+ },
123
+ "maxItems": 100
124
+ }
125
+ },
126
+ "required": [
127
+ "orgId",
128
+ "role"
129
+ ],
130
+ "additionalProperties": false
131
+ },
132
+ "maxItems": 25
133
+ },
134
+ "scope": {
135
+ "type": "array",
136
+ "uniqueItems": true,
137
+ "items": {
138
+ "type": "string",
139
+ "description": "OAuth-supported user-context API scope. See the `scopes_supported` field of the OAuth authorization server metadata document at /.well-known/oauth-authorization-server for the authoritative list.",
140
+ "enum": [
141
+ "all.Application.read",
142
+ "all.Application.bounded",
143
+ "only.Organization.read",
144
+ "only.Organization.bounded",
145
+ "all.Organization.read",
146
+ "all.Organization.bounded",
147
+ "only.User.read"
148
+ ]
149
+ },
150
+ "description": "API scopes for this OAuth token"
151
+ },
152
+ "status": {
153
+ "type": "string",
154
+ "enum": [
155
+ "active",
156
+ "inactive"
157
+ ]
158
+ },
159
+ "oauth": {
160
+ "type": "object",
161
+ "properties": {
162
+ "client_id": {
163
+ "type": "string",
164
+ "minLength": 24,
165
+ "maxLength": 1024,
166
+ "description": "The registered OAuth client ID (ObjectId or HTTPS URL for CIMD)"
167
+ },
168
+ "client_name": {
169
+ "type": "string",
170
+ "maxLength": 255,
171
+ "description": "Human-readable name of the OAuth client (from client registration)"
172
+ },
173
+ "client_uri": {
174
+ "type": "string",
175
+ "maxLength": 1024,
176
+ "description": "Informational URL for the OAuth client's homepage (from client registration)"
177
+ },
178
+ "logo_uri": {
179
+ "type": "string",
180
+ "maxLength": 32768,
181
+ "description": "Logo URL for the OAuth client (http(s) URL or data: URI, from client registration)"
182
+ },
183
+ "redirect_uri": {
184
+ "type": "string",
185
+ "format": "uri",
186
+ "maxLength": 1024
187
+ },
188
+ "resource": {
189
+ "type": "array",
190
+ "items": {
191
+ "type": "string",
192
+ "format": "uri",
193
+ "maxLength": 1024
194
+ },
195
+ "description": "Resource indicator(s) per RFC 8707 — audience(s) this token is bound to"
196
+ },
197
+ "authorizationStatus": {
198
+ "type": "string",
199
+ "enum": [
200
+ "pending",
201
+ "authorized"
202
+ ]
203
+ },
204
+ "authorizationCode": {
205
+ "type": "string"
206
+ }
207
+ }
208
+ }
209
+ }
210
+ }
data/schemas/userOauthTokenPatch.json ADDED
@@ -0,0 +1,123 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "description": {
11
+ "type": "string",
12
+ "maxLength": 32767
13
+ },
14
+ "defaultRole": {
15
+ "type": "string",
16
+ "enum": [
17
+ "admin",
18
+ "edit",
19
+ "collaborate",
20
+ "view",
21
+ "none"
22
+ ]
23
+ },
24
+ "orgRoles": {
25
+ "type": "array",
26
+ "items": {
27
+ "type": "object",
28
+ "properties": {
29
+ "orgId": {
30
+ "oneOf": [
31
+ {
32
+ "type": "string",
33
+ "pattern": "^[A-Fa-f\\d]{24}$"
34
+ },
35
+ {
36
+ "type": "string",
37
+ "enum": [
38
+ "sandbox"
39
+ ]
40
+ }
41
+ ]
42
+ },
43
+ "role": {
44
+ "type": "string",
45
+ "enum": [
46
+ "admin",
47
+ "edit",
48
+ "collaborate",
49
+ "view",
50
+ "none"
51
+ ]
52
+ },
53
+ "applicationRoles": {
54
+ "type": "array",
55
+ "items": {
56
+ "type": "object",
57
+ "properties": {
58
+ "resourceId": {
59
+ "type": "string",
60
+ "pattern": "^[A-Fa-f\\d]{24}$"
61
+ },
62
+ "role": {
63
+ "type": "string",
64
+ "enum": [
65
+ "collaborate",
66
+ "view",
67
+ "none"
68
+ ]
69
+ }
70
+ },
71
+ "required": [
72
+ "resourceId",
73
+ "role"
74
+ ],
75
+ "additionalProperties": false
76
+ },
77
+ "maxItems": 100
78
+ },
79
+ "dashboardRoles": {
80
+ "type": "array",
81
+ "items": {
82
+ "type": "object",
83
+ "properties": {
84
+ "resourceId": {
85
+ "type": "string",
86
+ "pattern": "^[A-Fa-f\\d]{24}$"
87
+ },
88
+ "role": {
89
+ "type": "string",
90
+ "enum": [
91
+ "collaborate",
92
+ "view",
93
+ "none"
94
+ ]
95
+ }
96
+ },
97
+ "required": [
98
+ "resourceId",
99
+ "role"
100
+ ],
101
+ "additionalProperties": false
102
+ },
103
+ "maxItems": 100
104
+ }
105
+ },
106
+ "required": [
107
+ "orgId",
108
+ "role"
109
+ ],
110
+ "additionalProperties": false
111
+ },
112
+ "maxItems": 25
113
+ },
114
+ "status": {
115
+ "type": "string",
116
+ "enum": [
117
+ "active",
118
+ "inactive"
119
+ ]
120
+ }
121
+ },
122
+ "additionalProperties": false
123
+ }
data/schemas/userOauthTokenPost.json ADDED
@@ -0,0 +1,197 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "description": {
11
+ "type": "string",
12
+ "maxLength": 32767
13
+ },
14
+ "expirationDate": {
15
+ "oneOf": [
16
+ {
17
+ "type": "string",
18
+ "format": "date-time"
19
+ },
20
+ {
21
+ "type": "null"
22
+ }
23
+ ],
24
+ "description": "Session expiration. Omit for the default 1-year session, pass an ISO date for a specific expiration, or pass null for a session that does not expire."
25
+ },
26
+ "oauth": {
27
+ "type": "object",
28
+ "properties": {
29
+ "client_id": {
30
+ "type": "string",
31
+ "minLength": 24,
32
+ "maxLength": 1024,
33
+ "description": "The registered OAuth client ID (ObjectId or HTTPS URL for CIMD)"
34
+ },
35
+ "redirect_uri": {
36
+ "type": "string",
37
+ "format": "uri",
38
+ "maxLength": 1024
39
+ },
40
+ "resource": {
41
+ "type": "array",
42
+ "maxItems": 10,
43
+ "items": {
44
+ "type": "string",
45
+ "format": "uri",
46
+ "maxLength": 1024
47
+ },
48
+ "description": "Resource indicator(s) per RFC 8707 — absolute URI(s) identifying the audience(s) this token is being requested for"
49
+ },
50
+ "code_challenge": {
51
+ "type": "string",
52
+ "minLength": 43,
53
+ "maxLength": 128,
54
+ "pattern": "^[A-Za-z0-9_-]+$",
55
+ "description": "PKCE code challenge (RFC 7636 base64url, 43-128 chars)"
56
+ },
57
+ "code_challenge_method": {
58
+ "type": "string",
59
+ "enum": [
60
+ "S256"
61
+ ],
62
+ "description": "PKCE code challenge method"
63
+ }
64
+ },
65
+ "additionalProperties": false,
66
+ "required": [
67
+ "client_id",
68
+ "redirect_uri",
69
+ "code_challenge",
70
+ "code_challenge_method"
71
+ ]
72
+ },
73
+ "defaultRole": {
74
+ "type": "string",
75
+ "enum": [
76
+ "admin",
77
+ "edit",
78
+ "collaborate",
79
+ "view",
80
+ "none"
81
+ ]
82
+ },
83
+ "orgRoles": {
84
+ "type": "array",
85
+ "items": {
86
+ "type": "object",
87
+ "properties": {
88
+ "orgId": {
89
+ "oneOf": [
90
+ {
91
+ "type": "string",
92
+ "pattern": "^[A-Fa-f\\d]{24}$"
93
+ },
94
+ {
95
+ "type": "string",
96
+ "enum": [
97
+ "sandbox"
98
+ ]
99
+ }
100
+ ]
101
+ },
102
+ "role": {
103
+ "type": "string",
104
+ "enum": [
105
+ "admin",
106
+ "edit",
107
+ "collaborate",
108
+ "view",
109
+ "none"
110
+ ]
111
+ },
112
+ "applicationRoles": {
113
+ "type": "array",
114
+ "items": {
115
+ "type": "object",
116
+ "properties": {
117
+ "resourceId": {
118
+ "type": "string",
119
+ "pattern": "^[A-Fa-f\\d]{24}$"
120
+ },
121
+ "role": {
122
+ "type": "string",
123
+ "enum": [
124
+ "collaborate",
125
+ "view",
126
+ "none"
127
+ ]
128
+ }
129
+ },
130
+ "required": [
131
+ "resourceId",
132
+ "role"
133
+ ],
134
+ "additionalProperties": false
135
+ },
136
+ "maxItems": 100
137
+ },
138
+ "dashboardRoles": {
139
+ "type": "array",
140
+ "items": {
141
+ "type": "object",
142
+ "properties": {
143
+ "resourceId": {
144
+ "type": "string",
145
+ "pattern": "^[A-Fa-f\\d]{24}$"
146
+ },
147
+ "role": {
148
+ "type": "string",
149
+ "enum": [
150
+ "collaborate",
151
+ "view",
152
+ "none"
153
+ ]
154
+ }
155
+ },
156
+ "required": [
157
+ "resourceId",
158
+ "role"
159
+ ],
160
+ "additionalProperties": false
161
+ },
162
+ "maxItems": 100
163
+ }
164
+ },
165
+ "required": [
166
+ "orgId",
167
+ "role"
168
+ ],
169
+ "additionalProperties": false
170
+ },
171
+ "maxItems": 25
172
+ },
173
+ "scope": {
174
+ "type": "array",
175
+ "uniqueItems": true,
176
+ "items": {
177
+ "type": "string",
178
+ "description": "OAuth-supported user-context API scope. See the `scopes_supported` field of the OAuth authorization server metadata document at /.well-known/oauth-authorization-server for the authoritative list.",
179
+ "enum": [
180
+ "all.Application.read",
181
+ "all.Application.bounded",
182
+ "only.Organization.read",
183
+ "only.Organization.bounded",
184
+ "all.Organization.read",
185
+ "all.Organization.bounded",
186
+ "only.User.read"
187
+ ]
188
+ },
189
+ "description": "API scopes for this OAuth token"
190
+ }
191
+ },
192
+ "additionalProperties": false,
193
+ "required": [
194
+ "name",
195
+ "oauth"
196
+ ]
197
+ }