losant_rest 2.1.1 → 2.1.2

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 (27) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +1391 -55
  3. data/lib/platform_rest/client.rb +2 -2
  4. data/lib/platform_rest/version.rb +1 -1
  5. data/schemas/apiTokenPost.json +4 -0
  6. data/schemas/applicationDashboardPost.json +142 -11
  7. data/schemas/dashboard.json +142 -11
  8. data/schemas/dashboardPatch.json +142 -11
  9. data/schemas/dashboardPost.json +142 -11
  10. data/schemas/dashboards.json +142 -11
  11. data/schemas/githubLogin.json +4 -0
  12. data/schemas/instance.json +6 -0
  13. data/schemas/instanceOrg.json +12 -0
  14. data/schemas/instanceOrgEntitlement.json +182 -0
  15. data/schemas/instanceOrgEntitlementSync.json +64 -0
  16. data/schemas/instanceOrgs.json +12 -0
  17. data/schemas/instances.json +6 -0
  18. data/schemas/meEntitlements.json +194 -0
  19. data/schemas/org.json +16 -0
  20. data/schemas/orgPost.json +4 -0
  21. data/schemas/orgs.json +16 -0
  22. data/schemas/samlResponse.json +4 -0
  23. data/schemas/userCredentials.json +4 -0
  24. data/schemas/userPost.json +4 -0
  25. data/schemas/validateContextError.json +28 -0
  26. data/schemas/validateContextSuccess.json +28 -0
  27. metadata +4 -1
data/docs/_schemas.md CHANGED
@@ -223,6 +223,8 @@
223
223
  * [Instance Member Post](#instance-member-post)
224
224
  * [Instance Members](#instance-members)
225
225
  * [Instance Organization](#instance-organization)
226
+ * [Instance Org Entitlement](#instance-org-entitlement)
227
+ * [Instance Org Entitlement Sync](#instance-org-entitlement-sync)
226
228
  * [Instance Organization Invitation](#instance-organization-invitation)
227
229
  * [Instance Organization Invite Sent](#instance-organization-invite-sent)
228
230
  * [Instance Organization Invitations](#instance-organization-invitations)
@@ -246,6 +248,7 @@
246
248
  * [Last Value Data](#last-value-data)
247
249
  * [Last Value Query](#last-value-query)
248
250
  * [Me](#me)
251
+ * [Me Entitlements](#me-entitlements)
249
252
  * [Me Patch](#me-patch)
250
253
  * [MQTT Publish Body](#mqtt-publish-body)
251
254
  * [Multi Device Command](#multi-device-command)
@@ -17191,6 +17194,7 @@ Schema for the body of an API Token creation request
17191
17194
  "instance.payloadCountsBreakdown",
17192
17195
  "instance.deviceCounts",
17193
17196
  "instance.notebookMinuteCounts",
17197
+ "instance.entitlements",
17194
17198
  "instanceOrg.*",
17195
17199
  "instanceOrg.get",
17196
17200
  "instanceOrg.patch",
@@ -17199,6 +17203,8 @@ Schema for the body of an API Token creation request
17199
17203
  "instanceOrg.payloadCountsBreakdown",
17200
17204
  "instanceOrg.deviceCounts",
17201
17205
  "instanceOrg.notebookMinuteCounts",
17206
+ "instanceOrg.entitlement",
17207
+ "instanceOrg.entitlementSync",
17202
17208
  "instanceOrg.convertToEnterprise",
17203
17209
  "instanceOrgs.*",
17204
17210
  "instanceOrgs.get",
@@ -17319,6 +17325,7 @@ Schema for the body of an API Token creation request
17319
17325
  "me.invites",
17320
17326
  "me.respondToInvite",
17321
17327
  "me.refreshToken",
17328
+ "me.entitlements",
17322
17329
  "orgs.*",
17323
17330
  "orgs.get",
17324
17331
  "orgs.post"
@@ -21559,7 +21566,8 @@ Schema for the body of an application-scoped Dashboard creation request
21559
21566
  "triangle-down",
21560
21567
  "triangle-up",
21561
21568
  "octagon"
21562
- ]
21569
+ ],
21570
+ "default": "circle"
21563
21571
  }
21564
21572
  },
21565
21573
  "additionalProperties": false
@@ -22527,7 +22535,8 @@ Schema for the body of an application-scoped Dashboard creation request
22527
22535
  "triangle-down",
22528
22536
  "triangle-up",
22529
22537
  "octagon"
22530
- ]
22538
+ ],
22539
+ "default": "circle"
22531
22540
  }
22532
22541
  },
22533
22542
  "additionalProperties": false
@@ -23569,7 +23578,6 @@ Schema for the body of an application-scoped Dashboard creation request
23569
23578
  "type": {
23570
23579
  "type": "string",
23571
23580
  "enum": [
23572
- "indicator",
23573
23581
  "label",
23574
23582
  "image"
23575
23583
  ]
@@ -23625,7 +23633,8 @@ Schema for the body of an application-scoped Dashboard creation request
23625
23633
  "triangle-down",
23626
23634
  "triangle-up",
23627
23635
  "octagon"
23628
- ]
23636
+ ],
23637
+ "default": "circle"
23629
23638
  }
23630
23639
  },
23631
23640
  "additionalProperties": false
@@ -23662,7 +23671,8 @@ Schema for the body of an application-scoped Dashboard creation request
23662
23671
  "triangle-down",
23663
23672
  "triangle-up",
23664
23673
  "octagon"
23665
- ]
23674
+ ],
23675
+ "default": "circle"
23666
23676
  }
23667
23677
  },
23668
23678
  "additionalProperties": false
@@ -23676,6 +23686,125 @@ Schema for the body of an application-scoped Dashboard creation request
23676
23686
  ],
23677
23687
  "additionalProperties": false
23678
23688
  },
23689
+ {
23690
+ "type": "object",
23691
+ "properties": {
23692
+ "type": {
23693
+ "type": "string",
23694
+ "enum": [
23695
+ "indicator"
23696
+ ]
23697
+ },
23698
+ "size": {
23699
+ "type": "string",
23700
+ "enum": [
23701
+ "small",
23702
+ "medium",
23703
+ "large"
23704
+ ]
23705
+ },
23706
+ "position": {
23707
+ "type": "string",
23708
+ "minLength": 3,
23709
+ "maxLength": 255
23710
+ },
23711
+ "popupTemplate": {
23712
+ "type": "string",
23713
+ "maxLength": 32767
23714
+ },
23715
+ "conditions": {
23716
+ "type": "array",
23717
+ "maxItems": 100,
23718
+ "items": {
23719
+ "type": "object",
23720
+ "properties": {
23721
+ "color": {
23722
+ "type": "string",
23723
+ "maxLength": 64
23724
+ },
23725
+ "id": {
23726
+ "type": "string",
23727
+ "maxLength": 48
23728
+ },
23729
+ "label": {
23730
+ "type": "string",
23731
+ "maxLength": 32767
23732
+ },
23733
+ "condition": {
23734
+ "type": "string",
23735
+ "maxLength": 2048
23736
+ },
23737
+ "imageUrl": {
23738
+ "type": "string",
23739
+ "maxLength": 32767
23740
+ },
23741
+ "shape": {
23742
+ "type": "string",
23743
+ "enum": [
23744
+ "circle",
23745
+ "square",
23746
+ "triangle-down",
23747
+ "triangle-up",
23748
+ "octagon"
23749
+ ],
23750
+ "default": "circle"
23751
+ }
23752
+ },
23753
+ "additionalProperties": false,
23754
+ "required": [
23755
+ "shape"
23756
+ ]
23757
+ }
23758
+ },
23759
+ "defaultCondition": {
23760
+ "type": "object",
23761
+ "properties": {
23762
+ "color": {
23763
+ "type": "string",
23764
+ "maxLength": 64
23765
+ },
23766
+ "id": {
23767
+ "type": "string",
23768
+ "maxLength": 48
23769
+ },
23770
+ "label": {
23771
+ "type": "string",
23772
+ "maxLength": 32767
23773
+ },
23774
+ "condition": {
23775
+ "type": "string",
23776
+ "maxLength": 2048
23777
+ },
23778
+ "imageUrl": {
23779
+ "type": "string",
23780
+ "maxLength": 32767
23781
+ },
23782
+ "shape": {
23783
+ "type": "string",
23784
+ "enum": [
23785
+ "circle",
23786
+ "square",
23787
+ "triangle-down",
23788
+ "triangle-up",
23789
+ "octagon"
23790
+ ],
23791
+ "default": "circle"
23792
+ }
23793
+ },
23794
+ "additionalProperties": false,
23795
+ "required": [
23796
+ "shape"
23797
+ ]
23798
+ }
23799
+ },
23800
+ "required": [
23801
+ "type",
23802
+ "position",
23803
+ "size",
23804
+ "defaultCondition"
23805
+ ],
23806
+ "additionalProperties": false
23807
+ },
23679
23808
  {
23680
23809
  "type": "object",
23681
23810
  "properties": {
@@ -23736,7 +23865,8 @@ Schema for the body of an application-scoped Dashboard creation request
23736
23865
  "triangle-down",
23737
23866
  "triangle-up",
23738
23867
  "octagon"
23739
- ]
23868
+ ],
23869
+ "default": "circle"
23740
23870
  }
