losant_rest 1.16.1 → 1.16.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +1260 -316
  3. data/docs/applications.md +1 -1
  4. data/docs/instanceSandbox.md +135 -0
  5. data/docs/instanceSandboxes.md +53 -0
  6. data/lib/losant_rest/client.rb +10 -2
  7. data/lib/losant_rest/instance_sandbox.rb +181 -0
  8. data/lib/losant_rest/instance_sandboxes.rb +94 -0
  9. data/lib/losant_rest/version.rb +1 -1
  10. data/lib/losant_rest.rb +2 -0
  11. data/schemas/apiTokenPost.json +7 -1
  12. data/schemas/applicationDashboardPost.json +3 -0
  13. data/schemas/applicationExportPost.json +1 -0
  14. data/schemas/applicationSearchResult.json +2 -1
  15. data/schemas/applicationTemplateCategories.json +11 -0
  16. data/schemas/applicationTemplateCategory.json +11 -0
  17. data/schemas/dashboard.json +3 -0
  18. data/schemas/dashboardPatch.json +3 -0
  19. data/schemas/dashboardPost.json +3 -0
  20. data/schemas/dashboardSendReport.json +3 -0
  21. data/schemas/dashboards.json +3 -0
  22. data/schemas/dataExport.json +1 -0
  23. data/schemas/devicesDeletePost.json +5 -0
  24. data/schemas/devicesExportPayloadCountPost.json +1 -0
  25. data/schemas/devicesExportPost.json +1 -0
  26. data/schemas/devicesPatch.json +5 -0
  27. data/schemas/embeddedDeploymentExport.json +5 -0
  28. data/schemas/eventsExport.json +1 -0
  29. data/schemas/flowVersionsDeletePost.json +5 -0
  30. data/schemas/githubLogin.json +7 -1
  31. data/schemas/importIntoApplicationOptions.json +52 -0
  32. data/schemas/importNewApplicationOptions.json +44 -0
  33. data/schemas/instance.json +1 -0
  34. data/schemas/instanceOrg.json +30 -0
  35. data/schemas/instanceOrgPatch.json +29 -0
  36. data/schemas/instanceOrgPost.json +29 -0
  37. data/schemas/instanceOrgs.json +30 -0
  38. data/schemas/instancePatch.json +1 -0
  39. data/schemas/instanceReportOptionsPost.json +1 -0
  40. data/schemas/instanceSandbox.json +423 -0
  41. data/schemas/instanceSandboxes.json +48 -0
  42. data/schemas/notebookDataExportOptions.json +5 -0
  43. data/schemas/org.json +17 -0
  44. data/schemas/orgs.json +17 -0
  45. data/schemas/userCredentials.json +7 -1
  46. data/schemas/userPost.json +7 -1
  47. metadata +10 -2
data/docs/_schemas.md CHANGED
@@ -28,7 +28,6 @@
28
28
  * [Application Export Post Schema](#application-export-post-schema)
29
29
  * [Application Export Result](#application-export-result)
30
30
  * [Application Global Patch](#application-global-patch)
31
- * [Application Import Options](#application-import-options)
32
31
  * [Application Key](#application-key)
33
32
  * [Application Key Patch](#application-key-patch)
34
33
  * [Application Key Post](#application-key-post)
@@ -185,6 +184,8 @@
185
184
  * [Github Login](#github-login)
186
185
  * [Historical Summaries](#historical-summaries)
187
186
  * [Historical Summary](#historical-summary)
187
+ * [Application Import Options](#application-import-options)
188
+ * [Applications Import Options](#applications-import-options)
188
189
  * [Instance](#instance)
189
190
  * [Instance Custom Node](#instance-custom-node)
190
191
  * [Instance Custom Node Patch](#instance-custom-node-patch)
@@ -204,6 +205,8 @@
204
205
  * [Instance Organizations](#instance-organizations)
205
206
  * [Instance Patch](#instance-patch)
206
207
  * [Instance Report Options Post](#instance-report-options-post)
208
+ * [Instance Sandbox User](#instance-sandbox-user)
209
+ * [Instance Sandboxes](#instance-sandboxes)
207
210
  * [Instances](#instances)
208
211
  * [Integration](#integration)
209
212
  * [Integration Patch](#integration-patch)
@@ -7192,7 +7195,13 @@ Schema for the body of an API Token creation request
7192
7195
  "instanceCustomNode.patch",
7193
7196
  "instanceCustomNode.delete",
7194
7197
  "instanceCustomNode.errors",
7195
- "instanceCustomNode.stats"
7198
+ "instanceCustomNode.stats",
7199
+ "instanceSandbox.*",
7200
+ "instanceSandbox.get",
7201
+ "instanceSandbox.delete",
7202
+ "instanceSandbox.undelete",
7203
+ "instanceSandboxes.*",
7204
+ "instanceSandboxes.get"
7196
7205
  ]
7197
7206
  },
7198
7207
  {
@@ -14895,6 +14904,9 @@ Schema for the body of an Application scoped Dashboard creation request
14895
14904
  },
14896
14905
  "ctx": {
14897
14906
  "ref": "#/definitions/dashboardContextInstance"
14907
+ },
14908
+ "branded": {
14909
+ "type": "boolean"
14898
14910
  }
14899
14911
  },
14900
14912
  "additionalProperties": false,
@@ -15295,6 +15307,7 @@ Schema for the body of an application export request
15295
15307
  },
15296
15308
  "callbackUrl": {
15297
15309
  "type": "string",
15310
+ "format": "uri",
15298
15311
  "maxLength": 1024
15299
15312
  }
15300
15313
  },
@@ -15402,71 +15415,6 @@ Schema for the body of an Application Global modification request
15402
15415
 
15403
15416
  <br/>
15404
15417
 
15405
- ## Application Import Options
15406
-
15407
- Schema for additional application import options
15408
-
15409
- ### <a name="application-import-options-schema"></a> Schema
15410
-
15411
- ```json
15412
- {
15413
- "$schema": "http://json-schema.org/draft-04/schema#",
15414
- "type": "object",
15415
- "properties": {
15416
- "importUrl": {
15417
- "type": "string",
15418
- "format": "uri",
15419
- "maxLength": 1024
15420
- },
15421
- "callbackUrl": {
15422
- "type": "string",
15423
- "format": "uri",
15424
- "maxLength": 1024
15425
- },
15426
- "include": {
15427
- "type": "array",
15428
- "items": {
15429
- "enum": [
15430
- "ApplicationCertificateAuthority",
15431
- "Dashboard",
15432
- "DataTableRow",
15433
- "DataTable",
15434
- "DeviceRecipe",
15435
- "Device",
15436
- "ExperienceEndpoint",
15437
- "ExperienceFlowVersion",
15438
- "ExperienceGroup",
15439
- "ExperienceUser",
15440
- "ExperienceVersion",
15441
- "ExperienceView",
15442
- "File",
15443
- "FlowVersion",
15444
- "Flow",
15445
- "Integration",
15446
- "Notebook",
15447
- "Webhook"
15448
- ]
15449
- },
15450
- "uniqueItems": true
15451
- }
15452
- },
15453
- "additionalProperties": false
15454
- }
15455
- ```
15456
- ### <a name="application-import-options-example"></a> Example
15457
-
15458
- ```json
15459
- {
15460
- "importUrl": "https://storage.mySite.com/myZipFile.zip",
15461
- "include": [
15462
- "Flow",
15463
- "Device"
15464
- ]
15465
- }
15466
- ```
15467
-
15468
- <br/>
15469
-
15470
15418
  ## Application Key
15471
15419
 
15472
15420
  Schema for a single Application Key
@@ -16729,7 +16677,8 @@ Results of a search of an application&#x27;s resources
16729
16677
  "file",
16730
16678
  "flow",
16731
16679
  "integration",
16732
- "webhook"
16680
+ "webhook",
16681
+ "notebook"
16733
16682
  ]
16734
16683
  }
16735
16684
  },
@@ -16955,6 +16904,17 @@ Schema for a collection of Application Template Categories
16955
16904
  "description": {
16956
16905
  "type": "string",
16957
16906
  "maxLength": 32767
16907
+ },
16908
+ "resourceTypes": {
16909
+ "type": "array",
16910
+ "items": {
16911
+ "type": "string",
16912
+ "enum": [
16913
+ "DeviceRecipe",
16914
+ "CustomNode"
16915
+ ]
16916
+ },
16917
+ "maxItems": 100
16958
16918
  }
16959
16919
  }
16960
16920
  }
@@ -17023,6 +16983,17 @@ Schema for a single Application Template Category
17023
16983
  "description": {
17024
16984
  "type": "string",
17025
16985
  "maxLength": 32767
16986
+ },
16987
+ "resourceTypes": {
16988
+ "type": "array",
16989
+ "items": {
16990
+ "type": "string",
16991
+ "enum": [
16992
+ "DeviceRecipe",
16993
+ "CustomNode"
16994
+ ]
16995
+ },
16996
+ "maxItems": 100
17026
16997
  }
17027
16998
  }
17028
16999
  }
@@ -18702,6 +18673,9 @@ Schema for a single Dashboard
18702
18673
  },
18703
18674
  "ctx": {
18704
18675
  "ref": "#/definitions/dashboardContextInstance"
18676
+ },
18677
+ "branded": {
18678
+ "type": "boolean"
18705
18679
  }
18706
18680
  },
18707
18681
  "additionalProperties": false,
@@ -30111,6 +30085,9 @@ Schema for the body of a Dashboard modification request
30111
30085
  },
30112
30086
  "ctx": {
30113
30087
  "ref": "#/definitions/dashboardContextInstance"
30088
+ },
30089
+ "branded": {
30090
+ "type": "boolean"
30114
30091
  }
30115
30092
  },
30116
30093
  "additionalProperties": false,
@@ -36002,6 +35979,9 @@ Schema for the body of a Dashboard creation request
36002
35979
  },
36003
35980
  "ctx": {
36004
35981
  "ref": "#/definitions/dashboardContextInstance"
35982
+ },
35983
+ "branded": {
35984
+ "type": "boolean"
36005
35985
  }
36006
35986
  },
36007
35987
  "additionalProperties": false,
@@ -36426,6 +36406,9 @@ Schema for the body of a Dashboard report request
36426
36406
  },
36427
36407
  "ctx": {
36428
36408
  "ref": "#/definitions/dashboardContextInstance"
36409
+ },
36410
+ "branded": {
36411
+ "type": "boolean"
36429
36412
  }
36430
36413
  },
36431
36414
  "anyOf": [
@@ -36675,6 +36658,9 @@ Schema for a collection of Dashboards
36675
36658
  },
36676
36659
  "ctx": {
36677
36660
  "ref": "#/definitions/dashboardContextInstance"
36661
+ },
36662
+ "branded": {
36663
+ "type": "boolean"
36678
36664
  }
36679
36665
  },
36680
36666
  "additionalProperties": false,
@@ -42620,6 +42606,7 @@ Schema for exporting data devices query
42620
42606
  },
42621
42607
  "callbackUrl": {
42622
42608
  "type": "string",
42609
+ "format": "uri",
42623
42610
  "maxLength": 1024
42624
42611
  },
42625
42612
  "deviceIds": {
@@ -48597,6 +48584,11 @@ Schema for the body of a bulk device delete request
48597
48584
  }
48598
48585
  },
