losant_rest 2.1.1 → 2.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/_schemas.md +2158 -55
- data/docs/flow.md +1 -0
- data/docs/flowVersions.md +1 -0
- data/docs/flows.md +1 -0
- data/docs/userOauthClient.md +125 -0
- data/docs/userOauthClients.md +87 -0
- data/lib/platform_rest/client.rb +10 -2
- data/lib/platform_rest/flow.rb +2 -0
- data/lib/platform_rest/flow_versions.rb +2 -0
- data/lib/platform_rest/flows.rb +2 -0
- data/lib/platform_rest/user_oauth_client.rb +170 -0
- data/lib/platform_rest/user_oauth_clients.rb +132 -0
- data/lib/platform_rest/version.rb +1 -1
- data/lib/platform_rest.rb +2 -0
- data/schemas/apiTokenPost.json +11 -0
- data/schemas/applicationDashboardPost.json +142 -11
- data/schemas/dashboard.json +142 -11
- data/schemas/dashboardPatch.json +142 -11
- data/schemas/dashboardPost.json +142 -11
- data/schemas/dashboards.json +142 -11
- data/schemas/githubLogin.json +11 -0
- data/schemas/instance.json +6 -0
- data/schemas/instanceOrg.json +12 -0
- data/schemas/instanceOrgEntitlement.json +182 -0
- data/schemas/instanceOrgEntitlementSync.json +64 -0
- data/schemas/instanceOrgs.json +12 -0
- data/schemas/instanceSandbox.json +6 -0
- data/schemas/instanceSandboxes.json +6 -0
- data/schemas/instances.json +6 -0
- data/schemas/me.json +15 -0
- data/schemas/meEntitlements.json +194 -0
- data/schemas/mePatch.json +9 -0
- data/schemas/org.json +16 -0
- data/schemas/orgPost.json +4 -0
- data/schemas/orgs.json +16 -0
- data/schemas/samlResponse.json +11 -0
- data/schemas/userCredentials.json +11 -0
- data/schemas/userOauthClient.json +125 -0
- data/schemas/userOauthClientPatch.json +113 -0
- data/schemas/userOauthClientPost.json +117 -0
- data/schemas/userOauthClients.json +166 -0
- data/schemas/userPost.json +20 -0
- data/schemas/validateContextError.json +28 -0
- data/schemas/validateContextSuccess.json +28 -0
- metadata +12 -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)
|
|
@@ -313,6 +316,10 @@
|
|
|
313
316
|
* [Time Series Data](#time-series-data)
|
|
314
317
|
* [Time Series Query](#time-series-query)
|
|
315
318
|
* [User Credentials](#user-credentials)
|
|
319
|
+
* [User OAuth Client](#user-oauth-client)
|
|
320
|
+
* [User OAuth Client Patch](#user-oauth-client-patch)
|
|
321
|
+
* [User OAuth Client Post](#user-oauth-client-post)
|
|
322
|
+
* [User OAuth Clients](#user-oauth-clients)
|
|
316
323
|
* [User OAuth Token](#user-oauth-token)
|
|
317
324
|
* [User OAuth Token Patch](#user-oauth-token-patch)
|
|
318
325
|
* [User OAuth Token Post](#user-oauth-token-post)
|
|
@@ -17191,6 +17198,7 @@ Schema for the body of an API Token creation request
|
|
|
17191
17198
|
"instance.payloadCountsBreakdown",
|
|
17192
17199
|
"instance.deviceCounts",
|
|
17193
17200
|
"instance.notebookMinuteCounts",
|
|
17201
|
+
"instance.entitlements",
|
|
17194
17202
|
"instanceOrg.*",
|
|
17195
17203
|
"instanceOrg.get",
|
|
17196
17204
|
"instanceOrg.patch",
|
|
@@ -17199,6 +17207,8 @@ Schema for the body of an API Token creation request
|
|
|
17199
17207
|
"instanceOrg.payloadCountsBreakdown",
|
|
17200
17208
|
"instanceOrg.deviceCounts",
|
|
17201
17209
|
"instanceOrg.notebookMinuteCounts",
|
|
17210
|
+
"instanceOrg.entitlement",
|
|
17211
|
+
"instanceOrg.entitlementSync",
|
|
17202
17212
|
"instanceOrg.convertToEnterprise",
|
|
17203
17213
|
"instanceOrgs.*",
|
|
17204
17214
|
"instanceOrgs.get",
|
|
@@ -17289,6 +17299,13 @@ Schema for the body of an API Token creation request
|
|
|
17289
17299
|
"userOauthTokens.*",
|
|
17290
17300
|
"userOauthTokens.get",
|
|
17291
17301
|
"userOauthTokens.post",
|
|
17302
|
+
"userOauthClient.*",
|
|
17303
|
+
"userOauthClient.get",
|
|
17304
|
+
"userOauthClient.patch",
|
|
17305
|
+
"userOauthClient.delete",
|
|
17306
|
+
"userOauthClients.*",
|
|
17307
|
+
"userOauthClients.get",
|
|
17308
|
+
"userOauthClients.post",
|
|
17292
17309
|
"applicationTemplate.*",
|
|
17293
17310
|
"applicationTemplate.get",
|
|
17294
17311
|
"applicationTemplates.*",
|
|
@@ -17319,6 +17336,7 @@ Schema for the body of an API Token creation request
|
|
|
17319
17336
|
"me.invites",
|
|
17320
17337
|
"me.respondToInvite",
|
|
17321
17338
|
"me.refreshToken",
|
|
17339
|
+
"me.entitlements",
|
|
17322
17340
|
"orgs.*",
|
|
17323
17341
|
"orgs.get",
|
|
17324
17342
|
"orgs.post"
|
|
@@ -21559,7 +21577,8 @@ Schema for the body of an application-scoped Dashboard creation request
|
|
|
21559
21577
|
"triangle-down",
|
|
21560
21578
|
"triangle-up",
|
|
21561
21579
|
"octagon"
|
|
21562
|
-
]
|
|
21580
|
+
],
|
|
21581
|
+
"default": "circle"
|
|
21563
21582
|
}
|
|
21564
21583
|
},
|
|
21565
21584
|
"additionalProperties": false
|
|
@@ -22527,7 +22546,8 @@ Schema for the body of an application-scoped Dashboard creation request
|
|
|
22527
22546
|
"triangle-down",
|
|
22528
22547
|
"triangle-up",
|
|
22529
22548
|
"octagon"
|
|
22530
|
-
]
|
|
22549
|
+
],
|
|
22550
|
+
"default": "circle"
|
|
22531
22551
|
}
|
|
22532
22552
|
},
|
|
22533
22553
|
"additionalProperties": false
|
|
@@ -23569,7 +23589,6 @@ Schema for the body of an application-scoped Dashboard creation request
|
|
|
23569
23589
|
"type": {
|
|
23570
23590
|
"type": "string",
|
|
23571
23591
|
"enum": [
|
|
23572
|
-
"indicator",
|
|
23573
23592
|
"label",
|
|
23574
23593
|
"image"
|
|
23575
23594
|
]
|
|
@@ -23625,7 +23644,8 @@ Schema for the body of an application-scoped Dashboard creation request
|
|
|
23625
23644
|
"triangle-down",
|
|
23626
23645
|
"triangle-up",
|
|
23627
23646
|
"octagon"
|
|
23628
|
-
]
|
|
23647
|
+
],
|
|
23648
|
+
"default": "circle"
|
|
23629
23649
|
}
|
|
23630
23650
|
},
|
|
23631
23651
|
"additionalProperties": false
|
|
@@ -23662,7 +23682,8 @@ Schema for the body of an application-scoped Dashboard creation request
|
|
|
23662
23682
|
"triangle-down",
|
|
23663
23683
|
"triangle-up",
|
|
23664
23684
|
"octagon"
|
|
23665
|
-
]
|
|
23685
|
+
],
|
|
23686
|
+
"default": "circle"
|
|
23666
23687
|
}
|
|
23667
23688
|
},
|
|
23668
23689
|
"additionalProperties": false
|
|
@@ -23676,6 +23697,125 @@ Schema for the body of an application-scoped Dashboard creation request
|
|
|
23676
23697
|
],
|
|
23677
23698
|
"additionalProperties": false
|
|
23678
23699
|
},
|
|
23700
|
+
{
|
|
23701
|
+
"type": "object",
|
|
23702
|
+
"properties": {
|
|
23703
|
+
"type": {
|
|
23704
|
+
"type": "string",
|
|
23705
|
+
"enum": [
|
|
23706
|
+
"indicator"
|
|
23707
|
+
]
|
|
23708
|
+
},
|
|
23709
|
+
"size": {
|
|
23710
|
+
"type": "string",
|
|
23711
|
+
"enum": [
|
|
23712
|
+
"small",
|
|
23713
|
+
"medium",
|
|
23714
|
+
"large"
|
|
23715
|
+
]
|
|
23716
|
+
},
|
|
23717
|
+
"position": {
|
|
23718
|
+
"type": "string",
|
|
23719
|
+
"minLength": 3,
|
|
23720
|
+
"maxLength": 255
|
|
23721
|
+
},
|
|
23722
|
+
"popupTemplate": {
|
|
23723
|
+
"type": "string",
|
|
23724
|
+
"maxLength": 32767
|
|
23725
|
+
},
|
|
23726
|
+
"conditions": {
|
|
23727
|
+
"type": "array",
|
|
23728
|
+
"maxItems": 100,
|
|
23729
|
+
"items": {
|
|
23730
|
+
"type": "object",
|
|
23731
|
+
"properties": {
|
|
23732
|
+
"color": {
|
|
23733
|
+
"type": "string",
|
|
23734
|
+
"maxLength": 64
|
|
23735
|
+
},
|
|
23736
|
+
"id": {
|
|
23737
|
+
"type": "string",
|
|
23738
|
+
"maxLength": 48
|
|
23739
|
+
},
|
|
23740
|
+
"label": {
|
|
23741
|
+
"type": "string",
|
|
23742
|
+
"maxLength": 32767
|
|
23743
|
+
},
|
|
23744
|
+
"condition": {
|
|
23745
|
+
"type": "string",
|
|
23746
|
+
"maxLength": 2048
|
|
23747
|
+
},
|
|
23748
|
+
"imageUrl": {
|
|
23749
|
+
"type": "string",
|
|
23750
|
+
"maxLength": 32767
|
|
23751
|
+
},
|
|
23752
|
+
"shape": {
|
|
23753
|
+
"type": "string",
|
|
23754
|
+
"enum": [
|
|
23755
|
+
"circle",
|
|
23756
|
+
"square",
|
|
23757
|
+
"triangle-down",
|
|
23758
|
+
"triangle-up",
|
|
23759
|
+
"octagon"
|
|
23760
|
+
],
|
|
23761
|
+
"default": "circle"
|
|
23762
|
+
}
|
|
23763
|
+
},
|
|
23764
|
+
"additionalProperties": false,
|
|
23765
|
+
"required": [
|
|
23766
|
+
"shape"
|
|
23767
|
+
]
|
|
23768
|
+
}
|
|
23769
|
+
},
|
|
23770
|
+
"defaultCondition": {
|
|
23771
|
+
"type": "object",
|
|
23772
|
+
"properties": {
|
|
23773
|
+
"color": {
|
|
23774
|
+
"type": "string",
|
|
23775
|
+
"maxLength": 64
|
|
23776
|
+
},
|
|
23777
|
+
"id": {
|
|
23778
|
+
"type": "string",
|
|
23779
|
+
"maxLength": 48
|
|
23780
|
+
},
|
|
23781
|
+
"label": {
|
|
23782
|
+
"type": "string",
|
|
23783
|
+
"maxLength": 32767
|
|
23784
|
+
},
|
|
23785
|
+
"condition": {
|
|
23786
|
+
"type": "string",
|
|
23787
|
+
"maxLength": 2048
|
|
23788
|
+
},
|
|
23789
|
+
"imageUrl": {
|
|
23790
|
+
"type": "string",
|
|
23791
|
+
"maxLength": 32767
|
|
23792
|
+
},
|
|
23793
|
+
"shape": {
|
|
23794
|
+
"type": "string",
|
|
23795
|
+
"enum": [
|
|
23796
|
+
"circle",
|
|
23797
|
+
"square",
|
|
23798
|
+
"triangle-down",
|
|
23799
|
+
"triangle-up",
|
|
23800
|
+
"octagon"
|
|
23801
|
+
],
|
|
23802
|
+
"default": "circle"
|
|
23803
|
+
}
|
|
23804
|
+
},
|
|
23805
|
+
"additionalProperties": false,
|
|
23806
|
+
"required": [
|
|
23807
|
+
"shape"
|
|
23808
|
+
]
|
|
23809
|
+
}
|
|
23810
|
+
},
|
|
23811
|
+
"required": [
|
|
23812
|
+
"type",
|
|
23813
|
+
"position",
|
|
23814
|
+
"size",
|
|
23815
|
+
"defaultCondition"
|
|
23816
|
+
],
|
|
23817
|
+
"additionalProperties": false
|
|
23818
|
+
},
|
|
23679
23819
|
{
|
|
23680
23820
|
"type": "object",
|
|
23681
23821
|
"properties": {
|
|
@@ -23736,7 +23876,8 @@ Schema for the body of an application-scoped Dashboard creation request
|
|
|
23736
23876
|
"triangle-down",
|
|
23737
23877
|
"triangle-up",
|
|
23738
23878
|
"octagon"
|
|
23739
|
-
]
|
|
23879
|
+
],
|
|
23880
|
+
"default": "circle"
|
|
23740
23881
|
}
|
|
23741
23882
|
},
|
|
23742
23883
|
"additionalProperties": false
|
|
@@ -23773,7 +23914,8 @@ Schema for the body of an application-scoped Dashboard creation request
|
|
|
23773
23914
|
"triangle-down",
|
|
23774
23915
|
"triangle-up",
|
|
23775
23916
|
"octagon"
|
|
23776
|
-
]
|
|
23917
|
+
],
|
|
23918
|
+
"default": "circle"
|
|
23777
23919
|
}
|
|
23778
23920
|
},
|
|
23779
23921
|
"additionalProperties": false
|
|
@@ -23851,7 +23993,8 @@ Schema for the body of an application-scoped Dashboard creation request
|
|
|
23851
23993
|
"triangle-down",
|
|
23852
23994
|
"triangle-up",
|
|
23853
23995
|
"octagon"
|
|
23854
|
-
]
|
|
23996
|
+
],
|
|
23997
|
+
"default": "circle"
|
|
23855
23998
|
}
|
|
23856
23999
|
},
|
|
23857
24000
|
"additionalProperties": false
|
|
@@ -23888,7 +24031,8 @@ Schema for the body of an application-scoped Dashboard creation request
|
|
|
23888
24031
|
"triangle-down",
|
|
23889
24032
|
"triangle-up",
|
|
23890
24033
|
"octagon"
|
|
23891
|
-
]
|
|
24034
|
+
],
|
|
24035
|
+
"default": "circle"
|
|
23892
24036
|
}
|
|
23893
24037
|
},
|
|
23894
24038
|
"additionalProperties": false
|
|
@@ -24232,7 +24376,8 @@ Schema for the body of an application-scoped Dashboard creation request
|
|
|
24232
24376
|
"triangle-down",
|
|
24233
24377
|
"triangle-up",
|
|
24234
24378
|
"octagon"
|
|
24235
|
-
]
|
|
24379
|
+
],
|
|
24380
|
+
"default": "circle"
|
|
24236
24381
|
}
|
|
24237
24382
|
},
|
|
24238
24383
|
"additionalProperties": false
|
|
@@ -24269,7 +24414,8 @@ Schema for the body of an application-scoped Dashboard creation request
|
|
|
24269
24414
|
"triangle-down",
|
|
24270
24415
|
"triangle-up",
|
|
24271
24416
|
"octagon"
|
|
24272
|
-
]
|
|
24417
|
+
],
|
|
24418
|
+
"default": "circle"
|
|
24273
24419
|
}
|
|
24274
24420
|
},
|
|
24275
24421
|
"additionalProperties": false
|
|
@@ -26728,6 +26874,9 @@ Schema for the body of an application-scoped Dashboard creation request
|
|
|
26728
26874
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
26729
26875
|
},
|
|
26730
26876
|
"maxItems": 1000
|
|
26877
|
+
},
|
|
26878
|
+
"includeExperienceGroups": {
|
|
26879
|
+
"type": "boolean"
|
|
26731
26880
|
}
|
|
26732
26881
|
},
|
|
26733
26882
|
"additionalProperties": false
|
|
@@ -64635,7 +64784,8 @@ Schema for a single Dashboard
|
|
|
64635
64784
|
"triangle-down",
|
|
64636
64785
|
"triangle-up",
|
|
64637
64786
|
"octagon"
|
|
64638
|
-
]
|
|
64787
|
+
],
|
|
64788
|
+
"default": "circle"
|
|
64639
64789
|
}
|
|
64640
64790
|
},
|
|
64641
64791
|
"additionalProperties": false
|
|
@@ -65603,7 +65753,8 @@ Schema for a single Dashboard
|
|
|
65603
65753
|
"triangle-down",
|
|
65604
65754
|
"triangle-up",
|
|
65605
65755
|
"octagon"
|
|
65606
|
-
]
|
|
65756
|
+
],
|
|
65757
|
+
"default": "circle"
|
|
65607
65758
|
}
|
|
65608
65759
|
},
|
|
65609
65760
|
"additionalProperties": false
|
|
@@ -66645,7 +66796,6 @@ Schema for a single Dashboard
|
|
|
66645
66796
|
"type": {
|
|
66646
66797
|
"type": "string",
|
|
66647
66798
|
"enum": [
|
|
66648
|
-
"indicator",
|
|
66649
66799
|
"label",
|
|
66650
66800
|
"image"
|
|
66651
66801
|
]
|
|
@@ -66701,7 +66851,8 @@ Schema for a single Dashboard
|
|
|
66701
66851
|
"triangle-down",
|
|
66702
66852
|
"triangle-up",
|
|
66703
66853
|
"octagon"
|
|
66704
|
-
]
|
|
66854
|
+
],
|
|
66855
|
+
"default": "circle"
|
|
66705
66856
|
}
|
|
66706
66857
|
},
|
|
66707
66858
|
"additionalProperties": false
|
|
@@ -66738,7 +66889,8 @@ Schema for a single Dashboard
|
|
|
66738
66889
|
"triangle-down",
|
|
66739
66890
|
"triangle-up",
|
|
66740
66891
|
"octagon"
|
|
66741
|
-
]
|
|
66892
|
+
],
|
|
66893
|
+
"default": "circle"
|
|
66742
66894
|
}
|
|
66743
66895
|
},
|
|
66744
66896
|
"additionalProperties": false
|
|
@@ -66752,6 +66904,125 @@ Schema for a single Dashboard
|
|
|
66752
66904
|
],
|
|
66753
66905
|
"additionalProperties": false
|
|
66754
66906
|
},
|
|
66907
|
+
{
|
|
66908
|
+
"type": "object",
|
|
66909
|
+
"properties": {
|
|
66910
|
+
"type": {
|
|
66911
|
+
"type": "string",
|
|
66912
|
+
"enum": [
|
|
66913
|
+
"indicator"
|
|
66914
|
+
]
|
|
66915
|
+
},
|
|
66916
|
+
"size": {
|
|
66917
|
+
"type": "string",
|
|
66918
|
+
"enum": [
|
|
66919
|
+
"small",
|
|
66920
|
+
"medium",
|
|
66921
|
+
"large"
|
|
66922
|
+
]
|
|
66923
|
+
},
|
|
66924
|
+
"position": {
|
|
66925
|
+
"type": "string",
|
|
66926
|
+
"minLength": 3,
|
|
66927
|
+
"maxLength": 255
|
|
66928
|
+
},
|
|
66929
|
+
"popupTemplate": {
|
|
66930
|
+
"type": "string",
|
|
66931
|
+
"maxLength": 32767
|
|
66932
|
+
},
|
|
66933
|
+
"conditions": {
|
|
66934
|
+
"type": "array",
|
|
66935
|
+
"maxItems": 100,
|
|
66936
|
+
"items": {
|
|
66937
|
+
"type": "object",
|
|
66938
|
+
"properties": {
|
|
66939
|
+
"color": {
|
|
66940
|
+
"type": "string",
|
|
66941
|
+
"maxLength": 64
|
|
66942
|
+
},
|
|
66943
|
+
"id": {
|
|
66944
|
+
"type": "string",
|
|
66945
|
+
"maxLength": 48
|
|
66946
|
+
},
|
|
66947
|
+
"label": {
|
|
66948
|
+
"type": "string",
|
|
66949
|
+
"maxLength": 32767
|
|
66950
|
+
},
|
|
66951
|
+
"condition": {
|
|
66952
|
+
"type": "string",
|
|
66953
|
+
"maxLength": 2048
|
|
66954
|
+
},
|
|
66955
|
+
"imageUrl": {
|
|
66956
|
+
"type": "string",
|
|
66957
|
+
"maxLength": 32767
|
|
66958
|
+
},
|
|
66959
|
+
"shape": {
|
|
66960
|
+
"type": "string",
|
|
66961
|
+
"enum": [
|
|
66962
|
+
"circle",
|
|
66963
|
+
"square",
|
|
66964
|
+
"triangle-down",
|
|
66965
|
+
"triangle-up",
|
|
66966
|
+
"octagon"
|
|
66967
|
+
],
|
|
66968
|
+
"default": "circle"
|
|
66969
|
+
}
|
|
66970
|
+
},
|
|
66971
|
+
"additionalProperties": false,
|
|
66972
|
+
"required": [
|
|
66973
|
+
"shape"
|
|
66974
|
+
]
|
|
66975
|
+
}
|
|
66976
|
+
},
|
|
66977
|
+
"defaultCondition": {
|
|
66978
|
+
"type": "object",
|
|
66979
|
+
"properties": {
|
|
66980
|
+
"color": {
|
|
66981
|
+
"type": "string",
|
|
66982
|
+
"maxLength": 64
|
|
66983
|
+
},
|
|
66984
|
+
"id": {
|
|
66985
|
+
"type": "string",
|
|
66986
|
+
"maxLength": 48
|
|
66987
|
+
},
|
|
66988
|
+
"label": {
|
|
66989
|
+
"type": "string",
|
|
66990
|
+
"maxLength": 32767
|
|
66991
|
+
},
|
|
66992
|
+
"condition": {
|
|
66993
|
+
"type": "string",
|
|
66994
|
+
"maxLength": 2048
|
|
66995
|
+
},
|
|
66996
|
+
"imageUrl": {
|
|
66997
|
+
"type": "string",
|
|
66998
|
+
"maxLength": 32767
|
|
66999
|
+
},
|
|
67000
|
+
"shape": {
|
|
67001
|
+
"type": "string",
|
|
67002
|
+
"enum": [
|
|
67003
|
+
"circle",
|
|
67004
|
+
"square",
|
|
67005
|
+
"triangle-down",
|
|
67006
|
+
"triangle-up",
|
|
67007
|
+
"octagon"
|
|
67008
|
+
],
|
|
67009
|
+
"default": "circle"
|
|
67010
|
+
}
|
|
67011
|
+
},
|
|
67012
|
+
"additionalProperties": false,
|
|
67013
|
+
"required": [
|
|
67014
|
+
"shape"
|
|
67015
|
+
]
|
|
67016
|
+
}
|
|
67017
|
+
},
|
|
67018
|
+
"required": [
|
|
67019
|
+
"type",
|
|
67020
|
+
"position",
|
|
67021
|
+
"size",
|
|
67022
|
+
"defaultCondition"
|
|
67023
|
+
],
|
|
67024
|
+
"additionalProperties": false
|
|
67025
|
+
},
|
|
66755
67026
|
{
|
|
66756
67027
|
"type": "object",
|
|
66757
67028
|
"properties": {
|
|
@@ -66812,7 +67083,8 @@ Schema for a single Dashboard
|
|
|
66812
67083
|
"triangle-down",
|
|
66813
67084
|
"triangle-up",
|
|
66814
67085
|
"octagon"
|
|
66815
|
-
]
|
|
67086
|
+
],
|
|
67087
|
+
"default": "circle"
|
|
66816
67088
|
}
|
|
66817
67089
|
},
|
|
66818
67090
|
"additionalProperties": false
|
|
@@ -66849,7 +67121,8 @@ Schema for a single Dashboard
|
|
|
66849
67121
|
"triangle-down",
|
|
66850
67122
|
"triangle-up",
|
|
66851
67123
|
"octagon"
|
|
66852
|
-
]
|
|
67124
|
+
],
|
|
67125
|
+
"default": "circle"
|
|
66853
67126
|
}
|
|
66854
67127
|
},
|
|
66855
67128
|
"additionalProperties": false
|
|
@@ -66927,7 +67200,8 @@ Schema for a single Dashboard
|
|
|
66927
67200
|
"triangle-down",
|
|
66928
67201
|
"triangle-up",
|
|
66929
67202
|
"octagon"
|
|
66930
|
-
]
|
|
67203
|
+
],
|
|
67204
|
+
"default": "circle"
|
|
66931
67205
|
}
|
|
66932
67206
|
},
|
|
66933
67207
|
"additionalProperties": false
|
|
@@ -66964,7 +67238,8 @@ Schema for a single Dashboard
|
|
|
66964
67238
|
"triangle-down",
|
|
66965
67239
|
"triangle-up",
|
|
66966
67240
|
"octagon"
|
|
66967
|
-
]
|
|
67241
|
+
],
|
|
67242
|
+
"default": "circle"
|
|
66968
67243
|
}
|
|
66969
67244
|
},
|
|
66970
67245
|
"additionalProperties": false
|
|
@@ -67308,7 +67583,8 @@ Schema for a single Dashboard
|
|
|
67308
67583
|
"triangle-down",
|
|
67309
67584
|
"triangle-up",
|
|
67310
67585
|
"octagon"
|
|
67311
|
-
]
|
|
67586
|
+
],
|
|
67587
|
+
"default": "circle"
|
|
67312
67588
|
}
|
|
67313
67589
|
},
|
|
67314
67590
|
"additionalProperties": false
|
|
@@ -67345,7 +67621,8 @@ Schema for a single Dashboard
|
|
|
67345
67621
|
"triangle-down",
|
|
67346
67622
|
"triangle-up",
|
|
67347
67623
|
"octagon"
|
|
67348
|
-
]
|
|
67624
|
+
],
|
|
67625
|
+
"default": "circle"
|
|
67349
67626
|
}
|
|
67350
67627
|
},
|
|
67351
67628
|
"additionalProperties": false
|
|
@@ -69665,6 +69942,9 @@ Schema for a single Dashboard
|
|
|
69665
69942
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
69666
69943
|
},
|
|
69667
69944
|
"maxItems": 1000
|
|
69945
|
+
},
|
|
69946
|
+
"includeExperienceGroups": {
|
|
69947
|
+
"type": "boolean"
|
|
69668
69948
|
}
|
|
69669
69949
|
},
|
|
69670
69950
|
"additionalProperties": false
|
|
@@ -71889,7 +72169,8 @@ Schema for the body of a Dashboard modification request
|
|
|
71889
72169
|
"triangle-down",
|
|
71890
72170
|
"triangle-up",
|
|
71891
72171
|
"octagon"
|
|
71892
|
-
]
|
|
72172
|
+
],
|
|
72173
|
+
"default": "circle"
|
|
71893
72174
|
}
|
|
71894
72175
|
},
|
|
71895
72176
|
"additionalProperties": false
|
|
@@ -72857,7 +73138,8 @@ Schema for the body of a Dashboard modification request
|
|
|
72857
73138
|
"triangle-down",
|
|
72858
73139
|
"triangle-up",
|
|
72859
73140
|
"octagon"
|
|
72860
|
-
]
|
|
73141
|
+
],
|
|
73142
|
+
"default": "circle"
|
|
72861
73143
|
}
|
|
72862
73144
|
},
|
|
72863
73145
|
"additionalProperties": false
|
|
@@ -73899,7 +74181,6 @@ Schema for the body of a Dashboard modification request
|
|
|
73899
74181
|
"type": {
|
|
73900
74182
|
"type": "string",
|
|
73901
74183
|
"enum": [
|
|
73902
|
-
"indicator",
|
|
73903
74184
|
"label",
|
|
73904
74185
|
"image"
|
|
73905
74186
|
]
|
|
@@ -73955,7 +74236,8 @@ Schema for the body of a Dashboard modification request
|
|
|
73955
74236
|
"triangle-down",
|
|
73956
74237
|
"triangle-up",
|
|
73957
74238
|
"octagon"
|
|
73958
|
-
]
|
|
74239
|
+
],
|
|
74240
|
+
"default": "circle"
|
|
73959
74241
|
}
|
|
73960
74242
|
},
|
|
73961
74243
|
"additionalProperties": false
|
|
@@ -73992,7 +74274,8 @@ Schema for the body of a Dashboard modification request
|
|
|
73992
74274
|
"triangle-down",
|
|
73993
74275
|
"triangle-up",
|
|
73994
74276
|
"octagon"
|
|
73995
|
-
]
|
|
74277
|
+
],
|
|
74278
|
+
"default": "circle"
|
|
73996
74279
|
}
|
|
73997
74280
|
},
|
|
73998
74281
|
"additionalProperties": false
|
|
@@ -74006,6 +74289,125 @@ Schema for the body of a Dashboard modification request
|
|
|
74006
74289
|
],
|
|
74007
74290
|
"additionalProperties": false
|
|
74008
74291
|
},
|
|
74292
|
+
{
|
|
74293
|
+
"type": "object",
|
|
74294
|
+
"properties": {
|
|
74295
|
+
"type": {
|
|
74296
|
+
"type": "string",
|
|
74297
|
+
"enum": [
|
|
74298
|
+
"indicator"
|
|
74299
|
+
]
|
|
74300
|
+
},
|
|
74301
|
+
"size": {
|
|
74302
|
+
"type": "string",
|
|
74303
|
+
"enum": [
|
|
74304
|
+
"small",
|
|
74305
|
+
"medium",
|
|
74306
|
+
"large"
|
|
74307
|
+
]
|
|
74308
|
+
},
|
|
74309
|
+
"position": {
|
|
74310
|
+
"type": "string",
|
|
74311
|
+
"minLength": 3,
|
|
74312
|
+
"maxLength": 255
|
|
74313
|
+
},
|
|
74314
|
+
"popupTemplate": {
|
|
74315
|
+
"type": "string",
|
|
74316
|
+
"maxLength": 32767
|
|
74317
|
+
},
|
|
74318
|
+
"conditions": {
|
|
74319
|
+
"type": "array",
|
|
74320
|
+
"maxItems": 100,
|
|
74321
|
+
"items": {
|
|
74322
|
+
"type": "object",
|
|
74323
|
+
"properties": {
|
|
74324
|
+
"color": {
|
|
74325
|
+
"type": "string",
|
|
74326
|
+
"maxLength": 64
|
|
74327
|
+
},
|
|
74328
|
+
"id": {
|
|
74329
|
+
"type": "string",
|
|
74330
|
+
"maxLength": 48
|
|
74331
|
+
},
|
|
74332
|
+
"label": {
|
|
74333
|
+
"type": "string",
|
|
74334
|
+
"maxLength": 32767
|
|
74335
|
+
},
|
|
74336
|
+
"condition": {
|
|
74337
|
+
"type": "string",
|
|
74338
|
+
"maxLength": 2048
|
|
74339
|
+
},
|
|
74340
|
+
"imageUrl": {
|
|
74341
|
+
"type": "string",
|
|
74342
|
+
"maxLength": 32767
|
|
74343
|
+
},
|
|
74344
|
+
"shape": {
|
|
74345
|
+
"type": "string",
|
|
74346
|
+
"enum": [
|
|
74347
|
+
"circle",
|
|
74348
|
+
"square",
|
|
74349
|
+
"triangle-down",
|
|
74350
|
+
"triangle-up",
|
|
74351
|
+
"octagon"
|
|
74352
|
+
],
|
|
74353
|
+
"default": "circle"
|
|
74354
|
+
}
|
|
74355
|
+
},
|
|
74356
|
+
"additionalProperties": false,
|
|
74357
|
+
"required": [
|
|
74358
|
+
"shape"
|
|
74359
|
+
]
|
|
74360
|
+
}
|
|
74361
|
+
},
|
|
74362
|
+
"defaultCondition": {
|
|
74363
|
+
"type": "object",
|
|
74364
|
+
"properties": {
|
|
74365
|
+
"color": {
|
|
74366
|
+
"type": "string",
|
|
74367
|
+
"maxLength": 64
|
|
74368
|
+
},
|
|
74369
|
+
"id": {
|
|
74370
|
+
"type": "string",
|
|
74371
|
+
"maxLength": 48
|
|
74372
|
+
},
|
|
74373
|
+
"label": {
|
|
74374
|
+
"type": "string",
|
|
74375
|
+
"maxLength": 32767
|
|
74376
|
+
},
|
|
74377
|
+
"condition": {
|
|
74378
|
+
"type": "string",
|
|
74379
|
+
"maxLength": 2048
|
|
74380
|
+
},
|
|
74381
|
+
"imageUrl": {
|
|
74382
|
+
"type": "string",
|
|
74383
|
+
"maxLength": 32767
|
|
74384
|
+
},
|
|
74385
|
+
"shape": {
|
|
74386
|
+
"type": "string",
|
|
74387
|
+
"enum": [
|
|
74388
|
+
"circle",
|
|
74389
|
+
"square",
|
|
74390
|
+
"triangle-down",
|
|
74391
|
+
"triangle-up",
|
|
74392
|
+
"octagon"
|
|
74393
|
+
],
|
|
74394
|
+
"default": "circle"
|
|
74395
|
+
}
|
|
74396
|
+
},
|
|
74397
|
+
"additionalProperties": false,
|
|
74398
|
+
"required": [
|
|
74399
|
+
"shape"
|
|
74400
|
+
]
|
|
74401
|
+
}
|
|
74402
|
+
},
|
|
74403
|
+
"required": [
|
|
74404
|
+
"type",
|
|
74405
|
+
"position",
|
|
74406
|
+
"size",
|
|
74407
|
+
"defaultCondition"
|
|
74408
|
+
],
|
|
74409
|
+
"additionalProperties": false
|
|
74410
|
+
},
|
|
74009
74411
|
{
|
|
74010
74412
|
"type": "object",
|
|
74011
74413
|
"properties": {
|
|
@@ -74066,7 +74468,8 @@ Schema for the body of a Dashboard modification request
|
|
|
74066
74468
|
"triangle-down",
|
|
74067
74469
|
"triangle-up",
|
|
74068
74470
|
"octagon"
|
|
74069
|
-
]
|
|
74471
|
+
],
|
|
74472
|
+
"default": "circle"
|
|
74070
74473
|
}
|
|
74071
74474
|
},
|
|
74072
74475
|
"additionalProperties": false
|
|
@@ -74103,7 +74506,8 @@ Schema for the body of a Dashboard modification request
|
|
|
74103
74506
|
"triangle-down",
|
|
74104
74507
|
"triangle-up",
|
|
74105
74508
|
"octagon"
|
|
74106
|
-
]
|
|
74509
|
+
],
|
|
74510
|
+
"default": "circle"
|
|
74107
74511
|
}
|
|
74108
74512
|
},
|
|
74109
74513
|
"additionalProperties": false
|
|
@@ -74181,7 +74585,8 @@ Schema for the body of a Dashboard modification request
|
|
|
74181
74585
|
"triangle-down",
|
|
74182
74586
|
"triangle-up",
|
|
74183
74587
|
"octagon"
|
|
74184
|
-
]
|
|
74588
|
+
],
|
|
74589
|
+
"default": "circle"
|
|
74185
74590
|
}
|
|
74186
74591
|
},
|
|
74187
74592
|
"additionalProperties": false
|
|
@@ -74218,7 +74623,8 @@ Schema for the body of a Dashboard modification request
|
|
|
74218
74623
|
"triangle-down",
|
|
74219
74624
|
"triangle-up",
|
|
74220
74625
|
"octagon"
|
|
74221
|
-
]
|
|
74626
|
+
],
|
|
74627
|
+
"default": "circle"
|
|
74222
74628
|
}
|
|
74223
74629
|
},
|
|
74224
74630
|
"additionalProperties": false
|
|
@@ -74562,7 +74968,8 @@ Schema for the body of a Dashboard modification request
|
|
|
74562
74968
|
"triangle-down",
|
|
74563
74969
|
"triangle-up",
|
|
74564
74970
|
"octagon"
|
|
74565
|
-
]
|
|
74971
|
+
],
|
|
74972
|
+
"default": "circle"
|
|
74566
74973
|
}
|
|
74567
74974
|
},
|
|
74568
74975
|
"additionalProperties": false
|
|
@@ -74599,7 +75006,8 @@ Schema for the body of a Dashboard modification request
|
|
|
74599
75006
|
"triangle-down",
|
|
74600
75007
|
"triangle-up",
|
|
74601
75008
|
"octagon"
|
|
74602
|
-
]
|
|
75009
|
+
],
|
|
75010
|
+
"default": "circle"
|
|
74603
75011
|
}
|
|
74604
75012
|
},
|
|
74605
75013
|
"additionalProperties": false
|
|
@@ -77065,6 +77473,9 @@ Schema for the body of a Dashboard modification request
|
|
|
77065
77473
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
77066
77474
|
},
|
|
77067
77475
|
"maxItems": 1000
|
|
77476
|
+
},
|
|
77477
|
+
"includeExperienceGroups": {
|
|
77478
|
+
"type": "boolean"
|
|
77068
77479
|
}
|
|
77069
77480
|
},
|
|
77070
77481
|
"additionalProperties": false
|
|
@@ -78381,7 +78792,8 @@ Schema for the body of a Dashboard creation request
|
|
|
78381
78792
|
"triangle-down",
|
|
78382
78793
|
"triangle-up",
|
|
78383
78794
|
"octagon"
|
|
78384
|
-
]
|
|
78795
|
+
],
|
|
78796
|
+
"default": "circle"
|
|
78385
78797
|
}
|
|
78386
78798
|
},
|
|
78387
78799
|
"additionalProperties": false
|
|
@@ -79349,7 +79761,8 @@ Schema for the body of a Dashboard creation request
|
|
|
79349
79761
|
"triangle-down",
|
|
79350
79762
|
"triangle-up",
|
|
79351
79763
|
"octagon"
|
|
79352
|
-
]
|
|
79764
|
+
],
|
|
79765
|
+
"default": "circle"
|
|
79353
79766
|
}
|
|
79354
79767
|
},
|
|
79355
79768
|
"additionalProperties": false
|
|
@@ -80391,7 +80804,6 @@ Schema for the body of a Dashboard creation request
|
|
|
80391
80804
|
"type": {
|
|
80392
80805
|
"type": "string",
|
|
80393
80806
|
"enum": [
|
|
80394
|
-
"indicator",
|
|
80395
80807
|
"label",
|
|
80396
80808
|
"image"
|
|
80397
80809
|
]
|
|
@@ -80447,7 +80859,8 @@ Schema for the body of a Dashboard creation request
|
|
|
80447
80859
|
"triangle-down",
|
|
80448
80860
|
"triangle-up",
|
|
80449
80861
|
"octagon"
|
|
80450
|
-
]
|
|
80862
|
+
],
|
|
80863
|
+
"default": "circle"
|
|
80451
80864
|
}
|
|
80452
80865
|
},
|
|
80453
80866
|
"additionalProperties": false
|
|
@@ -80484,7 +80897,8 @@ Schema for the body of a Dashboard creation request
|
|
|
80484
80897
|
"triangle-down",
|
|
80485
80898
|
"triangle-up",
|
|
80486
80899
|
"octagon"
|
|
80487
|
-
]
|
|
80900
|
+
],
|
|
80901
|
+
"default": "circle"
|
|
80488
80902
|
}
|
|
80489
80903
|
},
|
|
80490
80904
|
"additionalProperties": false
|
|
@@ -80498,6 +80912,125 @@ Schema for the body of a Dashboard creation request
|
|
|
80498
80912
|
],
|
|
80499
80913
|
"additionalProperties": false
|
|
80500
80914
|
},
|
|
80915
|
+
{
|
|
80916
|
+
"type": "object",
|
|
80917
|
+
"properties": {
|
|
80918
|
+
"type": {
|
|
80919
|
+
"type": "string",
|
|
80920
|
+
"enum": [
|
|
80921
|
+
"indicator"
|
|
80922
|
+
]
|
|
80923
|
+
},
|
|
80924
|
+
"size": {
|
|
80925
|
+
"type": "string",
|
|
80926
|
+
"enum": [
|
|
80927
|
+
"small",
|
|
80928
|
+
"medium",
|
|
80929
|
+
"large"
|
|
80930
|
+
]
|
|
80931
|
+
},
|
|
80932
|
+
"position": {
|
|
80933
|
+
"type": "string",
|
|
80934
|
+
"minLength": 3,
|
|
80935
|
+
"maxLength": 255
|
|
80936
|
+
},
|
|
80937
|
+
"popupTemplate": {
|
|
80938
|
+
"type": "string",
|
|
80939
|
+
"maxLength": 32767
|
|
80940
|
+
},
|
|
80941
|
+
"conditions": {
|
|
80942
|
+
"type": "array",
|
|
80943
|
+
"maxItems": 100,
|
|
80944
|
+
"items": {
|
|
80945
|
+
"type": "object",
|
|
80946
|
+
"properties": {
|
|
80947
|
+
"color": {
|
|
80948
|
+
"type": "string",
|
|
80949
|
+
"maxLength": 64
|
|
80950
|
+
},
|
|
80951
|
+
"id": {
|
|
80952
|
+
"type": "string",
|
|
80953
|
+
"maxLength": 48
|
|
80954
|
+
},
|
|
80955
|
+
"label": {
|
|
80956
|
+
"type": "string",
|
|
80957
|
+
"maxLength": 32767
|
|
80958
|
+
},
|
|
80959
|
+
"condition": {
|
|
80960
|
+
"type": "string",
|
|
80961
|
+
"maxLength": 2048
|
|
80962
|
+
},
|
|
80963
|
+
"imageUrl": {
|
|
80964
|
+
"type": "string",
|
|
80965
|
+
"maxLength": 32767
|
|
80966
|
+
},
|
|
80967
|
+
"shape": {
|
|
80968
|
+
"type": "string",
|
|
80969
|
+
"enum": [
|
|
80970
|
+
"circle",
|
|
80971
|
+
"square",
|
|
80972
|
+
"triangle-down",
|
|
80973
|
+
"triangle-up",
|
|
80974
|
+
"octagon"
|
|
80975
|
+
],
|
|
80976
|
+
"default": "circle"
|
|
80977
|
+
}
|
|
80978
|
+
},
|
|
80979
|
+
"additionalProperties": false,
|
|
80980
|
+
"required": [
|
|
80981
|
+
"shape"
|
|
80982
|
+
]
|
|
80983
|
+
}
|
|
80984
|
+
},
|
|
80985
|
+
"defaultCondition": {
|
|
80986
|
+
"type": "object",
|
|
80987
|
+
"properties": {
|
|
80988
|
+
"color": {
|
|
80989
|
+
"type": "string",
|
|
80990
|
+
"maxLength": 64
|
|
80991
|
+
},
|
|
80992
|
+
"id": {
|
|
80993
|
+
"type": "string",
|
|
80994
|
+
"maxLength": 48
|
|
80995
|
+
},
|
|
80996
|
+
"label": {
|
|
80997
|
+
"type": "string",
|
|
80998
|
+
"maxLength": 32767
|
|
80999
|
+
},
|
|
81000
|
+
"condition": {
|
|
81001
|
+
"type": "string",
|
|
81002
|
+
"maxLength": 2048
|
|
81003
|
+
},
|
|
81004
|
+
"imageUrl": {
|
|
81005
|
+
"type": "string",
|
|
81006
|
+
"maxLength": 32767
|
|
81007
|
+
},
|
|
81008
|
+
"shape": {
|
|
81009
|
+
"type": "string",
|
|
81010
|
+
"enum": [
|
|
81011
|
+
"circle",
|
|
81012
|
+
"square",
|
|
81013
|
+
"triangle-down",
|
|
81014
|
+
"triangle-up",
|
|
81015
|
+
"octagon"
|
|
81016
|
+
],
|
|
81017
|
+
"default": "circle"
|
|
81018
|
+
}
|
|
81019
|
+
},
|
|
81020
|
+
"additionalProperties": false,
|
|
81021
|
+
"required": [
|
|
81022
|
+
"shape"
|
|
81023
|
+
]
|
|
81024
|
+
}
|
|
81025
|
+
},
|
|
81026
|
+
"required": [
|
|
81027
|
+
"type",
|
|
81028
|
+
"position",
|
|
81029
|
+
"size",
|
|
81030
|
+
"defaultCondition"
|
|
81031
|
+
],
|
|
81032
|
+
"additionalProperties": false
|
|
81033
|
+
},
|
|
80501
81034
|
{
|
|
80502
81035
|
"type": "object",
|
|
80503
81036
|
"properties": {
|
|
@@ -80558,7 +81091,8 @@ Schema for the body of a Dashboard creation request
|
|
|
80558
81091
|
"triangle-down",
|
|
80559
81092
|
"triangle-up",
|
|
80560
81093
|
"octagon"
|
|
80561
|
-
]
|
|
81094
|
+
],
|
|
81095
|
+
"default": "circle"
|
|
80562
81096
|
}
|
|
80563
81097
|
},
|
|
80564
81098
|
"additionalProperties": false
|
|
@@ -80595,7 +81129,8 @@ Schema for the body of a Dashboard creation request
|
|
|
80595
81129
|
"triangle-down",
|
|
80596
81130
|
"triangle-up",
|
|
80597
81131
|
"octagon"
|
|
80598
|
-
]
|
|
81132
|
+
],
|
|
81133
|
+
"default": "circle"
|
|
80599
81134
|
}
|
|
80600
81135
|
},
|
|
80601
81136
|
"additionalProperties": false
|
|
@@ -80673,7 +81208,8 @@ Schema for the body of a Dashboard creation request
|
|
|
80673
81208
|
"triangle-down",
|
|
80674
81209
|
"triangle-up",
|
|
80675
81210
|
"octagon"
|
|
80676
|
-
]
|
|
81211
|
+
],
|
|
81212
|
+
"default": "circle"
|
|
80677
81213
|
}
|
|
80678
81214
|
},
|
|
80679
81215
|
"additionalProperties": false
|
|
@@ -80710,7 +81246,8 @@ Schema for the body of a Dashboard creation request
|
|
|
80710
81246
|
"triangle-down",
|
|
80711
81247
|
"triangle-up",
|
|
80712
81248
|
"octagon"
|
|
80713
|
-
]
|
|
81249
|
+
],
|
|
81250
|
+
"default": "circle"
|
|
80714
81251
|
}
|
|
80715
81252
|
},
|
|
80716
81253
|
"additionalProperties": false
|
|
@@ -81054,7 +81591,8 @@ Schema for the body of a Dashboard creation request
|
|
|
81054
81591
|
"triangle-down",
|
|
81055
81592
|
"triangle-up",
|
|
81056
81593
|
"octagon"
|
|
81057
|
-
]
|
|
81594
|
+
],
|
|
81595
|
+
"default": "circle"
|
|
81058
81596
|
}
|
|
81059
81597
|
},
|
|
81060
81598
|
"additionalProperties": false
|
|
@@ -81091,7 +81629,8 @@ Schema for the body of a Dashboard creation request
|
|
|
81091
81629
|
"triangle-down",
|
|
81092
81630
|
"triangle-up",
|
|
81093
81631
|
"octagon"
|
|
81094
|
-
]
|
|
81632
|
+
],
|
|
81633
|
+
"default": "circle"
|
|
81095
81634
|
}
|
|
81096
81635
|
},
|
|
81097
81636
|
"additionalProperties": false
|
|
@@ -83557,6 +84096,9 @@ Schema for the body of a Dashboard creation request
|
|
|
83557
84096
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
83558
84097
|
},
|
|
83559
84098
|
"maxItems": 1000
|
|
84099
|
+
},
|
|
84100
|
+
"includeExperienceGroups": {
|
|
84101
|
+
"type": "boolean"
|
|
83560
84102
|
}
|
|
83561
84103
|
},
|
|
83562
84104
|
"additionalProperties": false
|
|
@@ -85600,7 +86142,8 @@ Schema for a collection of Dashboards
|
|
|
85600
86142
|
"triangle-down",
|
|
85601
86143
|
"triangle-up",
|
|
85602
86144
|
"octagon"
|
|
85603
|
-
]
|
|
86145
|
+
],
|
|
86146
|
+
"default": "circle"
|
|
85604
86147
|
}
|
|
85605
86148
|
},
|
|
85606
86149
|
"additionalProperties": false
|
|
@@ -86568,7 +87111,8 @@ Schema for a collection of Dashboards
|
|
|
86568
87111
|
"triangle-down",
|
|
86569
87112
|
"triangle-up",
|
|
86570
87113
|
"octagon"
|
|
86571
|
-
]
|
|
87114
|
+
],
|
|
87115
|
+
"default": "circle"
|
|
86572
87116
|
}
|
|
86573
87117
|
},
|
|
86574
87118
|
"additionalProperties": false
|
|
@@ -87610,7 +88154,6 @@ Schema for a collection of Dashboards
|
|
|
87610
88154
|
"type": {
|
|
87611
88155
|
"type": "string",
|
|
87612
88156
|
"enum": [
|
|
87613
|
-
"indicator",
|
|
87614
88157
|
"label",
|
|
87615
88158
|
"image"
|
|
87616
88159
|
]
|
|
@@ -87666,7 +88209,8 @@ Schema for a collection of Dashboards
|
|
|
87666
88209
|
"triangle-down",
|
|
87667
88210
|
"triangle-up",
|
|
87668
88211
|
"octagon"
|
|
87669
|
-
]
|
|
88212
|
+
],
|
|
88213
|
+
"default": "circle"
|
|
87670
88214
|
}
|
|
87671
88215
|
},
|
|
87672
88216
|
"additionalProperties": false
|
|
@@ -87703,7 +88247,8 @@ Schema for a collection of Dashboards
|
|
|
87703
88247
|
"triangle-down",
|
|
87704
88248
|
"triangle-up",
|
|
87705
88249
|
"octagon"
|
|
87706
|
-
]
|
|
88250
|
+
],
|
|
88251
|
+
"default": "circle"
|
|
87707
88252
|
}
|
|
87708
88253
|
},
|
|
87709
88254
|
"additionalProperties": false
|
|
@@ -87717,6 +88262,125 @@ Schema for a collection of Dashboards
|
|
|
87717
88262
|
],
|
|
87718
88263
|
"additionalProperties": false
|
|
87719
88264
|
},
|
|
88265
|
+
{
|
|
88266
|
+
"type": "object",
|
|
88267
|
+
"properties": {
|
|
88268
|
+
"type": {
|
|
88269
|
+
"type": "string",
|
|
88270
|
+
"enum": [
|
|
88271
|
+
"indicator"
|
|
88272
|
+
]
|
|
88273
|
+
},
|
|
88274
|
+
"size": {
|
|
88275
|
+
"type": "string",
|
|
88276
|
+
"enum": [
|
|
88277
|
+
"small",
|
|
88278
|
+
"medium",
|
|
88279
|
+
"large"
|
|
88280
|
+
]
|
|
88281
|
+
},
|
|
88282
|
+
"position": {
|
|
88283
|
+
"type": "string",
|
|
88284
|
+
"minLength": 3,
|
|
88285
|
+
"maxLength": 255
|
|
88286
|
+
},
|
|
88287
|
+
"popupTemplate": {
|
|
88288
|
+
"type": "string",
|
|
88289
|
+
"maxLength": 32767
|
|
88290
|
+
},
|
|
88291
|
+
"conditions": {
|
|
88292
|
+
"type": "array",
|
|
88293
|
+
"maxItems": 100,
|
|
88294
|
+
"items": {
|
|
88295
|
+
"type": "object",
|
|
88296
|
+
"properties": {
|
|
88297
|
+
"color": {
|
|
88298
|
+
"type": "string",
|
|
88299
|
+
"maxLength": 64
|
|
88300
|
+
},
|
|
88301
|
+
"id": {
|
|
88302
|
+
"type": "string",
|
|
88303
|
+
"maxLength": 48
|
|
88304
|
+
},
|
|
88305
|
+
"label": {
|
|
88306
|
+
"type": "string",
|
|
88307
|
+
"maxLength": 32767
|
|
88308
|
+
},
|
|
88309
|
+
"condition": {
|
|
88310
|
+
"type": "string",
|
|
88311
|
+
"maxLength": 2048
|
|
88312
|
+
},
|
|
88313
|
+
"imageUrl": {
|
|
88314
|
+
"type": "string",
|
|
88315
|
+
"maxLength": 32767
|
|
88316
|
+
},
|
|
88317
|
+
"shape": {
|
|
88318
|
+
"type": "string",
|
|
88319
|
+
"enum": [
|
|
88320
|
+
"circle",
|
|
88321
|
+
"square",
|
|
88322
|
+
"triangle-down",
|
|
88323
|
+
"triangle-up",
|
|
88324
|
+
"octagon"
|
|
88325
|
+
],
|
|
88326
|
+
"default": "circle"
|
|
88327
|
+
}
|
|
88328
|
+
},
|
|
88329
|
+
"additionalProperties": false,
|
|
88330
|
+
"required": [
|
|
88331
|
+
"shape"
|
|
88332
|
+
]
|
|
88333
|
+
}
|
|
88334
|
+
},
|
|
88335
|
+
"defaultCondition": {
|
|
88336
|
+
"type": "object",
|
|
88337
|
+
"properties": {
|
|
88338
|
+
"color": {
|
|
88339
|
+
"type": "string",
|
|
88340
|
+
"maxLength": 64
|
|
88341
|
+
},
|
|
88342
|
+
"id": {
|
|
88343
|
+
"type": "string",
|
|
88344
|
+
"maxLength": 48
|
|
88345
|
+
},
|
|
88346
|
+
"label": {
|
|
88347
|
+
"type": "string",
|
|
88348
|
+
"maxLength": 32767
|
|
88349
|
+
},
|
|
88350
|
+
"condition": {
|
|
88351
|
+
"type": "string",
|
|
88352
|
+
"maxLength": 2048
|
|
88353
|
+
},
|
|
88354
|
+
"imageUrl": {
|
|
88355
|
+
"type": "string",
|
|
88356
|
+
"maxLength": 32767
|
|
88357
|
+
},
|
|
88358
|
+
"shape": {
|
|
88359
|
+
"type": "string",
|
|
88360
|
+
"enum": [
|
|
88361
|
+
"circle",
|
|
88362
|
+
"square",
|
|
88363
|
+
"triangle-down",
|
|
88364
|
+
"triangle-up",
|
|
88365
|
+
"octagon"
|
|
88366
|
+
],
|
|
88367
|
+
"default": "circle"
|
|
88368
|
+
}
|
|
88369
|
+
},
|
|
88370
|
+
"additionalProperties": false,
|
|
88371
|
+
"required": [
|
|
88372
|
+
"shape"
|
|
88373
|
+
]
|
|
88374
|
+
}
|
|
88375
|
+
},
|
|
88376
|
+
"required": [
|
|
88377
|
+
"type",
|
|
88378
|
+
"position",
|
|
88379
|
+
"size",
|
|
88380
|
+
"defaultCondition"
|
|
88381
|
+
],
|
|
88382
|
+
"additionalProperties": false
|
|
88383
|
+
},
|
|
87720
88384
|
{
|
|
87721
88385
|
"type": "object",
|
|
87722
88386
|
"properties": {
|
|
@@ -87777,7 +88441,8 @@ Schema for a collection of Dashboards
|
|
|
87777
88441
|
"triangle-down",
|
|
87778
88442
|
"triangle-up",
|
|
87779
88443
|
"octagon"
|
|
87780
|
-
]
|
|
88444
|
+
],
|
|
88445
|
+
"default": "circle"
|
|
87781
88446
|
}
|
|
87782
88447
|
},
|
|
87783
88448
|
"additionalProperties": false
|
|
@@ -87814,7 +88479,8 @@ Schema for a collection of Dashboards
|
|
|
87814
88479
|
"triangle-down",
|
|
87815
88480
|
"triangle-up",
|
|
87816
88481
|
"octagon"
|
|
87817
|
-
]
|
|
88482
|
+
],
|
|
88483
|
+
"default": "circle"
|
|
87818
88484
|
}
|
|
87819
88485
|
},
|
|
87820
88486
|
"additionalProperties": false
|
|
@@ -87892,7 +88558,8 @@ Schema for a collection of Dashboards
|
|
|
87892
88558
|
"triangle-down",
|
|
87893
88559
|
"triangle-up",
|
|
87894
88560
|
"octagon"
|
|
87895
|
-
]
|
|
88561
|
+
],
|
|
88562
|
+
"default": "circle"
|
|
87896
88563
|
}
|
|
87897
88564
|
},
|
|
87898
88565
|
"additionalProperties": false
|
|
@@ -87929,7 +88596,8 @@ Schema for a collection of Dashboards
|
|
|
87929
88596
|
"triangle-down",
|
|
87930
88597
|
"triangle-up",
|
|
87931
88598
|
"octagon"
|
|
87932
|
-
]
|
|
88599
|
+
],
|
|
88600
|
+
"default": "circle"
|
|
87933
88601
|
}
|
|
87934
88602
|
},
|
|
87935
88603
|
"additionalProperties": false
|
|
@@ -88273,7 +88941,8 @@ Schema for a collection of Dashboards
|
|
|
88273
88941
|
"triangle-down",
|
|
88274
88942
|
"triangle-up",
|
|
88275
88943
|
"octagon"
|
|
88276
|
-
]
|
|
88944
|
+
],
|
|
88945
|
+
"default": "circle"
|
|
88277
88946
|
}
|
|
88278
88947
|
},
|
|
88279
88948
|
"additionalProperties": false
|
|
@@ -88310,7 +88979,8 @@ Schema for a collection of Dashboards
|
|
|
88310
88979
|
"triangle-down",
|
|
88311
88980
|
"triangle-up",
|
|
88312
88981
|
"octagon"
|
|
88313
|
-
]
|
|
88982
|
+
],
|
|
88983
|
+
"default": "circle"
|
|
88314
88984
|
}
|
|
88315
88985
|
},
|
|
88316
88986
|
"additionalProperties": false
|
|
@@ -90630,6 +91300,9 @@ Schema for a collection of Dashboards
|
|
|
90630
91300
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
90631
91301
|
},
|
|
90632
91302
|
"maxItems": 1000
|
|
91303
|
+
},
|
|
91304
|
+
"includeExperienceGroups": {
|
|
91305
|
+
"type": "boolean"
|
|
90633
91306
|
}
|
|
90634
91307
|
},
|
|
90635
91308
|
"additionalProperties": false
|
|
@@ -220175,6 +220848,7 @@ Schema for the body of a GitHub login request
|
|
|
220175
220848
|
"instance.payloadCountsBreakdown",
|
|
220176
220849
|
"instance.deviceCounts",
|
|
220177
220850
|
"instance.notebookMinuteCounts",
|
|
220851
|
+
"instance.entitlements",
|
|
220178
220852
|
"instanceOrg.*",
|
|
220179
220853
|
"instanceOrg.get",
|
|
220180
220854
|
"instanceOrg.patch",
|
|
@@ -220183,6 +220857,8 @@ Schema for the body of a GitHub login request
|
|
|
220183
220857
|
"instanceOrg.payloadCountsBreakdown",
|
|
220184
220858
|
"instanceOrg.deviceCounts",
|
|
220185
220859
|
"instanceOrg.notebookMinuteCounts",
|
|
220860
|
+
"instanceOrg.entitlement",
|
|
220861
|
+
"instanceOrg.entitlementSync",
|
|
220186
220862
|
"instanceOrg.convertToEnterprise",
|
|
220187
220863
|
"instanceOrgs.*",
|
|
220188
220864
|
"instanceOrgs.get",
|
|
@@ -220273,6 +220949,13 @@ Schema for the body of a GitHub login request
|
|
|
220273
220949
|
"userOauthTokens.*",
|
|
220274
220950
|
"userOauthTokens.get",
|
|
220275
220951
|
"userOauthTokens.post",
|
|
220952
|
+
"userOauthClient.*",
|
|
220953
|
+
"userOauthClient.get",
|
|
220954
|
+
"userOauthClient.patch",
|
|
220955
|
+
"userOauthClient.delete",
|
|
220956
|
+
"userOauthClients.*",
|
|
220957
|
+
"userOauthClients.get",
|
|
220958
|
+
"userOauthClients.post",
|
|
220276
220959
|
"applicationTemplate.*",
|
|
220277
220960
|
"applicationTemplate.get",
|
|
220278
220961
|
"applicationTemplates.*",
|
|
@@ -220303,6 +220986,7 @@ Schema for the body of a GitHub login request
|
|
|
220303
220986
|
"me.invites",
|
|
220304
220987
|
"me.respondToInvite",
|
|
220305
220988
|
"me.refreshToken",
|
|
220989
|
+
"me.entitlements",
|
|
220306
220990
|
"orgs.*",
|
|
220307
220991
|
"orgs.get",
|
|
220308
220992
|
"orgs.post"
|
|
@@ -222367,6 +223051,12 @@ Schema for a single Instance
|
|
|
222367
223051
|
"adminRequired",
|
|
222368
223052
|
"required"
|
|
222369
223053
|
]
|
|
223054
|
+
},
|
|
223055
|
+
"entitlementMode": {
|
|
223056
|
+
"type": "string",
|
|
223057
|
+
"enum": [
|
|
223058
|
+
"scc"
|
|
223059
|
+
]
|
|
222370
223060
|
}
|
|
222371
223061
|
}
|
|
222372
223062
|
}
|
|
@@ -226272,6 +226962,18 @@ Schema for an Organization owned by an instance
|
|
|
226272
226962
|
"type": "integer",
|
|
226273
226963
|
"minimum": 5,
|
|
226274
226964
|
"maximum": 3600
|
|
226965
|
+
},
|
|
226966
|
+
"deviceHard": {
|
|
226967
|
+
"type": "integer",
|
|
226968
|
+
"minimum": 0
|
|
226969
|
+
},
|
|
226970
|
+
"applicationkeyHard": {
|
|
226971
|
+
"type": "integer",
|
|
226972
|
+
"minimum": 0
|
|
226973
|
+
},
|
|
226974
|
+
"applicationcertificateHard": {
|
|
226975
|
+
"type": "integer",
|
|
226976
|
+
"minimum": 0
|
|
226275
226977
|
}
|
|
226276
226978
|
},
|
|
226277
226979
|
"additionalProperties": false
|
|
@@ -226783,6 +227485,311 @@ Schema for an Organization owned by an instance
|
|
|
226783
227485
|
|
|
226784
227486
|
<br/>
|
|
226785
227487
|
|
|
227488
|
+
## Instance Org Entitlement
|
|
227489
|
+
|
|
227490
|
+
Schema for SCC entitlement details for an instance organization
|
|
227491
|
+
|
|
227492
|
+
### <a name="instance-org-entitlement-schema"></a> Schema
|
|
227493
|
+
|
|
227494
|
+
```json
|
|
227495
|
+
{
|
|
227496
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
227497
|
+
"type": "object",
|
|
227498
|
+
"properties": {
|
|
227499
|
+
"entitlementId": {
|
|
227500
|
+
"type": "string"
|
|
227501
|
+
},
|
|
227502
|
+
"expiresAt": {
|
|
227503
|
+
"type": "string",
|
|
227504
|
+
"format": "date-time"
|
|
227505
|
+
},
|
|
227506
|
+
"externalOrgId": {
|
|
227507
|
+
"type": "integer"
|
|
227508
|
+
},
|
|
227509
|
+
"externalOrgName": {
|
|
227510
|
+
"type": "string"
|
|
227511
|
+
},
|
|
227512
|
+
"subscriptionName": {
|
|
227513
|
+
"type": "string"
|
|
227514
|
+
},
|
|
227515
|
+
"hasSupport": {
|
|
227516
|
+
"type": "boolean"
|
|
227517
|
+
},
|
|
227518
|
+
"allowedOrgCount": {
|
|
227519
|
+
"type": "integer"
|
|
227520
|
+
},
|
|
227521
|
+
"usedOrgCount": {
|
|
227522
|
+
"type": "integer"
|
|
227523
|
+
},
|
|
227524
|
+
"orgIds": {
|
|
227525
|
+
"type": "array",
|
|
227526
|
+
"items": {
|
|
227527
|
+
"type": "string",
|
|
227528
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
227529
|
+
},
|
|
227530
|
+
"maxItems": 1000
|
|
227531
|
+
},
|
|
227532
|
+
"limits": {
|
|
227533
|
+
"type": "object",
|
|
227534
|
+
"properties": {
|
|
227535
|
+
"apitoken": {
|
|
227536
|
+
"type": "integer",
|
|
227537
|
+
"minimum": 0
|
|
227538
|
+
},
|
|
227539
|
+
"application": {
|
|
227540
|
+
"type": "integer",
|
|
227541
|
+
"minimum": 0
|
|
227542
|
+
},
|
|
227543
|
+
"applicationcertificate": {
|
|
227544
|
+
"type": "integer",
|
|
227545
|
+
"minimum": 0
|
|
227546
|
+
},
|
|
227547
|
+
"applicationcertificateauthority": {
|
|
227548
|
+
"type": "integer",
|
|
227549
|
+
"minimum": 0
|
|
227550
|
+
},
|
|
227551
|
+
"applicationkey": {
|
|
227552
|
+
"type": "integer",
|
|
227553
|
+
"minimum": 0
|
|
227554
|
+
},
|
|
227555
|
+
"credential": {
|
|
227556
|
+
"type": "integer",
|
|
227557
|
+
"minimum": 0
|
|
227558
|
+
},
|
|
227559
|
+
"dashboard": {
|
|
227560
|
+
"type": "integer",
|
|
227561
|
+
"minimum": 0
|
|
227562
|
+
},
|
|
227563
|
+
"datatable": {
|
|
227564
|
+
"type": "integer",
|
|
227565
|
+
"minimum": 0
|
|
227566
|
+
},
|
|
227567
|
+
"device": {
|
|
227568
|
+
"type": "integer",
|
|
227569
|
+
"minimum": 0
|
|
227570
|
+
},
|
|
227571
|
+
"devicerecipe": {
|
|
227572
|
+
"type": "integer",
|
|
227573
|
+
"minimum": 0
|
|
227574
|
+
},
|
|
227575
|
+
"experiencedomain": {
|
|
227576
|
+
"type": "integer",
|
|
227577
|
+
"minimum": 0
|
|
227578
|
+
},
|
|
227579
|
+
"experienceendpoint": {
|
|
227580
|
+
"type": "integer",
|
|
227581
|
+
"minimum": 0
|
|
227582
|
+
},
|
|
227583
|
+
"experiencegroup": {
|
|
227584
|
+
"type": "integer",
|
|
227585
|
+
"minimum": 0
|
|
227586
|
+
},
|
|
227587
|
+
"experienceslug": {
|
|
227588
|
+
"type": "integer",
|
|
227589
|
+
"minimum": 0
|
|
227590
|
+
},
|
|
227591
|
+
"experienceuser": {
|
|
227592
|
+
"type": "integer",
|
|
227593
|
+
"minimum": 0
|
|
227594
|
+
},
|
|
227595
|
+
"experienceversion": {
|
|
227596
|
+
"type": "integer",
|
|
227597
|
+
"minimum": 0
|
|
227598
|
+
},
|
|
227599
|
+
"experienceview": {
|
|
227600
|
+
"type": "integer",
|
|
227601
|
+
"minimum": 0
|
|
227602
|
+
},
|
|
227603
|
+
"file": {
|
|
227604
|
+
"type": "integer",
|
|
227605
|
+
"minimum": 0
|
|
227606
|
+
},
|
|
227607
|
+
"flow": {
|
|
227608
|
+
"type": "integer",
|
|
227609
|
+
"minimum": 0
|
|
227610
|
+
},
|
|
227611
|
+
"integration": {
|
|
227612
|
+
"type": "integer",
|
|
227613
|
+
"minimum": 0
|
|
227614
|
+
},
|
|
227615
|
+
"notebook": {
|
|
227616
|
+
"type": "integer",
|
|
227617
|
+
"minimum": 0
|
|
227618
|
+
},
|
|
227619
|
+
"privatefile": {
|
|
227620
|
+
"type": "integer",
|
|
227621
|
+
"minimum": 0
|
|
227622
|
+
},
|
|
227623
|
+
"resourcejob": {
|
|
227624
|
+
"type": "integer",
|
|
227625
|
+
"minimum": 0
|
|
227626
|
+
},
|
|
227627
|
+
"webhook": {
|
|
227628
|
+
"type": "integer",
|
|
227629
|
+
"minimum": 0
|
|
227630
|
+
},
|
|
227631
|
+
"dataTTL": {
|
|
227632
|
+
"type": "integer",
|
|
227633
|
+
"minimum": 86400
|
|
227634
|
+
},
|
|
227635
|
+
"member": {
|
|
227636
|
+
"type": "integer",
|
|
227637
|
+
"minimum": 0
|
|
227638
|
+
},
|
|
227639
|
+
"payload": {
|
|
227640
|
+
"type": "integer",
|
|
227641
|
+
"minimum": 0
|
|
227642
|
+
},
|
|
227643
|
+
"storage": {
|
|
227644
|
+
"type": "integer",
|
|
227645
|
+
"minimum": 0
|
|
227646
|
+
},
|
|
227647
|
+
"notebookMinutesPerRun": {
|
|
227648
|
+
"type": "integer",
|
|
227649
|
+
"minimum": 0
|
|
227650
|
+
},
|
|
227651
|
+
"notebookMinutesPerMonth": {
|
|
227652
|
+
"type": "integer",
|
|
227653
|
+
"minimum": 0
|
|
227654
|
+
},
|
|
227655
|
+
"notebookInParallel": {
|
|
227656
|
+
"type": "integer",
|
|
227657
|
+
"minimum": 0
|
|
227658
|
+
},
|
|
227659
|
+
"experienceFlowSlots": {
|
|
227660
|
+
"type": "integer",
|
|
227661
|
+
"minimum": 0
|
|
227662
|
+
},
|
|
227663
|
+
"applicationFlowSlots": {
|
|
227664
|
+
"type": "integer",
|
|
227665
|
+
"minimum": 0
|
|
227666
|
+
},
|
|
227667
|
+
"systemInterval": {
|
|
227668
|
+
"type": "integer",
|
|
227669
|
+
"minimum": 5,
|
|
227670
|
+
"maximum": 3600
|
|
227671
|
+
}
|
|
227672
|
+
},
|
|
227673
|
+
"additionalProperties": false
|
|
227674
|
+
}
|
|
227675
|
+
}
|
|
227676
|
+
}
|
|
227677
|
+
```
|
|
227678
|
+
### <a name="instance-org-entitlement-example"></a> Example
|
|
227679
|
+
|
|
227680
|
+
```json
|
|
227681
|
+
{
|
|
227682
|
+
"entitlementId": "l05antt35t",
|
|
227683
|
+
"expiresAt": "2029-06-16T15:36:50.338Z",
|
|
227684
|
+
"externalOrgId": 886788,
|
|
227685
|
+
"externalOrgName": "Example Organization",
|
|
227686
|
+
"subscriptionName": "Losant Test Subscription",
|
|
227687
|
+
"hasSupport": true,
|
|
227688
|
+
"allowedOrgCount": 1,
|
|
227689
|
+
"usedOrgCount": 1,
|
|
227690
|
+
"orgIds": [],
|
|
227691
|
+
"limits": {
|
|
227692
|
+
"device": 1000,
|
|
227693
|
+
"dataTTL": 31536000
|
|
227694
|
+
}
|
|
227695
|
+
}
|
|
227696
|
+
```
|
|
227697
|
+
|
|
227698
|
+
<br/>
|
|
227699
|
+
|
|
227700
|
+
## Instance Org Entitlement Sync
|
|
227701
|
+
|
|
227702
|
+
Schema for the result of an on-demand SCC entitlement sync for an instance organization
|
|
227703
|
+
|
|
227704
|
+
### <a name="instance-org-entitlement-sync-schema"></a> Schema
|
|
227705
|
+
|
|
227706
|
+
```json
|
|
227707
|
+
{
|
|
227708
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
227709
|
+
"type": "object",
|
|
227710
|
+
"properties": {
|
|
227711
|
+
"success": {
|
|
227712
|
+
"type": "boolean"
|
|
227713
|
+
},
|
|
227714
|
+
"limitsUpdated": {
|
|
227715
|
+
"type": "object",
|
|
227716
|
+
"patternProperties": {
|
|
227717
|
+
"^[a-zA-Z]+$": {
|
|
227718
|
+
"type": "object",
|
|
227719
|
+
"properties": {
|
|
227720
|
+
"previous": {
|
|
227721
|
+
"type": "integer",
|
|
227722
|
+
"minimum": 0
|
|
227723
|
+
},
|
|
227724
|
+
"current": {
|
|
227725
|
+
"type": "integer",
|
|
227726
|
+
"minimum": 0
|
|
227727
|
+
}
|
|
227728
|
+
}
|
|
227729
|
+
}
|
|
227730
|
+
}
|
|
227731
|
+
},
|
|
227732
|
+
"issues": {
|
|
227733
|
+
"type": "array",
|
|
227734
|
+
"items": {
|
|
227735
|
+
"type": "object",
|
|
227736
|
+
"properties": {
|
|
227737
|
+
"type": {
|
|
227738
|
+
"type": "string",
|
|
227739
|
+
"enum": [
|
|
227740
|
+
"expired",
|
|
227741
|
+
"limitsDecreased",
|
|
227742
|
+
"noMember"
|
|
227743
|
+
]
|
|
227744
|
+
},
|
|
227745
|
+
"decreased": {
|
|
227746
|
+
"type": "object",
|
|
227747
|
+
"patternProperties": {
|
|
227748
|
+
"^[a-zA-Z]+$": {
|
|
227749
|
+
"type": "object",
|
|
227750
|
+
"properties": {
|
|
227751
|
+
"requested": {
|
|
227752
|
+
"type": "integer",
|
|
227753
|
+
"minimum": 0
|
|
227754
|
+
},
|
|
227755
|
+
"current": {
|
|
227756
|
+
"type": "integer",
|
|
227757
|
+
"minimum": 0
|
|
227758
|
+
}
|
|
227759
|
+
}
|
|
227760
|
+
}
|
|
227761
|
+
}
|
|
227762
|
+
}
|
|
227763
|
+
},
|
|
227764
|
+
"required": [
|
|
227765
|
+
"type"
|
|
227766
|
+
]
|
|
227767
|
+
}
|
|
227768
|
+
}
|
|
227769
|
+
}
|
|
227770
|
+
}
|
|
227771
|
+
```
|
|
227772
|
+
### <a name="instance-org-entitlement-sync-example"></a> Example
|
|
227773
|
+
|
|
227774
|
+
```json
|
|
227775
|
+
{
|
|
227776
|
+
"success": true,
|
|
227777
|
+
"limitsUpdated": {
|
|
227778
|
+
"device": {
|
|
227779
|
+
"previous": 10,
|
|
227780
|
+
"current": 1000
|
|
227781
|
+
}
|
|
227782
|
+
},
|
|
227783
|
+
"issues": [
|
|
227784
|
+
{
|
|
227785
|
+
"type": "noMember"
|
|
227786
|
+
}
|
|
227787
|
+
]
|
|
227788
|
+
}
|
|
227789
|
+
```
|
|
227790
|
+
|
|
227791
|
+
<br/>
|
|
227792
|
+
|
|
226786
227793
|
## Instance Organization Invitation
|
|
226787
227794
|
|
|
226788
227795
|
Schema for a pending invitation to an Organization within an instance
|
|
@@ -228580,6 +229587,18 @@ Schema for a collection of Organizations within an instance
|
|
|
228580
229587
|
"type": "integer",
|
|
228581
229588
|
"minimum": 5,
|
|
228582
229589
|
"maximum": 3600
|
|
229590
|
+
},
|
|
229591
|
+
"deviceHard": {
|
|
229592
|
+
"type": "integer",
|
|
229593
|
+
"minimum": 0
|
|
229594
|
+
},
|
|
229595
|
+
"applicationkeyHard": {
|
|
229596
|
+
"type": "integer",
|
|
229597
|
+
"minimum": 0
|
|
229598
|
+
},
|
|
229599
|
+
"applicationcertificateHard": {
|
|
229600
|
+
"type": "integer",
|
|
229601
|
+
"minimum": 0
|
|
228583
229602
|
}
|
|
228584
229603
|
},
|
|
228585
229604
|
"additionalProperties": false
|
|
@@ -229646,6 +230665,9 @@ Schema for information about a sandbox user within an instance domain
|
|
|
229646
230665
|
"notebook": {
|
|
229647
230666
|
"type": "integer"
|
|
229648
230667
|
},
|
|
230668
|
+
"oauthclient": {
|
|
230669
|
+
"type": "integer"
|
|
230670
|
+
},
|
|
229649
230671
|
"privatefile": {
|
|
229650
230672
|
"type": "integer"
|
|
229651
230673
|
},
|
|
@@ -229754,6 +230776,9 @@ Schema for information about a sandbox user within an instance domain
|
|
|
229754
230776
|
"notebookCount": {
|
|
229755
230777
|
"type": "integer"
|
|
229756
230778
|
},
|
|
230779
|
+
"oauthClientCount": {
|
|
230780
|
+
"type": "integer"
|
|
230781
|
+
},
|
|
229757
230782
|
"resourceJobCount": {
|
|
229758
230783
|
"type": "integer"
|
|
229759
230784
|
},
|
|
@@ -230225,6 +231250,9 @@ Schema for a collection of instance associated sandboxes
|
|
|
230225
231250
|
"notebook": {
|
|
230226
231251
|
"type": "integer"
|
|
230227
231252
|
},
|
|
231253
|
+
"oauthclient": {
|
|
231254
|
+
"type": "integer"
|
|
231255
|
+
},
|
|
230228
231256
|
"privatefile": {
|
|
230229
231257
|
"type": "integer"
|
|
230230
231258
|
},
|
|
@@ -230333,6 +231361,9 @@ Schema for a collection of instance associated sandboxes
|
|
|
230333
231361
|
"notebookCount": {
|
|
230334
231362
|
"type": "integer"
|
|
230335
231363
|
},
|
|
231364
|
+
"oauthClientCount": {
|
|
231365
|
+
"type": "integer"
|
|
231366
|
+
},
|
|
230336
231367
|
"resourceJobCount": {
|
|
230337
231368
|
"type": "integer"
|
|
230338
231369
|
},
|
|
@@ -231087,6 +232118,12 @@ Schema for a collection of Instances
|
|
|
231087
232118
|
"adminRequired",
|
|
231088
232119
|
"required"
|
|
231089
232120
|
]
|
|
232121
|
+
},
|
|
232122
|
+
"entitlementMode": {
|
|
232123
|
+
"type": "string",
|
|
232124
|
+
"enum": [
|
|
232125
|
+
"scc"
|
|
232126
|
+
]
|
|
231090
232127
|
}
|
|
231091
232128
|
}
|
|
231092
232129
|
}
|
|
@@ -234997,6 +236034,15 @@ Schema for information about the currently authenticated user
|
|
|
234997
236034
|
"type": "string",
|
|
234998
236035
|
"maxLength": 1024
|
|
234999
236036
|
},
|
|
236037
|
+
"state": {
|
|
236038
|
+
"type": "string",
|
|
236039
|
+
"maxLength": 1024
|
|
236040
|
+
},
|
|
236041
|
+
"country": {
|
|
236042
|
+
"type": "string",
|
|
236043
|
+
"minLength": 1,
|
|
236044
|
+
"maxLength": 1024
|
|
236045
|
+
},
|
|
235000
236046
|
"tokenCutoff": {
|
|
235001
236047
|
"type": "string",
|
|
235002
236048
|
"format": "date-time"
|
|
@@ -235087,6 +236133,9 @@ Schema for information about the currently authenticated user
|
|
|
235087
236133
|
"notebook": {
|
|
235088
236134
|
"type": "integer"
|
|
235089
236135
|
},
|
|
236136
|
+
"oauthclient": {
|
|
236137
|
+
"type": "integer"
|
|
236138
|
+
},
|
|
235090
236139
|
"privatefile": {
|
|
235091
236140
|
"type": "integer"
|
|
235092
236141
|
},
|
|
@@ -235906,6 +236955,9 @@ Schema for information about the currently authenticated user
|
|
|
235906
236955
|
"notebookCount": {
|
|
235907
236956
|
"type": "integer"
|
|
235908
236957
|
},
|
|
236958
|
+
"oauthClientCount": {
|
|
236959
|
+
"type": "integer"
|
|
236960
|
+
},
|
|
235909
236961
|
"resourceJobCount": {
|
|
235910
236962
|
"type": "integer"
|
|
235911
236963
|
},
|
|
@@ -236135,6 +237187,8 @@ Schema for information about the currently authenticated user
|
|
|
236135
237187
|
"lastName": "Name",
|
|
236136
237188
|
"companyName": "Example, Inc.",
|
|
236137
237189
|
"url": "https://example.com",
|
|
237190
|
+
"state": "Ohio",
|
|
237191
|
+
"country": "United States",
|
|
236138
237192
|
"emailVerified": true,
|
|
236139
237193
|
"needsToVerifyEmail": false,
|
|
236140
237194
|
"twoFactorAuthEnabled": false,
|
|
@@ -236155,6 +237209,231 @@ Schema for information about the currently authenticated user
|
|
|
236155
237209
|
|
|
236156
237210
|
<br/>
|
|
236157
237211
|
|
|
237212
|
+
## Me Entitlements
|
|
237213
|
+
|
|
237214
|
+
Schema for entitlement information for the currently authenticated user
|
|
237215
|
+
|
|
237216
|
+
### <a name="me-entitlements-schema"></a> Schema
|
|
237217
|
+
|
|
237218
|
+
```json
|
|
237219
|
+
{
|
|
237220
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
237221
|
+
"type": "object",
|
|
237222
|
+
"properties": {
|
|
237223
|
+
"userFound": {
|
|
237224
|
+
"type": "boolean"
|
|
237225
|
+
},
|
|
237226
|
+
"entitlements": {
|
|
237227
|
+
"type": "array",
|
|
237228
|
+
"items": {
|
|
237229
|
+
"title": "Entitlement",
|
|
237230
|
+
"type": "object",
|
|
237231
|
+
"properties": {
|
|
237232
|
+
"entitlementId": {
|
|
237233
|
+
"type": "string"
|
|
237234
|
+
},
|
|
237235
|
+
"expiresAt": {
|
|
237236
|
+
"type": "string",
|
|
237237
|
+
"format": "date-time"
|
|
237238
|
+
},
|
|
237239
|
+
"externalOrgId": {
|
|
237240
|
+
"type": "integer"
|
|
237241
|
+
},
|
|
237242
|
+
"externalOrgName": {
|
|
237243
|
+
"type": "string"
|
|
237244
|
+
},
|
|
237245
|
+
"subscriptionName": {
|
|
237246
|
+
"type": "string"
|
|
237247
|
+
},
|
|
237248
|
+
"hasSupport": {
|
|
237249
|
+
"type": "boolean"
|
|
237250
|
+
},
|
|
237251
|
+
"allowedOrgCount": {
|
|
237252
|
+
"type": "integer"
|
|
237253
|
+
},
|
|
237254
|
+
"usedOrgCount": {
|
|
237255
|
+
"type": "integer"
|
|
237256
|
+
},
|
|
237257
|
+
"orgIds": {
|
|
237258
|
+
"type": "array",
|
|
237259
|
+
"items": {
|
|
237260
|
+
"type": "string",
|
|
237261
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
237262
|
+
},
|
|
237263
|
+
"maxItems": 1000
|
|
237264
|
+
},
|
|
237265
|
+
"limits": {
|
|
237266
|
+
"type": "object",
|
|
237267
|
+
"properties": {
|
|
237268
|
+
"apitoken": {
|
|
237269
|
+
"type": "integer",
|
|
237270
|
+
"minimum": 0
|
|
237271
|
+
},
|
|
237272
|
+
"application": {
|
|
237273
|
+
"type": "integer",
|
|
237274
|
+
"minimum": 0
|
|
237275
|
+
},
|
|
237276
|
+
"applicationcertificate": {
|
|
237277
|
+
"type": "integer",
|
|
237278
|
+
"minimum": 0
|
|
237279
|
+
},
|
|
237280
|
+
"applicationcertificateauthority": {
|
|
237281
|
+
"type": "integer",
|
|
237282
|
+
"minimum": 0
|
|
237283
|
+
},
|
|
237284
|
+
"applicationkey": {
|
|
237285
|
+
"type": "integer",
|
|
237286
|
+
"minimum": 0
|
|
237287
|
+
},
|
|
237288
|
+
"credential": {
|
|
237289
|
+
"type": "integer",
|
|
237290
|
+
"minimum": 0
|
|
237291
|
+
},
|
|
237292
|
+
"dashboard": {
|
|
237293
|
+
"type": "integer",
|
|
237294
|
+
"minimum": 0
|
|
237295
|
+
},
|
|
237296
|
+
"datatable": {
|
|
237297
|
+
"type": "integer",
|
|
237298
|
+
"minimum": 0
|
|
237299
|
+
},
|
|
237300
|
+
"device": {
|
|
237301
|
+
"type": "integer",
|
|
237302
|
+
"minimum": 0
|
|
237303
|
+
},
|
|
237304
|
+
"devicerecipe": {
|
|
237305
|
+
"type": "integer",
|
|
237306
|
+
"minimum": 0
|
|
237307
|
+
},
|
|
237308
|
+
"experiencedomain": {
|
|
237309
|
+
"type": "integer",
|
|
237310
|
+
"minimum": 0
|
|
237311
|
+
},
|
|
237312
|
+
"experienceendpoint": {
|
|
237313
|
+
"type": "integer",
|
|
237314
|
+
"minimum": 0
|
|
237315
|
+
},
|
|
237316
|
+
"experiencegroup": {
|
|
237317
|
+
"type": "integer",
|
|
237318
|
+
"minimum": 0
|
|
237319
|
+
},
|
|
237320
|
+
"experienceslug": {
|
|
237321
|
+
"type": "integer",
|
|
237322
|
+
"minimum": 0
|
|
237323
|
+
},
|
|
237324
|
+
"experienceuser": {
|
|
237325
|
+
"type": "integer",
|
|
237326
|
+
"minimum": 0
|
|
237327
|
+
},
|
|
237328
|
+
"experienceversion": {
|
|
237329
|
+
"type": "integer",
|
|
237330
|
+
"minimum": 0
|
|
237331
|
+
},
|
|
237332
|
+
"experienceview": {
|
|
237333
|
+
"type": "integer",
|
|
237334
|
+
"minimum": 0
|
|
237335
|
+
},
|
|
237336
|
+
"file": {
|
|
237337
|
+
"type": "integer",
|
|
237338
|
+
"minimum": 0
|
|
237339
|
+
},
|
|
237340
|
+
"flow": {
|
|
237341
|
+
"type": "integer",
|
|
237342
|
+
"minimum": 0
|
|
237343
|
+
},
|
|
237344
|
+
"integration": {
|
|
237345
|
+
"type": "integer",
|
|
237346
|
+
"minimum": 0
|
|
237347
|
+
},
|
|
237348
|
+
"notebook": {
|
|
237349
|
+
"type": "integer",
|
|
237350
|
+
"minimum": 0
|
|
237351
|
+
},
|
|
237352
|
+
"privatefile": {
|
|
237353
|
+
"type": "integer",
|
|
237354
|
+
"minimum": 0
|
|
237355
|
+
},
|
|
237356
|
+
"resourcejob": {
|
|
237357
|
+
"type": "integer",
|
|
237358
|
+
"minimum": 0
|
|
237359
|
+
},
|
|
237360
|
+
"webhook": {
|
|
237361
|
+
"type": "integer",
|
|
237362
|
+
"minimum": 0
|
|
237363
|
+
},
|
|
237364
|
+
"dataTTL": {
|
|
237365
|
+
"type": "integer",
|
|
237366
|
+
"minimum": 86400
|
|
237367
|
+
},
|
|
237368
|
+
"member": {
|
|
237369
|
+
"type": "integer",
|
|
237370
|
+
"minimum": 0
|
|
237371
|
+
},
|
|
237372
|
+
"payload": {
|
|
237373
|
+
"type": "integer",
|
|
237374
|
+
"minimum": 0
|
|
237375
|
+
},
|
|
237376
|
+
"storage": {
|
|
237377
|
+
"type": "integer",
|
|
237378
|
+
"minimum": 0
|
|
237379
|
+
},
|
|
237380
|
+
"notebookMinutesPerRun": {
|
|
237381
|
+
"type": "integer",
|
|
237382
|
+
"minimum": 0
|
|
237383
|
+
},
|
|
237384
|
+
"notebookMinutesPerMonth": {
|
|
237385
|
+
"type": "integer",
|
|
237386
|
+
"minimum": 0
|
|
237387
|
+
},
|
|
237388
|
+
"notebookInParallel": {
|
|
237389
|
+
"type": "integer",
|
|
237390
|
+
"minimum": 0
|
|
237391
|
+
},
|
|
237392
|
+
"experienceFlowSlots": {
|
|
237393
|
+
"type": "integer",
|
|
237394
|
+
"minimum": 0
|
|
237395
|
+
},
|
|
237396
|
+
"applicationFlowSlots": {
|
|
237397
|
+
"type": "integer",
|
|
237398
|
+
"minimum": 0
|
|
237399
|
+
},
|
|
237400
|
+
"systemInterval": {
|
|
237401
|
+
"type": "integer",
|
|
237402
|
+
"minimum": 5,
|
|
237403
|
+
"maximum": 3600
|
|
237404
|
+
}
|
|
237405
|
+
},
|
|
237406
|
+
"additionalProperties": false
|
|
237407
|
+
}
|
|
237408
|
+
}
|
|
237409
|
+
}
|
|
237410
|
+
}
|
|
237411
|
+
}
|
|
237412
|
+
}
|
|
237413
|
+
```
|
|
237414
|
+
### <a name="me-entitlements-example"></a> Example
|
|
237415
|
+
|
|
237416
|
+
```json
|
|
237417
|
+
{
|
|
237418
|
+
"userFound": true,
|
|
237419
|
+
"entitlements": [
|
|
237420
|
+
{
|
|
237421
|
+
"entitlementId": "l05antt35t",
|
|
237422
|
+
"expiresAt": "2029-06-16T15:36:50.338Z",
|
|
237423
|
+
"externalOrgId": 886788,
|
|
237424
|
+
"externalOrgName": "Example Organization",
|
|
237425
|
+
"subscriptionName": "Losant Test Subscription",
|
|
237426
|
+
"hasSupport": true,
|
|
237427
|
+
"allowedOrgCount": 1,
|
|
237428
|
+
"usedOrgCount": 0,
|
|
237429
|
+
"orgIds": []
|
|
237430
|
+
}
|
|
237431
|
+
]
|
|
237432
|
+
}
|
|
237433
|
+
```
|
|
237434
|
+
|
|
237435
|
+
<br/>
|
|
237436
|
+
|
|
236158
237437
|
## Me Patch
|
|
236159
237438
|
|
|
236160
237439
|
Schema for the body of request to modify the current user
|
|
@@ -236200,6 +237479,15 @@ Schema for the body of request to modify the current user
|
|
|
236200
237479
|
"type": "string",
|
|
236201
237480
|
"maxLength": 1024
|
|
236202
237481
|
},
|
|
237482
|
+
"state": {
|
|
237483
|
+
"type": "string",
|
|
237484
|
+
"maxLength": 1024
|
|
237485
|
+
},
|
|
237486
|
+
"country": {
|
|
237487
|
+
"type": "string",
|
|
237488
|
+
"minLength": 1,
|
|
237489
|
+
"maxLength": 1024
|
|
237490
|
+
},
|
|
236203
237491
|
"password": {
|
|
236204
237492
|
"type": "string",
|
|
236205
237493
|
"minLength": 12,
|
|
@@ -243835,6 +245123,18 @@ Schema for a single Organization
|
|
|
243835
245123
|
"type": "integer",
|
|
243836
245124
|
"minimum": 5,
|
|
243837
245125
|
"maximum": 3600
|
|
245126
|
+
},
|
|
245127
|
+
"deviceHard": {
|
|
245128
|
+
"type": "integer",
|
|
245129
|
+
"minimum": 0
|
|
245130
|
+
},
|
|
245131
|
+
"applicationkeyHard": {
|
|
245132
|
+
"type": "integer",
|
|
245133
|
+
"minimum": 0
|
|
245134
|
+
},
|
|
245135
|
+
"applicationcertificateHard": {
|
|
245136
|
+
"type": "integer",
|
|
245137
|
+
"minimum": 0
|
|
243838
245138
|
}
|
|
243839
245139
|
},
|
|
243840
245140
|
"additionalProperties": false
|
|
@@ -244109,6 +245409,10 @@ Schema for a single Organization
|
|
|
244109
245409
|
}
|
|
244110
245410
|
}
|
|
244111
245411
|
},
|
|
245412
|
+
"entitlementOrgId": {
|
|
245413
|
+
"type": "string",
|
|
245414
|
+
"maxLength": 1024
|
|
245415
|
+
},
|
|
244112
245416
|
"planId": {
|
|
244113
245417
|
"type": "string",
|
|
244114
245418
|
"maxLength": 1024
|
|
@@ -245041,6 +246345,10 @@ Schema for the body of an Organization creation request
|
|
|
245041
246345
|
"adminRequired",
|
|
245042
246346
|
"required"
|
|
245043
246347
|
]
|
|
246348
|
+
},
|
|
246349
|
+
"entitlementId": {
|
|
246350
|
+
"type": "string",
|
|
246351
|
+
"maxLength": 1024
|
|
245044
246352
|
}
|
|
245045
246353
|
},
|
|
245046
246354
|
"additionalProperties": false,
|
|
@@ -245438,6 +246746,18 @@ Schema for a collection of Organizations
|
|
|
245438
246746
|
"type": "integer",
|
|
245439
246747
|
"minimum": 5,
|
|
245440
246748
|
"maximum": 3600
|
|
246749
|
+
},
|
|
246750
|
+
"deviceHard": {
|
|
246751
|
+
"type": "integer",
|
|
246752
|
+
"minimum": 0
|
|
246753
|
+
},
|
|
246754
|
+
"applicationkeyHard": {
|
|
246755
|
+
"type": "integer",
|
|
246756
|
+
"minimum": 0
|
|
246757
|
+
},
|
|
246758
|
+
"applicationcertificateHard": {
|
|
246759
|
+
"type": "integer",
|
|
246760
|
+
"minimum": 0
|
|
245441
246761
|
}
|
|
245442
246762
|
},
|
|
245443
246763
|
"additionalProperties": false
|
|
@@ -245712,6 +247032,10 @@ Schema for a collection of Organizations
|
|
|
245712
247032
|
}
|
|
245713
247033
|
}
|
|
245714
247034
|
},
|
|
247035
|
+
"entitlementOrgId": {
|
|
247036
|
+
"type": "string",
|
|
247037
|
+
"maxLength": 1024
|
|
247038
|
+
},
|
|
245715
247039
|
"planId": {
|
|
245716
247040
|
"type": "string",
|
|
245717
247041
|
"maxLength": 1024
|
|
@@ -248938,6 +250262,7 @@ SAML Response body for login
|
|
|
248938
250262
|
"instance.payloadCountsBreakdown",
|
|
248939
250263
|
"instance.deviceCounts",
|
|
248940
250264
|
"instance.notebookMinuteCounts",
|
|
250265
|
+
"instance.entitlements",
|
|
248941
250266
|
"instanceOrg.*",
|
|
248942
250267
|
"instanceOrg.get",
|
|
248943
250268
|
"instanceOrg.patch",
|
|
@@ -248946,6 +250271,8 @@ SAML Response body for login
|
|
|
248946
250271
|
"instanceOrg.payloadCountsBreakdown",
|
|
248947
250272
|
"instanceOrg.deviceCounts",
|
|
248948
250273
|
"instanceOrg.notebookMinuteCounts",
|
|
250274
|
+
"instanceOrg.entitlement",
|
|
250275
|
+
"instanceOrg.entitlementSync",
|
|
248949
250276
|
"instanceOrg.convertToEnterprise",
|
|
248950
250277
|
"instanceOrgs.*",
|
|
248951
250278
|
"instanceOrgs.get",
|
|
@@ -249036,6 +250363,13 @@ SAML Response body for login
|
|
|
249036
250363
|
"userOauthTokens.*",
|
|
249037
250364
|
"userOauthTokens.get",
|
|
249038
250365
|
"userOauthTokens.post",
|
|
250366
|
+
"userOauthClient.*",
|
|
250367
|
+
"userOauthClient.get",
|
|
250368
|
+
"userOauthClient.patch",
|
|
250369
|
+
"userOauthClient.delete",
|
|
250370
|
+
"userOauthClients.*",
|
|
250371
|
+
"userOauthClients.get",
|
|
250372
|
+
"userOauthClients.post",
|
|
249039
250373
|
"applicationTemplate.*",
|
|
249040
250374
|
"applicationTemplate.get",
|
|
249041
250375
|
"applicationTemplates.*",
|
|
@@ -249066,6 +250400,7 @@ SAML Response body for login
|
|
|
249066
250400
|
"me.invites",
|
|
249067
250401
|
"me.respondToInvite",
|
|
249068
250402
|
"me.refreshToken",
|
|
250403
|
+
"me.entitlements",
|
|
249069
250404
|
"orgs.*",
|
|
249070
250405
|
"orgs.get",
|
|
249071
250406
|
"orgs.post"
|
|
@@ -252423,6 +253758,7 @@ Schema for the body of a User authentication request
|
|
|
252423
253758
|
"instance.payloadCountsBreakdown",
|
|
252424
253759
|
"instance.deviceCounts",
|
|
252425
253760
|
"instance.notebookMinuteCounts",
|
|
253761
|
+
"instance.entitlements",
|
|
252426
253762
|
"instanceOrg.*",
|
|
252427
253763
|
"instanceOrg.get",
|
|
252428
253764
|
"instanceOrg.patch",
|
|
@@ -252431,6 +253767,8 @@ Schema for the body of a User authentication request
|
|
|
252431
253767
|
"instanceOrg.payloadCountsBreakdown",
|
|
252432
253768
|
"instanceOrg.deviceCounts",
|
|
252433
253769
|
"instanceOrg.notebookMinuteCounts",
|
|
253770
|
+
"instanceOrg.entitlement",
|
|
253771
|
+
"instanceOrg.entitlementSync",
|
|
252434
253772
|
"instanceOrg.convertToEnterprise",
|
|
252435
253773
|
"instanceOrgs.*",
|
|
252436
253774
|
"instanceOrgs.get",
|
|
@@ -252521,6 +253859,13 @@ Schema for the body of a User authentication request
|
|
|
252521
253859
|
"userOauthTokens.*",
|
|
252522
253860
|
"userOauthTokens.get",
|
|
252523
253861
|
"userOauthTokens.post",
|
|
253862
|
+
"userOauthClient.*",
|
|
253863
|
+
"userOauthClient.get",
|
|
253864
|
+
"userOauthClient.patch",
|
|
253865
|
+
"userOauthClient.delete",
|
|
253866
|
+
"userOauthClients.*",
|
|
253867
|
+
"userOauthClients.get",
|
|
253868
|
+
"userOauthClients.post",
|
|
252524
253869
|
"applicationTemplate.*",
|
|
252525
253870
|
"applicationTemplate.get",
|
|
252526
253871
|
"applicationTemplates.*",
|
|
@@ -252551,6 +253896,7 @@ Schema for the body of a User authentication request
|
|
|
252551
253896
|
"me.invites",
|
|
252552
253897
|
"me.respondToInvite",
|
|
252553
253898
|
"me.refreshToken",
|
|
253899
|
+
"me.entitlements",
|
|
252554
253900
|
"orgs.*",
|
|
252555
253901
|
"orgs.get",
|
|
252556
253902
|
"orgs.post"
|
|
@@ -252582,6 +253928,685 @@ Schema for the body of a User authentication request
|
|
|
252582
253928
|
|
|
252583
253929
|
<br/>
|
|
252584
253930
|
|
|
253931
|
+
## User OAuth Client
|
|
253932
|
+
|
|
253933
|
+
Schema for a single private OAuth client
|
|
253934
|
+
|
|
253935
|
+
### <a name="user-oauth-client-schema"></a> Schema
|
|
253936
|
+
|
|
253937
|
+
```json
|
|
253938
|
+
{
|
|
253939
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
253940
|
+
"type": "object",
|
|
253941
|
+
"properties": {
|
|
253942
|
+
"id": {
|
|
253943
|
+
"type": "string",
|
|
253944
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
253945
|
+
},
|
|
253946
|
+
"creationDate": {
|
|
253947
|
+
"type": "string",
|
|
253948
|
+
"format": "date-time"
|
|
253949
|
+
},
|
|
253950
|
+
"lastUpdated": {
|
|
253951
|
+
"type": "string",
|
|
253952
|
+
"format": "date-time"
|
|
253953
|
+
},
|
|
253954
|
+
"client_id": {
|
|
253955
|
+
"type": "string",
|
|
253956
|
+
"description": "Unique client identifier"
|
|
253957
|
+
},
|
|
253958
|
+
"client_secret": {
|
|
253959
|
+
"type": "string",
|
|
253960
|
+
"description": "Client secret. Only ever included in the response to the initial creation request."
|
|
253961
|
+
},
|
|
253962
|
+
"client_name": {
|
|
253963
|
+
"type": "string",
|
|
253964
|
+
"minLength": 1,
|
|
253965
|
+
"maxLength": 255
|
|
253966
|
+
},
|
|
253967
|
+
"description": {
|
|
253968
|
+
"type": "string",
|
|
253969
|
+
"maxLength": 32767
|
|
253970
|
+
},
|
|
253971
|
+
"client_uri": {
|
|
253972
|
+
"type": "string",
|
|
253973
|
+
"format": "uri",
|
|
253974
|
+
"maxLength": 1024
|
|
253975
|
+
},
|
|
253976
|
+
"logo_uri": {
|
|
253977
|
+
"type": "string",
|
|
253978
|
+
"format": "uri",
|
|
253979
|
+
"maxLength": 32768,
|
|
253980
|
+
"description": "URL of the client's logo. May be an http(s) URL or a data:image/* URI."
|
|
253981
|
+
},
|
|
253982
|
+
"redirect_uris": {
|
|
253983
|
+
"type": "array",
|
|
253984
|
+
"minItems": 1,
|
|
253985
|
+
"maxItems": 25,
|
|
253986
|
+
"items": {
|
|
253987
|
+
"type": "string",
|
|
253988
|
+
"format": "uri",
|
|
253989
|
+
"maxLength": 1024
|
|
253990
|
+
},
|
|
253991
|
+
"description": "Array of redirect URIs for use in redirect-based flows"
|
|
253992
|
+
},
|
|
253993
|
+
"grant_types": {
|
|
253994
|
+
"type": "array",
|
|
253995
|
+
"items": {
|
|
253996
|
+
"type": "string",
|
|
253997
|
+
"enum": [
|
|
253998
|
+
"authorization_code",
|
|
253999
|
+
"refresh_token"
|
|
254000
|
+
]
|
|
254001
|
+
},
|
|
254002
|
+
"description": "Array of OAuth 2.0 grant types"
|
|
254003
|
+
},
|
|
254004
|
+
"response_types": {
|
|
254005
|
+
"type": "array",
|
|
254006
|
+
"items": {
|
|
254007
|
+
"type": "string",
|
|
254008
|
+
"enum": [
|
|
254009
|
+
"code"
|
|
254010
|
+
]
|
|
254011
|
+
},
|
|
254012
|
+
"description": "Array of OAuth 2.0 response types"
|
|
254013
|
+
},
|
|
254014
|
+
"token_endpoint_auth_method": {
|
|
254015
|
+
"type": "string",
|
|
254016
|
+
"description": "Authentication method for the token endpoint",
|
|
254017
|
+
"enum": [
|
|
254018
|
+
"client_secret_basic",
|
|
254019
|
+
"client_secret_post",
|
|
254020
|
+
"none"
|
|
254021
|
+
]
|
|
254022
|
+
},
|
|
254023
|
+
"scope": {
|
|
254024
|
+
"type": "array",
|
|
254025
|
+
"uniqueItems": true,
|
|
254026
|
+
"items": {
|
|
254027
|
+
"type": "string",
|
|
254028
|
+
"description": "OAuth-supported user-context API scope. See the `scopes_supported` field of the OAuth authorization server metadata document at /.well-known/oauth-authorization-server for the authoritative list.",
|
|
254029
|
+
"enum": [
|
|
254030
|
+
"all.Application.read",
|
|
254031
|
+
"all.Application.bounded",
|
|
254032
|
+
"only.Organization.read",
|
|
254033
|
+
"only.Organization.bounded",
|
|
254034
|
+
"all.Organization.read",
|
|
254035
|
+
"all.Organization.bounded",
|
|
254036
|
+
"only.User.read"
|
|
254037
|
+
]
|
|
254038
|
+
},
|
|
254039
|
+
"description": "API scopes this client may request"
|
|
254040
|
+
},
|
|
254041
|
+
"contacts": {
|
|
254042
|
+
"type": "array",
|
|
254043
|
+
"maxItems": 10,
|
|
254044
|
+
"items": {
|
|
254045
|
+
"type": "string",
|
|
254046
|
+
"format": "email",
|
|
254047
|
+
"maxLength": 1024
|
|
254048
|
+
},
|
|
254049
|
+
"description": "Contact email addresses for this client"
|
|
254050
|
+
},
|
|
254051
|
+
"tos_uri": {
|
|
254052
|
+
"type": "string",
|
|
254053
|
+
"format": "uri",
|
|
254054
|
+
"maxLength": 1024
|
|
254055
|
+
},
|
|
254056
|
+
"policy_uri": {
|
|
254057
|
+
"type": "string",
|
|
254058
|
+
"format": "uri",
|
|
254059
|
+
"maxLength": 1024
|
|
254060
|
+
}
|
|
254061
|
+
}
|
|
254062
|
+
}
|
|
254063
|
+
```
|
|
254064
|
+
### <a name="user-oauth-client-example"></a> Example
|
|
254065
|
+
|
|
254066
|
+
```json
|
|
254067
|
+
{
|
|
254068
|
+
"id": "575ec7417ae143cd83dc4a95",
|
|
254069
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
|
254070
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
|
254071
|
+
"client_id": "575ec7417ae143cd83dc4a95",
|
|
254072
|
+
"client_secret": "8f14e45fceea167a5a36dedd4bea2543",
|
|
254073
|
+
"client_name": "My Private Client",
|
|
254074
|
+
"description": "Private OAuth client for automation",
|
|
254075
|
+
"client_uri": "https://example.com",
|
|
254076
|
+
"logo_uri": "https://example.com/logo.png",
|
|
254077
|
+
"redirect_uris": [
|
|
254078
|
+
"https://example.com/callback"
|
|
254079
|
+
],
|
|
254080
|
+
"grant_types": [
|
|
254081
|
+
"authorization_code",
|
|
254082
|
+
"refresh_token"
|
|
254083
|
+
],
|
|
254084
|
+
"response_types": [
|
|
254085
|
+
"code"
|
|
254086
|
+
],
|
|
254087
|
+
"token_endpoint_auth_method": "client_secret_basic",
|
|
254088
|
+
"scope": [
|
|
254089
|
+
"only.User.read",
|
|
254090
|
+
"all.Application.read"
|
|
254091
|
+
],
|
|
254092
|
+
"contacts": [
|
|
254093
|
+
"admin@example.com"
|
|
254094
|
+
],
|
|
254095
|
+
"tos_uri": "https://example.com/tos",
|
|
254096
|
+
"policy_uri": "https://example.com/privacy"
|
|
254097
|
+
}
|
|
254098
|
+
```
|
|
254099
|
+
|
|
254100
|
+
<br/>
|
|
254101
|
+
|
|
254102
|
+
## User OAuth Client Patch
|
|
254103
|
+
|
|
254104
|
+
Schema for the body of a private OAuth client modification request
|
|
254105
|
+
|
|
254106
|
+
### <a name="user-oauth-client-patch-schema"></a> Schema
|
|
254107
|
+
|
|
254108
|
+
```json
|
|
254109
|
+
{
|
|
254110
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
254111
|
+
"type": "object",
|
|
254112
|
+
"properties": {
|
|
254113
|
+
"client_name": {
|
|
254114
|
+
"type": "string",
|
|
254115
|
+
"minLength": 1,
|
|
254116
|
+
"maxLength": 255
|
|
254117
|
+
},
|
|
254118
|
+
"description": {
|
|
254119
|
+
"type": "string",
|
|
254120
|
+
"maxLength": 32767
|
|
254121
|
+
},
|
|
254122
|
+
"client_uri": {
|
|
254123
|
+
"oneOf": [
|
|
254124
|
+
{
|
|
254125
|
+
"type": "string",
|
|
254126
|
+
"format": "uri",
|
|
254127
|
+
"maxLength": 1024
|
|
254128
|
+
},
|
|
254129
|
+
{
|
|
254130
|
+
"type": "null"
|
|
254131
|
+
}
|
|
254132
|
+
]
|
|
254133
|
+
},
|
|
254134
|
+
"logo_uri": {
|
|
254135
|
+
"oneOf": [
|
|
254136
|
+
{
|
|
254137
|
+
"type": "string",
|
|
254138
|
+
"format": "uri",
|
|
254139
|
+
"maxLength": 32768,
|
|
254140
|
+
"description": "URL of the client's logo. May be an http(s) URL or a data:image/* URI."
|
|
254141
|
+
},
|
|
254142
|
+
{
|
|
254143
|
+
"type": "null"
|
|
254144
|
+
}
|
|
254145
|
+
]
|
|
254146
|
+
},
|
|
254147
|
+
"redirect_uris": {
|
|
254148
|
+
"type": "array",
|
|
254149
|
+
"minItems": 1,
|
|
254150
|
+
"maxItems": 25,
|
|
254151
|
+
"items": {
|
|
254152
|
+
"type": "string",
|
|
254153
|
+
"format": "uri",
|
|
254154
|
+
"maxLength": 1024
|
|
254155
|
+
},
|
|
254156
|
+
"description": "Array of redirect URIs for use in redirect-based flows"
|
|
254157
|
+
},
|
|
254158
|
+
"token_endpoint_auth_method": {
|
|
254159
|
+
"type": "string",
|
|
254160
|
+
"description": "Authentication method for the token endpoint",
|
|
254161
|
+
"enum": [
|
|
254162
|
+
"client_secret_basic",
|
|
254163
|
+
"client_secret_post",
|
|
254164
|
+
"none"
|
|
254165
|
+
]
|
|
254166
|
+
},
|
|
254167
|
+
"scope": {
|
|
254168
|
+
"type": "array",
|
|
254169
|
+
"uniqueItems": true,
|
|
254170
|
+
"items": {
|
|
254171
|
+
"type": "string",
|
|
254172
|
+
"description": "OAuth-supported user-context API scope. See the `scopes_supported` field of the OAuth authorization server metadata document at /.well-known/oauth-authorization-server for the authoritative list.",
|
|
254173
|
+
"enum": [
|
|
254174
|
+
"all.Application.read",
|
|
254175
|
+
"all.Application.bounded",
|
|
254176
|
+
"only.Organization.read",
|
|
254177
|
+
"only.Organization.bounded",
|
|
254178
|
+
"all.Organization.read",
|
|
254179
|
+
"all.Organization.bounded",
|
|
254180
|
+
"only.User.read"
|
|
254181
|
+
]
|
|
254182
|
+
},
|
|
254183
|
+
"description": "API scopes this client may request"
|
|
254184
|
+
},
|
|
254185
|
+
"contacts": {
|
|
254186
|
+
"type": "array",
|
|
254187
|
+
"maxItems": 10,
|
|
254188
|
+
"items": {
|
|
254189
|
+
"type": "string",
|
|
254190
|
+
"format": "email",
|
|
254191
|
+
"maxLength": 1024
|
|
254192
|
+
},
|
|
254193
|
+
"description": "Contact email addresses for this client"
|
|
254194
|
+
},
|
|
254195
|
+
"tos_uri": {
|
|
254196
|
+
"oneOf": [
|
|
254197
|
+
{
|
|
254198
|
+
"type": "string",
|
|
254199
|
+
"format": "uri",
|
|
254200
|
+
"maxLength": 1024
|
|
254201
|
+
},
|
|
254202
|
+
{
|
|
254203
|
+
"type": "null"
|
|
254204
|
+
}
|
|
254205
|
+
]
|
|
254206
|
+
},
|
|
254207
|
+
"policy_uri": {
|
|
254208
|
+
"oneOf": [
|
|
254209
|
+
{
|
|
254210
|
+
"type": "string",
|
|
254211
|
+
"format": "uri",
|
|
254212
|
+
"maxLength": 1024
|
|
254213
|
+
},
|
|
254214
|
+
{
|
|
254215
|
+
"type": "null"
|
|
254216
|
+
}
|
|
254217
|
+
]
|
|
254218
|
+
}
|
|
254219
|
+
},
|
|
254220
|
+
"additionalProperties": false
|
|
254221
|
+
}
|
|
254222
|
+
```
|
|
254223
|
+
### <a name="user-oauth-client-patch-example"></a> Example
|
|
254224
|
+
|
|
254225
|
+
```json
|
|
254226
|
+
{
|
|
254227
|
+
"client_name": "Updated Private Client Name",
|
|
254228
|
+
"description": "Updated description",
|
|
254229
|
+
"redirect_uris": [
|
|
254230
|
+
"https://example.com/new-callback"
|
|
254231
|
+
]
|
|
254232
|
+
}
|
|
254233
|
+
```
|
|
254234
|
+
|
|
254235
|
+
<br/>
|
|
254236
|
+
|
|
254237
|
+
## User OAuth Client Post
|
|
254238
|
+
|
|
254239
|
+
Schema for the body of a private OAuth client creation request
|
|
254240
|
+
|
|
254241
|
+
### <a name="user-oauth-client-post-schema"></a> Schema
|
|
254242
|
+
|
|
254243
|
+
```json
|
|
254244
|
+
{
|
|
254245
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
254246
|
+
"type": "object",
|
|
254247
|
+
"properties": {
|
|
254248
|
+
"client_name": {
|
|
254249
|
+
"type": "string",
|
|
254250
|
+
"minLength": 1,
|
|
254251
|
+
"maxLength": 255
|
|
254252
|
+
},
|
|
254253
|
+
"description": {
|
|
254254
|
+
"type": "string",
|
|
254255
|
+
"maxLength": 32767
|
|
254256
|
+
},
|
|
254257
|
+
"client_uri": {
|
|
254258
|
+
"oneOf": [
|
|
254259
|
+
{
|
|
254260
|
+
"type": "string",
|
|
254261
|
+
"format": "uri",
|
|
254262
|
+
"maxLength": 1024
|
|
254263
|
+
},
|
|
254264
|
+
{
|
|
254265
|
+
"type": "null"
|
|
254266
|
+
}
|
|
254267
|
+
]
|
|
254268
|
+
},
|
|
254269
|
+
"logo_uri": {
|
|
254270
|
+
"oneOf": [
|
|
254271
|
+
{
|
|
254272
|
+
"type": "string",
|
|
254273
|
+
"format": "uri",
|
|
254274
|
+
"maxLength": 32768,
|
|
254275
|
+
"description": "URL of the client's logo. May be an http(s) URL or a data:image/* URI."
|
|
254276
|
+
},
|
|
254277
|
+
{
|
|
254278
|
+
"type": "null"
|
|
254279
|
+
}
|
|
254280
|
+
]
|
|
254281
|
+
},
|
|
254282
|
+
"redirect_uris": {
|
|
254283
|
+
"type": "array",
|
|
254284
|
+
"minItems": 1,
|
|
254285
|
+
"maxItems": 25,
|
|
254286
|
+
"items": {
|
|
254287
|
+
"type": "string",
|
|
254288
|
+
"format": "uri",
|
|
254289
|
+
"maxLength": 1024
|
|
254290
|
+
},
|
|
254291
|
+
"description": "Array of redirect URIs for use in redirect-based flows"
|
|
254292
|
+
},
|
|
254293
|
+
"token_endpoint_auth_method": {
|
|
254294
|
+
"type": "string",
|
|
254295
|
+
"description": "Authentication method for the token endpoint",
|
|
254296
|
+
"enum": [
|
|
254297
|
+
"client_secret_basic",
|
|
254298
|
+
"client_secret_post",
|
|
254299
|
+
"none"
|
|
254300
|
+
]
|
|
254301
|
+
},
|
|
254302
|
+
"scope": {
|
|
254303
|
+
"type": "array",
|
|
254304
|
+
"uniqueItems": true,
|
|
254305
|
+
"items": {
|
|
254306
|
+
"type": "string",
|
|
254307
|
+
"description": "OAuth-supported user-context API scope. See the `scopes_supported` field of the OAuth authorization server metadata document at /.well-known/oauth-authorization-server for the authoritative list.",
|
|
254308
|
+
"enum": [
|
|
254309
|
+
"all.Application.read",
|
|
254310
|
+
"all.Application.bounded",
|
|
254311
|
+
"only.Organization.read",
|
|
254312
|
+
"only.Organization.bounded",
|
|
254313
|
+
"all.Organization.read",
|
|
254314
|
+
"all.Organization.bounded",
|
|
254315
|
+
"only.User.read"
|
|
254316
|
+
]
|
|
254317
|
+
},
|
|
254318
|
+
"description": "API scopes this client may request"
|
|
254319
|
+
},
|
|
254320
|
+
"contacts": {
|
|
254321
|
+
"type": "array",
|
|
254322
|
+
"maxItems": 10,
|
|
254323
|
+
"items": {
|
|
254324
|
+
"type": "string",
|
|
254325
|
+
"format": "email",
|
|
254326
|
+
"maxLength": 1024
|
|
254327
|
+
},
|
|
254328
|
+
"description": "Contact email addresses for this client"
|
|
254329
|
+
},
|
|
254330
|
+
"tos_uri": {
|
|
254331
|
+
"oneOf": [
|
|
254332
|
+
{
|
|
254333
|
+
"type": "string",
|
|
254334
|
+
"format": "uri",
|
|
254335
|
+
"maxLength": 1024
|
|
254336
|
+
},
|
|
254337
|
+
{
|
|
254338
|
+
"type": "null"
|
|
254339
|
+
}
|
|
254340
|
+
]
|
|
254341
|
+
},
|
|
254342
|
+
"policy_uri": {
|
|
254343
|
+
"oneOf": [
|
|
254344
|
+
{
|
|
254345
|
+
"type": "string",
|
|
254346
|
+
"format": "uri",
|
|
254347
|
+
"maxLength": 1024
|
|
254348
|
+
},
|
|
254349
|
+
{
|
|
254350
|
+
"type": "null"
|
|
254351
|
+
}
|
|
254352
|
+
]
|
|
254353
|
+
}
|
|
254354
|
+
},
|
|
254355
|
+
"additionalProperties": false,
|
|
254356
|
+
"required": [
|
|
254357
|
+
"client_name",
|
|
254358
|
+
"redirect_uris"
|
|
254359
|
+
]
|
|
254360
|
+
}
|
|
254361
|
+
```
|
|
254362
|
+
### <a name="user-oauth-client-post-example"></a> Example
|
|
254363
|
+
|
|
254364
|
+
```json
|
|
254365
|
+
{
|
|
254366
|
+
"client_name": "My Private Client",
|
|
254367
|
+
"description": "Private OAuth client for automation",
|
|
254368
|
+
"client_uri": "https://example.com",
|
|
254369
|
+
"logo_uri": "https://example.com/logo.png",
|
|
254370
|
+
"redirect_uris": [
|
|
254371
|
+
"https://example.com/callback"
|
|
254372
|
+
],
|
|
254373
|
+
"token_endpoint_auth_method": "client_secret_basic",
|
|
254374
|
+
"scope": [
|
|
254375
|
+
"only.User.read",
|
|
254376
|
+
"all.Application.read"
|
|
254377
|
+
],
|
|
254378
|
+
"contacts": [
|
|
254379
|
+
"admin@example.com"
|
|
254380
|
+
],
|
|
254381
|
+
"tos_uri": "https://example.com/tos",
|
|
254382
|
+
"policy_uri": "https://example.com/privacy"
|
|
254383
|
+
}
|
|
254384
|
+
```
|
|
254385
|
+
|
|
254386
|
+
<br/>
|
|
254387
|
+
|
|
254388
|
+
## User OAuth Clients
|
|
254389
|
+
|
|
254390
|
+
Schema for a collection of private OAuth clients
|
|
254391
|
+
|
|
254392
|
+
### <a name="user-oauth-clients-schema"></a> Schema
|
|
254393
|
+
|
|
254394
|
+
```json
|
|
254395
|
+
{
|
|
254396
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
254397
|
+
"type": "object",
|
|
254398
|
+
"properties": {
|
|
254399
|
+
"items": {
|
|
254400
|
+
"type": "array",
|
|
254401
|
+
"items": {
|
|
254402
|
+
"title": "User OAuth Client",
|
|
254403
|
+
"description": "Schema for a single private OAuth client",
|
|
254404
|
+
"type": "object",
|
|
254405
|
+
"properties": {
|
|
254406
|
+
"id": {
|
|
254407
|
+
"type": "string",
|
|
254408
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
254409
|
+
},
|
|
254410
|
+
"creationDate": {
|
|
254411
|
+
"type": "string",
|
|
254412
|
+
"format": "date-time"
|
|
254413
|
+
},
|
|
254414
|
+
"lastUpdated": {
|
|
254415
|
+
"type": "string",
|
|
254416
|
+
"format": "date-time"
|
|
254417
|
+
},
|
|
254418
|
+
"client_id": {
|
|
254419
|
+
"type": "string",
|
|
254420
|
+
"description": "Unique client identifier"
|
|
254421
|
+
},
|
|
254422
|
+
"client_secret": {
|
|
254423
|
+
"type": "string",
|
|
254424
|
+
"description": "Client secret. Only ever included in the response to the initial creation request."
|
|
254425
|
+
},
|
|
254426
|
+
"client_name": {
|
|
254427
|
+
"type": "string",
|
|
254428
|
+
"minLength": 1,
|
|
254429
|
+
"maxLength": 255
|
|
254430
|
+
},
|
|
254431
|
+
"description": {
|
|
254432
|
+
"type": "string",
|
|
254433
|
+
"maxLength": 32767
|
|
254434
|
+
},
|
|
254435
|
+
"client_uri": {
|
|
254436
|
+
"type": "string",
|
|
254437
|
+
"format": "uri",
|
|
254438
|
+
"maxLength": 1024
|
|
254439
|
+
},
|
|
254440
|
+
"logo_uri": {
|
|
254441
|
+
"type": "string",
|
|
254442
|
+
"format": "uri",
|
|
254443
|
+
"maxLength": 32768,
|
|
254444
|
+
"description": "URL of the client's logo. May be an http(s) URL or a data:image/* URI."
|
|
254445
|
+
},
|
|
254446
|
+
"redirect_uris": {
|
|
254447
|
+
"type": "array",
|
|
254448
|
+
"minItems": 1,
|
|
254449
|
+
"maxItems": 25,
|
|
254450
|
+
"items": {
|
|
254451
|
+
"type": "string",
|
|
254452
|
+
"format": "uri",
|
|
254453
|
+
"maxLength": 1024
|
|
254454
|
+
},
|
|
254455
|
+
"description": "Array of redirect URIs for use in redirect-based flows"
|
|
254456
|
+
},
|
|
254457
|
+
"grant_types": {
|
|
254458
|
+
"type": "array",
|
|
254459
|
+
"items": {
|
|
254460
|
+
"type": "string",
|
|
254461
|
+
"enum": [
|
|
254462
|
+
"authorization_code",
|
|
254463
|
+
"refresh_token"
|
|
254464
|
+
]
|
|
254465
|
+
},
|
|
254466
|
+
"description": "Array of OAuth 2.0 grant types"
|
|
254467
|
+
},
|
|
254468
|
+
"response_types": {
|
|
254469
|
+
"type": "array",
|
|
254470
|
+
"items": {
|
|
254471
|
+
"type": "string",
|
|
254472
|
+
"enum": [
|
|
254473
|
+
"code"
|
|
254474
|
+
]
|
|
254475
|
+
},
|
|
254476
|
+
"description": "Array of OAuth 2.0 response types"
|
|
254477
|
+
},
|
|
254478
|
+
"token_endpoint_auth_method": {
|
|
254479
|
+
"type": "string",
|
|
254480
|
+
"description": "Authentication method for the token endpoint",
|
|
254481
|
+
"enum": [
|
|
254482
|
+
"client_secret_basic",
|
|
254483
|
+
"client_secret_post",
|
|
254484
|
+
"none"
|
|
254485
|
+
]
|
|
254486
|
+
},
|
|
254487
|
+
"scope": {
|
|
254488
|
+
"type": "array",
|
|
254489
|
+
"uniqueItems": true,
|
|
254490
|
+
"items": {
|
|
254491
|
+
"type": "string",
|
|
254492
|
+
"description": "OAuth-supported user-context API scope. See the `scopes_supported` field of the OAuth authorization server metadata document at /.well-known/oauth-authorization-server for the authoritative list.",
|
|
254493
|
+
"enum": [
|
|
254494
|
+
"all.Application.read",
|
|
254495
|
+
"all.Application.bounded",
|
|
254496
|
+
"only.Organization.read",
|
|
254497
|
+
"only.Organization.bounded",
|
|
254498
|
+
"all.Organization.read",
|
|
254499
|
+
"all.Organization.bounded",
|
|
254500
|
+
"only.User.read"
|
|
254501
|
+
]
|
|
254502
|
+
},
|
|
254503
|
+
"description": "API scopes this client may request"
|
|
254504
|
+
},
|
|
254505
|
+
"contacts": {
|
|
254506
|
+
"type": "array",
|
|
254507
|
+
"maxItems": 10,
|
|
254508
|
+
"items": {
|
|
254509
|
+
"type": "string",
|
|
254510
|
+
"format": "email",
|
|
254511
|
+
"maxLength": 1024
|
|
254512
|
+
},
|
|
254513
|
+
"description": "Contact email addresses for this client"
|
|
254514
|
+
},
|
|
254515
|
+
"tos_uri": {
|
|
254516
|
+
"type": "string",
|
|
254517
|
+
"format": "uri",
|
|
254518
|
+
"maxLength": 1024
|
|
254519
|
+
},
|
|
254520
|
+
"policy_uri": {
|
|
254521
|
+
"type": "string",
|
|
254522
|
+
"format": "uri",
|
|
254523
|
+
"maxLength": 1024
|
|
254524
|
+
}
|
|
254525
|
+
}
|
|
254526
|
+
}
|
|
254527
|
+
},
|
|
254528
|
+
"count": {
|
|
254529
|
+
"type": "integer"
|
|
254530
|
+
},
|
|
254531
|
+
"totalCount": {
|
|
254532
|
+
"type": "integer"
|
|
254533
|
+
},
|
|
254534
|
+
"perPage": {
|
|
254535
|
+
"type": "integer"
|
|
254536
|
+
},
|
|
254537
|
+
"page": {
|
|
254538
|
+
"type": "integer"
|
|
254539
|
+
},
|
|
254540
|
+
"filter": {
|
|
254541
|
+
"type": "string"
|
|
254542
|
+
},
|
|
254543
|
+
"filterField": {
|
|
254544
|
+
"type": "string"
|
|
254545
|
+
},
|
|
254546
|
+
"sortField": {
|
|
254547
|
+
"type": "string"
|
|
254548
|
+
},
|
|
254549
|
+
"sortDirection": {
|
|
254550
|
+
"type": "string",
|
|
254551
|
+
"enum": [
|
|
254552
|
+
"asc",
|
|
254553
|
+
"desc",
|
|
254554
|
+
"ASC",
|
|
254555
|
+
"DESC",
|
|
254556
|
+
""
|
|
254557
|
+
]
|
|
254558
|
+
}
|
|
254559
|
+
}
|
|
254560
|
+
}
|
|
254561
|
+
```
|
|
254562
|
+
### <a name="user-oauth-clients-example"></a> Example
|
|
254563
|
+
|
|
254564
|
+
```json
|
|
254565
|
+
{
|
|
254566
|
+
"items": [
|
|
254567
|
+
{
|
|
254568
|
+
"id": "575ec7417ae143cd83dc4a95",
|
|
254569
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
|
254570
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
|
254571
|
+
"client_id": "575ec7417ae143cd83dc4a95",
|
|
254572
|
+
"client_secret": "8f14e45fceea167a5a36dedd4bea2543",
|
|
254573
|
+
"client_name": "My Private Client",
|
|
254574
|
+
"description": "Private OAuth client for automation",
|
|
254575
|
+
"client_uri": "https://example.com",
|
|
254576
|
+
"logo_uri": "https://example.com/logo.png",
|
|
254577
|
+
"redirect_uris": [
|
|
254578
|
+
"https://example.com/callback"
|
|
254579
|
+
],
|
|
254580
|
+
"grant_types": [
|
|
254581
|
+
"authorization_code",
|
|
254582
|
+
"refresh_token"
|
|
254583
|
+
],
|
|
254584
|
+
"response_types": [
|
|
254585
|
+
"code"
|
|
254586
|
+
],
|
|
254587
|
+
"token_endpoint_auth_method": "client_secret_basic",
|
|
254588
|
+
"scope": [
|
|
254589
|
+
"only.User.read",
|
|
254590
|
+
"all.Application.read"
|
|
254591
|
+
],
|
|
254592
|
+
"contacts": [
|
|
254593
|
+
"admin@example.com"
|
|
254594
|
+
],
|
|
254595
|
+
"tos_uri": "https://example.com/tos",
|
|
254596
|
+
"policy_uri": "https://example.com/privacy"
|
|
254597
|
+
}
|
|
254598
|
+
],
|
|
254599
|
+
"count": 1,
|
|
254600
|
+
"totalCount": 1,
|
|
254601
|
+
"perPage": 1000,
|
|
254602
|
+
"page": 0,
|
|
254603
|
+
"sortField": "client_name",
|
|
254604
|
+
"sortDirection": "asc"
|
|
254605
|
+
}
|
|
254606
|
+
```
|
|
254607
|
+
|
|
254608
|
+
<br/>
|
|
254609
|
+
|
|
252585
254610
|
## User OAuth Token
|
|
252586
254611
|
|
|
252587
254612
|
Schema for a single OAuth Token
|
|
@@ -253545,6 +255570,15 @@ Schema for the body of a User creation request
|
|
|
253545
255570
|
"type": "string",
|
|
253546
255571
|
"maxLength": 1024
|
|
253547
255572
|
},
|
|
255573
|
+
"state": {
|
|
255574
|
+
"type": "string",
|
|
255575
|
+
"maxLength": 1024
|
|
255576
|
+
},
|
|
255577
|
+
"country": {
|
|
255578
|
+
"type": "string",
|
|
255579
|
+
"minLength": 1,
|
|
255580
|
+
"maxLength": 1024
|
|
255581
|
+
},
|
|
253548
255582
|
"oauth": {
|
|
253549
255583
|
"type": "object",
|
|
253550
255584
|
"properties": {
|
|
@@ -253979,6 +256013,7 @@ Schema for the body of a User creation request
|
|
|
253979
256013
|
"instance.payloadCountsBreakdown",
|
|
253980
256014
|
"instance.deviceCounts",
|
|
253981
256015
|
"instance.notebookMinuteCounts",
|
|
256016
|
+
"instance.entitlements",
|
|
253982
256017
|
"instanceOrg.*",
|
|
253983
256018
|
"instanceOrg.get",
|
|
253984
256019
|
"instanceOrg.patch",
|
|
@@ -253987,6 +256022,8 @@ Schema for the body of a User creation request
|
|
|
253987
256022
|
"instanceOrg.payloadCountsBreakdown",
|
|
253988
256023
|
"instanceOrg.deviceCounts",
|
|
253989
256024
|
"instanceOrg.notebookMinuteCounts",
|
|
256025
|
+
"instanceOrg.entitlement",
|
|
256026
|
+
"instanceOrg.entitlementSync",
|
|
253990
256027
|
"instanceOrg.convertToEnterprise",
|
|
253991
256028
|
"instanceOrgs.*",
|
|
253992
256029
|
"instanceOrgs.get",
|
|
@@ -254077,6 +256114,13 @@ Schema for the body of a User creation request
|
|
|
254077
256114
|
"userOauthTokens.*",
|
|
254078
256115
|
"userOauthTokens.get",
|
|
254079
256116
|
"userOauthTokens.post",
|
|
256117
|
+
"userOauthClient.*",
|
|
256118
|
+
"userOauthClient.get",
|
|
256119
|
+
"userOauthClient.patch",
|
|
256120
|
+
"userOauthClient.delete",
|
|
256121
|
+
"userOauthClients.*",
|
|
256122
|
+
"userOauthClients.get",
|
|
256123
|
+
"userOauthClients.post",
|
|
254080
256124
|
"applicationTemplate.*",
|
|
254081
256125
|
"applicationTemplate.get",
|
|
254082
256126
|
"applicationTemplates.*",
|
|
@@ -254107,6 +256151,7 @@ Schema for the body of a User creation request
|
|
|
254107
256151
|
"me.invites",
|
|
254108
256152
|
"me.respondToInvite",
|
|
254109
256153
|
"me.refreshToken",
|
|
256154
|
+
"me.entitlements",
|
|
254110
256155
|
"orgs.*",
|
|
254111
256156
|
"orgs.get",
|
|
254112
256157
|
"orgs.post"
|
|
@@ -254158,6 +256203,8 @@ Schema for the body of a User creation request
|
|
|
254158
256203
|
"lastName": "Name",
|
|
254159
256204
|
"companyName": "Example, Inc.",
|
|
254160
256205
|
"url": "https://example.com",
|
|
256206
|
+
"state": "Ohio",
|
|
256207
|
+
"country": "United States",
|
|
254161
256208
|
"password": "The new password1!",
|
|
254162
256209
|
"acceptTerms": "on"
|
|
254163
256210
|
}
|
|
@@ -254325,6 +256372,34 @@ Schema for the result of a validateContext call when invalid context is passed
|
|
|
254325
256372
|
}
|
|
254326
256373
|
},
|
|
254327
256374
|
"additionalProperties": false
|
|
256375
|
+
},
|
|
256376
|
+
"experienceGroups": {
|
|
256377
|
+
"type": "array",
|
|
256378
|
+
"items": {
|
|
256379
|
+
"type": "object",
|
|
256380
|
+
"properties": {
|
|
256381
|
+
"name": {
|
|
256382
|
+
"type": "string",
|
|
256383
|
+
"minLength": 1,
|
|
256384
|
+
"maxLength": 255
|
|
256385
|
+
},
|
|
256386
|
+
"id": {
|
|
256387
|
+
"type": "string",
|
|
256388
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
256389
|
+
},
|
|
256390
|
+
"parentId": {
|
|
256391
|
+
"oneOf": [
|
|
256392
|
+
{
|
|
256393
|
+
"type": "string",
|
|
256394
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
256395
|
+
},
|
|
256396
|
+
{
|
|
256397
|
+
"type": "null"
|
|
256398
|
+
}
|
|
256399
|
+
]
|
|
256400
|
+
}
|
|
256401
|
+
}
|
|
256402
|
+
}
|
|
254328
256403
|
}
|
|
254329
256404
|
}
|
|
254330
256405
|
}
|
|
@@ -254569,6 +256644,34 @@ Schema for the result of a successful validateContext call
|
|
|
254569
256644
|
}
|
|
254570
256645
|
},
|
|
254571
256646
|
"additionalProperties": false
|
|
256647
|
+
},
|
|
256648
|
+
"experienceGroups": {
|
|
256649
|
+
"type": "array",
|
|
256650
|
+
"items": {
|
|
256651
|
+
"type": "object",
|
|
256652
|
+
"properties": {
|
|
256653
|
+
"name": {
|
|
256654
|
+
"type": "string",
|
|
256655
|
+
"minLength": 1,
|
|
256656
|
+
"maxLength": 255
|
|
256657
|
+
},
|
|
256658
|
+
"id": {
|
|
256659
|
+
"type": "string",
|
|
256660
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
256661
|
+
},
|
|
256662
|
+
"parentId": {
|
|
256663
|
+
"oneOf": [
|
|
256664
|
+
{
|
|
256665
|
+
"type": "string",
|
|
256666
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
256667
|
+
},
|
|
256668
|
+
{
|
|
256669
|
+
"type": "null"
|
|
256670
|
+
}
|
|
256671
|
+
]
|
|
256672
|
+
}
|
|
256673
|
+
}
|
|
256674
|
+
}
|
|
254572
256675
|
}
|
|
254573
256676
|
}
|
|
254574
256677
|
}
|