23741
23871
  },
23742
23872
  "additionalProperties": false
@@ -23773,7 +23903,8 @@ Schema for the body of an application-scoped Dashboard creation request
23773
23903
  "triangle-down",
23774
23904
  "triangle-up",
23775
23905
  "octagon"
23776
- ]
23906
+ ],
23907
+ "default": "circle"
23777
23908
  }
23778
23909
  },
23779
23910
  "additionalProperties": false
@@ -23851,7 +23982,8 @@ Schema for the body of an application-scoped Dashboard creation request
23851
23982
  "triangle-down",
23852
23983
  "triangle-up",
23853
23984
  "octagon"
23854
- ]
23985
+ ],
23986
+ "default": "circle"
23855
23987
  }
23856
23988
  },
23857
23989
  "additionalProperties": false
@@ -23888,7 +24020,8 @@ Schema for the body of an application-scoped Dashboard creation request
23888
24020
  "triangle-down",
23889
24021
  "triangle-up",
23890
24022
  "octagon"
23891
- ]
24023
+ ],
24024
+ "default": "circle"
23892
24025
  }
23893
24026
  },
23894
24027
  "additionalProperties": false
@@ -24232,7 +24365,8 @@ Schema for the body of an application-scoped Dashboard creation request
24232
24365
  "triangle-down",
24233
24366
  "triangle-up",
24234
24367
  "octagon"
24235
- ]
24368
+ ],
24369
+ "default": "circle"
24236
24370
  }
24237
24371
  },
24238
24372
  "additionalProperties": false
@@ -24269,7 +24403,8 @@ Schema for the body of an application-scoped Dashboard creation request
24269
24403
  "triangle-down",
24270
24404
  "triangle-up",
24271
24405
  "octagon"
24272
- ]
24406
+ ],
24407
+ "default": "circle"
24273
24408
  }
24274
24409
  },
24275
24410
  "additionalProperties": false
@@ -26728,6 +26863,9 @@ Schema for the body of an application-scoped Dashboard creation request
26728
26863
  "pattern": "^[A-Fa-f\\d]{24}$"
26729
26864
  },
26730
26865
  "maxItems": 1000
26866
+ },
26867
+ "includeExperienceGroups": {
26868
+ "type": "boolean"
26731
26869
  }
26732
26870
  },
26733
26871
  "additionalProperties": false
@@ -64635,7 +64773,8 @@ Schema for a single Dashboard
64635
64773
  "triangle-down",
64636
64774
  "triangle-up",
64637
64775
  "octagon"
64638
- ]
64776
+ ],
64777
+ "default": "circle"
64639
64778
  }
64640
64779
  },
64641
64780
  "additionalProperties": false
@@ -65603,7 +65742,8 @@ Schema for a single Dashboard
65603
65742
  "triangle-down",
65604
65743
  "triangle-up",
65605
65744
  "octagon"
65606
- ]
65745
+ ],
65746
+ "default": "circle"
65607
65747
  }
65608
65748
  },
65609
65749
  "additionalProperties": false
@@ -66645,7 +66785,6 @@ Schema for a single Dashboard
66645
66785
  "type": {
66646
66786
  "type": "string",
66647
66787
  "enum": [
66648
- "indicator",
66649
66788
  "label",
66650
66789
  "image"
66651
66790
  ]
@@ -66701,7 +66840,8 @@ Schema for a single Dashboard
66701
66840
  "triangle-down",
66702
66841
  "triangle-up",
66703
66842
  "octagon"
66704
- ]
66843
+ ],
66844
+ "default": "circle"
66705
66845
  }
66706
66846
  },
66707
66847
  "additionalProperties": false
@@ -66738,7 +66878,8 @@ Schema for a single Dashboard
66738
66878
  "triangle-down",
66739
66879
  "triangle-up",
66740
66880
  "octagon"
66741
- ]
66881
+ ],
66882
+ "default": "circle"
66742
66883
  }
66743
66884
  },
66744
66885
  "additionalProperties": false
@@ -66752,6 +66893,125 @@ Schema for a single Dashboard
66752
66893
  ],
66753
66894
  "additionalProperties": false
66754
66895
  },
66896
+ {
66897
+ "type": "object",
66898
+ "properties": {
66899
+ "type": {
66900
+ "type": "string",
66901
+ "enum": [
66902
+ "indicator"
66903
+ ]
66904
+ },
66905
+ "size": {
66906
+ "type": "string",
66907
+ "enum": [
66908
+ "small",
66909
+ "medium",
66910
+ "large"
66911
+ ]
66912
+ },
66913
+ "position": {
66914
+ "type": "string",
66915
+ "minLength": 3,
66916
+ "maxLength": 255
66917
+ },
66918
+ "popupTemplate": {
66919
+ "type": "string",
66920
+ "maxLength": 32767
66921
+ },
66922
+ "conditions": {
66923
+ "type": "array",
66924
+ "maxItems": 100,
66925
+ "items": {
66926
+ "type": "object",
66927
+ "properties": {
66928
+ "color": {
66929
+ "type": "string",
66930
+ "maxLength": 64
66931
+ },
66932
+ "id": {
66933
+ "type": "string",
66934
+ "maxLength": 48
66935
+ },
66936
+ "label": {
66937
+ "type": "string",
66938
+ "maxLength": 32767
66939
+ },
66940
+ "condition": {
66941
+ "type": "string",
66942
+ "maxLength": 2048
66943
+ },
66944
+ "imageUrl": {
66945
+ "type": "string",
66946
+ "maxLength": 32767
66947
+ },
66948
+ "shape": {
66949
+ "type": "string",
66950
+ "enum": [
66951
+ "circle",
66952
+ "square",
66953
+ "triangle-down",
66954
+ "triangle-up",
66955
+ "octagon"
66956
+ ],
66957
+ "default": "circle"
66958
+ }
66959
+ },
66960
+ "additionalProperties": false,
66961
+ "required": [
66962
+ "shape"
66963
+ ]
66964
+ }
66965
+ },
66966
+ "defaultCondition": {
66967
+ "type": "object",
66968
+ "properties": {
66969
+ "color": {
66970
+ "type": "string",
66971
+ "maxLength": 64
66972
+ },
66973
+ "id": {
66974
+ "type": "string",
66975
+ "maxLength": 48
66976
+ },
66977
+ "label": {
66978
+ "type": "string",
66979
+ "maxLength": 32767
66980
+ },
66981
+ "condition": {
66982
+ "type": "string",
66983
+ "maxLength": 2048
66984
+ },
66985
+ "imageUrl": {
66986
+ "type": "string",
66987
+ "maxLength": 32767
66988
+ },
66989
+ "shape": {
66990
+ "type": "string",
66991
+ "enum": [
66992
+ "circle",
66993
+ "square",
66994
+ "triangle-down",
66995
+ "triangle-up",
66996
+ "octagon"
66997
+ ],
66998
+ "default": "circle"
66999
+ }
67000
+ },
67001
+ "additionalProperties": false,
67002
+ "required": [
67003
+ "shape"
67004
+ ]
67005
+ }
67006
+ },
67007
+ "required": [
67008
+ "type",
67009
+ "position",
67010
+ "size",
67011
+ "defaultCondition"
67012
+ ],
67013
+ "additionalProperties": false
67014
+ },
66755
67015
  {
66756
67016
  "type": "object",
66757
67017
  "properties": {
@@ -66812,7 +67072,8 @@ Schema for a single Dashboard
66812
67072
  "triangle-down",
66813
67073
  "triangle-up",
66814
67074
  "octagon"
66815
- ]
67075
+ ],
67076
+ "default": "circle"
66816
67077
  }
66817
67078
  },
66818
67079
  "additionalProperties": false
@@ -66849,7 +67110,8 @@ Schema for a single Dashboard
66849
67110
  "triangle-down",
66850
67111
  "triangle-up",
66851
67112
  "octagon"
66852
- ]
67113
+ ],
67114
+ "default": "circle"
66853
67115
  }
66854
67116
  },
66855
67117
  "additionalProperties": false
@@ -66927,7 +67189,8 @@ Schema for a single Dashboard
66927
67189
  "triangle-down",