48599
48586
  "additionalProperties": false
48587
+ },
48588
+ "callbackUrl": {
48589
+ "type": "string",
48590
+ "format": "uri",
48591
+ "maxLength": 1024
48600
48592
  }
48601
48593
  },
48602
48594
  "additionalProperties": false,
@@ -48638,6 +48630,7 @@ Schema for the body of a device payload count export request
48638
48630
  },
48639
48631
  "callbackUrl": {
48640
48632
  "type": "string",
48633
+ "format": "uri",
48641
48634
  "maxLength": 1024
48642
48635
  },
48643
48636
  "query": {
@@ -50011,6 +50004,7 @@ Schema for the body of a device metadata export request
50011
50004
  },
50012
50005
  "callbackUrl": {
50013
50006
  "type": "string",
50007
+ "format": "uri",
50014
50008
  "maxLength": 1024
50015
50009
  },
50016
50010
  "query": {
@@ -53648,6 +53642,11 @@ Schema for the body of a Devices modification request
53648
53642
  "type": "string",
53649
53643
  "format": "email",
53650
53644
  "maxLength": 1024
53645
+ },
53646
+ "callbackUrl": {
53647
+ "type": "string",
53648
+ "format": "uri",
53649
+ "maxLength": 1024
53651
53650
  }
53652
53651
  },
53653
53652
  "additionalProperties": false,
@@ -55995,6 +55994,11 @@ Schema for the body of a compiled embedded deployment files request
55995
55994
  "format": "email",
55996
55995
  "maxLength": 1024
55997
55996
  },
55997
+ "callbackUrl": {
55998
+ "type": "string",
55999
+ "format": "uri",
56000
+ "maxLength": 1024
56001
+ },
55998
56002
  "embeddedDeploymentId": {
55999
56003
  "type": "string",
56000
56004
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -57240,6 +57244,7 @@ Export options for events
57240
57244
  },
57241
57245
  "callbackUrl": {
57242
57246
  "type": "string",
57247
+ "format": "uri",
57243
57248
  "maxLength": 1024
57244
57249
  },
57245
57250
  "query": {
@@ -91928,6 +91933,11 @@ Schema for the body of a bulk flow versions delete request
91928
91933
  }
91929
91934
  },
91930
91935
  "additionalProperties": false
91936
+ },
91937
+ "callbackUrl": {
91938
+ "type": "string",
91939
+ "format": "uri",
91940
+ "maxLength": 1024
91931
91941
  }
91932
91942
  },
91933
91943
  "additionalProperties": false,
@@ -107772,7 +107782,13 @@ Schema for the body of a Github login request
107772
107782
  "instanceCustomNode.patch",
107773
107783
  "instanceCustomNode.delete",
107774
107784
  "instanceCustomNode.errors",
107775
- "instanceCustomNode.stats"
107785
+ "instanceCustomNode.stats",
107786
+ "instanceSandbox.*",
107787
+ "instanceSandbox.get",
107788
+ "instanceSandbox.delete",
107789
+ "instanceSandbox.undelete",
107790
+ "instanceSandboxes.*",
107791
+ "instanceSandboxes.get"
107776
107792
  ]
107777
107793
  },