66928
67190
  "triangle-up",
66929
67191
  "octagon"
66930
- ]
67192
+ ],
67193
+ "default": "circle"
66931
67194
  }
66932
67195
  },
66933
67196
  "additionalProperties": false
@@ -66964,7 +67227,8 @@ Schema for a single Dashboard
66964
67227
  "triangle-down",
66965
67228
  "triangle-up",
66966
67229
  "octagon"
66967
- ]
67230
+ ],
67231
+ "default": "circle"
66968
67232
  }
66969
67233
  },
66970
67234
  "additionalProperties": false
@@ -67308,7 +67572,8 @@ Schema for a single Dashboard
67308
67572
  "triangle-down",
67309
67573
  "triangle-up",
67310
67574
  "octagon"
67311
- ]
67575
+ ],
67576
+ "default": "circle"
67312
67577
  }
67313
67578
  },
67314
67579
  "additionalProperties": false
@@ -67345,7 +67610,8 @@ Schema for a single Dashboard
67345
67610
  "triangle-down",
67346
67611
  "triangle-up",
67347
67612
  "octagon"
67348
- ]
67613
+ ],
67614
+ "default": "circle"
67349
67615
  }
67350
67616
  },
67351
67617
  "additionalProperties": false
@@ -69665,6 +69931,9 @@ Schema for a single Dashboard
69665
69931
  "pattern": "^[A-Fa-f\\d]{24}$"
69666
69932
  },
69667
69933
  "maxItems": 1000
69934
+ },
69935
+ "includeExperienceGroups": {
69936
+ "type": "boolean"
69668
69937
  }
69669
69938
  },
69670
69939
  "additionalProperties": false
@@ -71889,7 +72158,8 @@ Schema for the body of a Dashboard modification request
71889
72158
  "triangle-down",
71890
72159
  "triangle-up",
71891
72160
  "octagon"
71892
- ]
72161
+ ],
72162
+ "default": "circle"
71893
72163
  }
71894
72164
  },
71895
72165
  "additionalProperties": false
@@ -72857,7 +73127,8 @@ Schema for the body of a Dashboard modification request
72857
73127
  "triangle-down",
72858
73128
  "triangle-up",
72859
73129
  "octagon"
72860
- ]
73130
+ ],
73131
+ "default": "circle"
72861
73132
  }
72862
73133
  },
72863
73134
  "additionalProperties": false
@@ -73899,7 +74170,6 @@ Schema for the body of a Dashboard modification request
73899
74170
  "type": {
73900
74171
  "type": "string",
73901
74172
  "enum": [
73902
- "indicator",
73903
74173
  "label",
73904
74174
  "image"
73905
74175
  ]
@@ -73955,7 +74225,8 @@ Schema for the body of a Dashboard modification request
73955
74225
  "triangle-down",
73956
74226
  "triangle-up",
73957
74227
  "octagon"
73958
- ]
74228
+ ],
74229
+ "default": "circle"
73959
74230
  }
73960
74231
  },
73961
74232
  "additionalProperties": false
@@ -73992,7 +74263,8 @@ Schema for the body of a Dashboard modification request
73992
74263
  "triangle-down",
73993
74264
  "triangle-up",
73994
74265
  "octagon"
73995
- ]
74266
+ ],
74267
+ "default": "circle"
73996
74268
  }
73997
74269
  },
73998
74270
  "additionalProperties": false
@@ -74006,6 +74278,125 @@ Schema for the body of a Dashboard modification request
74006
74278
  ],
74007
74279
  "additionalProperties": false
74008
74280
  },
74281
+ {
74282
+ "type": "object",
74283
+ "properties": {
74284
+ "type": {
74285
+ "type": "string",
74286
+ "enum": [
74287
+ "indicator"
74288
+ ]
74289
+ },
74290
+ "size": {
74291
+ "type": "string",
74292
+ "enum": [
74293
+ "small",
74294
+ "medium",
74295
+ "large"
74296
+ ]
74297
+ },
74298
+ "position": {
74299
+ "type": "string",
74300
+ "minLength": 3,
74301
+ "maxLength": 255
74302
+ },
74303
+ "popupTemplate": {
74304
+ "type": "string",
74305
+ "maxLength": 32767
74306
+ },
74307
+ "conditions": {
74308
+ "type": "array",
74309
+ "maxItems": 100,
74310
+ "items": {
74311
+ "type": "object",
74312
+ "properties": {
74313
+ "color": {
74314
+ "type": "string",
74315
+ "maxLength": 64
74316
+ },
74317
+ "id": {
74318
+ "type": "string",
74319
+ "maxLength": 48
74320
+ },
74321
+ "label": {
74322
+ "type": "string",
74323
+ "maxLength": 32767
74324
+ },
74325
+ "condition": {
74326
+ "type": "string",
74327
+ "maxLength": 2048
74328
+ },
74329
+ "imageUrl": {
74330
+ "type": "string",
74331
+ "maxLength": 32767
74332
+ },
74333
+ "shape": {
74334
+ "type": "string",
74335
+ "enum": [
74336
+ "circle",
74337
+ "square",
74338
+ "triangle-down",
74339
+ "triangle-up",
74340
+ "octagon"
74341
+ ],
74342
+ "default": "circle"
74343
+ }
74344
+ },
74345
+ "additionalProperties": false,
74346
+ "required": [
74347
+ "shape"
74348
+ ]
74349
+ }
74350
+ },
74351
+ "defaultCondition": {
74352
+ "type": "object",
74353
+ "properties": {
74354
+ "color": {
74355
+ "type": "string",
74356
+ "maxLength": 64
74357
+ },
74358
+ "id": {
74359
+ "type": "string",
74360
+ "maxLength": 48
74361
+ },
74362
+ "label": {
74363
+ "type": "string",
74364
+ "maxLength": 32767
74365
+ },
74366
+ "condition": {
74367
+ "type": "string",
74368
+ "maxLength": 2048
74369
+ },
74370
+ "imageUrl": {
74371
+ "type": "string",
74372
+ "maxLength": 32767
74373
+ },
74374
+ "shape": {
74375
+ "type": "string",
74376
+ "enum": [
74377
+ "circle",
74378
+ "square",
74379
+ "triangle-down",
74380
+ "triangle-up",
74381
+ "octagon"
74382
+ ],
74383
+ "default": "circle"
74384
+ }
74385
+ },
74386
+ "additionalProperties": false,
74387
+ "required": [
74388
+ "shape"
74389
+ ]
74390
+ }
74391
+ },
74392
+ "required": [
74393
+ "type",
74394
+ "position",
74395
+ "size",
74396
+ "defaultCondition"
74397
+ ],
74398
+ "additionalProperties": false
74399
+ },
74009
74400
  {
74010
74401
  "type": "object",
74011
74402
  "properties": {
@@ -74066,7 +74457,8 @@ Schema for the body of a Dashboard modification request
74066
74457
  "triangle-down",
74067
74458
  "triangle-up",
74068
74459
  "octagon"
74069
- ]
74460
+ ],
74461
+ "default": "circle"
74070
74462
  }
74071
74463
  },
74072
74464
  "additionalProperties": false
@@ -74103,7 +74495,8 @@ Schema for the body of a Dashboard modification request
74103
74495
  "triangle-down",
74104
74496
  "triangle-up",
74105
74497
  "octagon"
74106
- ]
74498
+ ],
74499
+ "default": "circle"
74107
74500
  }
74108
74501
  },
74109
74502
  "additionalProperties": false
@@ -74181,7 +74574,8 @@ Schema for the body of a Dashboard modification request
74181
74574
  "triangle-down",
74182
74575
  "triangle-up",
74183
74576
  "octagon"
74184
- ]
74577
+ ],
74578
+ "default": "circle"
74185
74579
  }
74186
74580
  },
74187
74581
  "additionalProperties": false
@@ -74218,7 +74612,8 @@ Schema for the body of a Dashboard modification request
74218
74612
  "triangle-down",
74219
74613
  "triangle-up",
74220
74614
  "octagon"
74221
- ]
74615
+ ],
74616
+ "default": "circle"
74222
74617
  }
74223
74618
  },
74224
74619
  "additionalProperties": false
@@ -74562,7 +74957,8 @@ Schema for the body of a Dashboard modification request
74562
74957
  "triangle-down",
74563
74958
  "triangle-up",
74564
74959
  "octagon"
74565
- ]
74960
+ ],
74961
+ "default": "circle"
74566
74962
  }
74567
74963
  },
74568
74964
  "additionalProperties": false
@@ -74599,7 +74995,8 @@ Schema for the body of a Dashboard modification request
74599
74995
  "triangle-down",
74600
74996
  "triangle-up",
74601
74997
  "octagon"