107778
107794
  {
@@ -108541,6 +108557,146 @@ Schema for a historical summary report
108541
108557
 
108542
108558
  <br/>
108543
108559
 
108560
+ ## Application Import Options
108561
+
108562
+ Schema for additional application import options
108563
+
108564
+ ### <a name="application-import-options-schema"></a> Schema
108565
+
108566
+ ```json
108567
+ {
108568
+ "$schema": "http://json-schema.org/draft-04/schema#",
108569
+ "type": "object",
108570
+ "properties": {
108571
+ "importUrl": {
108572
+ "type": "string",
108573
+ "format": "uri",
108574
+ "maxLength": 1024
108575
+ },
108576
+ "callbackUrl": {
108577
+ "type": "string",
108578
+ "format": "uri",
108579
+ "maxLength": 1024
108580
+ },
108581
+ "conflictBehavior": {
108582
+ "type": "string",
108583
+ "enum": [
108584
+ "create",
108585
+ "error"
108586
+ ],
108587
+ "default": "create"
108588
+ },
108589
+ "include": {
108590
+ "type": "array",
108591
+ "items": {
108592
+ "enum": [
108593
+ "ApplicationCertificateAuthority",
108594
+ "Dashboard",
108595
+ "DataTableRow",
108596
+ "DataTable",
108597
+ "DeviceRecipe",
108598
+ "Device",
108599
+ "ExperienceDevelopConfig",
108600
+ "ExperienceEndpoint",
108601
+ "ExperienceFlowVersion",
108602
+ "ExperienceGroup",
108603
+ "ExperienceUser",
108604
+ "ExperienceVersion",
108605
+ "ExperienceView",
108606
+ "File",
108607
+ "FlowVersion",
108608
+ "Flow",
108609
+ "Integration",
108610
+ "Notebook",
108611
+ "Webhook"
108612
+ ]
108613
+ },
108614
+ "uniqueItems": true
108615
+ }
108616
+ },
108617
+ "additionalProperties": false
108618
+ }
108619
+ ```
108620
+ ### <a name="application-import-options-example"></a> Example
108621
+
108622
+ ```json
108623
+ {
108624
+ "importUrl": "https://storage.mySite.com/myZipFile.zip",
108625
+ "include": [
108626
+ "Flow",
108627
+ "Device"
108628
+ ]
108629
+ }
108630
+ ```
108631
+
108632
+ <br/>
108633
+
108634
+ ## Applications Import Options
108635
+
108636
+ Schema for additional application import options (new application)
108637
+
108638
+ ### <a name="applications-import-options-schema"></a> Schema
108639
+
108640
+ ```json
108641
+ {
108642
+ "$schema": "http://json-schema.org/draft-04/schema#",
108643
+ "type": "object",
108644
+ "properties": {
108645
+ "importUrl": {
108646
+ "type": "string",
108647
+ "format": "uri",
108648
+ "maxLength": 1024
108649
+ },
108650
+ "callbackUrl": {
108651
+ "type": "string",
108652
+ "format": "uri",
108653
+ "maxLength": 1024
108654
+ },
108655
+ "include": {
108656
+ "type": "array",
108657
+ "items": {
108658
+ "enum": [
108659
+ "ApplicationCertificateAuthority",
108660
+ "Dashboard",
108661
+ "DataTableRow",
108662
+ "DataTable",
108663
+ "DeviceRecipe",
108664
+ "Device",
108665
+ "ExperienceDevelopConfig",
108666
+ "ExperienceEndpoint",
108667
+ "ExperienceFlowVersion",
108668
+ "ExperienceGroup",
108669
+ "ExperienceUser",
108670
+ "ExperienceVersion",
108671
+ "ExperienceView",
108672
+ "File",
108673
+ "FlowVersion",
108674
+ "Flow",
108675
+ "Integration",
108676
+ "Notebook",
108677
+ "Webhook"
108678
+ ]
108679
+ },
108680
+ "uniqueItems": true
108681
+ }
108682
+ },
108683
+ "additionalProperties": false
108684
+ }
108685
+ ```
108686
+ ### <a name="applications-import-options-example"></a> Example
108687
+
108688
+ ```json
108689
+ {
108690
+ "importUrl": "https://storage.mySite.com/myZipFile.zip",
108691
+ "include": [
108692
+ "Flow",
108693
+ "Device"
108694
+ ]
108695
+ }
108696
+ ```
108697
+
108698
+ <br/>
108699
+
108544
108700
  ## Instance
108545
108701
 
108546
108702
  Schema for a single Instance
@@ -108605,6 +108761,7 @@ Schema for a single Instance
108605
108761
  },
108606
108762
  "callbackUrl": {
108607
108763
  "type": "string",
108764
+ "format": "uri",
108608
108765
  "maxLength": 1024
108609
108766
  },
108610
108767
  "resourceGroupBy": {
@@ -111958,6 +112115,36 @@ Schema for the body of an Organization owned by an instance
111958
112115
  "format": "date-time"
111959
112116
  }
111960
112117
  ]
112118
+ },
112119
+ "isReadOnly": {
112120
+ "type": "boolean"
112121
+ },
112122
+ "tags": {
112123
+ "type": "array",
112124
+ "items": {
112125
+ "type": "object",
112126
+ "properties": {
112127
+ "key": {
112128
+ "type": "string",
112129
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
112130
+ },
112131
+ "value": {
112132
+ "type": "string",
112133
+ "minLength": 1,
112134
+ "maxLength": 255
112135
+ }
112136
+ },
112137
+ "required": [
112138
+ "key",
112139
+ "value"
112140
+ ],
112141
+ "additionalProperties": false
112142
+ },
112143
+ "maxItems": 100
112144
+ },
112145
+ "referralId": {
112146
+ "type": "string",
112147
+ "maxLength": 1024
111961
112148
  }
111962
112149
  },
111963
112150
  "additionalProperties": false,
@@ -112570,6 +112757,35 @@ Schema for the body of an Organization modification request within an instance
112570
112757
  "type": "boolean"
112571
112758
  }
112572
112759
  ]
112760
+ },
112761
+ "isReadOnly": {
112762
+ "type": "boolean"
112763
+ },
112764
+ "tags": {
112765
+ "type": "array",
112766
+ "items": {
112767
+ "type": "object",
112768
+ "properties": {
112769
+ "key": {
112770
+ "type": "string",
112771
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
112772
+ },
112773
+ "value": {
112774
+ "type": "string",
112775
+ "minLength": 1,
112776
+ "maxLength": 255
112777
+ }
112778
+ },
112779
+ "required": [
112780
+ "key",
112781
+ "value"
112782
+ ],
112783
+ "additionalProperties": false
112784
+ },
112785
+ "maxItems": 100
112786
+ },
112787
+ "referralId": {
112788
+ "ref": "#/definitions/common/optMedStr"
112573
112789
  }
112574
112790
  },
112575
112791
  "additionalProperties": false
@@ -112918,6 +113134,35 @@ Schema for the body of an Organization creation request within an instance
112918
113134
  "type": "boolean"
112919
113135
  }
112920
113136
  ]
113137
+ },
113138
+ "isReadOnly": {
113139
+ "type": "boolean"
113140
+ },
113141
+ "tags": {
113142
+ "type": "array",
113143
+ "items": {
113144
+ "type": "object",
113145
+ "properties": {
113146
+ "key": {
113147
+ "type": "string",
113148
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
113149
+ },
113150
+ "value": {
113151
+ "type": "string",
113152
+ "minLength": 1,
113153
+ "maxLength": 255
113154
+ }
113155
+ },
113156
+ "required": [
113157
+ "key",
113158
+ "value"
113159
+ ],
113160
+ "additionalProperties": false
113161
+ },
113162
+ "maxItems": 100
113163
+ },
113164
+ "referralId": {
113165
+ "ref": "#/definitions/common/optMedStr"
112921
113166
  }
112922
113167
  },
112923
113168
  "additionalProperties": false,
@@ -113101,264 +113346,912 @@ Schema for a collection of Organizations within an instance
113101
113346
  "format": "date-time"
113102
113347
  }
113103
113348
  ]
113104
- }
113105
- },
113106
- "additionalProperties": false,
113107
- "required": [
113108
- "name"
113109
- ]
113110
- }
113111
- },
113112
- "instanceId": {
113113
- "type": "string",
113114
- "pattern": "^[A-Fa-f\\d]{24}$"
113115
- },
113116
- "count": {
113117
- "type": "integer"
113118
- },
113119
- "totalCount": {
113120
- "type": "integer"
113121
- },
113122
- "perPage": {
113123
- "type": "integer"
113124
- },
113125
- "page": {
113126
- "type": "integer"
113127
- },
113128
- "filter": {
113129
- "type": "string"
113130
- },
113131
- "filterField": {
113132
- "type": "string"
113133
- },
113134
- "sortField": {
113135
- "type": "string"
113136
- },
113137
- "sortDirection": {
113138
- "type": "string",
113139
- "enum": [
113140
- "asc",
113141
- "desc",
113142
- "ASC",
113143
- "DESC",
113144
- ""
113145
- ]
113146
- }
113147
- }
113148
- }
113149
- ```
113150
- ### <a name="instance-organizations-example"></a> Example
113151
-
113152
- ```json
113153
- {
113154
- "items": [
113155
- {
113156
- "name": "My Org",
113157
- "id": "60106426dc03c6aad06540bb",
113158
- "instanceId": "60106426dc03c6aad06560ba",
113159
- "limits": {
113160
- "members": 500
113161
- },
113162
- "auditLogEnabled": true
113163
- }
113164
- ],
113165
- "count": 1,
113166
- "totalCount": 2,
113167
- "perPage": 1,
113168
- "page": 0,
113169
- "sortField": "name",
113170
- "sortDirection": "asc"
113171
- }
113172
- ```
113173
-
113174
- <br/>
113175
-
113176
- ## Instance Patch
113177
-
113178
- Schema for instance patch request
113179
-
113180
- ### <a name="instance-patch-schema"></a> Schema
113181
-
113182
- ```json
113183
- {
113184
- "$schema": "http://json-schema.org/draft-04/schema#",
113185
- "type": "object",
113186
- "properties": {
113187
- "reportConfigs": {
113188
- "type": "array",
113189
- "maxItems": 10,
113190
- "items": {
113191
- "type": "object",
113192
- "properties": {
113193
- "id": {
113194
- "type": "string",
113195
- "maxLength": 48
113196
- },
113197
- "cron": {
113198
- "type": "string",
113199
- "maxLength": 255
113200
113349
  },
113201
- "timezone": {
113202
- "type": "string",
113203
- "maxLength": 255
113350
+ "isReadOnly": {
113351
+ "type": "boolean"
113204
113352
  },
113205
- "emails": {
113353
+ "tags": {
113206
113354
  "type": "array",
113207
- "maxItems": 10,
113208
113355
  "items": {
113209
- "type": "string",
113210
- "format": "email",
113211
- "maxLength": 1024
113212
- }
113356
+ "type": "object",
113357
+ "properties": {
113358
+ "key": {
113359
+ "type": "string",
113360
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
113361
+ },
113362
+ "value": {
113363
+ "type": "string",
113364
+ "minLength": 1,
113365
+ "maxLength": 255
113366
+ }
113367
+ },
113368
+ "required": [
113369
+ "key",
113370
+ "value"
113371
+ ],
113372
+ "additionalProperties": false
113373
+ },
113374
+ "maxItems": 100
113213
113375
  },
113214
- "callbackUrl": {
113376
+ "referralId": {
113215
113377
  "type": "string",
113216
113378
  "maxLength": 1024
113217
- },
113218
- "resourceGroupBy": {
113219
- "type": "string",
113220
- "enum": [
113221
- "application",
113222
- "organization"
113223
- ]
113224
- },
113225
- "dateGroupBy": {
113226
- "type": "string",
113227
- "enum": [
113228
- "day",
113229
- "month"
113230
- ]
113231
- },
113232
- "periods": {
113233
- "type": "integer",
113234
- "minimum": 1,
113235
- "maximum": 90
113236
- },
113237
- "includeSandbox": {
113238
- "type": "boolean"
113239
113379
  }
113240
113380
  },
113381
+ "additionalProperties": false,
113241
113382
  "required": [
113242
- "cron"
113243
- ],
113244
- "additionalProperties": false
113383
+ "name"
113384
+ ]
113245
113385
  }
113246
- }
113247
- },
113248
- "additionalProperties": false
113249
- }
113250
- ```
113251
- ### <a name="instance-patch-example"></a> Example
113252
-
113253
- ```json
113254
- {
113255
- "reportConfigs": [
113256
- {
113257
- "email": [
113258
- "email@example.com"
113259
- ],
113260
- "callbackUrl": "https://example.com/callback",
113261
- "resourceGroupBy": "organization",
113262
- "dateGroupBy": "month",
113263
- "includeSandbox": false,
113264
- "periods": 3
113265
113386
  },
113266
- {
113267
- "emails": [
113268
- "email@example.com",
113269
- "anotheremail@example.com"
113270
- ],
113271
- "resourceGroupBy": "application",
113272
- "dateGroupBy": "month",
113273
- "includeSandbox": true
113274
- }
113275
- ]
113276
- }
113277
- ```
113278
-
113279
- <br/>
113280
-
113281
- ## Instance Report Options Post
113282
-
113283
- Schema for the body of a instance report request
113284
-
113285
- ### <a name="instance-report-options-post-schema"></a> Schema
113286
-
113287
- ```json
113288
- {
113289
- "$schema": "http://json-schema.org/draft-04/schema#",
113290
- "type": "object",
113291
- "properties": {
113292
- "email": {
113293
- "type": "string",
113294
- "format": "email",
113295
- "maxLength": 1024
113296
- },
113297
- "callbackUrl": {
113298
- "type": "string",
113299
- "maxLength": 1024
113300
- },
113301
- "resourceGroupBy": {
113302
- "type": "string",
113303
- "enum": [
113304
- "application",
113305
- "organization"
113306
- ]
113307
- },
113308
- "dateGroupBy": {
113309
- "type": "string",
113310
- "enum": [
113311
- "day",
113312
- "month"
113313
- ]
113314
- },
113315
- "includeSandbox": {
113316
- "type": "boolean"
113317
- },
113318
- "start": {
113319
- "type": "string",
113320
- "format": "date-time"
113321
- },
113322
- "end": {
113387
+ "instanceId": {
113323
113388
  "type": "string",
113324
- "format": "date-time"
113325
- }
113326
- },
113327
- "additionalProperties": false
113328
- }
113329
- ```
113330
- ### <a name="instance-report-options-post-example"></a> Example
113331
-
113332
- ```json
113333
- {
113334
- "email": "email@example.com",
113335
- "callbackUrl": "https://example.com/callback",
113336
- "resourceGroupBy": "organization",
113337
- "dateGroupBy": "month",
113338
- "includeSandbox": false,
113339
- "start": "2020-01-01T00:00:00.000Z",
113340
- "end": "2020-01-31T11:59:59.999Z"
113341
- }
113342
- ```
113343
-
113344
- <br/>
113345
-
113346
- ## Instances
113347
-
113348
- Schema for a collection of Instances
113349
-
113350
- ### <a name="instances-schema"></a> Schema
113351
-
113352
- ```json
113353
- {
113354
- "$schema": "http://json-schema.org/draft-04/schema#",
113355
- "type": "object",
113356
- "properties": {
113357
- "items": {
113358
- "type": "array",
113359
- "items": {
113360
- "type": "#/definitions/instance"
113361
- }
113389
+ "pattern": "^[A-Fa-f\\d]{24}$"
113390
+ },
113391
+ "count": {
113392
+ "type": "integer"
113393
+ },
113394
+ "totalCount": {
113395
+ "type": "integer"
113396
+ },
113397
+ "perPage": {
113398
+ "type": "integer"
113399
+ },
113400
+ "page": {
113401
+ "type": "integer"
113402
+ },
113403
+ "filter": {
113404
+ "type": "string"
113405
+ },
113406
+ "filterField": {
113407
+ "type": "string"
113408
+ },
113409
+ "sortField": {
113410
+ "type": "string"
113411
+ },
113412
+ "sortDirection": {
113413
+ "type": "string",
113414
+ "enum": [
113415
+ "asc",
113416
+ "desc",
113417
+ "ASC",
113418
+ "DESC",
113419
+ ""
113420
+ ]
113421
+ }
113422
+ }
113423
+ }
113424
+ ```
113425
+ ### <a name="instance-organizations-example"></a> Example
113426
+
113427
+ ```json
113428
+ {
113429
+ "items": [
113430
+ {
113431
+ "name": "My Org",
113432
+ "id": "60106426dc03c6aad06540bb",
113433
+ "instanceId": "60106426dc03c6aad06560ba",
113434
+ "limits": {
113435
+ "members": 500
113436
+ },
113437
+ "auditLogEnabled": true
113438
+ }
113439
+ ],
113440
+ "count": 1,
113441
+ "totalCount": 2,
113442
+ "perPage": 1,
113443
+ "page": 0,
113444
+ "sortField": "name",
113445
+ "sortDirection": "asc"
113446
+ }
113447
+ ```
113448
+
113449
+ <br/>
113450
+
113451
+ ## Instance Patch
113452
+
113453
+ Schema for instance patch request
113454
+
113455
+ ### <a name="instance-patch-schema"></a> Schema
113456
+
113457
+ ```json
113458
+ {
113459
+ "$schema": "http://json-schema.org/draft-04/schema#",
113460
+ "type": "object",
113461
+ "properties": {
113462
+ "reportConfigs": {
113463
+ "type": "array",
113464
+ "maxItems": 10,
113465
+ "items": {
113466
+ "type": "object",
113467
+ "properties": {
113468
+ "id": {
113469
+ "type": "string",
113470
+ "maxLength": 48
113471
+ },
113472
+ "cron": {
113473
+ "type": "string",
113474
+ "maxLength": 255
113475
+ },
113476
+ "timezone": {
113477
+ "type": "string",
113478
+ "maxLength": 255
113479
+ },
113480
+ "emails": {
113481
+ "type": "array",
113482
+ "maxItems": 10,
113483
+ "items": {
113484
+ "type": "string",
113485
+ "format": "email",
113486
+ "maxLength": 1024
113487
+ }
113488
+ },
113489
+ "callbackUrl": {
113490
+ "type": "string",
113491
+ "format": "uri",
113492
+ "maxLength": 1024
113493
+ },
113494
+ "resourceGroupBy": {
113495
+ "type": "string",
113496
+ "enum": [
113497
+ "application",
113498
+ "organization"
113499
+ ]
113500
+ },
113501
+ "dateGroupBy": {
113502
+ "type": "string",
113503
+ "enum": [
113504
+ "day",
113505
+ "month"
113506
+ ]
113507
+ },
113508
+ "periods": {
113509
+ "type": "integer",
113510
+ "minimum": 1,
113511
+ "maximum": 90
113512
+ },
113513
+ "includeSandbox": {
113514
+ "type": "boolean"
113515
+ }
113516
+ },
113517
+ "required": [
113518
+ "cron"
113519
+ ],
113520
+ "additionalProperties": false
113521
+ }
113522
+ }
113523
+ },
113524
+ "additionalProperties": false
113525
+ }
113526
+ ```
113527
+ ### <a name="instance-patch-example"></a> Example
113528
+
113529
+ ```json
113530
+ {
113531
+ "reportConfigs": [
113532
+ {
113533
+ "email": [
113534
+ "email@example.com"
113535
+ ],
113536
+ "callbackUrl": "https://example.com/callback",
113537
+ "resourceGroupBy": "organization",
113538
+ "dateGroupBy": "month",
113539
+ "includeSandbox": false,
113540
+ "periods": 3
113541
+ },
113542
+ {
113543
+ "emails": [
113544
+ "email@example.com",
113545
+ "anotheremail@example.com"
113546
+ ],
113547
+ "resourceGroupBy": "application",
113548
+ "dateGroupBy": "month",
113549
+ "includeSandbox": true
113550
+ }
113551
+ ]
113552
+ }
113553
+ ```
113554
+
113555
+ <br/>
113556
+
113557
+ ## Instance Report Options Post
113558
+
113559
+ Schema for the body of a instance report request
113560
+
113561
+ ### <a name="instance-report-options-post-schema"></a> Schema
113562
+
113563
+ ```json
113564
+ {
113565
+ "$schema": "http://json-schema.org/draft-04/schema#",
113566
+ "type": "object",
113567
+ "properties": {
113568
+ "email": {
113569
+ "type": "string",
113570
+ "format": "email",
113571
+ "maxLength": 1024
113572
+ },
113573
+ "callbackUrl": {
113574
+ "type": "string",
113575
+ "format": "uri",
113576
+ "maxLength": 1024
113577
+ },
113578
+ "resourceGroupBy": {
113579
+ "type": "string",
113580
+ "enum": [
113581
+ "application",
113582
+ "organization"
113583
+ ]
113584
+ },
113585
+ "dateGroupBy": {
113586
+ "type": "string",
113587
+ "enum": [
113588
+ "day",
113589
+ "month"
113590
+ ]
113591
+ },
113592
+ "includeSandbox": {
113593
+ "type": "boolean"
113594
+ },
113595
+ "start": {
113596
+ "type": "string",
113597
+ "format": "date-time"
113598
+ },
113599
+ "end": {
113600
+ "type": "string",
113601
+ "format": "date-time"
113602
+ }
113603
+ },
113604
+ "additionalProperties": false
113605
+ }
113606
+ ```
113607
+ ### <a name="instance-report-options-post-example"></a> Example
113608
+
113609
+ ```json
113610
+ {
113611
+ "email": "email@example.com",
113612
+ "callbackUrl": "https://example.com/callback",
113613
+ "resourceGroupBy": "organization",
113614
+ "dateGroupBy": "month",
113615
+ "includeSandbox": false,
113616
+ "start": "2020-01-01T00:00:00.000Z",
113617
+ "end": "2020-01-31T11:59:59.999Z"
113618
+ }
113619
+ ```
113620
+
113621
+ <br/>
113622
+
113623
+ ## Instance Sandbox User
113624
+
113625
+ Schema for information about a sandbox user within an instance domain
113626
+
113627
+ ### <a name="instance-sandbox-user-schema"></a> Schema
113628
+
113629
+ ```json
113630
+ {
113631
+ "$schema": "http://json-schema.org/draft-04/schema#",
113632
+ "type": "object",
113633
+ "properties": {
113634
+ "id": {
113635
+ "type": "string",
113636
+ "pattern": "^[A-Fa-f\\d]{24}$"
113637
+ },
113638
+ "instanceSandboxId": {
113639
+ "type": "string",
113640
+ "pattern": "^[A-Fa-f\\d]{24}$"
113641
+ },
113642
+ "instanceId": {
113643
+ "type": "string",
113644
+ "pattern": "^[A-Fa-f\\d]{24}$"
113645
+ },
113646
+ "creationDate": {
113647
+ "type": "string",
113648
+ "format": "date-time"
113649
+ },
113650
+ "permanentDeletion": {
113651
+ "type": "string",
113652
+ "format": "date-time"
113653
+ },
113654
+ "dataDeletion": {
113655
+ "type": "string",
113656
+ "format": "date-time"
113657
+ },
113658
+ "lastUpdated": {
113659
+ "type": "string",
113660
+ "format": "date-time"
113661
+ },
113662
+ "lastSuccessfulLogin": {
113663
+ "type": "string",
113664
+ "format": "date-time"
113665
+ },
113666
+ "lastFailedLogin": {
113667
+ "type": "string",
113668
+ "format": "date-time"
113669
+ },
113670
+ "failedLoginCount": {
113671
+ "type": "number"
113672
+ },
113673
+ "passwordLastUpdated": {
113674
+ "type": "string",
113675
+ "format": "date-time"
113676
+ },
113677
+ "email": {
113678
+ "type": "string",
113679
+ "format": "email",
113680
+ "maxLength": 1024
113681
+ },
113682
+ "firstName": {
113683
+ "type": "string",
113684
+ "minLength": 1,
113685
+ "maxLength": 1024
113686
+ },
113687
+ "lastName": {
113688
+ "type": "string",
113689
+ "maxLength": 1024
113690
+ },
113691
+ "companyName": {
113692
+ "type": "string",
113693
+ "maxLength": 1024
113694
+ },
113695
+ "title": {
113696
+ "type": "string",
113697
+ "maxLength": 1024
113698
+ },
113699
+ "phoneNumber": {
113700
+ "type": "string",
113701
+ "maxLength": 1024
113702
+ },
113703
+ "location": {
113704
+ "type": "string",
113705
+ "maxLength": 1024
113706
+ },
113707
+ "url": {
113708
+ "type": "string",
113709
+ "maxLength": 1024
113710
+ },
113711
+ "tokenCutoff": {
113712
+ "type": "string",
113713
+ "format": "date-time"
113714
+ },
113715
+ "emailVerified": {
113716
+ "type": "boolean"
113717
+ },
113718
+ "needsToVerifyEmail": {
113719
+ "type": "boolean"
113720
+ },
113721
+ "twoFactorAuthEnabled": {
113722
+ "type": "boolean"
113723
+ },
113724
+ "fullName": {
113725
+ "type": "string"
113726
+ },
113727
+ "githubName": {
113728
+ "type": "string"
113729
+ },
113730
+ "avatarUrl": {
113731
+ "type": "string",
113732
+ "format": "uri",
113733
+ "maxLength": 1024
113734
+ },
113735
+ "limits": {
113736
+ "type": "object",
113737
+ "properties": {
113738
+ "apitoken": {
113739
+ "type": "integer"
113740
+ },
113741
+ "application": {
113742
+ "type": "integer"
113743
+ },
113744
+ "applicationkey": {
113745
+ "type": "integer"
113746
+ },
113747
+ "dashboard": {
113748
+ "type": "integer"
113749
+ },
113750
+ "datatable": {
113751
+ "type": "integer"
113752
+ },
113753
+ "device": {
113754
+ "type": "integer"
113755
+ },
113756
+ "devicerecipe": {
113757
+ "type": "integer"
113758
+ },
113759
+ "experiencedomain": {
113760
+ "type": "integer"
113761
+ },
113762
+ "experienceendpoint": {
113763
+ "type": "integer"
113764
+ },
113765
+ "experiencegroup": {
113766
+ "type": "integer"
113767
+ },
113768
+ "experienceslug": {
113769
+ "type": "integer"
113770
+ },
113771
+ "experienceuser": {
113772
+ "type": "integer"
113773
+ },
113774
+ "experienceversion": {
113775
+ "type": "integer"
113776
+ },
113777
+ "experienceview": {
113778
+ "type": "integer"
113779
+ },
113780
+ "file": {
113781
+ "type": "integer"
113782
+ },
113783
+ "flow": {
113784
+ "type": "integer"
113785
+ },
113786
+ "integration": {
113787
+ "type": "integer"
113788
+ },
113789
+ "notebook": {
113790
+ "type": "integer"
113791
+ },
113792
+ "webhook": {
113793
+ "type": "integer"
113794
+ },
113795
+ "dataTTL": {
113796
+ "type": "integer"
113797
+ },
113798
+ "payload": {
113799
+ "type": "integer"
113800
+ },
113801
+ "storage": {
113802
+ "type": "integer"
113803
+ },
113804
+ "notebookMinutesPerRun": {
113805
+ "type": "integer"
113806
+ },
113807
+ "notebookMinutesPerMonth": {
113808
+ "type": "integer"
113809
+ },
113810
+ "notebookInParallel": {
113811
+ "type": "integer"
113812
+ },
113813
+ "experienceFlowSlots": {
113814
+ "type": "integer"
113815
+ },
113816
+ "applicationFlowSlots": {
113817
+ "type": "integer"
113818
+ }
113819
+ },
113820
+ "additionalProperties": false
113821
+ },
113822
+ "summary": {
113823
+ "type": "object",
113824
+ "properties": {
113825
+ "apiTokenCount": {
113826
+ "type": "integer"
113827
+ },
113828
+ "appCount": {
113829
+ "type": "integer"
113830
+ },
113831
+ "dashCount": {
113832
+ "type": "integer"
113833
+ },
113834
+ "dataTableCount": {
113835
+ "type": "integer"
113836
+ },
113837
+ "deviceCount": {
113838
+ "type": "integer"
113839
+ },
113840
+ "deviceRecipeCount": {
113841
+ "type": "integer"
113842
+ },
113843
+ "experienceEndpointCount": {
113844
+ "type": "integer"
113845
+ },
113846
+ "experienceGroupCount": {
113847
+ "type": "integer"
113848
+ },
113849
+ "experienceSlugCount": {
113850
+ "type": "integer"
113851
+ },
113852
+ "experienceUserCount": {
113853
+ "type": "integer"
113854
+ },
113855
+ "experienceVersionCount": {
113856
+ "type": "integer"
113857
+ },
113858
+ "experienceViewCount": {
113859
+ "type": "integer"
113860
+ },
113861
+ "fileCount": {
113862
+ "type": "integer"
113863
+ },
113864
+ "flowCount": {
113865
+ "type": "integer"
113866
+ },
113867
+ "integrationCount": {
113868
+ "type": "integer"
113869
+ },
113870
+ "keyCount": {
113871
+ "type": "integer"
113872
+ },
113873
+ "orgCount": {
113874
+ "type": "integer"
113875
+ },
113876
+ "payloadCount": {
113877
+ "title": "Payload Stats",
113878
+ "description": "Schema for the result of a payload stats request",
113879
+ "type": "object",
113880
+ "properties": {
113881
+ "dataTable": {
113882
+ "type": "object",
113883
+ "patternProperties": {
113884
+ ".*": {
113885
+ "type": "number"
113886
+ }
113887
+ }
113888
+ },
113889
+ "deviceCommand": {
113890
+ "type": "object",
113891
+ "patternProperties": {
113892
+ ".*": {
113893
+ "type": "number"
113894
+ }
113895
+ }
113896
+ },
113897
+ "deviceConnect": {
113898
+ "type": "object",
113899
+ "patternProperties": {
113900
+ ".*": {
113901
+ "type": "number"
113902
+ }
113903
+ }
113904
+ },
113905
+ "deviceDisconnect": {
113906
+ "type": "object",
113907
+ "patternProperties": {
113908
+ ".*": {
113909
+ "type": "number"
113910
+ }
113911
+ }
113912
+ },
113913
+ "deviceState": {
113914
+ "type": "object",
113915
+ "patternProperties": {
113916
+ ".*": {
113917
+ "type": "number"
113918
+ }
113919
+ }
113920
+ },
113921
+ "endpoint": {
113922
+ "type": "object",
113923
+ "patternProperties": {
113924
+ ".*": {
113925
+ "type": "number"
113926
+ }
113927
+ }
113928
+ },
113929
+ "event": {
113930
+ "type": "object",
113931
+ "patternProperties": {
113932
+ ".*": {
113933
+ "type": "number"
113934
+ }
113935
+ }
113936
+ },
113937
+ "flowError": {
113938
+ "type": "object",
113939
+ "patternProperties": {
113940
+ ".*": {
113941
+ "type": "number"
113942
+ }
113943
+ }
113944
+ },
113945
+ "integration": {
113946
+ "type": "object",
113947
+ "patternProperties": {
113948
+ ".*": {
113949
+ "type": "number"
113950
+ }
113951
+ }
113952
+ },
113953
+ "mqttIn": {
113954
+ "type": "object",
113955
+ "patternProperties": {
113956
+ ".*": {
113957
+ "type": "number"
113958
+ }
113959
+ }
113960
+ },
113961
+ "mqttOut": {
113962
+ "type": "object",
113963
+ "patternProperties": {
113964
+ ".*": {
113965
+ "type": "number"
113966
+ }
113967
+ }
113968
+ },
113969
+ "notebook": {
113970
+ "type": "object",
113971
+ "patternProperties": {
113972
+ ".*": {
113973
+ "type": "number"
113974
+ }
113975
+ }
113976
+ },
113977
+ "timer": {
113978
+ "type": "object",
113979
+ "patternProperties": {
113980
+ ".*": {
113981
+ "type": "number"
113982
+ }
113983
+ }
113984
+ },
113985
+ "virtualButton": {
113986
+ "type": "object",
113987
+ "patternProperties": {
113988
+ ".*": {
113989
+ "type": "number"
113990
+ }
113991
+ }
113992
+ },
113993
+ "webhook": {
113994
+ "type": "object",
113995
+ "patternProperties": {
113996
+ ".*": {
113997
+ "type": "number"
113998
+ }
113999
+ }
114000
+ }
114001
+ }
114002
+ },
114003
+ "storageStats": {
114004
+ "type": "object",
114005
+ "properties": {
114006
+ "count": {
114007
+ "type": "integer"
114008
+ },
114009
+ "size": {
114010
+ "type": "integer"
114011
+ }
114012
+ }
114013
+ },
114014
+ "webhookCount": {
114015
+ "type": "integer"
114016
+ }
114017
+ }
114018
+ },
114019
+ "currentPeriodStart": {
114020
+ "type": "string",
114021
+ "format": "date-time"
114022
+ },
114023
+ "currentPeriodEnd": {
114024
+ "type": "string",
114025
+ "format": "date-time"
114026
+ },
114027
+ "ssoLinked": {
114028
+ "type": "boolean"
114029
+ },
114030
+ "orgs": {
114031
+ "type": "array",
114032
+ "items": {
114033
+ "type": "object",
114034
+ "properties": {
114035
+ "id": {
114036
+ "type": "string",
114037
+ "pattern": "^[A-Fa-f\\d]{24}$"
114038
+ },
114039
+ "iconColor": {
114040
+ "type": "string",
114041
+ "maxLength": 64
114042
+ },
114043
+ "name": {
114044
+ "type": "string",
114045
+ "minLength": 1,
114046
+ "maxLength": 255
114047
+ }
114048
+ }
114049
+ }
114050
+ }
114051
+ }
114052
+ }
114053
+ ```
114054
+ ### <a name="instance-sandbox-user-example"></a> Example
114055
+
114056
+ ```json
114057
+ {
114058
+ "id": "575ed70c7ae143cd83dc4aa9",
114059
+ "instanceId": "575ed70c7ae143cd83dc4aa9",
114060
+ "instanceSandboxId": "575ed70c7ae143cd83dc4aa9",
114061
+ "creationDate": "2016-06-13T04:00:00.000Z",
114062
+ "lastUpdated": "2016-06-13T04:00:00.000Z",
114063
+ "passwordLastUpdated": "2016-06-13T04:00:00.000Z",
114064
+ "email": "email@example.com",
114065
+ "firstName": "Example",
114066
+ "lastName": "Name",
114067
+ "companyName": "Example, Inc.",
114068
+ "url": "https://example.com",
114069
+ "emailVerified": true,
114070
+ "needsToVerifyEmail": false,
114071
+ "twoFactorAuthEnabled": false,
114072
+ "fullName": "Example Name",
114073
+ "summary": {
114074
+ "appCount": 8,
114075
+ "dashCount": 5,
114076
+ "orgCount": 2,
114077
+ "deviceCount": 12,
114078
+ "flowCount": 3,
114079
+ "webhookCount": 0,
114080
+ "keyCount": 2,
114081
+ "deviceRecipeCount": 0
114082
+ },
114083
+ "orgs": [
114084
+ {
114085
+ "id": "575ed70c7ae143cd83dc4aa9",
114086
+ "iconColor": "red",
114087
+ "name": "Example"
114088
+ }
114089
+ ],
114090
+ "ssoLinked": false
114091
+ }
114092
+ ```
114093
+
114094
+ <br/>
114095
+
114096
+ ## Instance Sandboxes
114097
+
114098
+ Schema for a collection of instance associated sandboxes
114099
+
114100
+ ### <a name="instance-sandboxes-schema"></a> Schema
114101
+
114102
+ ```json
114103
+ {
114104
+ "$schema": "http://json-schema.org/draft-04/schema#",
114105
+ "type": "object",
114106
+ "properties": {
114107
+ "items": {
114108
+ "type": "array",
114109
+ "items": {
114110
+ "type": "#/definitions/instanceSandbox"
114111
+ }
114112
+ },
114113
+ "count": {
114114
+ "type": "integer"
114115
+ },
114116
+ "limit": {
114117
+ "type": "integer"
114118
+ },
114119
+ "startingAfterId": {
114120
+ "type": "string",
114121
+ "pattern": "^[A-Fa-f\\d]{24}$"
114122
+ },
114123
+ "endingBeforeId": {
114124
+ "type": "string",
114125
+ "pattern": "^[A-Fa-f\\d]{24}$"
114126
+ },
114127
+ "filter": {
114128
+ "type": "string"
114129
+ },
114130
+ "filterField": {
114131
+ "type": "string"
114132
+ },
114133
+ "sortField": {
114134
+ "type": "string"
114135
+ },
114136
+ "sortDirection": {
114137
+ "type": "string",
114138
+ "enum": [
114139
+ "asc",
114140
+ "desc",
114141
+ "ASC",
114142
+ "DESC",
114143
+ ""
114144
+ ]
114145
+ },
114146
+ "hasMore": {
114147
+ "type": "boolean"
114148
+ }
114149
+ }
114150
+ }
114151
+ ```
114152
+ ### <a name="instance-sandboxes-example"></a> Example
114153
+
114154
+ ```json
114155
+ {
114156
+ "count": 2,
114157
+ "items": [
114158
+ {
114159
+ "id": "575ed70c7ae143cd83dc4aa9",
114160
+ "instanceId": "575ed70c7ae143cd83dc4aa9",
114161
+ "instanceSandboxId": "575ed70c7ae143cd83dc4aa9",
114162
+ "creationDate": "2016-06-13T04:00:00.000Z",
114163
+ "lastUpdated": "2016-06-13T04:00:00.000Z",
114164
+ "passwordLastUpdated": "2016-06-13T04:00:00.000Z",
114165
+ "email": "email@example.com",
114166
+ "firstName": "Example",
114167
+ "lastName": "Name",
114168
+ "companyName": "Example, Inc.",
114169
+ "url": "https://example.com",
114170
+ "emailVerified": true,
114171
+ "needsToVerifyEmail": false,
114172
+ "twoFactorAuthEnabled": false,
114173
+ "fullName": "Example Name",
114174
+ "summary": {
114175
+ "appCount": 8,
114176
+ "dashCount": 5,
114177
+ "orgCount": 2,
114178
+ "deviceCount": 12,
114179
+ "flowCount": 3,
114180
+ "webhookCount": 0,
114181
+ "keyCount": 2,
114182
+ "deviceRecipeCount": 0
114183
+ },
114184
+ "orgs": [
114185
+ {
114186
+ "id": "575ed70c7ae143cd83dc4aa9",
114187
+ "iconColor": "red",
114188
+ "name": "Example"
114189
+ }
114190
+ ],
114191
+ "ssoLinked": false
114192
+ },
114193
+ {
114194
+ "id": "575ed70c7ae143cd83dc4aa9",
114195
+ "instanceId": "575ed70c7ae143cd83dc4aa9",
114196
+ "instanceSandboxId": "575ed70c7ae143cd83dc4aa9",
114197
+ "creationDate": "2016-06-13T04:00:00.000Z",
114198
+ "lastUpdated": "2016-06-13T04:00:00.000Z",
114199
+ "passwordLastUpdated": "2016-06-13T04:00:00.000Z",
114200
+ "email": "email@example.com",
114201
+ "firstName": "Example",
114202
+ "lastName": "Name",
114203
+ "companyName": "Example, Inc.",
114204
+ "url": "https://example.com",
114205
+ "emailVerified": true,
114206
+ "needsToVerifyEmail": false,
114207
+ "twoFactorAuthEnabled": false,
114208
+ "fullName": "Example Name",
114209
+ "summary": {
114210
+ "appCount": 8,
114211
+ "dashCount": 5,
114212
+ "orgCount": 2,
114213
+ "deviceCount": 12,
114214
+ "flowCount": 3,
114215
+ "webhookCount": 0,
114216
+ "keyCount": 2,
114217
+ "deviceRecipeCount": 0
114218
+ },
114219
+ "orgs": [
114220
+ {
114221
+ "id": "575ed70c7ae143cd83dc4aa9",
114222
+ "iconColor": "red",
114223
+ "name": "Example"
114224
+ }
114225
+ ],
114226
+ "ssoLinked": false
114227
+ }
114228
+ ],
114229
+ "limit": 100,
114230
+ "startingAfterId": "575ed70c7ae143cd83dc4aa9",
114231
+ "sortField": "firstName",
114232
+ "sortDirection": "asc",
114233
+ "hasMore": false
114234
+ }
114235
+ ```
114236
+
114237
+ <br/>
114238
+
114239
+ ## Instances
114240
+
114241
+ Schema for a collection of Instances
114242
+
114243
+ ### <a name="instances-schema"></a> Schema
114244
+
114245
+ ```json
114246
+ {
114247
+ "$schema": "http://json-schema.org/draft-04/schema#",
114248
+ "type": "object",
114249
+ "properties": {
114250
+ "items": {
114251
+ "type": "array",
114252
+ "items": {
114253
+ "type": "#/definitions/instance"
114254
+ }
113362
114255
  },
113363
114256
  "count": {
113364
114257
  "type": "integer"
@@ -117648,6 +118541,11 @@ Schema for the options for a Notebook data export request
117648
118541
  "templateContext": {
117649
118542
  "type": "string",
117650
118543
  "maxLength": 32767
118544
+ },
118545
+ "callbackUrl": {
118546
+ "type": "string",
118547
+ "format": "uri",
118548
+ "maxLength": 1024
117651
118549
  }
117652
118550
  },
117653
118551
  "additionalProperties": false
@@ -120488,6 +121386,23 @@ Schema for a single Organization
120488
121386
  "maxLength": 45,
120489
121387
  "minLength": 3
120490
121388
  }
121389
+ },
121390
+ "disabledAt": {
121391
+ "oneOf": [
121392
+ {
121393
+ "type": "boolean",
121394
+ "enum": [
121395
+ false
121396
+ ]
121397
+ },
121398
+ {
121399
+ "type": "string",
121400
+ "format": "date-time"
121401
+ }
121402
+ ]
121403
+ },
121404
+ "isReadOnly": {
121405
+ "type": "boolean"
120491
121406
  }
120492
121407
  }
120493
121408
  }