74602
- ]
74998
+ ],
74999
+ "default": "circle"
74603
75000
  }
74604
75001
  },
74605
75002
  "additionalProperties": false
@@ -77065,6 +77462,9 @@ Schema for the body of a Dashboard modification request
77065
77462
  "pattern": "^[A-Fa-f\\d]{24}$"
77066
77463
  },
77067
77464
  "maxItems": 1000
77465
+ },
77466
+ "includeExperienceGroups": {
77467
+ "type": "boolean"
77068
77468
  }
77069
77469
  },
77070
77470
  "additionalProperties": false
@@ -78381,7 +78781,8 @@ Schema for the body of a Dashboard creation request
78381
78781
  "triangle-down",
78382
78782
  "triangle-up",
78383
78783
  "octagon"
78384
- ]
78784
+ ],
78785
+ "default": "circle"
78385
78786
  }
78386
78787
  },
78387
78788
  "additionalProperties": false
@@ -79349,7 +79750,8 @@ Schema for the body of a Dashboard creation request
79349
79750
  "triangle-down",
79350
79751
  "triangle-up",
79351
79752
  "octagon"
79352
- ]
79753
+ ],
79754
+ "default": "circle"
79353
79755
  }
79354
79756
  },
79355
79757
  "additionalProperties": false
@@ -80391,7 +80793,6 @@ Schema for the body of a Dashboard creation request
80391
80793
  "type": {
80392
80794
  "type": "string",
80393
80795
  "enum": [
80394
- "indicator",
80395
80796
  "label",
80396
80797
  "image"
80397
80798
  ]
@@ -80447,7 +80848,8 @@ Schema for the body of a Dashboard creation request
80447
80848
  "triangle-down",
80448
80849
  "triangle-up",
80449
80850
  "octagon"
80450
- ]
80851
+ ],
80852
+ "default": "circle"
80451
80853
  }
80452
80854
  },
80453
80855
  "additionalProperties": false
@@ -80484,7 +80886,8 @@ Schema for the body of a Dashboard creation request
80484
80886
  "triangle-down",
80485
80887
  "triangle-up",
80486
80888
  "octagon"
80487
- ]
80889
+ ],
80890
+ "default": "circle"
80488
80891
  }
80489
80892
  },
80490
80893
  "additionalProperties": false
@@ -80498,6 +80901,125 @@ Schema for the body of a Dashboard creation request
80498
80901
  ],
80499
80902
  "additionalProperties": false
80500
80903
  },
80904
+ {
80905
+ "type": "object",
80906
+ "properties": {
80907
+ "type": {
80908
+ "type": "string",
80909
+ "enum": [
80910
+ "indicator"
80911
+ ]
80912
+ },
80913
+ "size": {
80914
+ "type": "string",
80915
+ "enum": [
80916
+ "small",
80917
+ "medium",
80918
+ "large"
80919
+ ]
80920
+ },
80921
+ "position": {
80922
+ "type": "string",
80923
+ "minLength": 3,
80924
+ "maxLength": 255
80925
+ },
80926
+ "popupTemplate": {
80927
+ "type": "string",
80928
+ "maxLength": 32767
80929
+ },
80930
+ "conditions": {
80931
+ "type": "array",
80932
+ "maxItems": 100,
80933
+ "items": {
80934
+ "type": "object",
80935
+ "properties": {
80936
+ "color": {
80937
+ "type": "string",
80938
+ "maxLength": 64
80939
+ },
80940
+ "id": {
80941
+ "type": "string",
80942
+ "maxLength": 48
80943
+ },
80944
+ "label": {
80945
+ "type": "string",
80946
+ "maxLength": 32767
80947
+ },
80948
+ "condition": {
80949
+ "type": "string",
80950
+ "maxLength": 2048
80951
+ },
80952
+ "imageUrl": {
80953
+ "type": "string",
80954
+ "maxLength": 32767
80955
+ },
80956
+ "shape": {
80957
+ "type": "string",
80958
+ "enum": [
80959
+ "circle",
80960
+ "square",
80961
+ "triangle-down",
80962
+ "triangle-up",
80963
+ "octagon"
80964
+ ],
80965
+ "default": "circle"
80966
+ }
80967
+ },
80968
+ "additionalProperties": false,
80969
+ "required": [
80970
+ "shape"
80971
+ ]
80972
+ }
80973
+ },
80974
+ "defaultCondition": {
80975
+ "type": "object",
80976
+ "properties": {
80977
+ "color": {
80978
+ "type": "string",
80979
+ "maxLength": 64
80980
+ },
80981
+ "id": {
80982
+ "type": "string",
80983
+ "maxLength": 48
80984
+ },
80985
+ "label": {
80986
+ "type": "string",
80987
+ "maxLength": 32767
80988
+ },
80989
+ "condition": {
80990
+ "type": "string",
80991
+ "maxLength": 2048
80992
+ },
80993
+ "imageUrl": {
80994
+ "type": "string",
80995
+ "maxLength": 32767
80996
+ },
80997
+ "shape": {
80998
+ "type": "string",
80999
+ "enum": [
81000
+ "circle",
81001
+ "square",
81002
+ "triangle-down",
81003
+ "triangle-up",
81004
+ "octagon"
81005
+ ],
81006
+ "default": "circle"
81007
+ }
81008
+ },
81009
+ "additionalProperties": false,
81010
+ "required": [
81011
+ "shape"
81012
+ ]
81013
+ }
81014
+ },
81015
+ "required": [
81016
+ "type",
81017
+ "position",
81018
+ "size",
81019
+ "defaultCondition"
81020
+ ],
81021
+ "additionalProperties": false
81022
+ },
80501
81023
  {
80502
81024
  "type": "object",
80503
81025
  "properties": {
@@ -80558,7 +81080,8 @@ Schema for the body of a Dashboard creation request
80558
81080
  "triangle-down",
80559
81081
  "triangle-up",
80560
81082
  "octagon"
80561
- ]
81083
+ ],
81084
+ "default": "circle"
80562
81085
  }
80563
81086
  },
80564
81087
  "additionalProperties": false
@@ -80595,7 +81118,8 @@ Schema for the body of a Dashboard creation request
80595
81118
  "triangle-down",
80596
81119
  "triangle-up",
80597
81120
  "octagon"
80598
- ]
81121
+ ],
81122
+ "default": "circle"
80599
81123
  }
80600
81124
  },
80601
81125
  "additionalProperties": false
@@ -80673,7 +81197,8 @@ Schema for the body of a Dashboard creation request
80673
81197
  "triangle-down",
80674
81198
  "triangle-up",
80675
81199
  "octagon"
80676
- ]
81200
+ ],
81201
+ "default": "circle"
80677
81202
  }
80678
81203
  },
80679
81204
  "additionalProperties": false
@@ -80710,7 +81235,8 @@ Schema for the body of a Dashboard creation request
80710
81235
  "triangle-down",
80711
81236
  "triangle-up",
80712
81237
  "octagon"
80713
- ]
81238
+ ],
81239
+ "default": "circle"
80714
81240
  }
80715
81241
  },
80716
81242
  "additionalProperties": false
@@ -81054,7 +81580,8 @@ Schema for the body of a Dashboard creation request
81054
81580
  "triangle-down",
81055
81581
  "triangle-up",
81056
81582
  "octagon"
81057
- ]
81583
+ ],
81584
+ "default": "circle"
81058
81585
  }
81059
81586
  },
81060
81587
  "additionalProperties": false
@@ -81091,7 +81618,8 @@ Schema for the body of a Dashboard creation request
81091
81618
  "triangle-down",
81092
81619
  "triangle-up",
81093
81620
  "octagon"
81094
- ]
81621
+ ],
81622
+ "default": "circle"
81095
81623
  }
81096
81624
  },
81097
81625
  "additionalProperties": false
@@ -83557,6 +84085,9 @@ Schema for the body of a Dashboard creation request
83557
84085
  "pattern": "^[A-Fa-f\\d]{24}$"
83558
84086
  },
83559
84087
  "maxItems": 1000
84088
+ },
84089
+ "includeExperienceGroups": {
84090
+ "type": "boolean"
83560
84091
  }
83561
84092
  },
83562
84093
  "additionalProperties": false
@@ -85600,7 +86131,8 @@ Schema for a collection of Dashboards
85600
86131
  "triangle-down",
85601
86132
  "triangle-up",
85602
86133
  "octagon"
85603
- ]
86134
+ ],
86135
+ "default": "circle"
85604
86136
  }
85605
86137
  },
85606
86138
  "additionalProperties": false
@@ -86568,7 +87100,8 @@ Schema for a collection of Dashboards
86568
87100
  "triangle-down",
86569
87101
  "triangle-up",