@@ -121967,6 +122882,23 @@ Schema for a collection of Organizations
121967
122882
  "maxLength": 45,
121968
122883
  "minLength": 3
121969
122884
  }
122885
+ },
122886
+ "disabledAt": {
122887
+ "oneOf": [
122888
+ {
122889
+ "type": "boolean",
122890
+ "enum": [
122891
+ false
122892
+ ]
122893
+ },
122894
+ {
122895
+ "type": "string",
122896
+ "format": "date-time"
122897
+ }
122898
+ ]
122899
+ },
122900
+ "isReadOnly": {
122901
+ "type": "boolean"
121970
122902
  }
121971
122903
  }
121972
122904
  }
@@ -124402,7 +125334,13 @@ Schema for the body of a User authentication request
124402
125334
  "instanceCustomNode.patch",
124403
125335
  "instanceCustomNode.delete",
124404
125336
  "instanceCustomNode.errors",
124405
- "instanceCustomNode.stats"
125337
+ "instanceCustomNode.stats",
125338
+ "instanceSandbox.*",
125339
+ "instanceSandbox.get",
125340
+ "instanceSandbox.delete",
125341
+ "instanceSandbox.undelete",
125342
+ "instanceSandboxes.*",
125343
+ "instanceSandboxes.get"
124406
125344
  ]
124407
125345
  },
124408
125346
  {
@@ -124929,7 +125867,13 @@ Schema for the body of a User creation request
124929
125867
  "instanceCustomNode.patch",
124930
125868
  "instanceCustomNode.delete",
124931
125869
  "instanceCustomNode.errors",
124932
- "instanceCustomNode.stats"
125870
+ "instanceCustomNode.stats",
125871
+ "instanceSandbox.*",
125872
+ "instanceSandbox.get",
125873
+ "instanceSandbox.delete",
125874
+ "instanceSandbox.undelete",
125875
+ "instanceSandboxes.*",
125876
+ "instanceSandboxes.get"
124933
125877
  ]
124934
125878
  },
124935
125879
  {