86570
87102
  "octagon"
86571
- ]
87103
+ ],
87104
+ "default": "circle"
86572
87105
  }
86573
87106
  },
86574
87107
  "additionalProperties": false
@@ -87610,7 +88143,6 @@ Schema for a collection of Dashboards
87610
88143
  "type": {
87611
88144
  "type": "string",
87612
88145
  "enum": [
87613
- "indicator",
87614
88146
  "label",
87615
88147
  "image"
87616
88148
  ]
@@ -87666,7 +88198,8 @@ Schema for a collection of Dashboards
87666
88198
  "triangle-down",
87667
88199
  "triangle-up",
87668
88200
  "octagon"
87669
- ]
88201
+ ],
88202
+ "default": "circle"
87670
88203
  }
87671
88204
  },
87672
88205
  "additionalProperties": false
@@ -87703,7 +88236,8 @@ Schema for a collection of Dashboards
87703
88236
  "triangle-down",
87704
88237
  "triangle-up",
87705
88238
  "octagon"
87706
- ]
88239
+ ],
88240
+ "default": "circle"
87707
88241
  }
87708
88242
  },
87709
88243
  "additionalProperties": false
@@ -87717,6 +88251,125 @@ Schema for a collection of Dashboards
87717
88251
  ],
87718
88252
  "additionalProperties": false
87719
88253
  },
88254
+ {
88255
+ "type": "object",
88256
+ "properties": {
88257
+ "type": {
88258
+ "type": "string",
88259
+ "enum": [
88260
+ "indicator"
88261
+ ]
88262
+ },
88263
+ "size": {
88264
+ "type": "string",
88265
+ "enum": [
88266
+ "small",
88267
+ "medium",
88268
+ "large"
88269
+ ]
88270
+ },
88271
+ "position": {
88272
+ "type": "string",
88273
+ "minLength": 3,
88274
+ "maxLength": 255
88275
+ },
88276
+ "popupTemplate": {
88277
+ "type": "string",
88278
+ "maxLength": 32767
88279
+ },
88280
+ "conditions": {
88281
+ "type": "array",
88282
+ "maxItems": 100,
88283
+ "items": {
88284
+ "type": "object",
88285
+ "properties": {
88286
+ "color": {
88287
+ "type": "string",
88288
+ "maxLength": 64
88289
+ },
88290
+ "id": {
88291
+ "type": "string",
88292
+ "maxLength": 48
88293
+ },
88294
+ "label": {
88295
+ "type": "string",
88296
+ "maxLength": 32767
88297
+ },
88298
+ "condition": {
88299
+ "type": "string",
88300
+ "maxLength": 2048
88301
+ },
88302
+ "imageUrl": {
88303
+ "type": "string",
88304
+ "maxLength": 32767
88305
+ },
88306
+ "shape": {
88307
+ "type": "string",
88308
+ "enum": [
88309
+ "circle",
88310
+ "square",
88311
+ "triangle-down",
88312
+ "triangle-up",
88313
+ "octagon"
88314
+ ],
88315
+ "default": "circle"
88316
+ }
88317
+ },
88318
+ "additionalProperties": false,
88319
+ "required": [
88320
+ "shape"
88321
+ ]
88322
+ }
88323
+ },
88324
+ "defaultCondition": {
88325
+ "type": "object",
88326
+ "properties": {
88327
+ "color": {
88328
+ "type": "string",
88329
+ "maxLength": 64
88330
+ },
88331
+ "id": {
88332
+ "type": "string",
88333
+ "maxLength": 48
88334
+ },
88335
+ "label": {
88336
+ "type": "string",
88337
+ "maxLength": 32767
88338
+ },
88339
+ "condition": {
88340
+ "type": "string",
88341
+ "maxLength": 2048
88342
+ },
88343
+ "imageUrl": {
88344
+ "type": "string",
88345
+ "maxLength": 32767
88346
+ },
88347
+ "shape": {
88348
+ "type": "string",
88349
+ "enum": [
88350
+ "circle",
88351
+ "square",
88352
+ "triangle-down",
88353
+ "triangle-up",
88354
+ "octagon"
88355
+ ],
88356
+ "default": "circle"
88357
+ }
88358
+ },
88359
+ "additionalProperties": false,
88360
+ "required": [
88361
+ "shape"
88362
+ ]
88363
+ }
88364
+ },
88365
+ "required": [
88366
+ "type",
88367
+ "position",
88368
+ "size",
88369
+ "defaultCondition"
88370
+ ],
88371
+ "additionalProperties": false
88372
+ },
87720
88373
  {
87721
88374
  "type": "object",
87722
88375
  "properties": {
@@ -87777,7 +88430,8 @@ Schema for a collection of Dashboards
87777
88430
  "triangle-down",
87778
88431
  "triangle-up",
87779
88432
  "octagon"
87780
- ]
88433
+ ],
88434
+ "default": "circle"
87781
88435
  }
87782
88436
  },
87783
88437
  "additionalProperties": false
@@ -87814,7 +88468,8 @@ Schema for a collection of Dashboards
87814
88468
  "triangle-down",
87815
88469
  "triangle-up",
87816
88470
  "octagon"
87817
- ]
88471
+ ],
88472
+ "default": "circle"
87818
88473
  }
87819
88474
  },
87820
88475
  "additionalProperties": false
@@ -87892,7 +88547,8 @@ Schema for a collection of Dashboards
87892
88547
  "triangle-down",
87893
88548
  "triangle-up",
87894
88549
  "octagon"
87895
- ]
88550
+ ],
88551
+ "default": "circle"
87896
88552
  }
87897
88553
  },
87898
88554
  "additionalProperties": false
@@ -87929,7 +88585,8 @@ Schema for a collection of Dashboards
87929
88585
  "triangle-down",
87930
88586
  "triangle-up",
87931
88587
  "octagon"
87932
- ]
88588
+ ],
88589
+ "default": "circle"
87933
88590
  }
87934
88591
  },
87935
88592
  "additionalProperties": false
@@ -88273,7 +88930,8 @@ Schema for a collection of Dashboards
88273
88930
  "triangle-down",
88274
88931
  "triangle-up",
88275
88932
  "octagon"
88276
- ]
88933
+ ],
88934
+ "default": "circle"
88277
88935
  }
88278
88936
  },
88279
88937
  "additionalProperties": false
@@ -88310,7 +88968,8 @@ Schema for a collection of Dashboards
88310
88968
  "triangle-down",
88311
88969
  "triangle-up",
88312
88970
  "octagon"
88313
- ]
88971
+ ],
88972
+ "default": "circle"
88314
88973
  }
88315
88974
  },
88316
88975
  "additionalProperties": false
@@ -90630,6 +91289,9 @@ Schema for a collection of Dashboards
90630
91289
  "pattern": "^[A-Fa-f\\d]{24}$"
90631
91290
  },
90632
91291
  "maxItems": 1000
91292
+ },
91293
+ "includeExperienceGroups": {
91294
+ "type": "boolean"
90633
91295
  }
90634
91296
  },
90635
91297
  "additionalProperties": false
@@ -220175,6 +220837,7 @@ Schema for the body of a GitHub login request
220175
220837
  "instance.payloadCountsBreakdown",
220176
220838
  "instance.deviceCounts",
220177
220839
  "instance.notebookMinuteCounts",
220840
+ "instance.entitlements",
220178
220841
  "instanceOrg.*",
220179
220842
  "instanceOrg.get",
220180
220843
  "instanceOrg.patch",
@@ -220183,6 +220846,8 @@ Schema for the body of a GitHub login request
220183
220846
  "instanceOrg.payloadCountsBreakdown",
220184
220847
  "instanceOrg.deviceCounts",
220185
220848
  "instanceOrg.notebookMinuteCounts",
220849
+ "instanceOrg.entitlement",
220850
+ "instanceOrg.entitlementSync",
220186
220851
  "instanceOrg.convertToEnterprise",
220187
220852
  "instanceOrgs.*",
220188
220853
  "instanceOrgs.get",
@@ -220303,6 +220968,7 @@ Schema for the body of a GitHub login request
220303
220968
  "me.invites",
220304
220969
  "me.respondToInvite",
220305
220970
  "me.refreshToken",
220971
+ "me.entitlements",
220306
220972
  "orgs.*",
220307
220973
  "orgs.get",
220308
220974
  "orgs.post"
@@ -222367,6 +223033,12 @@ Schema for a single Instance
222367
223033
  "adminRequired",
222368
223034
  "required"
222369
223035
  ]
223036
+ },
223037
+ "entitlementMode": {
223038
+ "type": "string",
223039
+ "enum": [
223040
+ "scc"
223041
+ ]
222370
223042
  }
222371
223043
  }
222372
223044
  }
@@ -226272,6 +226944,18 @@ Schema for an Organization owned by an instance
226272
226944
  "type": "integer",
226273
226945
  "minimum": 5,
226274
226946
  "maximum": 3600
226947
+ },
226948
+ "deviceHard": {
226949
+ "type": "integer",
226950
+ "minimum": 0
226951
+ },
226952
+ "applicationkeyHard": {
226953
+ "type": "integer",
226954
+ "minimum": 0
226955
+ },
226956
+ "applicationcertificateHard": {
226957
+ "type": "integer",
226958
+ "minimum": 0
226275
226959
  }
226276
226960
  },
226277
226961
  "additionalProperties": false
@@ -226783,6 +227467,311 @@ Schema for an Organization owned by an instance
226783
227467
 
226784
227468
  <br/>
226785
227469
 
227470
+ ## Instance Org Entitlement
227471
+
227472
+ Schema for SCC entitlement details for an instance organization
227473
+
227474
+ ### <a name="instance-org-entitlement-schema"></a> Schema
227475
+
227476
+ ```json
227477
+ {
227478
+ "$schema": "http://json-schema.org/draft-07/schema#",
227479
+ "type": "object",
227480
+ "properties": {
227481
+ "entitlementId": {
227482
+ "type": "string"
227483
+ },
227484
+ "expiresAt": {
227485
+ "type": "string",
227486
+ "format": "date-time"
227487
+ },
227488
+ "externalOrgId": {
227489
+ "type": "integer"
227490
+ },
227491
+ "externalOrgName": {
227492
+ "type": "string"
227493
+ },
227494
+ "subscriptionName": {
227495
+ "type": "string"
227496
+ },
227497
+ "hasSupport": {
227498
+ "type": "boolean"
227499
+ },
227500
+ "allowedOrgCount": {
227501
+ "type": "integer"
227502
+ },
227503
+ "usedOrgCount": {
227504
+ "type": "integer"
227505
+ },
227506
+ "orgIds": {
227507
+ "type": "array",
227508
+ "items": {
227509
+ "type": "string",
227510
+ "pattern": "^[A-Fa-f\\d]{24}$"
227511
+ },
227512
+ "maxItems": 1000
227513
+ },
227514
+ "limits": {
227515
+ "type": "object",
227516
+ "properties": {
227517
+ "apitoken": {
227518
+ "type": "integer",
227519
+ "minimum": 0
227520
+ },
227521
+ "application": {
227522
+ "type": "integer",
227523
+ "minimum": 0
227524
+ },
227525
+ "applicationcertificate": {
227526
+ "type": "integer",
227527
+ "minimum": 0
227528
+ },
227529
+ "applicationcertificateauthority": {
227530
+ "type": "integer",
227531
+ "minimum": 0
227532
+ },
227533
+ "applicationkey": {
227534
+ "type": "integer",
227535
+ "minimum": 0
227536
+ },
227537
+ "credential": {
227538
+ "type": "integer",
227539
+ "minimum": 0
227540
+ },
227541
+ "dashboard": {
227542
+ "type": "integer",
227543
+ "minimum": 0
227544
+ },
227545
+ "datatable": {
227546
+ "type": "integer",
227547
+ "minimum": 0
227548
+ },
227549
+ "device": {
227550
+ "type": "integer",
227551
+ "minimum": 0
227552
+ },
227553
+ "devicerecipe": {
227554
+ "type": "integer",
227555
+ "minimum": 0
227556
+ },
227557
+ "experiencedomain": {
227558
+ "type": "integer",
227559
+ "minimum": 0
227560
+ },
227561
+ "experienceendpoint": {
227562
+ "type": "integer",
227563
+ "minimum": 0
227564
+ },
227565
+ "experiencegroup": {
227566
+ "type": "integer",
227567
+ "minimum": 0
227568
+ },
227569
+ "experienceslug": {
227570
+ "type": "integer",
227571
+ "minimum": 0
227572
+ },
227573
+ "experienceuser": {
227574
+ "type": "integer",
227575
+ "minimum": 0
227576
+ },
227577
+ "experienceversion": {
227578
+ "type": "integer",
227579
+ "minimum": 0
227580
+ },
227581
+ "experienceview": {
227582
+ "type": "integer",
227583
+ "minimum": 0
227584
+ },
227585
+ "file": {
227586
+ "type": "integer",
227587
+ "minimum": 0
227588
+ },
227589
+ "flow": {
227590
+ "type": "integer",
227591
+ "minimum": 0
227592
+ },
227593
+ "integration": {
227594
+ "type": "integer",
227595
+ "minimum": 0
227596
+ },
227597
+ "notebook": {
227598
+ "type": "integer",
227599
+ "minimum": 0
227600
+ },
227601
+ "privatefile": {
227602
+ "type": "integer",
227603
+ "minimum": 0
227604
+ },
227605
+ "resourcejob": {
227606
+ "type": "integer",
227607
+ "minimum": 0
227608
+ },
227609
+ "webhook": {
227610
+ "type": "integer",
227611
+ "minimum": 0
227612
+ },
227613
+ "dataTTL": {
227614
+ "type": "integer",
227615
+ "minimum": 86400
227616
+ },
227617
+ "member": {
227618
+ "type": "integer",
227619
+ "minimum": 0
227620
+ },
227621
+ "payload": {
227622
+ "type": "integer",
227623
+ "minimum": 0
227624
+ },
227625
+ "storage": {
227626
+ "type": "integer",
227627
+ "minimum": 0
227628
+ },
227629
+ "notebookMinutesPerRun": {
227630
+ "type": "integer",
227631
+ "minimum": 0
227632
+ },
227633
+ "notebookMinutesPerMonth": {
227634
+ "type": "integer",
227635
+ "minimum": 0
227636
+ },
227637
+ "notebookInParallel": {
227638
+ "type": "integer",
227639
+ "minimum": 0
227640
+ },
227641
+ "experienceFlowSlots": {
227642
+ "type": "integer",
227643
+ "minimum": 0
227644
+ },
227645
+ "applicationFlowSlots": {
227646
+ "type": "integer",
227647
+ "minimum": 0
227648
+ },
227649
+ "systemInterval": {
227650
+ "type": "integer",
227651
+ "minimum": 5,
227652
+ "maximum": 3600
227653
+ }
227654
+ },
227655
+ "additionalProperties": false
227656
+ }
227657
+ }
227658
+ }
227659
+ ```
227660
+ ### <a name="instance-org-entitlement-example"></a> Example
227661
+
227662
+ ```json
227663
+ {
227664
+ "entitlementId": "l05antt35t",
227665
+ "expiresAt": "2029-06-16T15:36:50.338Z",
227666
+ "externalOrgId": 886788,
227667
+ "externalOrgName": "Example Organization",
227668
+ "subscriptionName": "Losant Test Subscription",
227669
+ "hasSupport": true,
227670
+ "allowedOrgCount": 1,
227671
+ "usedOrgCount": 1,
227672
+ "orgIds": [],
227673
+ "limits": {
227674
+ "device": 1000,
227675
+ "dataTTL": 31536000
227676
+ }
227677
+ }
227678
+ ```
227679
+
227680
+ <br/>
227681
+
227682
+ ## Instance Org Entitlement Sync
227683
+
227684
+ Schema for the result of an on-demand SCC entitlement sync for an instance organization
227685
+
227686
+ ### <a name="instance-org-entitlement-sync-schema"></a> Schema
227687
+
227688
+ ```json
227689
+ {
227690
+ "$schema": "http://json-schema.org/draft-07/schema#",
227691
+ "type": "object",
227692
+ "properties": {
227693
+ "success": {
227694
+ "type": "boolean"
227695
+ },
227696
+ "limitsUpdated": {
227697
+ "type": "object",
227698
+ "patternProperties": {
227699
+ "^[a-zA-Z]+$": {
227700
+ "type": "object",
227701
+ "properties": {
227702
+ "previous": {
227703
+ "type": "integer",
227704
+ "minimum": 0
227705
+ },
227706
+ "current": {
227707
+ "type": "integer",
227708
+ "minimum": 0
227709
+ }
227710
+ }
227711
+ }
227712
+ }
227713
+ },
227714
+ "issues": {
227715
+ "type": "array",
227716
+ "items": {
227717
+ "type": "object",
227718
+ "properties": {
227719
+ "type": {
227720
+ "type": "string",
227721
+ "enum": [
227722
+ "expired",
227723
+ "limitsDecreased",
227724
+ "noMember"
227725
+ ]
227726
+ },
227727
+ "decreased": {
227728
+ "type": "object",
227729
+ "patternProperties": {
227730
+ "^[a-zA-Z]+$": {
227731
+ "type": "object",
227732
+ "properties": {
227733
+ "requested": {
227734
+ "type": "integer",
227735
+ "minimum": 0
227736
+ },
227737
+ "current": {
227738
+ "type": "integer",
227739
+ "minimum": 0
227740
+ }
227741
+ }
227742
+ }
227743
+ }
227744
+ }
227745
+ },
227746
+ "required": [
227747
+ "type"
227748
+ ]
227749
+ }
227750
+ }
227751
+ }
227752
+ }
227753
+ ```
227754
+ ### <a name="instance-org-entitlement-sync-example"></a> Example
227755
+
227756
+ ```json
227757
+ {
227758
+ "success": true,
227759
+ "limitsUpdated": {
227760
+ "device": {
227761
+ "previous": 10,
227762
+ "current": 1000
227763
+ }
227764
+ },
227765
+ "issues": [
227766
+ {
227767
+ "type": "noMember"
227768
+ }
227769
+ ]
227770
+ }
227771
+ ```
227772
+
227773
+ <br/>
227774
+
226786
227775
  ## Instance Organization Invitation
226787
227776
 
226788
227777
  Schema for a pending invitation to an Organization within an instance
@@ -228580,6 +229569,18 @@ Schema for a collection of Organizations within an instance
228580
229569
  "type": "integer",
228581
229570
  "minimum": 5,
228582
229571
  "maximum": 3600
229572
+ },
229573
+ "deviceHard": {
229574
+ "type": "integer",
229575
+ "minimum": 0
229576
+ },
229577
+ "applicationkeyHard": {
229578
+ "type": "integer",
229579
+ "minimum": 0
229580
+ },
229581
+ "applicationcertificateHard": {
229582
+ "type": "integer",
229583
+ "minimum": 0
228583
229584
  }
228584
229585
  },
228585
229586
  "additionalProperties": false
@@ -231087,6 +232088,12 @@ Schema for a collection of Instances
231087
232088
  "adminRequired",
231088
232089
  "required"
231089
232090
  ]
232091
+ },
232092
+ "entitlementMode": {
232093
+ "type": "string",
232094
+ "enum": [
232095
+ "scc"
232096
+ ]
231090
232097
  }
231091
232098
  }
231092
232099
  }
@@ -236155,6 +237162,231 @@ Schema for information about the currently authenticated user
236155
237162
 
236156
237163
  <br/>
236157
237164
 
237165
+ ## Me Entitlements
237166
+
237167
+ Schema for entitlement information for the currently authenticated user
237168
+
237169
+ ### <a name="me-entitlements-schema"></a> Schema
237170
+
237171
+ ```json
237172
+ {
237173
+ "$schema": "http://json-schema.org/draft-07/schema#",
237174
+ "type": "object",
237175
+ "properties": {
237176
+ "userFound": {
237177
+ "type": "boolean"
237178
+ },
237179
+ "entitlements": {
237180
+ "type": "array",
237181
+ "items": {
237182
+ "title": "Entitlement",
237183
+ "type": "object",
237184
+ "properties": {
237185
+ "entitlementId": {
237186
+ "type": "string"
237187
+ },
237188
+ "expiresAt": {
237189
+ "type": "string",
237190
+ "format": "date-time"
237191
+ },
237192
+ "externalOrgId": {
237193
+ "type": "integer"
237194
+ },
237195
+ "externalOrgName": {
237196
+ "type": "string"
237197
+ },
237198
+ "subscriptionName": {
237199
+ "type": "string"
237200
+ },
237201
+ "hasSupport": {
237202
+ "type": "boolean"
237203
+ },
237204
+ "allowedOrgCount": {
237205
+ "type": "integer"
237206
+ },
237207
+ "usedOrgCount": {
237208
+ "type": "integer"
237209
+ },
237210
+ "orgIds": {
237211
+ "type": "array",
237212
+ "items": {
237213
+ "type": "string",
237214
+ "pattern": "^[A-Fa-f\\d]{24}$"
237215
+ },
237216
+ "maxItems": 1000
237217
+ },
237218
+ "limits": {
237219
+ "type": "object",
237220
+ "properties": {
237221
+ "apitoken": {
237222
+ "type": "integer",
237223
+ "minimum": 0
237224
+ },
237225
+ "application": {
237226
+ "type": "integer",
237227
+ "minimum": 0
237228
+ },
237229
+ "applicationcertificate": {
237230
+ "type": "integer",
237231
+ "minimum": 0
237232
+ },
237233
+ "applicationcertificateauthority": {
237234
+ "type": "integer",
237235
+ "minimum": 0
237236
+ },
237237
+ "applicationkey": {
237238
+ "type": "integer",
237239
+ "minimum": 0
237240
+ },
237241
+ "credential": {
237242
+ "type": "integer",
237243
+ "minimum": 0
237244
+ },
237245
+ "dashboard": {
237246
+ "type": "integer",
237247
+ "minimum": 0
237248
+ },
237249
+ "datatable": {
237250
+ "type": "integer",
237251
+ "minimum": 0
237252
+ },
237253
+ "device": {
237254
+ "type": "integer",
237255
+ "minimum": 0
237256
+ },
237257
+ "devicerecipe": {
237258
+ "type": "integer",
237259
+ "minimum": 0
237260
+ },
237261
+ "experiencedomain": {
237262
+ "type": "integer",
237263
+ "minimum": 0
237264
+ },
237265
+ "experienceendpoint": {
237266
+ "type": "integer",
237267
+ "minimum": 0
237268
+ },
237269
+ "experiencegroup": {
237270
+ "type": "integer",
237271
+ "minimum": 0
237272
+ },
237273
+ "experienceslug": {
237274
+ "type": "integer",
237275
+ "minimum": 0
237276
+ },
237277
+ "experienceuser": {
237278
+ "type": "integer",
237279
+ "minimum": 0
237280
+ },
237281
+ "experienceversion": {
237282
+ "type": "integer",
237283
+ "minimum": 0
237284
+ },
237285
+ "experienceview": {
237286
+ "type": "integer",
237287
+ "minimum": 0
237288
+ },
237289
+ "file": {
237290
+ "type": "integer",
237291
+ "minimum": 0
237292
+ },
237293
+ "flow": {
237294
+ "type": "integer",
237295
+ "minimum": 0
237296
+ },
237297
+ "integration": {
237298
+ "type": "integer",
237299
+ "minimum": 0
237300
+ },
237301
+ "notebook": {
237302
+ "type": "integer",
237303
+ "minimum": 0
237304
+ },
237305
+ "privatefile": {
237306
+ "type": "integer",
237307
+ "minimum": 0
237308
+ },
237309
+ "resourcejob": {
237310
+ "type": "integer",
237311
+ "minimum": 0
237312
+ },
237313
+ "webhook": {
237314
+ "type": "integer",
237315
+ "minimum": 0
237316
+ },
237317
+ "dataTTL": {
237318
+ "type": "integer",
237319
+ "minimum": 86400
237320
+ },
237321
+ "member": {
237322
+ "type": "integer",
237323
+ "minimum": 0
237324
+ },
237325
+ "payload": {
237326
+ "type": "integer",
237327
+ "minimum": 0
237328
+ },
237329
+ "storage": {
237330
+ "type": "integer",
237331
+ "minimum": 0
237332
+ },
237333
+ "notebookMinutesPerRun": {
237334
+ "type": "integer",
237335
+ "minimum": 0
237336
+ },
237337
+ "notebookMinutesPerMonth": {
237338
+ "type": "integer",
237339
+ "minimum": 0
237340
+ },
237341
+ "notebookInParallel": {
237342
+ "type": "integer",
237343
+ "minimum": 0
237344
+ },
237345
+ "experienceFlowSlots": {
237346
+ "type": "integer",
237347
+ "minimum": 0
237348
+ },
237349
+ "applicationFlowSlots": {
237350
+ "type": "integer",
237351
+ "minimum": 0
237352
+ },
237353
+ "systemInterval": {
237354
+ "type": "integer",
237355
+ "minimum": 5,
237356
+ "maximum": 3600
237357
+ }
237358
+ },
237359
+ "additionalProperties": false
237360
+ }
237361
+ }
237362
+ }
237363
+ }
237364
+ }
237365
+ }
237366
+ ```
237367
+ ### <a name="me-entitlements-example"></a> Example
237368
+
237369
+ ```json
237370
+ {
237371
+ "userFound": true,
237372
+ "entitlements": [
237373
+ {
237374
+ "entitlementId": "l05antt35t",
237375
+ "expiresAt": "2029-06-16T15:36:50.338Z",
237376
+ "externalOrgId": 886788,
237377
+ "externalOrgName": "Example Organization",
237378
+ "subscriptionName": "Losant Test Subscription",
237379
+ "hasSupport": true,
237380
+ "allowedOrgCount": 1,
237381
+ "usedOrgCount": 0,
237382
+ "orgIds": []
237383
+ }
237384
+ ]
237385
+ }
237386
+ ```
237387
+
237388
+ <br/>
237389
+
236158
237390
  ## Me Patch
236159
237391
 
236160
237392
  Schema for the body of request to modify the current user
@@ -243835,6 +245067,18 @@ Schema for a single Organization
243835
245067
  "type": "integer",
243836
245068
  "minimum": 5,
243837
245069
  "maximum": 3600
245070
+ },
245071
+ "deviceHard": {
245072
+ "type": "integer",
245073
+ "minimum": 0
245074
+ },
245075
+ "applicationkeyHard": {
245076
+ "type": "integer",
245077
+ "minimum": 0
245078
+ },
245079
+ "applicationcertificateHard": {
245080
+ "type": "integer",
245081
+ "minimum": 0
243838
245082
  }
243839
245083
  },
243840
245084
  "additionalProperties": false
@@ -244109,6 +245353,10 @@ Schema for a single Organization
244109
245353
  }
244110
245354
  }
244111
245355
  },
245356
+ "entitlementOrgId": {
245357
+ "type": "string",
245358
+ "maxLength": 1024
245359
+ },
244112
245360
  "planId": {
244113
245361
  "type": "string",
244114
245362
  "maxLength": 1024
@@ -245041,6 +246289,10 @@ Schema for the body of an Organization creation request
245041
246289
  "adminRequired",
245042
246290
  "required"
245043
246291
  ]
246292
+ },
246293
+ "entitlementId": {
246294
+ "type": "string",
246295
+ "maxLength": 1024
245044
246296
  }
245045
246297
  },
245046
246298
  "additionalProperties": false,
@@ -245438,6 +246690,18 @@ Schema for a collection of Organizations
245438
246690
  "type": "integer",
245439
246691
  "minimum": 5,
245440
246692
  "maximum": 3600
246693
+ },
246694
+ "deviceHard": {
246695
+ "type": "integer",
246696
+ "minimum": 0
246697
+ },
246698
+ "applicationkeyHard": {
246699
+ "type": "integer",
246700
+ "minimum": 0
246701
+ },
246702
+ "applicationcertificateHard": {
246703
+ "type": "integer",
246704
+ "minimum": 0
245441
246705
  }
245442
246706
  },
245443
246707
  "additionalProperties": false
@@ -245712,6 +246976,10 @@ Schema for a collection of Organizations
245712
246976
  }
245713
246977
  }
245714
246978
  },
246979
+ "entitlementOrgId": {
246980
+ "type": "string",
246981
+ "maxLength": 1024
246982
+ },
245715
246983
  "planId": {
245716
246984
  "type": "string",
245717
246985
  "maxLength": 1024
@@ -248938,6 +250206,7 @@ SAML Response body for login
248938
250206
  "instance.payloadCountsBreakdown",
248939
250207
  "instance.deviceCounts",
248940
250208
  "instance.notebookMinuteCounts",
250209
+ "instance.entitlements",
248941
250210
  "instanceOrg.*",
248942
250211
  "instanceOrg.get",
248943
250212
  "instanceOrg.patch",
@@ -248946,6 +250215,8 @@ SAML Response body for login
248946
250215
  "instanceOrg.payloadCountsBreakdown",
248947
250216
  "instanceOrg.deviceCounts",
248948
250217
  "instanceOrg.notebookMinuteCounts",
250218
+ "instanceOrg.entitlement",
250219
+ "instanceOrg.entitlementSync",
248949
250220
  "instanceOrg.convertToEnterprise",
248950
250221
  "instanceOrgs.*",
248951
250222
  "instanceOrgs.get",
@@ -249066,6 +250337,7 @@ SAML Response body for login
249066
250337
  "me.invites",
249067
250338
  "me.respondToInvite",
249068
250339
  "me.refreshToken",
250340
+ "me.entitlements",
249069
250341
  "orgs.*",
249070
250342
  "orgs.get",
249071
250343
  "orgs.post"
@@ -252423,6 +253695,7 @@ Schema for the body of a User authentication request
252423
253695
  "instance.payloadCountsBreakdown",
252424
253696
  "instance.deviceCounts",
252425
253697
  "instance.notebookMinuteCounts",
253698
+ "instance.entitlements",
252426
253699
  "instanceOrg.*",
252427
253700
  "instanceOrg.get",
252428
253701
  "instanceOrg.patch",
@@ -252431,6 +253704,8 @@ Schema for the body of a User authentication request
252431
253704
  "instanceOrg.payloadCountsBreakdown",
252432
253705
  "instanceOrg.deviceCounts",
252433
253706
  "instanceOrg.notebookMinuteCounts",
253707
+ "instanceOrg.entitlement",
253708
+ "instanceOrg.entitlementSync",
252434
253709
  "instanceOrg.convertToEnterprise",
252435
253710
  "instanceOrgs.*",
252436
253711
  "instanceOrgs.get",
@@ -252551,6 +253826,7 @@ Schema for the body of a User authentication request
252551
253826
  "me.invites",
252552
253827
  "me.respondToInvite",
252553
253828
  "me.refreshToken",
253829
+ "me.entitlements",
252554
253830
  "orgs.*",
252555
253831
  "orgs.get",
252556
253832
  "orgs.post"
@@ -253979,6 +255255,7 @@ Schema for the body of a User creation request
253979
255255
  "instance.payloadCountsBreakdown",
253980
255256
  "instance.deviceCounts",
253981
255257
  "instance.notebookMinuteCounts",
255258
+ "instance.entitlements",
253982
255259
  "instanceOrg.*",
253983
255260
  "instanceOrg.get",
253984
255261
  "instanceOrg.patch",
@@ -253987,6 +255264,8 @@ Schema for the body of a User creation request
253987
255264
  "instanceOrg.payloadCountsBreakdown",
253988
255265
  "instanceOrg.deviceCounts",
253989
255266
  "instanceOrg.notebookMinuteCounts",
255267
+ "instanceOrg.entitlement",
255268
+ "instanceOrg.entitlementSync",
253990
255269
  "instanceOrg.convertToEnterprise",
253991
255270
  "instanceOrgs.*",
253992
255271
  "instanceOrgs.get",
@@ -254107,6 +255386,7 @@ Schema for the body of a User creation request
254107
255386
  "me.invites",
254108
255387
  "me.respondToInvite",
254109
255388
  "me.refreshToken",
255389
+ "me.entitlements",
254110
255390
  "orgs.*",
254111
255391
  "orgs.get",
254112
255392
  "orgs.post"
@@ -254325,6 +255605,34 @@ Schema for the result of a validateContext call when invalid context is passed
254325
255605
  }
254326
255606
  },
254327
255607
  "additionalProperties": false
255608
+ },
255609
+ "experienceGroups": {
255610
+ "type": "array",
255611
+ "items": {
255612
+ "type": "object",
255613
+ "properties": {
255614
+ "name": {
255615
+ "type": "string",
255616
+ "minLength": 1,
255617
+ "maxLength": 255
255618
+ },
255619
+ "id": {
255620
+ "type": "string",
255621
+ "pattern": "^[A-Fa-f\\d]{24}$"
255622
+ },
255623
+ "parentId": {
255624
+ "oneOf": [
255625
+ {
255626
+ "type": "string",
255627
+ "pattern": "^[A-Fa-f\\d]{24}$"
255628
+ },
255629
+ {
255630
+ "type": "null"
255631
+ }
255632
+ ]
255633
+ }
255634
+ }
255635
+ }
254328
255636
  }
254329
255637
  }
254330
255638
  }
@@ -254569,6 +255877,34 @@ Schema for the result of a successful validateContext call
254569
255877
  }
254570
255878
  },
254571
255879
  "additionalProperties": false
255880
+ },
255881
+ "experienceGroups": {
255882
+ "type": "array",
255883
+ "items": {
255884
+ "type": "object",
255885
+ "properties": {
255886
+ "name": {
255887
+ "type": "string",
255888
+ "minLength": 1,
255889
+ "maxLength": 255
255890
+ },
255891
+ "id": {
255892
+ "type": "string",
255893
+ "pattern": "^[A-Fa-f\\d]{24}$"
255894
+ },
255895
+ "parentId": {
255896
+ "oneOf": [
255897
+ {
255898
+ "type": "string",
255899
+ "pattern": "^[A-Fa-f\\d]{24}$"
255900
+ },
255901
+ {
255902
+ "type": "null"
255903
+ }
255904
+ ]
255905
+ }
255906
+ }
255907
+ }
254572
255908
  }
254573
255909
  }
254574
255910
  }