losant_rest 2.0.0 → 2.1.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 +2454 -666
- data/docs/application.md +21 -21
- data/docs/applicationApiToken.md +1 -1
- data/docs/applicationApiTokens.md +1 -1
- data/docs/applicationCertificate.md +3 -3
- data/docs/applicationCertificateAuthorities.md +2 -2
- data/docs/applicationCertificateAuthority.md +3 -3
- data/docs/applicationCertificates.md +2 -2
- data/docs/applicationDashboard.md +4 -4
- data/docs/applicationDashboards.md +2 -2
- data/docs/applicationJobLog.md +1 -1
- data/docs/applicationJobLogs.md +1 -1
- data/docs/applicationKey.md +3 -3
- data/docs/applicationKeys.md +2 -2
- data/docs/applicationTemplate.md +1 -1
- data/docs/applicationTemplates.md +3 -3
- data/docs/applications.md +4 -4
- data/docs/auditLog.md +1 -1
- data/docs/auditLogs.md +1 -1
- data/docs/credential.md +4 -4
- data/docs/credentials.md +2 -2
- data/docs/dashboard.md +3 -3
- data/docs/dashboards.md +2 -2
- data/docs/data.md +3 -3
- data/docs/dataTable.md +5 -5
- data/docs/dataTableRow.md +3 -3
- data/docs/dataTableRows.md +6 -6
- data/docs/dataTables.md +2 -2
- data/docs/device.md +14 -14
- data/docs/deviceAttribute.md +3 -3
- data/docs/deviceAttributes.md +2 -2
- data/docs/deviceRecipe.md +4 -4
- data/docs/deviceRecipes.md +2 -2
- data/docs/devices.md +14 -14
- data/docs/edgeDeployment.md +1 -1
- data/docs/edgeDeployments.md +4 -4
- data/docs/embeddedDeployment.md +1 -1
- data/docs/embeddedDeployments.md +5 -5
- data/docs/event.md +3 -3
- data/docs/events.md +6 -6
- data/docs/experience.md +2 -2
- data/docs/experienceDomain.md +3 -3
- data/docs/experienceDomains.md +2 -2
- data/docs/experienceEndpoint.md +4 -4
- data/docs/experienceEndpoints.md +3 -3
- data/docs/experienceGroup.md +3 -3
- data/docs/experienceGroups.md +2 -2
- data/docs/experienceSlug.md +3 -3
- data/docs/experienceSlugs.md +2 -2
- data/docs/experienceUser.md +3 -3
- data/docs/experienceUsers.md +2 -2
- data/docs/experienceVersion.md +3 -3
- data/docs/experienceVersions.md +2 -2
- data/docs/experienceView.md +4 -4
- data/docs/experienceViews.md +2 -2
- data/docs/file.md +5 -5
- data/docs/files.md +2 -2
- data/docs/flow.md +11 -11
- data/docs/flowVersion.md +6 -6
- data/docs/flowVersions.md +3 -3
- data/docs/flows.md +5 -5
- data/docs/instance.md +8 -8
- data/docs/instanceApiToken.md +1 -1
- data/docs/instanceApiTokens.md +1 -1
- data/docs/instanceAuditLog.md +1 -1
- data/docs/instanceAuditLogs.md +1 -1
- data/docs/instanceCustomNode.md +5 -5
- data/docs/instanceCustomNodes.md +2 -2
- data/docs/instanceMember.md +1 -1
- data/docs/instanceMembers.md +1 -1
- data/docs/instanceNotificationRule.md +5 -5
- data/docs/instanceNotificationRules.md +2 -2
- data/docs/instanceOrg.md +7 -7
- data/docs/instanceOrgInvite.md +1 -1
- data/docs/instanceOrgInvites.md +1 -1
- data/docs/instanceOrgMember.md +1 -1
- data/docs/instanceOrgMembers.md +1 -1
- data/docs/instanceOrgs.md +2 -2
- data/docs/instanceSandbox.md +7 -7
- data/docs/instanceSandboxes.md +1 -1
- data/docs/instances.md +1 -1
- data/docs/integration.md +3 -3
- data/docs/integrations.md +2 -2
- data/docs/me.md +20 -20
- data/docs/notebook.md +9 -9
- data/docs/notebooks.md +2 -2
- data/docs/org.md +13 -13
- data/docs/orgs.md +2 -2
- data/docs/privateFile.md +5 -5
- data/docs/privateFiles.md +2 -2
- data/docs/resourceJob.md +6 -6
- data/docs/resourceJobs.md +2 -2
- data/docs/userApiToken.md +3 -3
- data/docs/userApiTokens.md +2 -2
- data/docs/userOauthToken.md +125 -0
- data/docs/userOauthTokens.md +87 -0
- data/docs/webhook.md +3 -3
- data/docs/webhooks.md +2 -2
- data/lib/platform_rest/application.rb +20 -20
- data/lib/platform_rest/application_api_token.rb +1 -1
- data/lib/platform_rest/application_api_tokens.rb +1 -1
- data/lib/platform_rest/application_certificate.rb +3 -3
- data/lib/platform_rest/application_certificate_authorities.rb +2 -2
- data/lib/platform_rest/application_certificate_authority.rb +3 -3
- data/lib/platform_rest/application_certificates.rb +2 -2
- data/lib/platform_rest/application_dashboard.rb +4 -4
- data/lib/platform_rest/application_dashboards.rb +2 -2
- data/lib/platform_rest/application_job_log.rb +1 -1
- data/lib/platform_rest/application_job_logs.rb +1 -1
- data/lib/platform_rest/application_key.rb +3 -3
- data/lib/platform_rest/application_keys.rb +2 -2
- data/lib/platform_rest/application_template.rb +1 -1
- data/lib/platform_rest/application_templates.rb +3 -3
- data/lib/platform_rest/applications.rb +3 -3
- data/lib/platform_rest/audit_log.rb +1 -1
- data/lib/platform_rest/audit_logs.rb +1 -1
- data/lib/platform_rest/client.rb +10 -2
- data/lib/platform_rest/credential.rb +4 -4
- data/lib/platform_rest/credentials.rb +2 -2
- data/lib/platform_rest/dashboard.rb +3 -3
- data/lib/platform_rest/dashboards.rb +2 -2
- data/lib/platform_rest/data.rb +3 -3
- data/lib/platform_rest/data_table.rb +5 -5
- data/lib/platform_rest/data_table_row.rb +3 -3
- data/lib/platform_rest/data_table_rows.rb +6 -6
- data/lib/platform_rest/data_tables.rb +2 -2
- data/lib/platform_rest/device.rb +14 -14
- data/lib/platform_rest/device_attribute.rb +3 -3
- data/lib/platform_rest/device_attributes.rb +2 -2
- data/lib/platform_rest/device_recipe.rb +4 -4
- data/lib/platform_rest/device_recipes.rb +2 -2
- data/lib/platform_rest/devices.rb +14 -14
- data/lib/platform_rest/edge_deployment.rb +1 -1
- data/lib/platform_rest/edge_deployments.rb +4 -4
- data/lib/platform_rest/embedded_deployment.rb +1 -1
- data/lib/platform_rest/embedded_deployments.rb +5 -5
- data/lib/platform_rest/event.rb +3 -3
- data/lib/platform_rest/events.rb +6 -6
- data/lib/platform_rest/experience.rb +2 -2
- data/lib/platform_rest/experience_domain.rb +3 -3
- data/lib/platform_rest/experience_domains.rb +2 -2
- data/lib/platform_rest/experience_endpoint.rb +4 -4
- data/lib/platform_rest/experience_endpoints.rb +3 -3
- data/lib/platform_rest/experience_group.rb +3 -3
- data/lib/platform_rest/experience_groups.rb +2 -2
- data/lib/platform_rest/experience_slug.rb +3 -3
- data/lib/platform_rest/experience_slugs.rb +2 -2
- data/lib/platform_rest/experience_user.rb +3 -3
- data/lib/platform_rest/experience_users.rb +2 -2
- data/lib/platform_rest/experience_version.rb +3 -3
- data/lib/platform_rest/experience_versions.rb +2 -2
- data/lib/platform_rest/experience_view.rb +4 -4
- data/lib/platform_rest/experience_views.rb +2 -2
- data/lib/platform_rest/file.rb +4 -4
- data/lib/platform_rest/files.rb +2 -2
- data/lib/platform_rest/flow.rb +11 -11
- data/lib/platform_rest/flow_version.rb +6 -6
- data/lib/platform_rest/flow_versions.rb +3 -3
- data/lib/platform_rest/flows.rb +5 -5
- data/lib/platform_rest/instance.rb +8 -8
- data/lib/platform_rest/instance_api_token.rb +1 -1
- data/lib/platform_rest/instance_api_tokens.rb +1 -1
- data/lib/platform_rest/instance_audit_log.rb +1 -1
- data/lib/platform_rest/instance_audit_logs.rb +1 -1
- data/lib/platform_rest/instance_custom_node.rb +5 -5
- data/lib/platform_rest/instance_custom_nodes.rb +2 -2
- data/lib/platform_rest/instance_member.rb +1 -1
- data/lib/platform_rest/instance_members.rb +1 -1
- data/lib/platform_rest/instance_notification_rule.rb +5 -5
- data/lib/platform_rest/instance_notification_rules.rb +2 -2
- data/lib/platform_rest/instance_org.rb +7 -7
- data/lib/platform_rest/instance_org_invite.rb +1 -1
- data/lib/platform_rest/instance_org_invites.rb +1 -1
- data/lib/platform_rest/instance_org_member.rb +1 -1
- data/lib/platform_rest/instance_org_members.rb +1 -1
- data/lib/platform_rest/instance_orgs.rb +2 -2
- data/lib/platform_rest/instance_sandbox.rb +7 -7
- data/lib/platform_rest/instance_sandboxes.rb +1 -1
- data/lib/platform_rest/instances.rb +1 -1
- data/lib/platform_rest/integration.rb +3 -3
- data/lib/platform_rest/integrations.rb +2 -2
- data/lib/platform_rest/me.rb +20 -20
- data/lib/platform_rest/notebook.rb +8 -8
- data/lib/platform_rest/notebooks.rb +2 -2
- data/lib/platform_rest/org.rb +13 -13
- data/lib/platform_rest/orgs.rb +2 -2
- data/lib/platform_rest/private_file.rb +4 -4
- data/lib/platform_rest/private_files.rb +2 -2
- data/lib/platform_rest/resource_job.rb +6 -6
- data/lib/platform_rest/resource_jobs.rb +2 -2
- data/lib/platform_rest/user_api_token.rb +3 -3
- data/lib/platform_rest/user_api_tokens.rb +2 -2
- data/lib/platform_rest/user_oauth_token.rb +170 -0
- data/lib/platform_rest/user_oauth_tokens.rb +132 -0
- data/lib/platform_rest/version.rb +1 -1
- data/lib/platform_rest/webhook.rb +3 -3
- data/lib/platform_rest/webhooks.rb +2 -2
- data/lib/platform_rest.rb +2 -0
- data/schemas/apiToken.json +100 -0
- data/schemas/apiTokenPatch.json +100 -0
- data/schemas/apiTokenPost.json +118 -0
- data/schemas/apiTokens.json +100 -0
- data/schemas/applicationDashboardPost.json +4 -0
- data/schemas/dashboard.json +4 -0
- data/schemas/dashboardPatch.json +4 -0
- data/schemas/dashboardPost.json +4 -0
- data/schemas/dashboards.json +4 -0
- data/schemas/githubLogin.json +18 -0
- data/schemas/instanceOrgMemberPatch.json +2 -2
- data/schemas/instanceOrgMemberPost.json +4 -4
- data/schemas/instanceOrgPost.json +4 -4
- data/schemas/oauthClient.json +107 -0
- data/schemas/oauthClientPost.json +89 -0
- data/schemas/oauthDcrError.json +23 -0
- data/schemas/oauthError.json +31 -0
- data/schemas/org.json +2 -2
- data/schemas/orgInvite.json +2 -2
- data/schemas/orgInviteCollection.json +2 -2
- data/schemas/orgInvitePost.json +2 -2
- data/schemas/orgInvites.json +2 -2
- data/schemas/orgMemberPatch.json +2 -2
- data/schemas/orgRoleInfo.json +2 -2
- data/schemas/orgs.json +2 -2
- data/schemas/samlResponse.json +18 -0
- data/schemas/userCredentials.json +18 -0
- data/schemas/userOauthToken.json +207 -0
- data/schemas/userOauthTokenPatch.json +123 -0
- data/schemas/userOauthTokenPost.json +197 -0
- data/schemas/userOauthTokens.json +248 -0
- data/schemas/userPost.json +18 -0
- metadata +13 -1
data/docs/_schemas.md
CHANGED
|
@@ -261,6 +261,10 @@
|
|
|
261
261
|
* [Notification Rule Patch](#notification-rule-patch)
|
|
262
262
|
* [Notification Rule Post](#notification-rule-post)
|
|
263
263
|
* [Notification Rules](#notification-rules)
|
|
264
|
+
* [OAuth Client](#oauth-client)
|
|
265
|
+
* [OAuth Client Registration Request](#oauth-client-registration-request)
|
|
266
|
+
* [OAuth DCR Error](#oauth-dcr-error)
|
|
267
|
+
* [OAuth Error](#oauth-error)
|
|
264
268
|
* [Organization](#organization)
|
|
265
269
|
* [Organization Invitation](#organization-invitation)
|
|
266
270
|
* [Organization Invitation Action](#organization-invitation-action)
|
|
@@ -306,6 +310,10 @@
|
|
|
306
310
|
* [Time Series Data](#time-series-data)
|
|
307
311
|
* [Time Series Query](#time-series-query)
|
|
308
312
|
* [User Credentials](#user-credentials)
|
|
313
|
+
* [User OAuth Token](#user-oauth-token)
|
|
314
|
+
* [User OAuth Token Patch](#user-oauth-token-patch)
|
|
315
|
+
* [User OAuth Token Post](#user-oauth-token-post)
|
|
316
|
+
* [User OAuth Tokens](#user-oauth-tokens)
|
|
309
317
|
* [User Post](#user-post)
|
|
310
318
|
* [Validate Context Error](#validate-context-error)
|
|
311
319
|
* [Validate Context Success](#validate-context-success)
|
|
@@ -14451,6 +14459,106 @@ Schema for a single API Token
|
|
|
14451
14459
|
"type": "string",
|
|
14452
14460
|
"format": "date-time"
|
|
14453
14461
|
},
|
|
14462
|
+
"defaultRole": {
|
|
14463
|
+
"type": "string",
|
|
14464
|
+
"enum": [
|
|
14465
|
+
"admin",
|
|
14466
|
+
"edit",
|
|
14467
|
+
"collaborate",
|
|
14468
|
+
"view",
|
|
14469
|
+
"none"
|
|
14470
|
+
]
|
|
14471
|
+
},
|
|
14472
|
+
"orgRoles": {
|
|
14473
|
+
"type": "array",
|
|
14474
|
+
"items": {
|
|
14475
|
+
"type": "object",
|
|
14476
|
+
"properties": {
|
|
14477
|
+
"orgId": {
|
|
14478
|
+
"oneOf": [
|
|
14479
|
+
{
|
|
14480
|
+
"type": "string",
|
|
14481
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
14482
|
+
},
|
|
14483
|
+
{
|
|
14484
|
+
"type": "string",
|
|
14485
|
+
"enum": [
|
|
14486
|
+
"sandbox"
|
|
14487
|
+
]
|
|
14488
|
+
}
|
|
14489
|
+
]
|
|
14490
|
+
},
|
|
14491
|
+
"role": {
|
|
14492
|
+
"type": "string",
|
|
14493
|
+
"enum": [
|
|
14494
|
+
"admin",
|
|
14495
|
+
"edit",
|
|
14496
|
+
"collaborate",
|
|
14497
|
+
"view",
|
|
14498
|
+
"none"
|
|
14499
|
+
]
|
|
14500
|
+
},
|
|
14501
|
+
"applicationRoles": {
|
|
14502
|
+
"type": "array",
|
|
14503
|
+
"items": {
|
|
14504
|
+
"type": "object",
|
|
14505
|
+
"properties": {
|
|
14506
|
+
"resourceId": {
|
|
14507
|
+
"type": "string",
|
|
14508
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
14509
|
+
},
|
|
14510
|
+
"role": {
|
|
14511
|
+
"type": "string",
|
|
14512
|
+
"enum": [
|
|
14513
|
+
"collaborate",
|
|
14514
|
+
"view",
|
|
14515
|
+
"none"
|
|
14516
|
+
]
|
|
14517
|
+
}
|
|
14518
|
+
},
|
|
14519
|
+
"required": [
|
|
14520
|
+
"resourceId",
|
|
14521
|
+
"role"
|
|
14522
|
+
],
|
|
14523
|
+
"additionalProperties": false
|
|
14524
|
+
},
|
|
14525
|
+
"maxItems": 100
|
|
14526
|
+
},
|
|
14527
|
+
"dashboardRoles": {
|
|
14528
|
+
"type": "array",
|
|
14529
|
+
"items": {
|
|
14530
|
+
"type": "object",
|
|
14531
|
+
"properties": {
|
|
14532
|
+
"resourceId": {
|
|
14533
|
+
"type": "string",
|
|
14534
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
14535
|
+
},
|
|
14536
|
+
"role": {
|
|
14537
|
+
"type": "string",
|
|
14538
|
+
"enum": [
|
|
14539
|
+
"collaborate",
|
|
14540
|
+
"view",
|
|
14541
|
+
"none"
|
|
14542
|
+
]
|
|
14543
|
+
}
|
|
14544
|
+
},
|
|
14545
|
+
"required": [
|
|
14546
|
+
"resourceId",
|
|
14547
|
+
"role"
|
|
14548
|
+
],
|
|
14549
|
+
"additionalProperties": false
|
|
14550
|
+
},
|
|
14551
|
+
"maxItems": 100
|
|
14552
|
+
}
|
|
14553
|
+
},
|
|
14554
|
+
"required": [
|
|
14555
|
+
"orgId",
|
|
14556
|
+
"role"
|
|
14557
|
+
],
|
|
14558
|
+
"additionalProperties": false
|
|
14559
|
+
},
|
|
14560
|
+
"maxItems": 25
|
|
14561
|
+
},
|
|
14454
14562
|
"scope": {
|
|
14455
14563
|
"type": "array",
|
|
14456
14564
|
"items": {
|
|
@@ -14517,6 +14625,106 @@ Schema for the body of an API Token modification request
|
|
|
14517
14625
|
"type": "string",
|
|
14518
14626
|
"maxLength": 32767
|
|
14519
14627
|
},
|
|
14628
|
+
"defaultRole": {
|
|
14629
|
+
"type": "string",
|
|
14630
|
+
"enum": [
|
|
14631
|
+
"admin",
|
|
14632
|
+
"edit",
|
|
14633
|
+
"collaborate",
|
|
14634
|
+
"view",
|
|
14635
|
+
"none"
|
|
14636
|
+
]
|
|
14637
|
+
},
|
|
14638
|
+
"orgRoles": {
|
|
14639
|
+
"type": "array",
|
|
14640
|
+
"items": {
|
|
14641
|
+
"type": "object",
|
|
14642
|
+
"properties": {
|
|
14643
|
+
"orgId": {
|
|
14644
|
+
"oneOf": [
|
|
14645
|
+
{
|
|
14646
|
+
"type": "string",
|
|
14647
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
14648
|
+
},
|
|
14649
|
+
{
|
|
14650
|
+
"type": "string",
|
|
14651
|
+
"enum": [
|
|
14652
|
+
"sandbox"
|
|
14653
|
+
]
|
|
14654
|
+
}
|
|
14655
|
+
]
|
|
14656
|
+
},
|
|
14657
|
+
"role": {
|
|
14658
|
+
"type": "string",
|
|
14659
|
+
"enum": [
|
|
14660
|
+
"admin",
|
|
14661
|
+
"edit",
|
|
14662
|
+
"collaborate",
|
|
14663
|
+
"view",
|
|
14664
|
+
"none"
|
|
14665
|
+
]
|
|
14666
|
+
},
|
|
14667
|
+
"applicationRoles": {
|
|
14668
|
+
"type": "array",
|
|
14669
|
+
"items": {
|
|
14670
|
+
"type": "object",
|
|
14671
|
+
"properties": {
|
|
14672
|
+
"resourceId": {
|
|
14673
|
+
"type": "string",
|
|
14674
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
14675
|
+
},
|
|
14676
|
+
"role": {
|
|
14677
|
+
"type": "string",
|
|
14678
|
+
"enum": [
|
|
14679
|
+
"collaborate",
|
|
14680
|
+
"view",
|
|
14681
|
+
"none"
|
|
14682
|
+
]
|
|
14683
|
+
}
|
|
14684
|
+
},
|
|
14685
|
+
"required": [
|
|
14686
|
+
"resourceId",
|
|
14687
|
+
"role"
|
|
14688
|
+
],
|
|
14689
|
+
"additionalProperties": false
|
|
14690
|
+
},
|
|
14691
|
+
"maxItems": 100
|
|
14692
|
+
},
|
|
14693
|
+
"dashboardRoles": {
|
|
14694
|
+
"type": "array",
|
|
14695
|
+
"items": {
|
|
14696
|
+
"type": "object",
|
|
14697
|
+
"properties": {
|
|
14698
|
+
"resourceId": {
|
|
14699
|
+
"type": "string",
|
|
14700
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
14701
|
+
},
|
|
14702
|
+
"role": {
|
|
14703
|
+
"type": "string",
|
|
14704
|
+
"enum": [
|
|
14705
|
+
"collaborate",
|
|
14706
|
+
"view",
|
|
14707
|
+
"none"
|
|
14708
|
+
]
|
|
14709
|
+
}
|
|
14710
|
+
},
|
|
14711
|
+
"required": [
|
|
14712
|
+
"resourceId",
|
|
14713
|
+
"role"
|
|
14714
|
+
],
|
|
14715
|
+
"additionalProperties": false
|
|
14716
|
+
},
|
|
14717
|
+
"maxItems": 100
|
|
14718
|
+
}
|
|
14719
|
+
},
|
|
14720
|
+
"required": [
|
|
14721
|
+
"orgId",
|
|
14722
|
+
"role"
|
|
14723
|
+
],
|
|
14724
|
+
"additionalProperties": false
|
|
14725
|
+
},
|
|
14726
|
+
"maxItems": 25
|
|
14727
|
+
},
|
|
14520
14728
|
"status": {
|
|
14521
14729
|
"type": "string",
|
|
14522
14730
|
"enum": [
|
|
@@ -14563,6 +14771,106 @@ Schema for the body of an API Token creation request
|
|
|
14563
14771
|
"type": "string",
|
|
14564
14772
|
"format": "date-time"
|
|
14565
14773
|
},
|
|
14774
|
+
"defaultRole": {
|
|
14775
|
+
"type": "string",
|
|
14776
|
+
"enum": [
|
|
14777
|
+
"admin",
|
|
14778
|
+
"edit",
|
|
14779
|
+
"collaborate",
|
|
14780
|
+
"view",
|
|
14781
|
+
"none"
|
|
14782
|
+
]
|
|
14783
|
+
},
|
|
14784
|
+
"orgRoles": {
|
|
14785
|
+
"type": "array",
|
|
14786
|
+
"items": {
|
|
14787
|
+
"type": "object",
|
|
14788
|
+
"properties": {
|
|
14789
|
+
"orgId": {
|
|
14790
|
+
"oneOf": [
|
|
14791
|
+
{
|
|
14792
|
+
"type": "string",
|
|
14793
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
14794
|
+
},
|
|
14795
|
+
{
|
|
14796
|
+
"type": "string",
|
|
14797
|
+
"enum": [
|
|
14798
|
+
"sandbox"
|
|
14799
|
+
]
|
|
14800
|
+
}
|
|
14801
|
+
]
|
|
14802
|
+
},
|
|
14803
|
+
"role": {
|
|
14804
|
+
"type": "string",
|
|
14805
|
+
"enum": [
|
|
14806
|
+
"admin",
|
|
14807
|
+
"edit",
|
|
14808
|
+
"collaborate",
|
|
14809
|
+
"view",
|
|
14810
|
+
"none"
|
|
14811
|
+
]
|
|
14812
|
+
},
|
|
14813
|
+
"applicationRoles": {
|
|
14814
|
+
"type": "array",
|
|
14815
|
+
"items": {
|
|
14816
|
+
"type": "object",
|
|
14817
|
+
"properties": {
|
|
14818
|
+
"resourceId": {
|
|
14819
|
+
"type": "string",
|
|
14820
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
14821
|
+
},
|
|
14822
|
+
"role": {
|
|
14823
|
+
"type": "string",
|
|
14824
|
+
"enum": [
|
|
14825
|
+
"collaborate",
|
|
14826
|
+
"view",
|
|
14827
|
+
"none"
|
|
14828
|
+
]
|
|
14829
|
+
}
|
|
14830
|
+
},
|
|
14831
|
+
"required": [
|
|
14832
|
+
"resourceId",
|
|
14833
|
+
"role"
|
|
14834
|
+
],
|
|
14835
|
+
"additionalProperties": false
|
|
14836
|
+
},
|
|
14837
|
+
"maxItems": 100
|
|
14838
|
+
},
|
|
14839
|
+
"dashboardRoles": {
|
|
14840
|
+
"type": "array",
|
|
14841
|
+
"items": {
|
|
14842
|
+
"type": "object",
|
|
14843
|
+
"properties": {
|
|
14844
|
+
"resourceId": {
|
|
14845
|
+
"type": "string",
|
|
14846
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
14847
|
+
},
|
|
14848
|
+
"role": {
|
|
14849
|
+
"type": "string",
|
|
14850
|
+
"enum": [
|
|
14851
|
+
"collaborate",
|
|
14852
|
+
"view",
|
|
14853
|
+
"none"
|
|
14854
|
+
]
|
|
14855
|
+
}
|
|
14856
|
+
},
|
|
14857
|
+
"required": [
|
|
14858
|
+
"resourceId",
|
|
14859
|
+
"role"
|
|
14860
|
+
],
|
|
14861
|
+
"additionalProperties": false
|
|
14862
|
+
},
|
|
14863
|
+
"maxItems": 100
|
|
14864
|
+
}
|
|
14865
|
+
},
|
|
14866
|
+
"required": [
|
|
14867
|
+
"orgId",
|
|
14868
|
+
"role"
|
|
14869
|
+
],
|
|
14870
|
+
"additionalProperties": false
|
|
14871
|
+
},
|
|
14872
|
+
"maxItems": 25
|
|
14873
|
+
},
|
|
14566
14874
|
"scope": {
|
|
14567
14875
|
"type": "array",
|
|
14568
14876
|
"uniqueItems": true,
|
|
@@ -14574,6 +14882,7 @@ Schema for the body of an API Token creation request
|
|
|
14574
14882
|
"type": "string",
|
|
14575
14883
|
"enum": [
|
|
14576
14884
|
"all.Application",
|
|
14885
|
+
"all.Application.bounded",
|
|
14577
14886
|
"all.Application.read",
|
|
14578
14887
|
"all.Application.cli",
|
|
14579
14888
|
"all.Device",
|
|
@@ -14900,7 +15209,11 @@ Schema for the body of an API Token creation request
|
|
|
14900
15209
|
"type": "string",
|
|
14901
15210
|
"enum": [
|
|
14902
15211
|
"all.Organization",
|
|
15212
|
+
"all.Organization.bounded",
|
|
14903
15213
|
"all.Organization.read",
|
|
15214
|
+
"only.Organization",
|
|
15215
|
+
"only.Organization.bounded",
|
|
15216
|
+
"only.Organization.read",
|
|
14904
15217
|
"applications.*",
|
|
14905
15218
|
"auditLog.*",
|
|
14906
15219
|
"auditLogs.*",
|
|
@@ -14943,6 +15256,7 @@ Schema for the body of an API Token creation request
|
|
|
14943
15256
|
"type": "string",
|
|
14944
15257
|
"enum": [
|
|
14945
15258
|
"all.Instance",
|
|
15259
|
+
"all.Instance.bounded",
|
|
14946
15260
|
"all.Instance.read",
|
|
14947
15261
|
"instance.*",
|
|
14948
15262
|
"instance.get",
|
|
@@ -15031,8 +15345,12 @@ Schema for the body of an API Token creation request
|
|
|
15031
15345
|
"type": "string",
|
|
15032
15346
|
"enum": [
|
|
15033
15347
|
"all.User",
|
|
15348
|
+
"all.User.bounded",
|
|
15034
15349
|
"all.User.read",
|
|
15035
15350
|
"all.User.cli",
|
|
15351
|
+
"only.User",
|
|
15352
|
+
"only.User.bounded",
|
|
15353
|
+
"only.User.read",
|
|
15036
15354
|
"userApiToken.*",
|
|
15037
15355
|
"userApiToken.get",
|
|
15038
15356
|
"userApiToken.patch",
|
|
@@ -15040,6 +15358,13 @@ Schema for the body of an API Token creation request
|
|
|
15040
15358
|
"userApiTokens.*",
|
|
15041
15359
|
"userApiTokens.get",
|
|
15042
15360
|
"userApiTokens.post",
|
|
15361
|
+
"userOauthToken.*",
|
|
15362
|
+
"userOauthToken.get",
|
|
15363
|
+
"userOauthToken.patch",
|
|
15364
|
+
"userOauthToken.delete",
|
|
15365
|
+
"userOauthTokens.*",
|
|
15366
|
+
"userOauthTokens.get",
|
|
15367
|
+
"userOauthTokens.post",
|
|
15043
15368
|
"applicationTemplate.*",
|
|
15044
15369
|
"applicationTemplate.get",
|
|
15045
15370
|
"applicationTemplates.*",
|
|
@@ -15069,6 +15394,7 @@ Schema for the body of an API Token creation request
|
|
|
15069
15394
|
"me.invite",
|
|
15070
15395
|
"me.invites",
|
|
15071
15396
|
"me.respondToInvite",
|
|
15397
|
+
"me.refreshToken",
|
|
15072
15398
|
"orgs.*",
|
|
15073
15399
|
"orgs.get",
|
|
15074
15400
|
"orgs.post"
|
|
@@ -15180,6 +15506,106 @@ Schema for a collection of API Tokens
|
|
|
15180
15506
|
"type": "string",
|
|
15181
15507
|
"format": "date-time"
|
|
15182
15508
|
},
|
|
15509
|
+
"defaultRole": {
|
|
15510
|
+
"type": "string",
|
|
15511
|
+
"enum": [
|
|
15512
|
+
"admin",
|
|
15513
|
+
"edit",
|
|
15514
|
+
"collaborate",
|
|
15515
|
+
"view",
|
|
15516
|
+
"none"
|
|
15517
|
+
]
|
|
15518
|
+
},
|
|
15519
|
+
"orgRoles": {
|
|
15520
|
+
"type": "array",
|
|
15521
|
+
"items": {
|
|
15522
|
+
"type": "object",
|
|
15523
|
+
"properties": {
|
|
15524
|
+
"orgId": {
|
|
15525
|
+
"oneOf": [
|
|
15526
|
+
{
|
|
15527
|
+
"type": "string",
|
|
15528
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
15529
|
+
},
|
|
15530
|
+
{
|
|
15531
|
+
"type": "string",
|
|
15532
|
+
"enum": [
|
|
15533
|
+
"sandbox"
|
|
15534
|
+
]
|
|
15535
|
+
}
|
|
15536
|
+
]
|
|
15537
|
+
},
|
|
15538
|
+
"role": {
|
|
15539
|
+
"type": "string",
|
|
15540
|
+
"enum": [
|
|
15541
|
+
"admin",
|
|
15542
|
+
"edit",
|
|
15543
|
+
"collaborate",
|
|
15544
|
+
"view",
|
|
15545
|
+
"none"
|
|
15546
|
+
]
|
|
15547
|
+
},
|
|
15548
|
+
"applicationRoles": {
|
|
15549
|
+
"type": "array",
|
|
15550
|
+
"items": {
|
|
15551
|
+
"type": "object",
|
|
15552
|
+
"properties": {
|
|
15553
|
+
"resourceId": {
|
|
15554
|
+
"type": "string",
|
|
15555
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
15556
|
+
},
|
|
15557
|
+
"role": {
|
|
15558
|
+
"type": "string",
|
|
15559
|
+
"enum": [
|
|
15560
|
+
"collaborate",
|
|
15561
|
+
"view",
|
|
15562
|
+
"none"
|
|
15563
|
+
]
|
|
15564
|
+
}
|
|
15565
|
+
},
|
|
15566
|
+
"required": [
|
|
15567
|
+
"resourceId",
|
|
15568
|
+
"role"
|
|
15569
|
+
],
|
|
15570
|
+
"additionalProperties": false
|
|
15571
|
+
},
|
|
15572
|
+
"maxItems": 100
|
|
15573
|
+
},
|
|
15574
|
+
"dashboardRoles": {
|
|
15575
|
+
"type": "array",
|
|
15576
|
+
"items": {
|
|
15577
|
+
"type": "object",
|
|
15578
|
+
"properties": {
|
|
15579
|
+
"resourceId": {
|
|
15580
|
+
"type": "string",
|
|
15581
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
15582
|
+
},
|
|
15583
|
+
"role": {
|
|
15584
|
+
"type": "string",
|
|
15585
|
+
"enum": [
|
|
15586
|
+
"collaborate",
|
|
15587
|
+
"view",
|
|
15588
|
+
"none"
|
|
15589
|
+
]
|
|
15590
|
+
}
|
|
15591
|
+
},
|
|
15592
|
+
"required": [
|
|
15593
|
+
"resourceId",
|
|
15594
|
+
"role"
|
|
15595
|
+
],
|
|
15596
|
+
"additionalProperties": false
|
|
15597
|
+
},
|
|
15598
|
+
"maxItems": 100
|
|
15599
|
+
}
|
|
15600
|
+
},
|
|
15601
|
+
"required": [
|
|
15602
|
+
"orgId",
|
|
15603
|
+
"role"
|
|
15604
|
+
],
|
|
15605
|
+
"additionalProperties": false
|
|
15606
|
+
},
|
|
15607
|
+
"maxItems": 25
|
|
15608
|
+
},
|
|
15183
15609
|
"scope": {
|
|
15184
15610
|
"type": "array",
|
|
15185
15611
|
"items": {
|
|
@@ -19330,6 +19756,10 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
|
19330
19756
|
},
|
|
19331
19757
|
"includeDeviceInfo": {
|
|
19332
19758
|
"type": "boolean"
|
|
19759
|
+
},
|
|
19760
|
+
"maxResultsPerDevice": {
|
|
19761
|
+
"type": "string",
|
|
19762
|
+
"maxLength": 255
|
|
19333
19763
|
}
|
|
19334
19764
|
},
|
|
19335
19765
|
"additionalProperties": false
|
|
@@ -42207,168 +42637,172 @@ Schema for a single Dashboard
|
|
|
42207
42637
|
},
|
|
42208
42638
|
"includeDeviceInfo": {
|
|
42209
42639
|
"type": "boolean"
|
|
42210
|
-
}
|
|
42211
|
-
},
|
|
42212
|
-
"additionalProperties": false
|
|
42213
|
-
}
|
|
42214
|
-
},
|
|
42215
|
-
"required": [
|
|
42216
|
-
"blockType",
|
|
42217
|
-
"startX",
|
|
42218
|
-
"startY",
|
|
42219
|
-
"width",
|
|
42220
|
-
"height"
|
|
42221
|
-
],
|
|
42222
|
-
"additionalProperties": false
|
|
42223
|
-
},
|
|
42224
|
-
{
|
|
42225
|
-
"type": "object",
|
|
42226
|
-
"properties": {
|
|
42227
|
-
"id": {
|
|
42228
|
-
"type": "string",
|
|
42229
|
-
"maxLength": 48
|
|
42230
|
-
},
|
|
42231
|
-
"title": {
|
|
42232
|
-
"type": "string",
|
|
42233
|
-
"maxLength": 255
|
|
42234
|
-
},
|
|
42235
|
-
"description": {
|
|
42236
|
-
"type": "string",
|
|
42237
|
-
"maxLength": 32767
|
|
42238
|
-
},
|
|
42239
|
-
"applicationId": {
|
|
42240
|
-
"type": "string",
|
|
42241
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
42242
|
-
},
|
|
42243
|
-
"startX": {
|
|
42244
|
-
"type": "number"
|
|
42245
|
-
},
|
|
42246
|
-
"startY": {
|
|
42247
|
-
"type": "number"
|
|
42248
|
-
},
|
|
42249
|
-
"width": {
|
|
42250
|
-
"type": "number"
|
|
42251
|
-
},
|
|
42252
|
-
"height": {
|
|
42253
|
-
"type": "number"
|
|
42254
|
-
},
|
|
42255
|
-
"blockType": {
|
|
42256
|
-
"type": "string",
|
|
42257
|
-
"enum": [
|
|
42258
|
-
"device-state-table"
|
|
42259
|
-
]
|
|
42260
|
-
},
|
|
42261
|
-
"config": {
|
|
42262
|
-
"type": "object",
|
|
42263
|
-
"properties": {
|
|
42264
|
-
"attributes": {
|
|
42265
|
-
"oneOf": [
|
|
42266
|
-
{
|
|
42267
|
-
"type": "null"
|
|
42268
|
-
},
|
|
42269
|
-
{
|
|
42270
|
-
"type": "array",
|
|
42271
|
-
"maxItems": 100,
|
|
42272
|
-
"items": {
|
|
42273
|
-
"type": "string",
|
|
42274
|
-
"maxLength": 255
|
|
42275
|
-
}
|
|
42276
|
-
}
|
|
42277
|
-
]
|
|
42278
|
-
},
|
|
42279
|
-
"deviceIds": {
|
|
42280
|
-
"type": "array",
|
|
42281
|
-
"maxItems": 100,
|
|
42282
|
-
"items": {
|
|
42283
|
-
"type": "string",
|
|
42284
|
-
"maxLength": 255
|
|
42285
|
-
}
|
|
42286
42640
|
},
|
|
42287
|
-
"
|
|
42288
|
-
"type": "array",
|
|
42289
|
-
"maxItems": 100,
|
|
42290
|
-
"items": {
|
|
42291
|
-
"type": "object",
|
|
42292
|
-
"properties": {
|
|
42293
|
-
"key": {
|
|
42294
|
-
"type": "string",
|
|
42295
|
-
"maxLength": 255
|
|
42296
|
-
},
|
|
42297
|
-
"value": {
|
|
42298
|
-
"type": "string",
|
|
42299
|
-
"maxLength": 255
|
|
42300
|
-
},
|
|
42301
|
-
"fromCtx": {
|
|
42302
|
-
"type": "string",
|
|
42303
|
-
"maxLength": 255
|
|
42304
|
-
}
|
|
42305
|
-
},
|
|
42306
|
-
"additionalProperties": false
|
|
42307
|
-
}
|
|
42308
|
-
},
|
|
42309
|
-
"query": {
|
|
42641
|
+
"maxResultsPerDevice": {
|
|
42310
42642
|
"type": "string",
|
|
42311
|
-
"maxLength":
|
|
42312
|
-
}
|
|
42313
|
-
|
|
42314
|
-
|
|
42315
|
-
|
|
42316
|
-
|
|
42317
|
-
|
|
42318
|
-
|
|
42319
|
-
|
|
42320
|
-
|
|
42321
|
-
|
|
42322
|
-
|
|
42323
|
-
|
|
42324
|
-
|
|
42325
|
-
|
|
42326
|
-
|
|
42327
|
-
|
|
42328
|
-
|
|
42329
|
-
|
|
42330
|
-
|
|
42331
|
-
|
|
42332
|
-
|
|
42333
|
-
|
|
42334
|
-
|
|
42335
|
-
|
|
42336
|
-
|
|
42337
|
-
|
|
42338
|
-
|
|
42339
|
-
|
|
42340
|
-
|
|
42341
|
-
|
|
42342
|
-
|
|
42343
|
-
|
|
42344
|
-
|
|
42345
|
-
|
|
42346
|
-
|
|
42347
|
-
|
|
42348
|
-
|
|
42349
|
-
|
|
42350
|
-
|
|
42351
|
-
|
|
42352
|
-
|
|
42353
|
-
|
|
42354
|
-
|
|
42355
|
-
|
|
42356
|
-
|
|
42357
|
-
|
|
42358
|
-
|
|
42359
|
-
|
|
42360
|
-
|
|
42361
|
-
|
|
42362
|
-
|
|
42363
|
-
|
|
42364
|
-
|
|
42365
|
-
|
|
42366
|
-
|
|
42367
|
-
|
|
42368
|
-
|
|
42369
|
-
|
|
42370
|
-
|
|
42371
|
-
|
|
42643
|
+
"maxLength": 255
|
|
42644
|
+
}
|
|
42645
|
+
},
|
|
42646
|
+
"additionalProperties": false
|
|
42647
|
+
}
|
|
42648
|
+
},
|
|
42649
|
+
"required": [
|
|
42650
|
+
"blockType",
|
|
42651
|
+
"startX",
|
|
42652
|
+
"startY",
|
|
42653
|
+
"width",
|
|
42654
|
+
"height"
|
|
42655
|
+
],
|
|
42656
|
+
"additionalProperties": false
|
|
42657
|
+
},
|
|
42658
|
+
{
|
|
42659
|
+
"type": "object",
|
|
42660
|
+
"properties": {
|
|
42661
|
+
"id": {
|
|
42662
|
+
"type": "string",
|
|
42663
|
+
"maxLength": 48
|
|
42664
|
+
},
|
|
42665
|
+
"title": {
|
|
42666
|
+
"type": "string",
|
|
42667
|
+
"maxLength": 255
|
|
42668
|
+
},
|
|
42669
|
+
"description": {
|
|
42670
|
+
"type": "string",
|
|
42671
|
+
"maxLength": 32767
|
|
42672
|
+
},
|
|
42673
|
+
"applicationId": {
|
|
42674
|
+
"type": "string",
|
|
42675
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
42676
|
+
},
|
|
42677
|
+
"startX": {
|
|
42678
|
+
"type": "number"
|
|
42679
|
+
},
|
|
42680
|
+
"startY": {
|
|
42681
|
+
"type": "number"
|
|
42682
|
+
},
|
|
42683
|
+
"width": {
|
|
42684
|
+
"type": "number"
|
|
42685
|
+
},
|
|
42686
|
+
"height": {
|
|
42687
|
+
"type": "number"
|
|
42688
|
+
},
|
|
42689
|
+
"blockType": {
|
|
42690
|
+
"type": "string",
|
|
42691
|
+
"enum": [
|
|
42692
|
+
"device-state-table"
|
|
42693
|
+
]
|
|
42694
|
+
},
|
|
42695
|
+
"config": {
|
|
42696
|
+
"type": "object",
|
|
42697
|
+
"properties": {
|
|
42698
|
+
"attributes": {
|
|
42699
|
+
"oneOf": [
|
|
42700
|
+
{
|
|
42701
|
+
"type": "null"
|
|
42702
|
+
},
|
|
42703
|
+
{
|
|
42704
|
+
"type": "array",
|
|
42705
|
+
"maxItems": 100,
|
|
42706
|
+
"items": {
|
|
42707
|
+
"type": "string",
|
|
42708
|
+
"maxLength": 255
|
|
42709
|
+
}
|
|
42710
|
+
}
|
|
42711
|
+
]
|
|
42712
|
+
},
|
|
42713
|
+
"deviceIds": {
|
|
42714
|
+
"type": "array",
|
|
42715
|
+
"maxItems": 100,
|
|
42716
|
+
"items": {
|
|
42717
|
+
"type": "string",
|
|
42718
|
+
"maxLength": 255
|
|
42719
|
+
}
|
|
42720
|
+
},
|
|
42721
|
+
"deviceTags": {
|
|
42722
|
+
"type": "array",
|
|
42723
|
+
"maxItems": 100,
|
|
42724
|
+
"items": {
|
|
42725
|
+
"type": "object",
|
|
42726
|
+
"properties": {
|
|
42727
|
+
"key": {
|
|
42728
|
+
"type": "string",
|
|
42729
|
+
"maxLength": 255
|
|
42730
|
+
},
|
|
42731
|
+
"value": {
|
|
42732
|
+
"type": "string",
|
|
42733
|
+
"maxLength": 255
|
|
42734
|
+
},
|
|
42735
|
+
"fromCtx": {
|
|
42736
|
+
"type": "string",
|
|
42737
|
+
"maxLength": 255
|
|
42738
|
+
}
|
|
42739
|
+
},
|
|
42740
|
+
"additionalProperties": false
|
|
42741
|
+
}
|
|
42742
|
+
},
|
|
42743
|
+
"query": {
|
|
42744
|
+
"type": "string",
|
|
42745
|
+
"maxLength": 32767
|
|
42746
|
+
},
|
|
42747
|
+
"duration": {
|
|
42748
|
+
"oneOf": [
|
|
42749
|
+
{
|
|
42750
|
+
"type": "integer",
|
|
42751
|
+
"minimum": 0
|
|
42752
|
+
},
|
|
42753
|
+
{
|
|
42754
|
+
"type": "string",
|
|
42755
|
+
"enum": [
|
|
42756
|
+
"{{dashboard.duration}}"
|
|
42757
|
+
]
|
|
42758
|
+
}
|
|
42759
|
+
]
|
|
42760
|
+
},
|
|
42761
|
+
"sortDirection": {
|
|
42762
|
+
"type": "integer",
|
|
42763
|
+
"minimum": -1,
|
|
42764
|
+
"maximum": 1
|
|
42765
|
+
},
|
|
42766
|
+
"sortIndex": {
|
|
42767
|
+
"type": "integer",
|
|
42768
|
+
"minimum": 0,
|
|
42769
|
+
"maximum": 100
|
|
42770
|
+
},
|
|
42771
|
+
"columns": {
|
|
42772
|
+
"type": "array",
|
|
42773
|
+
"maxItems": 100,
|
|
42774
|
+
"items": {
|
|
42775
|
+
"type": "object",
|
|
42776
|
+
"properties": {
|
|
42777
|
+
"headerTemplate": {
|
|
42778
|
+
"type": "string",
|
|
42779
|
+
"maxLength": 1024
|
|
42780
|
+
},
|
|
42781
|
+
"id": {
|
|
42782
|
+
"type": "string",
|
|
42783
|
+
"maxLength": 48
|
|
42784
|
+
},
|
|
42785
|
+
"rowTemplate": {
|
|
42786
|
+
"type": "string",
|
|
42787
|
+
"maxLength": 32767
|
|
42788
|
+
},
|
|
42789
|
+
"type": {
|
|
42790
|
+
"type": "string",
|
|
42791
|
+
"enum": [
|
|
42792
|
+
"deviceTags",
|
|
42793
|
+
"deviceId",
|
|
42794
|
+
"deviceName",
|
|
42795
|
+
"timestamp",
|
|
42796
|
+
"attribute"
|
|
42797
|
+
]
|
|
42798
|
+
},
|
|
42799
|
+
"attribute": {
|
|
42800
|
+
"type": "string",
|
|
42801
|
+
"maxLength": 255
|
|
42802
|
+
}
|
|
42803
|
+
},
|
|
42804
|
+
"additionalProperties": false
|
|
42805
|
+
}
|
|
42372
42806
|
}
|
|
42373
42807
|
},
|
|
42374
42808
|
"additionalProperties": false
|
|
@@ -49386,168 +49820,172 @@ Schema for the body of a Dashboard modification request
|
|
|
49386
49820
|
},
|
|
49387
49821
|
"includeDeviceInfo": {
|
|
49388
49822
|
"type": "boolean"
|
|
49389
|
-
}
|
|
49390
|
-
},
|
|
49391
|
-
"additionalProperties": false
|
|
49392
|
-
}
|
|
49393
|
-
},
|
|
49394
|
-
"required": [
|
|
49395
|
-
"blockType",
|
|
49396
|
-
"startX",
|
|
49397
|
-
"startY",
|
|
49398
|
-
"width",
|
|
49399
|
-
"height"
|
|
49400
|
-
],
|
|
49401
|
-
"additionalProperties": false
|
|
49402
|
-
},
|
|
49403
|
-
{
|
|
49404
|
-
"type": "object",
|
|
49405
|
-
"properties": {
|
|
49406
|
-
"id": {
|
|
49407
|
-
"type": "string",
|
|
49408
|
-
"maxLength": 48
|
|
49409
|
-
},
|
|
49410
|
-
"title": {
|
|
49411
|
-
"type": "string",
|
|
49412
|
-
"maxLength": 255
|
|
49413
|
-
},
|
|
49414
|
-
"description": {
|
|
49415
|
-
"type": "string",
|
|
49416
|
-
"maxLength": 32767
|
|
49417
|
-
},
|
|
49418
|
-
"applicationId": {
|
|
49419
|
-
"type": "string",
|
|
49420
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
49421
|
-
},
|
|
49422
|
-
"startX": {
|
|
49423
|
-
"type": "number"
|
|
49424
|
-
},
|
|
49425
|
-
"startY": {
|
|
49426
|
-
"type": "number"
|
|
49427
|
-
},
|
|
49428
|
-
"width": {
|
|
49429
|
-
"type": "number"
|
|
49430
|
-
},
|
|
49431
|
-
"height": {
|
|
49432
|
-
"type": "number"
|
|
49433
|
-
},
|
|
49434
|
-
"blockType": {
|
|
49435
|
-
"type": "string",
|
|
49436
|
-
"enum": [
|
|
49437
|
-
"device-state-table"
|
|
49438
|
-
]
|
|
49439
|
-
},
|
|
49440
|
-
"config": {
|
|
49441
|
-
"type": "object",
|
|
49442
|
-
"properties": {
|
|
49443
|
-
"attributes": {
|
|
49444
|
-
"oneOf": [
|
|
49445
|
-
{
|
|
49446
|
-
"type": "null"
|
|
49447
|
-
},
|
|
49448
|
-
{
|
|
49449
|
-
"type": "array",
|
|
49450
|
-
"maxItems": 100,
|
|
49451
|
-
"items": {
|
|
49452
|
-
"type": "string",
|
|
49453
|
-
"maxLength": 255
|
|
49454
|
-
}
|
|
49455
|
-
}
|
|
49456
|
-
]
|
|
49457
|
-
},
|
|
49458
|
-
"deviceIds": {
|
|
49459
|
-
"type": "array",
|
|
49460
|
-
"maxItems": 100,
|
|
49461
|
-
"items": {
|
|
49462
|
-
"type": "string",
|
|
49463
|
-
"maxLength": 255
|
|
49464
|
-
}
|
|
49465
49823
|
},
|
|
49466
|
-
"
|
|
49467
|
-
"type": "array",
|
|
49468
|
-
"maxItems": 100,
|
|
49469
|
-
"items": {
|
|
49470
|
-
"type": "object",
|
|
49471
|
-
"properties": {
|
|
49472
|
-
"key": {
|
|
49473
|
-
"type": "string",
|
|
49474
|
-
"maxLength": 255
|
|
49475
|
-
},
|
|
49476
|
-
"value": {
|
|
49477
|
-
"type": "string",
|
|
49478
|
-
"maxLength": 255
|
|
49479
|
-
},
|
|
49480
|
-
"fromCtx": {
|
|
49481
|
-
"type": "string",
|
|
49482
|
-
"maxLength": 255
|
|
49483
|
-
}
|
|
49484
|
-
},
|
|
49485
|
-
"additionalProperties": false
|
|
49486
|
-
}
|
|
49487
|
-
},
|
|
49488
|
-
"query": {
|
|
49824
|
+
"maxResultsPerDevice": {
|
|
49489
49825
|
"type": "string",
|
|
49490
|
-
"maxLength":
|
|
49491
|
-
}
|
|
49492
|
-
|
|
49493
|
-
|
|
49494
|
-
|
|
49495
|
-
|
|
49496
|
-
|
|
49497
|
-
|
|
49498
|
-
|
|
49499
|
-
|
|
49500
|
-
|
|
49501
|
-
|
|
49502
|
-
|
|
49503
|
-
|
|
49504
|
-
|
|
49505
|
-
|
|
49506
|
-
|
|
49507
|
-
|
|
49508
|
-
|
|
49509
|
-
|
|
49510
|
-
|
|
49511
|
-
|
|
49512
|
-
|
|
49513
|
-
|
|
49514
|
-
|
|
49515
|
-
|
|
49516
|
-
|
|
49517
|
-
|
|
49518
|
-
|
|
49519
|
-
|
|
49520
|
-
|
|
49521
|
-
|
|
49522
|
-
|
|
49523
|
-
|
|
49524
|
-
|
|
49525
|
-
|
|
49526
|
-
|
|
49527
|
-
|
|
49528
|
-
|
|
49529
|
-
|
|
49530
|
-
|
|
49531
|
-
|
|
49532
|
-
|
|
49533
|
-
|
|
49534
|
-
|
|
49535
|
-
|
|
49536
|
-
|
|
49537
|
-
|
|
49538
|
-
|
|
49539
|
-
|
|
49540
|
-
|
|
49541
|
-
|
|
49542
|
-
|
|
49543
|
-
|
|
49544
|
-
|
|
49545
|
-
|
|
49546
|
-
|
|
49547
|
-
|
|
49548
|
-
|
|
49549
|
-
|
|
49550
|
-
|
|
49826
|
+
"maxLength": 255
|
|
49827
|
+
}
|
|
49828
|
+
},
|
|
49829
|
+
"additionalProperties": false
|
|
49830
|
+
}
|
|
49831
|
+
},
|
|
49832
|
+
"required": [
|
|
49833
|
+
"blockType",
|
|
49834
|
+
"startX",
|
|
49835
|
+
"startY",
|
|
49836
|
+
"width",
|
|
49837
|
+
"height"
|
|
49838
|
+
],
|
|
49839
|
+
"additionalProperties": false
|
|
49840
|
+
},
|
|
49841
|
+
{
|
|
49842
|
+
"type": "object",
|
|
49843
|
+
"properties": {
|
|
49844
|
+
"id": {
|
|
49845
|
+
"type": "string",
|
|
49846
|
+
"maxLength": 48
|
|
49847
|
+
},
|
|
49848
|
+
"title": {
|
|
49849
|
+
"type": "string",
|
|
49850
|
+
"maxLength": 255
|
|
49851
|
+
},
|
|
49852
|
+
"description": {
|
|
49853
|
+
"type": "string",
|
|
49854
|
+
"maxLength": 32767
|
|
49855
|
+
},
|
|
49856
|
+
"applicationId": {
|
|
49857
|
+
"type": "string",
|
|
49858
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
49859
|
+
},
|
|
49860
|
+
"startX": {
|
|
49861
|
+
"type": "number"
|
|
49862
|
+
},
|
|
49863
|
+
"startY": {
|
|
49864
|
+
"type": "number"
|
|
49865
|
+
},
|
|
49866
|
+
"width": {
|
|
49867
|
+
"type": "number"
|
|
49868
|
+
},
|
|
49869
|
+
"height": {
|
|
49870
|
+
"type": "number"
|
|
49871
|
+
},
|
|
49872
|
+
"blockType": {
|
|
49873
|
+
"type": "string",
|
|
49874
|
+
"enum": [
|
|
49875
|
+
"device-state-table"
|
|
49876
|
+
]
|
|
49877
|
+
},
|
|
49878
|
+
"config": {
|
|
49879
|
+
"type": "object",
|
|
49880
|
+
"properties": {
|
|
49881
|
+
"attributes": {
|
|
49882
|
+
"oneOf": [
|
|
49883
|
+
{
|
|
49884
|
+
"type": "null"
|
|
49885
|
+
},
|
|
49886
|
+
{
|
|
49887
|
+
"type": "array",
|
|
49888
|
+
"maxItems": 100,
|
|
49889
|
+
"items": {
|
|
49890
|
+
"type": "string",
|
|
49891
|
+
"maxLength": 255
|
|
49892
|
+
}
|
|
49893
|
+
}
|
|
49894
|
+
]
|
|
49895
|
+
},
|
|
49896
|
+
"deviceIds": {
|
|
49897
|
+
"type": "array",
|
|
49898
|
+
"maxItems": 100,
|
|
49899
|
+
"items": {
|
|
49900
|
+
"type": "string",
|
|
49901
|
+
"maxLength": 255
|
|
49902
|
+
}
|
|
49903
|
+
},
|
|
49904
|
+
"deviceTags": {
|
|
49905
|
+
"type": "array",
|
|
49906
|
+
"maxItems": 100,
|
|
49907
|
+
"items": {
|
|
49908
|
+
"type": "object",
|
|
49909
|
+
"properties": {
|
|
49910
|
+
"key": {
|
|
49911
|
+
"type": "string",
|
|
49912
|
+
"maxLength": 255
|
|
49913
|
+
},
|
|
49914
|
+
"value": {
|
|
49915
|
+
"type": "string",
|
|
49916
|
+
"maxLength": 255
|
|
49917
|
+
},
|
|
49918
|
+
"fromCtx": {
|
|
49919
|
+
"type": "string",
|
|
49920
|
+
"maxLength": 255
|
|
49921
|
+
}
|
|
49922
|
+
},
|
|
49923
|
+
"additionalProperties": false
|
|
49924
|
+
}
|
|
49925
|
+
},
|
|
49926
|
+
"query": {
|
|
49927
|
+
"type": "string",
|
|
49928
|
+
"maxLength": 32767
|
|
49929
|
+
},
|
|
49930
|
+
"duration": {
|
|
49931
|
+
"oneOf": [
|
|
49932
|
+
{
|
|
49933
|
+
"type": "integer",
|
|
49934
|
+
"minimum": 0
|
|
49935
|
+
},
|
|
49936
|
+
{
|
|
49937
|
+
"type": "string",
|
|
49938
|
+
"enum": [
|
|
49939
|
+
"{{dashboard.duration}}"
|
|
49940
|
+
]
|
|
49941
|
+
}
|
|
49942
|
+
]
|
|
49943
|
+
},
|
|
49944
|
+
"sortDirection": {
|
|
49945
|
+
"type": "integer",
|
|
49946
|
+
"minimum": -1,
|
|
49947
|
+
"maximum": 1
|
|
49948
|
+
},
|
|
49949
|
+
"sortIndex": {
|
|
49950
|
+
"type": "integer",
|
|
49951
|
+
"minimum": 0,
|
|
49952
|
+
"maximum": 100
|
|
49953
|
+
},
|
|
49954
|
+
"columns": {
|
|
49955
|
+
"type": "array",
|
|
49956
|
+
"maxItems": 100,
|
|
49957
|
+
"items": {
|
|
49958
|
+
"type": "object",
|
|
49959
|
+
"properties": {
|
|
49960
|
+
"headerTemplate": {
|
|
49961
|
+
"type": "string",
|
|
49962
|
+
"maxLength": 1024
|
|
49963
|
+
},
|
|
49964
|
+
"id": {
|
|
49965
|
+
"type": "string",
|
|
49966
|
+
"maxLength": 48
|
|
49967
|
+
},
|
|
49968
|
+
"rowTemplate": {
|
|
49969
|
+
"type": "string",
|
|
49970
|
+
"maxLength": 32767
|
|
49971
|
+
},
|
|
49972
|
+
"type": {
|
|
49973
|
+
"type": "string",
|
|
49974
|
+
"enum": [
|
|
49975
|
+
"deviceTags",
|
|
49976
|
+
"deviceId",
|
|
49977
|
+
"deviceName",
|
|
49978
|
+
"timestamp",
|
|
49979
|
+
"attribute"
|
|
49980
|
+
]
|
|
49981
|
+
},
|
|
49982
|
+
"attribute": {
|
|
49983
|
+
"type": "string",
|
|
49984
|
+
"maxLength": 255
|
|
49985
|
+
}
|
|
49986
|
+
},
|
|
49987
|
+
"additionalProperties": false
|
|
49988
|
+
}
|
|
49551
49989
|
}
|
|
49552
49990
|
},
|
|
49553
49991
|
"additionalProperties": false
|
|
@@ -55823,168 +56261,172 @@ Schema for the body of a Dashboard creation request
|
|
|
55823
56261
|
},
|
|
55824
56262
|
"includeDeviceInfo": {
|
|
55825
56263
|
"type": "boolean"
|
|
55826
|
-
}
|
|
55827
|
-
},
|
|
55828
|
-
"additionalProperties": false
|
|
55829
|
-
}
|
|
55830
|
-
},
|
|
55831
|
-
"required": [
|
|
55832
|
-
"blockType",
|
|
55833
|
-
"startX",
|
|
55834
|
-
"startY",
|
|
55835
|
-
"width",
|
|
55836
|
-
"height"
|
|
55837
|
-
],
|
|
55838
|
-
"additionalProperties": false
|
|
55839
|
-
},
|
|
55840
|
-
{
|
|
55841
|
-
"type": "object",
|
|
55842
|
-
"properties": {
|
|
55843
|
-
"id": {
|
|
55844
|
-
"type": "string",
|
|
55845
|
-
"maxLength": 48
|
|
55846
|
-
},
|
|
55847
|
-
"title": {
|
|
55848
|
-
"type": "string",
|
|
55849
|
-
"maxLength": 255
|
|
55850
|
-
},
|
|
55851
|
-
"description": {
|
|
55852
|
-
"type": "string",
|
|
55853
|
-
"maxLength": 32767
|
|
55854
|
-
},
|
|
55855
|
-
"applicationId": {
|
|
55856
|
-
"type": "string",
|
|
55857
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
55858
|
-
},
|
|
55859
|
-
"startX": {
|
|
55860
|
-
"type": "number"
|
|
55861
|
-
},
|
|
55862
|
-
"startY": {
|
|
55863
|
-
"type": "number"
|
|
55864
|
-
},
|
|
55865
|
-
"width": {
|
|
55866
|
-
"type": "number"
|
|
55867
|
-
},
|
|
55868
|
-
"height": {
|
|
55869
|
-
"type": "number"
|
|
55870
|
-
},
|
|
55871
|
-
"blockType": {
|
|
55872
|
-
"type": "string",
|
|
55873
|
-
"enum": [
|
|
55874
|
-
"device-state-table"
|
|
55875
|
-
]
|
|
55876
|
-
},
|
|
55877
|
-
"config": {
|
|
55878
|
-
"type": "object",
|
|
55879
|
-
"properties": {
|
|
55880
|
-
"attributes": {
|
|
55881
|
-
"oneOf": [
|
|
55882
|
-
{
|
|
55883
|
-
"type": "null"
|
|
55884
|
-
},
|
|
55885
|
-
{
|
|
55886
|
-
"type": "array",
|
|
55887
|
-
"maxItems": 100,
|
|
55888
|
-
"items": {
|
|
55889
|
-
"type": "string",
|
|
55890
|
-
"maxLength": 255
|
|
55891
|
-
}
|
|
55892
|
-
}
|
|
55893
|
-
]
|
|
55894
|
-
},
|
|
55895
|
-
"deviceIds": {
|
|
55896
|
-
"type": "array",
|
|
55897
|
-
"maxItems": 100,
|
|
55898
|
-
"items": {
|
|
55899
|
-
"type": "string",
|
|
55900
|
-
"maxLength": 255
|
|
55901
|
-
}
|
|
55902
56264
|
},
|
|
55903
|
-
"
|
|
55904
|
-
"type": "array",
|
|
55905
|
-
"maxItems": 100,
|
|
55906
|
-
"items": {
|
|
55907
|
-
"type": "object",
|
|
55908
|
-
"properties": {
|
|
55909
|
-
"key": {
|
|
55910
|
-
"type": "string",
|
|
55911
|
-
"maxLength": 255
|
|
55912
|
-
},
|
|
55913
|
-
"value": {
|
|
55914
|
-
"type": "string",
|
|
55915
|
-
"maxLength": 255
|
|
55916
|
-
},
|
|
55917
|
-
"fromCtx": {
|
|
55918
|
-
"type": "string",
|
|
55919
|
-
"maxLength": 255
|
|
55920
|
-
}
|
|
55921
|
-
},
|
|
55922
|
-
"additionalProperties": false
|
|
55923
|
-
}
|
|
55924
|
-
},
|
|
55925
|
-
"query": {
|
|
56265
|
+
"maxResultsPerDevice": {
|
|
55926
56266
|
"type": "string",
|
|
55927
|
-
"maxLength":
|
|
55928
|
-
}
|
|
55929
|
-
|
|
55930
|
-
|
|
55931
|
-
|
|
55932
|
-
|
|
55933
|
-
|
|
55934
|
-
|
|
55935
|
-
|
|
55936
|
-
|
|
55937
|
-
|
|
55938
|
-
|
|
55939
|
-
|
|
55940
|
-
|
|
55941
|
-
|
|
55942
|
-
|
|
55943
|
-
|
|
55944
|
-
|
|
55945
|
-
|
|
55946
|
-
|
|
55947
|
-
|
|
55948
|
-
|
|
55949
|
-
|
|
55950
|
-
|
|
55951
|
-
|
|
55952
|
-
|
|
55953
|
-
|
|
55954
|
-
|
|
55955
|
-
|
|
55956
|
-
|
|
55957
|
-
|
|
55958
|
-
|
|
55959
|
-
|
|
55960
|
-
|
|
55961
|
-
|
|
55962
|
-
|
|
55963
|
-
|
|
55964
|
-
|
|
55965
|
-
|
|
55966
|
-
|
|
55967
|
-
|
|
55968
|
-
|
|
55969
|
-
|
|
55970
|
-
|
|
55971
|
-
|
|
55972
|
-
|
|
55973
|
-
|
|
55974
|
-
|
|
55975
|
-
|
|
55976
|
-
|
|
55977
|
-
|
|
55978
|
-
|
|
55979
|
-
|
|
55980
|
-
|
|
55981
|
-
|
|
55982
|
-
|
|
55983
|
-
|
|
55984
|
-
|
|
55985
|
-
|
|
55986
|
-
|
|
55987
|
-
|
|
56267
|
+
"maxLength": 255
|
|
56268
|
+
}
|
|
56269
|
+
},
|
|
56270
|
+
"additionalProperties": false
|
|
56271
|
+
}
|
|
56272
|
+
},
|
|
56273
|
+
"required": [
|
|
56274
|
+
"blockType",
|
|
56275
|
+
"startX",
|
|
56276
|
+
"startY",
|
|
56277
|
+
"width",
|
|
56278
|
+
"height"
|
|
56279
|
+
],
|
|
56280
|
+
"additionalProperties": false
|
|
56281
|
+
},
|
|
56282
|
+
{
|
|
56283
|
+
"type": "object",
|
|
56284
|
+
"properties": {
|
|
56285
|
+
"id": {
|
|
56286
|
+
"type": "string",
|
|
56287
|
+
"maxLength": 48
|
|
56288
|
+
},
|
|
56289
|
+
"title": {
|
|
56290
|
+
"type": "string",
|
|
56291
|
+
"maxLength": 255
|
|
56292
|
+
},
|
|
56293
|
+
"description": {
|
|
56294
|
+
"type": "string",
|
|
56295
|
+
"maxLength": 32767
|
|
56296
|
+
},
|
|
56297
|
+
"applicationId": {
|
|
56298
|
+
"type": "string",
|
|
56299
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
56300
|
+
},
|
|
56301
|
+
"startX": {
|
|
56302
|
+
"type": "number"
|
|
56303
|
+
},
|
|
56304
|
+
"startY": {
|
|
56305
|
+
"type": "number"
|
|
56306
|
+
},
|
|
56307
|
+
"width": {
|
|
56308
|
+
"type": "number"
|
|
56309
|
+
},
|
|
56310
|
+
"height": {
|
|
56311
|
+
"type": "number"
|
|
56312
|
+
},
|
|
56313
|
+
"blockType": {
|
|
56314
|
+
"type": "string",
|
|
56315
|
+
"enum": [
|
|
56316
|
+
"device-state-table"
|
|
56317
|
+
]
|
|
56318
|
+
},
|
|
56319
|
+
"config": {
|
|
56320
|
+
"type": "object",
|
|
56321
|
+
"properties": {
|
|
56322
|
+
"attributes": {
|
|
56323
|
+
"oneOf": [
|
|
56324
|
+
{
|
|
56325
|
+
"type": "null"
|
|
56326
|
+
},
|
|
56327
|
+
{
|
|
56328
|
+
"type": "array",
|
|
56329
|
+
"maxItems": 100,
|
|
56330
|
+
"items": {
|
|
56331
|
+
"type": "string",
|
|
56332
|
+
"maxLength": 255
|
|
56333
|
+
}
|
|
56334
|
+
}
|
|
56335
|
+
]
|
|
56336
|
+
},
|
|
56337
|
+
"deviceIds": {
|
|
56338
|
+
"type": "array",
|
|
56339
|
+
"maxItems": 100,
|
|
56340
|
+
"items": {
|
|
56341
|
+
"type": "string",
|
|
56342
|
+
"maxLength": 255
|
|
56343
|
+
}
|
|
56344
|
+
},
|
|
56345
|
+
"deviceTags": {
|
|
56346
|
+
"type": "array",
|
|
56347
|
+
"maxItems": 100,
|
|
56348
|
+
"items": {
|
|
56349
|
+
"type": "object",
|
|
56350
|
+
"properties": {
|
|
56351
|
+
"key": {
|
|
56352
|
+
"type": "string",
|
|
56353
|
+
"maxLength": 255
|
|
56354
|
+
},
|
|
56355
|
+
"value": {
|
|
56356
|
+
"type": "string",
|
|
56357
|
+
"maxLength": 255
|
|
56358
|
+
},
|
|
56359
|
+
"fromCtx": {
|
|
56360
|
+
"type": "string",
|
|
56361
|
+
"maxLength": 255
|
|
56362
|
+
}
|
|
56363
|
+
},
|
|
56364
|
+
"additionalProperties": false
|
|
56365
|
+
}
|
|
56366
|
+
},
|
|
56367
|
+
"query": {
|
|
56368
|
+
"type": "string",
|
|
56369
|
+
"maxLength": 32767
|
|
56370
|
+
},
|
|
56371
|
+
"duration": {
|
|
56372
|
+
"oneOf": [
|
|
56373
|
+
{
|
|
56374
|
+
"type": "integer",
|
|
56375
|
+
"minimum": 0
|
|
56376
|
+
},
|
|
56377
|
+
{
|
|
56378
|
+
"type": "string",
|
|
56379
|
+
"enum": [
|
|
56380
|
+
"{{dashboard.duration}}"
|
|
56381
|
+
]
|
|
56382
|
+
}
|
|
56383
|
+
]
|
|
56384
|
+
},
|
|
56385
|
+
"sortDirection": {
|
|
56386
|
+
"type": "integer",
|
|
56387
|
+
"minimum": -1,
|
|
56388
|
+
"maximum": 1
|
|
56389
|
+
},
|
|
56390
|
+
"sortIndex": {
|
|
56391
|
+
"type": "integer",
|
|
56392
|
+
"minimum": 0,
|
|
56393
|
+
"maximum": 100
|
|
56394
|
+
},
|
|
56395
|
+
"columns": {
|
|
56396
|
+
"type": "array",
|
|
56397
|
+
"maxItems": 100,
|
|
56398
|
+
"items": {
|
|
56399
|
+
"type": "object",
|
|
56400
|
+
"properties": {
|
|
56401
|
+
"headerTemplate": {
|
|
56402
|
+
"type": "string",
|
|
56403
|
+
"maxLength": 1024
|
|
56404
|
+
},
|
|
56405
|
+
"id": {
|
|
56406
|
+
"type": "string",
|
|
56407
|
+
"maxLength": 48
|
|
56408
|
+
},
|
|
56409
|
+
"rowTemplate": {
|
|
56410
|
+
"type": "string",
|
|
56411
|
+
"maxLength": 32767
|
|
56412
|
+
},
|
|
56413
|
+
"type": {
|
|
56414
|
+
"type": "string",
|
|
56415
|
+
"enum": [
|
|
56416
|
+
"deviceTags",
|
|
56417
|
+
"deviceId",
|
|
56418
|
+
"deviceName",
|
|
56419
|
+
"timestamp",
|
|
56420
|
+
"attribute"
|
|
56421
|
+
]
|
|
56422
|
+
},
|
|
56423
|
+
"attribute": {
|
|
56424
|
+
"type": "string",
|
|
56425
|
+
"maxLength": 255
|
|
56426
|
+
}
|
|
56427
|
+
},
|
|
56428
|
+
"additionalProperties": false
|
|
56429
|
+
}
|
|
55988
56430
|
}
|
|
55989
56431
|
},
|
|
55990
56432
|
"additionalProperties": false
|
|
@@ -62684,168 +63126,172 @@ Schema for a collection of Dashboards
|
|
|
62684
63126
|
},
|
|
62685
63127
|
"includeDeviceInfo": {
|
|
62686
63128
|
"type": "boolean"
|
|
62687
|
-
}
|
|
62688
|
-
},
|
|
62689
|
-
"additionalProperties": false
|
|
62690
|
-
}
|
|
62691
|
-
},
|
|
62692
|
-
"required": [
|
|
62693
|
-
"blockType",
|
|
62694
|
-
"startX",
|
|
62695
|
-
"startY",
|
|
62696
|
-
"width",
|
|
62697
|
-
"height"
|
|
62698
|
-
],
|
|
62699
|
-
"additionalProperties": false
|
|
62700
|
-
},
|
|
62701
|
-
{
|
|
62702
|
-
"type": "object",
|
|
62703
|
-
"properties": {
|
|
62704
|
-
"id": {
|
|
62705
|
-
"type": "string",
|
|
62706
|
-
"maxLength": 48
|
|
62707
|
-
},
|
|
62708
|
-
"title": {
|
|
62709
|
-
"type": "string",
|
|
62710
|
-
"maxLength": 255
|
|
62711
|
-
},
|
|
62712
|
-
"description": {
|
|
62713
|
-
"type": "string",
|
|
62714
|
-
"maxLength": 32767
|
|
62715
|
-
},
|
|
62716
|
-
"applicationId": {
|
|
62717
|
-
"type": "string",
|
|
62718
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
62719
|
-
},
|
|
62720
|
-
"startX": {
|
|
62721
|
-
"type": "number"
|
|
62722
|
-
},
|
|
62723
|
-
"startY": {
|
|
62724
|
-
"type": "number"
|
|
62725
|
-
},
|
|
62726
|
-
"width": {
|
|
62727
|
-
"type": "number"
|
|
62728
|
-
},
|
|
62729
|
-
"height": {
|
|
62730
|
-
"type": "number"
|
|
62731
|
-
},
|
|
62732
|
-
"blockType": {
|
|
62733
|
-
"type": "string",
|
|
62734
|
-
"enum": [
|
|
62735
|
-
"device-state-table"
|
|
62736
|
-
]
|
|
62737
|
-
},
|
|
62738
|
-
"config": {
|
|
62739
|
-
"type": "object",
|
|
62740
|
-
"properties": {
|
|
62741
|
-
"attributes": {
|
|
62742
|
-
"oneOf": [
|
|
62743
|
-
{
|
|
62744
|
-
"type": "null"
|
|
62745
|
-
},
|
|
62746
|
-
{
|
|
62747
|
-
"type": "array",
|
|
62748
|
-
"maxItems": 100,
|
|
62749
|
-
"items": {
|
|
62750
|
-
"type": "string",
|
|
62751
|
-
"maxLength": 255
|
|
62752
|
-
}
|
|
62753
|
-
}
|
|
62754
|
-
]
|
|
62755
|
-
},
|
|
62756
|
-
"deviceIds": {
|
|
62757
|
-
"type": "array",
|
|
62758
|
-
"maxItems": 100,
|
|
62759
|
-
"items": {
|
|
62760
|
-
"type": "string",
|
|
62761
|
-
"maxLength": 255
|
|
62762
|
-
}
|
|
62763
63129
|
},
|
|
62764
|
-
"
|
|
62765
|
-
"type": "array",
|
|
62766
|
-
"maxItems": 100,
|
|
62767
|
-
"items": {
|
|
62768
|
-
"type": "object",
|
|
62769
|
-
"properties": {
|
|
62770
|
-
"key": {
|
|
62771
|
-
"type": "string",
|
|
62772
|
-
"maxLength": 255
|
|
62773
|
-
},
|
|
62774
|
-
"value": {
|
|
62775
|
-
"type": "string",
|
|
62776
|
-
"maxLength": 255
|
|
62777
|
-
},
|
|
62778
|
-
"fromCtx": {
|
|
62779
|
-
"type": "string",
|
|
62780
|
-
"maxLength": 255
|
|
62781
|
-
}
|
|
62782
|
-
},
|
|
62783
|
-
"additionalProperties": false
|
|
62784
|
-
}
|
|
62785
|
-
},
|
|
62786
|
-
"query": {
|
|
63130
|
+
"maxResultsPerDevice": {
|
|
62787
63131
|
"type": "string",
|
|
62788
|
-
"maxLength":
|
|
62789
|
-
}
|
|
62790
|
-
|
|
62791
|
-
|
|
62792
|
-
|
|
62793
|
-
|
|
62794
|
-
|
|
62795
|
-
|
|
62796
|
-
|
|
62797
|
-
|
|
62798
|
-
|
|
62799
|
-
|
|
62800
|
-
|
|
62801
|
-
|
|
62802
|
-
|
|
62803
|
-
|
|
62804
|
-
|
|
62805
|
-
|
|
62806
|
-
|
|
62807
|
-
|
|
62808
|
-
|
|
62809
|
-
|
|
62810
|
-
|
|
62811
|
-
|
|
62812
|
-
|
|
62813
|
-
|
|
62814
|
-
|
|
62815
|
-
|
|
62816
|
-
|
|
62817
|
-
|
|
62818
|
-
|
|
62819
|
-
|
|
62820
|
-
|
|
62821
|
-
|
|
62822
|
-
|
|
62823
|
-
|
|
62824
|
-
|
|
62825
|
-
|
|
62826
|
-
|
|
62827
|
-
|
|
62828
|
-
|
|
62829
|
-
|
|
62830
|
-
|
|
62831
|
-
|
|
62832
|
-
|
|
62833
|
-
|
|
62834
|
-
|
|
62835
|
-
|
|
62836
|
-
|
|
62837
|
-
|
|
62838
|
-
|
|
62839
|
-
|
|
62840
|
-
|
|
62841
|
-
|
|
62842
|
-
|
|
62843
|
-
|
|
62844
|
-
|
|
62845
|
-
|
|
62846
|
-
|
|
62847
|
-
|
|
62848
|
-
|
|
63132
|
+
"maxLength": 255
|
|
63133
|
+
}
|
|
63134
|
+
},
|
|
63135
|
+
"additionalProperties": false
|
|
63136
|
+
}
|
|
63137
|
+
},
|
|
63138
|
+
"required": [
|
|
63139
|
+
"blockType",
|
|
63140
|
+
"startX",
|
|
63141
|
+
"startY",
|
|
63142
|
+
"width",
|
|
63143
|
+
"height"
|
|
63144
|
+
],
|
|
63145
|
+
"additionalProperties": false
|
|
63146
|
+
},
|
|
63147
|
+
{
|
|
63148
|
+
"type": "object",
|
|
63149
|
+
"properties": {
|
|
63150
|
+
"id": {
|
|
63151
|
+
"type": "string",
|
|
63152
|
+
"maxLength": 48
|
|
63153
|
+
},
|
|
63154
|
+
"title": {
|
|
63155
|
+
"type": "string",
|
|
63156
|
+
"maxLength": 255
|
|
63157
|
+
},
|
|
63158
|
+
"description": {
|
|
63159
|
+
"type": "string",
|
|
63160
|
+
"maxLength": 32767
|
|
63161
|
+
},
|
|
63162
|
+
"applicationId": {
|
|
63163
|
+
"type": "string",
|
|
63164
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
63165
|
+
},
|
|
63166
|
+
"startX": {
|
|
63167
|
+
"type": "number"
|
|
63168
|
+
},
|
|
63169
|
+
"startY": {
|
|
63170
|
+
"type": "number"
|
|
63171
|
+
},
|
|
63172
|
+
"width": {
|
|
63173
|
+
"type": "number"
|
|
63174
|
+
},
|
|
63175
|
+
"height": {
|
|
63176
|
+
"type": "number"
|
|
63177
|
+
},
|
|
63178
|
+
"blockType": {
|
|
63179
|
+
"type": "string",
|
|
63180
|
+
"enum": [
|
|
63181
|
+
"device-state-table"
|
|
63182
|
+
]
|
|
63183
|
+
},
|
|
63184
|
+
"config": {
|
|
63185
|
+
"type": "object",
|
|
63186
|
+
"properties": {
|
|
63187
|
+
"attributes": {
|
|
63188
|
+
"oneOf": [
|
|
63189
|
+
{
|
|
63190
|
+
"type": "null"
|
|
63191
|
+
},
|
|
63192
|
+
{
|
|
63193
|
+
"type": "array",
|
|
63194
|
+
"maxItems": 100,
|
|
63195
|
+
"items": {
|
|
63196
|
+
"type": "string",
|
|
63197
|
+
"maxLength": 255
|
|
63198
|
+
}
|
|
63199
|
+
}
|
|
63200
|
+
]
|
|
63201
|
+
},
|
|
63202
|
+
"deviceIds": {
|
|
63203
|
+
"type": "array",
|
|
63204
|
+
"maxItems": 100,
|
|
63205
|
+
"items": {
|
|
63206
|
+
"type": "string",
|
|
63207
|
+
"maxLength": 255
|
|
63208
|
+
}
|
|
63209
|
+
},
|
|
63210
|
+
"deviceTags": {
|
|
63211
|
+
"type": "array",
|
|
63212
|
+
"maxItems": 100,
|
|
63213
|
+
"items": {
|
|
63214
|
+
"type": "object",
|
|
63215
|
+
"properties": {
|
|
63216
|
+
"key": {
|
|
63217
|
+
"type": "string",
|
|
63218
|
+
"maxLength": 255
|
|
63219
|
+
},
|
|
63220
|
+
"value": {
|
|
63221
|
+
"type": "string",
|
|
63222
|
+
"maxLength": 255
|
|
63223
|
+
},
|
|
63224
|
+
"fromCtx": {
|
|
63225
|
+
"type": "string",
|
|
63226
|
+
"maxLength": 255
|
|
63227
|
+
}
|
|
63228
|
+
},
|
|
63229
|
+
"additionalProperties": false
|
|
63230
|
+
}
|
|
63231
|
+
},
|
|
63232
|
+
"query": {
|
|
63233
|
+
"type": "string",
|
|
63234
|
+
"maxLength": 32767
|
|
63235
|
+
},
|
|
63236
|
+
"duration": {
|
|
63237
|
+
"oneOf": [
|
|
63238
|
+
{
|
|
63239
|
+
"type": "integer",
|
|
63240
|
+
"minimum": 0
|
|
63241
|
+
},
|
|
63242
|
+
{
|
|
63243
|
+
"type": "string",
|
|
63244
|
+
"enum": [
|
|
63245
|
+
"{{dashboard.duration}}"
|
|
63246
|
+
]
|
|
63247
|
+
}
|
|
63248
|
+
]
|
|
63249
|
+
},
|
|
63250
|
+
"sortDirection": {
|
|
63251
|
+
"type": "integer",
|
|
63252
|
+
"minimum": -1,
|
|
63253
|
+
"maximum": 1
|
|
63254
|
+
},
|
|
63255
|
+
"sortIndex": {
|
|
63256
|
+
"type": "integer",
|
|
63257
|
+
"minimum": 0,
|
|
63258
|
+
"maximum": 100
|
|
63259
|
+
},
|
|
63260
|
+
"columns": {
|
|
63261
|
+
"type": "array",
|
|
63262
|
+
"maxItems": 100,
|
|
63263
|
+
"items": {
|
|
63264
|
+
"type": "object",
|
|
63265
|
+
"properties": {
|
|
63266
|
+
"headerTemplate": {
|
|
63267
|
+
"type": "string",
|
|
63268
|
+
"maxLength": 1024
|
|
63269
|
+
},
|
|
63270
|
+
"id": {
|
|
63271
|
+
"type": "string",
|
|
63272
|
+
"maxLength": 48
|
|
63273
|
+
},
|
|
63274
|
+
"rowTemplate": {
|
|
63275
|
+
"type": "string",
|
|
63276
|
+
"maxLength": 32767
|
|
63277
|
+
},
|
|
63278
|
+
"type": {
|
|
63279
|
+
"type": "string",
|
|
63280
|
+
"enum": [
|
|
63281
|
+
"deviceTags",
|
|
63282
|
+
"deviceId",
|
|
63283
|
+
"deviceName",
|
|
63284
|
+
"timestamp",
|
|
63285
|
+
"attribute"
|
|
63286
|
+
]
|
|
63287
|
+
},
|
|
63288
|
+
"attribute": {
|
|
63289
|
+
"type": "string",
|
|
63290
|
+
"maxLength": 255
|
|
63291
|
+
}
|
|
63292
|
+
},
|
|
63293
|
+
"additionalProperties": false
|
|
63294
|
+
}
|
|
62849
63295
|
}
|
|
62850
63296
|
},
|
|
62851
63297
|
"additionalProperties": false
|
|
@@ -148824,6 +149270,7 @@ Schema for the body of a Github login request
|
|
|
148824
149270
|
"type": "string",
|
|
148825
149271
|
"enum": [
|
|
148826
149272
|
"all.Application",
|
|
149273
|
+
"all.Application.bounded",
|
|
148827
149274
|
"all.Application.read",
|
|
148828
149275
|
"all.Application.cli",
|
|
148829
149276
|
"all.Device",
|
|
@@ -149150,7 +149597,11 @@ Schema for the body of a Github login request
|
|
|
149150
149597
|
"type": "string",
|
|
149151
149598
|
"enum": [
|
|
149152
149599
|
"all.Organization",
|
|
149600
|
+
"all.Organization.bounded",
|
|
149153
149601
|
"all.Organization.read",
|
|
149602
|
+
"only.Organization",
|
|
149603
|
+
"only.Organization.bounded",
|
|
149604
|
+
"only.Organization.read",
|
|
149154
149605
|
"applications.*",
|
|
149155
149606
|
"auditLog.*",
|
|
149156
149607
|
"auditLogs.*",
|
|
@@ -149193,6 +149644,7 @@ Schema for the body of a Github login request
|
|
|
149193
149644
|
"type": "string",
|
|
149194
149645
|
"enum": [
|
|
149195
149646
|
"all.Instance",
|
|
149647
|
+
"all.Instance.bounded",
|
|
149196
149648
|
"all.Instance.read",
|
|
149197
149649
|
"instance.*",
|
|
149198
149650
|
"instance.get",
|
|
@@ -149281,8 +149733,12 @@ Schema for the body of a Github login request
|
|
|
149281
149733
|
"type": "string",
|
|
149282
149734
|
"enum": [
|
|
149283
149735
|
"all.User",
|
|
149736
|
+
"all.User.bounded",
|
|
149284
149737
|
"all.User.read",
|
|
149285
149738
|
"all.User.cli",
|
|
149739
|
+
"only.User",
|
|
149740
|
+
"only.User.bounded",
|
|
149741
|
+
"only.User.read",
|
|
149286
149742
|
"userApiToken.*",
|
|
149287
149743
|
"userApiToken.get",
|
|
149288
149744
|
"userApiToken.patch",
|
|
@@ -149290,6 +149746,13 @@ Schema for the body of a Github login request
|
|
|
149290
149746
|
"userApiTokens.*",
|
|
149291
149747
|
"userApiTokens.get",
|
|
149292
149748
|
"userApiTokens.post",
|
|
149749
|
+
"userOauthToken.*",
|
|
149750
|
+
"userOauthToken.get",
|
|
149751
|
+
"userOauthToken.patch",
|
|
149752
|
+
"userOauthToken.delete",
|
|
149753
|
+
"userOauthTokens.*",
|
|
149754
|
+
"userOauthTokens.get",
|
|
149755
|
+
"userOauthTokens.post",
|
|
149293
149756
|
"applicationTemplate.*",
|
|
149294
149757
|
"applicationTemplate.get",
|
|
149295
149758
|
"applicationTemplates.*",
|
|
@@ -149319,6 +149782,7 @@ Schema for the body of a Github login request
|
|
|
149319
149782
|
"me.invite",
|
|
149320
149783
|
"me.invites",
|
|
149321
149784
|
"me.respondToInvite",
|
|
149785
|
+
"me.refreshToken",
|
|
149322
149786
|
"orgs.*",
|
|
149323
149787
|
"orgs.get",
|
|
149324
149788
|
"orgs.post"
|
|
@@ -155628,7 +156092,7 @@ Schema for an Instance Organization member modification request
|
|
|
155628
156092
|
],
|
|
155629
156093
|
"additionalProperties": false
|
|
155630
156094
|
},
|
|
155631
|
-
"maxItems":
|
|
156095
|
+
"maxItems": 100
|
|
155632
156096
|
},
|
|
155633
156097
|
"dashboardRoles": {
|
|
155634
156098
|
"type": "array",
|
|
@@ -155654,7 +156118,7 @@ Schema for an Instance Organization member modification request
|
|
|
155654
156118
|
],
|
|
155655
156119
|
"additionalProperties": false
|
|
155656
156120
|
},
|
|
155657
|
-
"maxItems":
|
|
156121
|
+
"maxItems": 100
|
|
155658
156122
|
}
|
|
155659
156123
|
},
|
|
155660
156124
|
"additionalProperties": false
|
|
@@ -155721,7 +156185,7 @@ Schema for an Instance Organization member creation request
|
|
|
155721
156185
|
],
|
|
155722
156186
|
"additionalProperties": false
|
|
155723
156187
|
},
|
|
155724
|
-
"maxItems":
|
|
156188
|
+
"maxItems": 100
|
|
155725
156189
|
},
|
|
155726
156190
|
"dashboardRoles": {
|
|
155727
156191
|
"type": "array",
|
|
@@ -155747,7 +156211,7 @@ Schema for an Instance Organization member creation request
|
|
|
155747
156211
|
],
|
|
155748
156212
|
"additionalProperties": false
|
|
155749
156213
|
},
|
|
155750
|
-
"maxItems":
|
|
156214
|
+
"maxItems": 100
|
|
155751
156215
|
}
|
|
155752
156216
|
},
|
|
155753
156217
|
"additionalProperties": false,
|
|
@@ -155798,7 +156262,7 @@ Schema for an Instance Organization member creation request
|
|
|
155798
156262
|
],
|
|
155799
156263
|
"additionalProperties": false
|
|
155800
156264
|
},
|
|
155801
|
-
"maxItems":
|
|
156265
|
+
"maxItems": 100
|
|
155802
156266
|
},
|
|
155803
156267
|
"dashboardRoles": {
|
|
155804
156268
|
"type": "array",
|
|
@@ -155824,7 +156288,7 @@ Schema for an Instance Organization member creation request
|
|
|
155824
156288
|
],
|
|
155825
156289
|
"additionalProperties": false
|
|
155826
156290
|
},
|
|
155827
|
-
"maxItems":
|
|
156291
|
+
"maxItems": 100
|
|
155828
156292
|
},
|
|
155829
156293
|
"disallowTransfer": {
|
|
155830
156294
|
"type": "boolean"
|
|
@@ -156402,7 +156866,7 @@ Schema for the body of an Organization creation request within an instance
|
|
|
156402
156866
|
],
|
|
156403
156867
|
"additionalProperties": false
|
|
156404
156868
|
},
|
|
156405
|
-
"maxItems":
|
|
156869
|
+
"maxItems": 100
|
|
156406
156870
|
},
|
|
156407
156871
|
"dashboardRoles": {
|
|
156408
156872
|
"type": "array",
|
|
@@ -156428,7 +156892,7 @@ Schema for the body of an Organization creation request within an instance
|
|
|
156428
156892
|
],
|
|
156429
156893
|
"additionalProperties": false
|
|
156430
156894
|
},
|
|
156431
|
-
"maxItems":
|
|
156895
|
+
"maxItems": 100
|
|
156432
156896
|
}
|
|
156433
156897
|
},
|
|
156434
156898
|
"additionalProperties": false,
|
|
@@ -156479,7 +156943,7 @@ Schema for the body of an Organization creation request within an instance
|
|
|
156479
156943
|
],
|
|
156480
156944
|
"additionalProperties": false
|
|
156481
156945
|
},
|
|
156482
|
-
"maxItems":
|
|
156946
|
+
"maxItems": 100
|
|
156483
156947
|
},
|
|
156484
156948
|
"dashboardRoles": {
|
|
156485
156949
|
"type": "array",
|
|
@@ -156505,7 +156969,7 @@ Schema for the body of an Organization creation request within an instance
|
|
|
156505
156969
|
],
|
|
156506
156970
|
"additionalProperties": false
|
|
156507
156971
|
},
|
|
156508
|
-
"maxItems":
|
|
156972
|
+
"maxItems": 100
|
|
156509
156973
|
},
|
|
156510
156974
|
"disallowTransfer": {
|
|
156511
156975
|
"type": "boolean"
|
|
@@ -170740,6 +171204,364 @@ Schema for a collection of notification rules
|
|
|
170740
171204
|
|
|
170741
171205
|
<br/>
|
|
170742
171206
|
|
|
171207
|
+
## OAuth Client
|
|
171208
|
+
|
|
171209
|
+
Schema for an OAuth 2.0 client registration response
|
|
171210
|
+
|
|
171211
|
+
### <a name="oauth-client-schema"></a> Schema
|
|
171212
|
+
|
|
171213
|
+
```json
|
|
171214
|
+
{
|
|
171215
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
171216
|
+
"type": "object",
|
|
171217
|
+
"properties": {
|
|
171218
|
+
"client_id": {
|
|
171219
|
+
"type": "string",
|
|
171220
|
+
"description": "Unique client identifier"
|
|
171221
|
+
},
|
|
171222
|
+
"client_secret": {
|
|
171223
|
+
"type": "string",
|
|
171224
|
+
"description": "Client secret (only included in registration response)"
|
|
171225
|
+
},
|
|
171226
|
+
"client_id_issued_at": {
|
|
171227
|
+
"type": "integer",
|
|
171228
|
+
"description": "Time at which the client_id was issued (seconds since epoch)"
|
|
171229
|
+
},
|
|
171230
|
+
"client_secret_expires_at": {
|
|
171231
|
+
"type": "integer",
|
|
171232
|
+
"description": "Time at which the client_secret will expire or 0 if it will not expire (seconds since epoch)"
|
|
171233
|
+
},
|
|
171234
|
+
"client_name": {
|
|
171235
|
+
"type": "string",
|
|
171236
|
+
"minLength": 1,
|
|
171237
|
+
"maxLength": 255,
|
|
171238
|
+
"description": "Human-readable name of the client"
|
|
171239
|
+
},
|
|
171240
|
+
"client_uri": {
|
|
171241
|
+
"type": "string",
|
|
171242
|
+
"format": "uri",
|
|
171243
|
+
"maxLength": 1024
|
|
171244
|
+
},
|
|
171245
|
+
"logo_uri": {
|
|
171246
|
+
"type": "string",
|
|
171247
|
+
"format": "uri",
|
|
171248
|
+
"maxLength": 32768,
|
|
171249
|
+
"description": "URL of the client's logo. May be an http(s) URL or a data:image/* URI."
|
|
171250
|
+
},
|
|
171251
|
+
"redirect_uris": {
|
|
171252
|
+
"type": "array",
|
|
171253
|
+
"minItems": 1,
|
|
171254
|
+
"maxItems": 25,
|
|
171255
|
+
"items": {
|
|
171256
|
+
"type": "string",
|
|
171257
|
+
"format": "uri",
|
|
171258
|
+
"maxLength": 1024
|
|
171259
|
+
},
|
|
171260
|
+
"description": "Array of redirect URIs for use in redirect-based flows"
|
|
171261
|
+
},
|
|
171262
|
+
"grant_types": {
|
|
171263
|
+
"type": "array",
|
|
171264
|
+
"items": {
|
|
171265
|
+
"type": "string",
|
|
171266
|
+
"enum": [
|
|
171267
|
+
"authorization_code",
|
|
171268
|
+
"refresh_token"
|
|
171269
|
+
]
|
|
171270
|
+
},
|
|
171271
|
+
"description": "Array of OAuth 2.0 grant types"
|
|
171272
|
+
},
|
|
171273
|
+
"response_types": {
|
|
171274
|
+
"type": "array",
|
|
171275
|
+
"items": {
|
|
171276
|
+
"type": "string",
|
|
171277
|
+
"enum": [
|
|
171278
|
+
"code"
|
|
171279
|
+
]
|
|
171280
|
+
},
|
|
171281
|
+
"description": "Array of OAuth 2.0 response types"
|
|
171282
|
+
},
|
|
171283
|
+
"token_endpoint_auth_method": {
|
|
171284
|
+
"type": "string",
|
|
171285
|
+
"description": "Authentication method for the token endpoint",
|
|
171286
|
+
"enum": [
|
|
171287
|
+
"client_secret_basic",
|
|
171288
|
+
"client_secret_post",
|
|
171289
|
+
"none"
|
|
171290
|
+
]
|
|
171291
|
+
},
|
|
171292
|
+
"scope": {
|
|
171293
|
+
"type": "string",
|
|
171294
|
+
"maxLength": 1024,
|
|
171295
|
+
"description": "Space-separated list of requested scope values"
|
|
171296
|
+
},
|
|
171297
|
+
"tos_uri": {
|
|
171298
|
+
"type": "string",
|
|
171299
|
+
"format": "uri",
|
|
171300
|
+
"maxLength": 1024
|
|
171301
|
+
},
|
|
171302
|
+
"policy_uri": {
|
|
171303
|
+
"type": "string",
|
|
171304
|
+
"format": "uri",
|
|
171305
|
+
"maxLength": 1024
|
|
171306
|
+
},
|
|
171307
|
+
"creationDate": {
|
|
171308
|
+
"type": "string",
|
|
171309
|
+
"format": "date-time"
|
|
171310
|
+
},
|
|
171311
|
+
"lastUpdated": {
|
|
171312
|
+
"type": "string",
|
|
171313
|
+
"format": "date-time"
|
|
171314
|
+
},
|
|
171315
|
+
"id": {
|
|
171316
|
+
"type": "string",
|
|
171317
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
171318
|
+
}
|
|
171319
|
+
}
|
|
171320
|
+
}
|
|
171321
|
+
```
|
|
171322
|
+
### <a name="oauth-client-example"></a> Example
|
|
171323
|
+
|
|
171324
|
+
```json
|
|
171325
|
+
{
|
|
171326
|
+
"id": "575ec7417ae143cd83dc4a95",
|
|
171327
|
+
"client_id": "575ec7417ae143cd83dc4a95",
|
|
171328
|
+
"client_name": "My OAuth Application",
|
|
171329
|
+
"client_uri": "https://example.com",
|
|
171330
|
+
"logo_uri": "https://example.com/logo.png",
|
|
171331
|
+
"redirect_uris": [
|
|
171332
|
+
"https://example.com/callback",
|
|
171333
|
+
"http://localhost:3000/callback"
|
|
171334
|
+
],
|
|
171335
|
+
"grant_types": [
|
|
171336
|
+
"authorization_code",
|
|
171337
|
+
"refresh_token"
|
|
171338
|
+
],
|
|
171339
|
+
"response_types": [
|
|
171340
|
+
"code"
|
|
171341
|
+
],
|
|
171342
|
+
"token_endpoint_auth_method": "client_secret_post",
|
|
171343
|
+
"scope": "all.User.read all.Application.read",
|
|
171344
|
+
"client_id_issued_at": 1465790400,
|
|
171345
|
+
"client_secret_expires_at": 0,
|
|
171346
|
+
"tos_uri": "https://example.com/terms",
|
|
171347
|
+
"policy_uri": "https://example.com/privacy",
|
|
171348
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
|
171349
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z"
|
|
171350
|
+
}
|
|
171351
|
+
```
|
|
171352
|
+
|
|
171353
|
+
<br/>
|
|
171354
|
+
|
|
171355
|
+
## OAuth Client Registration Request
|
|
171356
|
+
|
|
171357
|
+
Schema for OAuth 2.0 dynamic client registration request
|
|
171358
|
+
|
|
171359
|
+
### <a name="oauth-client-registration-request-schema"></a> Schema
|
|
171360
|
+
|
|
171361
|
+
```json
|
|
171362
|
+
{
|
|
171363
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
171364
|
+
"type": "object",
|
|
171365
|
+
"properties": {
|
|
171366
|
+
"client_name": {
|
|
171367
|
+
"type": "string",
|
|
171368
|
+
"minLength": 1,
|
|
171369
|
+
"maxLength": 255,
|
|
171370
|
+
"description": "Human-readable name of the client"
|
|
171371
|
+
},
|
|
171372
|
+
"client_uri": {
|
|
171373
|
+
"type": "string",
|
|
171374
|
+
"format": "uri",
|
|
171375
|
+
"maxLength": 1024
|
|
171376
|
+
},
|
|
171377
|
+
"logo_uri": {
|
|
171378
|
+
"type": "string",
|
|
171379
|
+
"format": "uri",
|
|
171380
|
+
"maxLength": 32768,
|
|
171381
|
+
"description": "URL of the client's logo. May be an http(s) URL or a data:image/* URI."
|
|
171382
|
+
},
|
|
171383
|
+
"redirect_uris": {
|
|
171384
|
+
"type": "array",
|
|
171385
|
+
"minItems": 1,
|
|
171386
|
+
"maxItems": 25,
|
|
171387
|
+
"items": {
|
|
171388
|
+
"type": "string",
|
|
171389
|
+
"format": "uri",
|
|
171390
|
+
"maxLength": 1024
|
|
171391
|
+
},
|
|
171392
|
+
"description": "Array of redirect URIs for use in redirect-based flows"
|
|
171393
|
+
},
|
|
171394
|
+
"grant_types": {
|
|
171395
|
+
"type": "array",
|
|
171396
|
+
"items": {
|
|
171397
|
+
"type": "string",
|
|
171398
|
+
"enum": [
|
|
171399
|
+
"authorization_code",
|
|
171400
|
+
"refresh_token"
|
|
171401
|
+
]
|
|
171402
|
+
},
|
|
171403
|
+
"description": "Array of OAuth 2.0 grant types"
|
|
171404
|
+
},
|
|
171405
|
+
"response_types": {
|
|
171406
|
+
"type": "array",
|
|
171407
|
+
"items": {
|
|
171408
|
+
"type": "string",
|
|
171409
|
+
"enum": [
|
|
171410
|
+
"code"
|
|
171411
|
+
]
|
|
171412
|
+
},
|
|
171413
|
+
"description": "Array of OAuth 2.0 response types"
|
|
171414
|
+
},
|
|
171415
|
+
"token_endpoint_auth_method": {
|
|
171416
|
+
"type": "string",
|
|
171417
|
+
"description": "Authentication method for the token endpoint",
|
|
171418
|
+
"enum": [
|
|
171419
|
+
"client_secret_basic",
|
|
171420
|
+
"client_secret_post",
|
|
171421
|
+
"none"
|
|
171422
|
+
]
|
|
171423
|
+
},
|
|
171424
|
+
"scope": {
|
|
171425
|
+
"type": "string",
|
|
171426
|
+
"maxLength": 1024,
|
|
171427
|
+
"description": "Space-separated list of requested scope values"
|
|
171428
|
+
},
|
|
171429
|
+
"contacts": {
|
|
171430
|
+
"type": "array",
|
|
171431
|
+
"maxItems": 10,
|
|
171432
|
+
"items": {
|
|
171433
|
+
"type": "string",
|
|
171434
|
+
"format": "email",
|
|
171435
|
+
"maxLength": 1024
|
|
171436
|
+
},
|
|
171437
|
+
"description": "Contact email addresses (stored but not returned in responses)"
|
|
171438
|
+
},
|
|
171439
|
+
"tos_uri": {
|
|
171440
|
+
"type": "string",
|
|
171441
|
+
"format": "uri",
|
|
171442
|
+
"maxLength": 1024
|
|
171443
|
+
},
|
|
171444
|
+
"policy_uri": {
|
|
171445
|
+
"type": "string",
|
|
171446
|
+
"format": "uri",
|
|
171447
|
+
"maxLength": 1024
|
|
171448
|
+
}
|
|
171449
|
+
}
|
|
171450
|
+
}
|
|
171451
|
+
```
|
|
171452
|
+
### <a name="oauth-client-registration-request-example"></a> Example
|
|
171453
|
+
|
|
171454
|
+
```json
|
|
171455
|
+
{
|
|
171456
|
+
"client_name": "My OAuth Application",
|
|
171457
|
+
"client_uri": "https://example.com",
|
|
171458
|
+
"logo_uri": "https://example.com/logo.png",
|
|
171459
|
+
"redirect_uris": [
|
|
171460
|
+
"https://example.com/callback",
|
|
171461
|
+
"http://localhost:3000/callback"
|
|
171462
|
+
],
|
|
171463
|
+
"contacts": [
|
|
171464
|
+
"admin@example.com"
|
|
171465
|
+
],
|
|
171466
|
+
"tos_uri": "https://example.com/terms",
|
|
171467
|
+
"policy_uri": "https://example.com/privacy"
|
|
171468
|
+
}
|
|
171469
|
+
```
|
|
171470
|
+
|
|
171471
|
+
<br/>
|
|
171472
|
+
|
|
171473
|
+
## OAuth DCR Error
|
|
171474
|
+
|
|
171475
|
+
Schema for OAuth 2.0 Dynamic Client Registration error responses (RFC 7591 Section 3.2.2)
|
|
171476
|
+
|
|
171477
|
+
### <a name="oauth-dcr-error-schema"></a> Schema
|
|
171478
|
+
|
|
171479
|
+
```json
|
|
171480
|
+
{
|
|
171481
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
171482
|
+
"type": "object",
|
|
171483
|
+
"properties": {
|
|
171484
|
+
"error": {
|
|
171485
|
+
"type": "string",
|
|
171486
|
+
"enum": [
|
|
171487
|
+
"invalid_redirect_uri",
|
|
171488
|
+
"invalid_client_metadata",
|
|
171489
|
+
"invalid_software_statement",
|
|
171490
|
+
"unapproved_software_statement"
|
|
171491
|
+
],
|
|
171492
|
+
"description": "OAuth 2.0 DCR error code"
|
|
171493
|
+
},
|
|
171494
|
+
"error_description": {
|
|
171495
|
+
"type": "string",
|
|
171496
|
+
"description": "Human-readable error description"
|
|
171497
|
+
}
|
|
171498
|
+
},
|
|
171499
|
+
"required": [
|
|
171500
|
+
"error"
|
|
171501
|
+
]
|
|
171502
|
+
}
|
|
171503
|
+
```
|
|
171504
|
+
### <a name="oauth-dcr-error-example"></a> Example
|
|
171505
|
+
|
|
171506
|
+
```json
|
|
171507
|
+
{
|
|
171508
|
+
"error": "invalid_redirect_uri",
|
|
171509
|
+
"error_description": "HTTP redirect URIs are only allowed for localhost"
|
|
171510
|
+
}
|
|
171511
|
+
```
|
|
171512
|
+
|
|
171513
|
+
<br/>
|
|
171514
|
+
|
|
171515
|
+
## OAuth Error
|
|
171516
|
+
|
|
171517
|
+
Schema for OAuth 2.0 error responses (RFC 6749 Section 5.2)
|
|
171518
|
+
|
|
171519
|
+
### <a name="oauth-error-schema"></a> Schema
|
|
171520
|
+
|
|
171521
|
+
```json
|
|
171522
|
+
{
|
|
171523
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
171524
|
+
"type": "object",
|
|
171525
|
+
"properties": {
|
|
171526
|
+
"error": {
|
|
171527
|
+
"type": "string",
|
|
171528
|
+
"enum": [
|
|
171529
|
+
"invalid_request",
|
|
171530
|
+
"invalid_client",
|
|
171531
|
+
"invalid_grant",
|
|
171532
|
+
"unauthorized_client",
|
|
171533
|
+
"unsupported_grant_type",
|
|
171534
|
+
"invalid_scope",
|
|
171535
|
+
"invalid_target",
|
|
171536
|
+
"temporarily_unavailable"
|
|
171537
|
+
],
|
|
171538
|
+
"description": "OAuth 2.0 error code"
|
|
171539
|
+
},
|
|
171540
|
+
"error_description": {
|
|
171541
|
+
"type": "string",
|
|
171542
|
+
"description": "Human-readable error description"
|
|
171543
|
+
},
|
|
171544
|
+
"error_uri": {
|
|
171545
|
+
"type": "string",
|
|
171546
|
+
"description": "URI identifying a human-readable web page with information about the error"
|
|
171547
|
+
}
|
|
171548
|
+
},
|
|
171549
|
+
"required": [
|
|
171550
|
+
"error"
|
|
171551
|
+
]
|
|
171552
|
+
}
|
|
171553
|
+
```
|
|
171554
|
+
### <a name="oauth-error-example"></a> Example
|
|
171555
|
+
|
|
171556
|
+
```json
|
|
171557
|
+
{
|
|
171558
|
+
"error": "invalid_grant",
|
|
171559
|
+
"error_description": "The provided authorization code is invalid, expired, or revoked"
|
|
171560
|
+
}
|
|
171561
|
+
```
|
|
171562
|
+
|
|
171563
|
+
<br/>
|
|
171564
|
+
|
|
170743
171565
|
## Organization
|
|
170744
171566
|
|
|
170745
171567
|
Schema for a single Organization
|
|
@@ -170838,7 +171660,7 @@ Schema for a single Organization
|
|
|
170838
171660
|
],
|
|
170839
171661
|
"additionalProperties": false
|
|
170840
171662
|
},
|
|
170841
|
-
"maxItems":
|
|
171663
|
+
"maxItems": 100
|
|
170842
171664
|
},
|
|
170843
171665
|
"dashboardRoles": {
|
|
170844
171666
|
"type": "array",
|
|
@@ -170864,7 +171686,7 @@ Schema for a single Organization
|
|
|
170864
171686
|
],
|
|
170865
171687
|
"additionalProperties": false
|
|
170866
171688
|
},
|
|
170867
|
-
"maxItems":
|
|
171689
|
+
"maxItems": 100
|
|
170868
171690
|
},
|
|
170869
171691
|
"twoFactorAuthEnabled": {
|
|
170870
171692
|
"type": "boolean"
|
|
@@ -171470,7 +172292,7 @@ Schema for a pending invitation to an Organization
|
|
|
171470
172292
|
],
|
|
171471
172293
|
"additionalProperties": false
|
|
171472
172294
|
},
|
|
171473
|
-
"maxItems":
|
|
172295
|
+
"maxItems": 100
|
|
171474
172296
|
},
|
|
171475
172297
|
"dashboardRoles": {
|
|
171476
172298
|
"type": "array",
|
|
@@ -171496,7 +172318,7 @@ Schema for a pending invitation to an Organization
|
|
|
171496
172318
|
],
|
|
171497
172319
|
"additionalProperties": false
|
|
171498
172320
|
},
|
|
171499
|
-
"maxItems":
|
|
172321
|
+
"maxItems": 100
|
|
171500
172322
|
},
|
|
171501
172323
|
"inviteDate": {
|
|
171502
172324
|
"type": "string",
|
|
@@ -171683,7 +172505,7 @@ Schema for an collection of pending invitations to an Instance Organization
|
|
|
171683
172505
|
],
|
|
171684
172506
|
"additionalProperties": false
|
|
171685
172507
|
},
|
|
171686
|
-
"maxItems":
|
|
172508
|
+
"maxItems": 100
|
|
171687
172509
|
},
|
|
171688
172510
|
"dashboardRoles": {
|
|
171689
172511
|
"type": "array",
|
|
@@ -171709,7 +172531,7 @@ Schema for an collection of pending invitations to an Instance Organization
|
|
|
171709
172531
|
],
|
|
171710
172532
|
"additionalProperties": false
|
|
171711
172533
|
},
|
|
171712
|
-
"maxItems":
|
|
172534
|
+
"maxItems": 100
|
|
171713
172535
|
},
|
|
171714
172536
|
"inviteDate": {
|
|
171715
172537
|
"type": "string",
|
|
@@ -171904,7 +172726,7 @@ Schema for the body of a request to send an invitation
|
|
|
171904
172726
|
],
|
|
171905
172727
|
"additionalProperties": false
|
|
171906
172728
|
},
|
|
171907
|
-
"maxItems":
|
|
172729
|
+
"maxItems": 100
|
|
171908
172730
|
},
|
|
171909
172731
|
"dashboardRoles": {
|
|
171910
172732
|
"type": "array",
|
|
@@ -171930,7 +172752,7 @@ Schema for the body of a request to send an invitation
|
|
|
171930
172752
|
],
|
|
171931
172753
|
"additionalProperties": false
|
|
171932
172754
|
},
|
|
171933
|
-
"maxItems":
|
|
172755
|
+
"maxItems": 100
|
|
171934
172756
|
},
|
|
171935
172757
|
"disallowTransfer": {
|
|
171936
172758
|
"type": "boolean"
|
|
@@ -172157,7 +172979,7 @@ Schema for an array of pending invitations to an Organization
|
|
|
172157
172979
|
],
|
|
172158
172980
|
"additionalProperties": false
|
|
172159
172981
|
},
|
|
172160
|
-
"maxItems":
|
|
172982
|
+
"maxItems": 100
|
|
172161
172983
|
},
|
|
172162
172984
|
"dashboardRoles": {
|
|
172163
172985
|
"type": "array",
|
|
@@ -172183,7 +173005,7 @@ Schema for an array of pending invitations to an Organization
|
|
|
172183
173005
|
],
|
|
172184
173006
|
"additionalProperties": false
|
|
172185
173007
|
},
|
|
172186
|
-
"maxItems":
|
|
173008
|
+
"maxItems": 100
|
|
172187
173009
|
},
|
|
172188
173010
|
"inviteDate": {
|
|
172189
173011
|
"type": "string",
|
|
@@ -172374,7 +173196,7 @@ Schema for the body of a request to modify an Organization member
|
|
|
172374
173196
|
],
|
|
172375
173197
|
"additionalProperties": false
|
|
172376
173198
|
},
|
|
172377
|
-
"maxItems":
|
|
173199
|
+
"maxItems": 100
|
|
172378
173200
|
},
|
|
172379
173201
|
"dashboardRoles": {
|
|
172380
173202
|
"type": "array",
|
|
@@ -172400,7 +173222,7 @@ Schema for the body of a request to modify an Organization member
|
|
|
172400
173222
|
],
|
|
172401
173223
|
"additionalProperties": false
|
|
172402
173224
|
},
|
|
172403
|
-
"maxItems":
|
|
173225
|
+
"maxItems": 100
|
|
172404
173226
|
}
|
|
172405
173227
|
},
|
|
172406
173228
|
"additionalProperties": false,
|
|
@@ -172588,7 +173410,7 @@ Schema for an Organization member's role info
|
|
|
172588
173410
|
],
|
|
172589
173411
|
"additionalProperties": false
|
|
172590
173412
|
},
|
|
172591
|
-
"maxItems":
|
|
173413
|
+
"maxItems": 100
|
|
172592
173414
|
},
|
|
172593
173415
|
"dashboardRoles": {
|
|
172594
173416
|
"type": "array",
|
|
@@ -172614,7 +173436,7 @@ Schema for an Organization member's role info
|
|
|
172614
173436
|
],
|
|
172615
173437
|
"additionalProperties": false
|
|
172616
173438
|
},
|
|
172617
|
-
"maxItems":
|
|
173439
|
+
"maxItems": 100
|
|
172618
173440
|
}
|
|
172619
173441
|
},
|
|
172620
173442
|
"additionalProperties": false
|
|
@@ -172735,7 +173557,7 @@ Schema for a collection of Organizations
|
|
|
172735
173557
|
],
|
|
172736
173558
|
"additionalProperties": false
|
|
172737
173559
|
},
|
|
172738
|
-
"maxItems":
|
|
173560
|
+
"maxItems": 100
|
|
172739
173561
|
},
|
|
172740
173562
|
"dashboardRoles": {
|
|
172741
173563
|
"type": "array",
|
|
@@ -172761,7 +173583,7 @@ Schema for a collection of Organizations
|
|
|
172761
173583
|
],
|
|
172762
173584
|
"additionalProperties": false
|
|
172763
173585
|
},
|
|
172764
|
-
"maxItems":
|
|
173586
|
+
"maxItems": 100
|
|
172765
173587
|
},
|
|
172766
173588
|
"twoFactorAuthEnabled": {
|
|
172767
173589
|
"type": "boolean"
|
|
@@ -175754,6 +176576,7 @@ SAML Response body for login
|
|
|
175754
176576
|
"type": "string",
|
|
175755
176577
|
"enum": [
|
|
175756
176578
|
"all.Application",
|
|
176579
|
+
"all.Application.bounded",
|
|
175757
176580
|
"all.Application.read",
|
|
175758
176581
|
"all.Application.cli",
|
|
175759
176582
|
"all.Device",
|
|
@@ -176080,7 +176903,11 @@ SAML Response body for login
|
|
|
176080
176903
|
"type": "string",
|
|
176081
176904
|
"enum": [
|
|
176082
176905
|
"all.Organization",
|
|
176906
|
+
"all.Organization.bounded",
|
|
176083
176907
|
"all.Organization.read",
|
|
176908
|
+
"only.Organization",
|
|
176909
|
+
"only.Organization.bounded",
|
|
176910
|
+
"only.Organization.read",
|
|
176084
176911
|
"applications.*",
|
|
176085
176912
|
"auditLog.*",
|
|
176086
176913
|
"auditLogs.*",
|
|
@@ -176123,6 +176950,7 @@ SAML Response body for login
|
|
|
176123
176950
|
"type": "string",
|
|
176124
176951
|
"enum": [
|
|
176125
176952
|
"all.Instance",
|
|
176953
|
+
"all.Instance.bounded",
|
|
176126
176954
|
"all.Instance.read",
|
|
176127
176955
|
"instance.*",
|
|
176128
176956
|
"instance.get",
|
|
@@ -176211,8 +177039,12 @@ SAML Response body for login
|
|
|
176211
177039
|
"type": "string",
|
|
176212
177040
|
"enum": [
|
|
176213
177041
|
"all.User",
|
|
177042
|
+
"all.User.bounded",
|
|
176214
177043
|
"all.User.read",
|
|
176215
177044
|
"all.User.cli",
|
|
177045
|
+
"only.User",
|
|
177046
|
+
"only.User.bounded",
|
|
177047
|
+
"only.User.read",
|
|
176216
177048
|
"userApiToken.*",
|
|
176217
177049
|
"userApiToken.get",
|
|
176218
177050
|
"userApiToken.patch",
|
|
@@ -176220,6 +177052,13 @@ SAML Response body for login
|
|
|
176220
177052
|
"userApiTokens.*",
|
|
176221
177053
|
"userApiTokens.get",
|
|
176222
177054
|
"userApiTokens.post",
|
|
177055
|
+
"userOauthToken.*",
|
|
177056
|
+
"userOauthToken.get",
|
|
177057
|
+
"userOauthToken.patch",
|
|
177058
|
+
"userOauthToken.delete",
|
|
177059
|
+
"userOauthTokens.*",
|
|
177060
|
+
"userOauthTokens.get",
|
|
177061
|
+
"userOauthTokens.post",
|
|
176223
177062
|
"applicationTemplate.*",
|
|
176224
177063
|
"applicationTemplate.get",
|
|
176225
177064
|
"applicationTemplates.*",
|
|
@@ -176249,6 +177088,7 @@ SAML Response body for login
|
|
|
176249
177088
|
"me.invite",
|
|
176250
177089
|
"me.invites",
|
|
176251
177090
|
"me.respondToInvite",
|
|
177091
|
+
"me.refreshToken",
|
|
176252
177092
|
"orgs.*",
|
|
176253
177093
|
"orgs.get",
|
|
176254
177094
|
"orgs.post"
|
|
@@ -179189,6 +180029,7 @@ Schema for the body of a User authentication request
|
|
|
179189
180029
|
"type": "string",
|
|
179190
180030
|
"enum": [
|
|
179191
180031
|
"all.Application",
|
|
180032
|
+
"all.Application.bounded",
|
|
179192
180033
|
"all.Application.read",
|
|
179193
180034
|
"all.Application.cli",
|
|
179194
180035
|
"all.Device",
|
|
@@ -179515,7 +180356,11 @@ Schema for the body of a User authentication request
|
|
|
179515
180356
|
"type": "string",
|
|
179516
180357
|
"enum": [
|
|
179517
180358
|
"all.Organization",
|
|
180359
|
+
"all.Organization.bounded",
|
|
179518
180360
|
"all.Organization.read",
|
|
180361
|
+
"only.Organization",
|
|
180362
|
+
"only.Organization.bounded",
|
|
180363
|
+
"only.Organization.read",
|
|
179519
180364
|
"applications.*",
|
|
179520
180365
|
"auditLog.*",
|
|
179521
180366
|
"auditLogs.*",
|
|
@@ -179558,6 +180403,7 @@ Schema for the body of a User authentication request
|
|
|
179558
180403
|
"type": "string",
|
|
179559
180404
|
"enum": [
|
|
179560
180405
|
"all.Instance",
|
|
180406
|
+
"all.Instance.bounded",
|
|
179561
180407
|
"all.Instance.read",
|
|
179562
180408
|
"instance.*",
|
|
179563
180409
|
"instance.get",
|
|
@@ -179646,8 +180492,12 @@ Schema for the body of a User authentication request
|
|
|
179646
180492
|
"type": "string",
|
|
179647
180493
|
"enum": [
|
|
179648
180494
|
"all.User",
|
|
180495
|
+
"all.User.bounded",
|
|
179649
180496
|
"all.User.read",
|
|
179650
180497
|
"all.User.cli",
|
|
180498
|
+
"only.User",
|
|
180499
|
+
"only.User.bounded",
|
|
180500
|
+
"only.User.read",
|
|
179651
180501
|
"userApiToken.*",
|
|
179652
180502
|
"userApiToken.get",
|
|
179653
180503
|
"userApiToken.patch",
|
|
@@ -179655,6 +180505,13 @@ Schema for the body of a User authentication request
|
|
|
179655
180505
|
"userApiTokens.*",
|
|
179656
180506
|
"userApiTokens.get",
|
|
179657
180507
|
"userApiTokens.post",
|
|
180508
|
+
"userOauthToken.*",
|
|
180509
|
+
"userOauthToken.get",
|
|
180510
|
+
"userOauthToken.patch",
|
|
180511
|
+
"userOauthToken.delete",
|
|
180512
|
+
"userOauthTokens.*",
|
|
180513
|
+
"userOauthTokens.get",
|
|
180514
|
+
"userOauthTokens.post",
|
|
179658
180515
|
"applicationTemplate.*",
|
|
179659
180516
|
"applicationTemplate.get",
|
|
179660
180517
|
"applicationTemplates.*",
|
|
@@ -179684,6 +180541,7 @@ Schema for the body of a User authentication request
|
|
|
179684
180541
|
"me.invite",
|
|
179685
180542
|
"me.invites",
|
|
179686
180543
|
"me.respondToInvite",
|
|
180544
|
+
"me.refreshToken",
|
|
179687
180545
|
"orgs.*",
|
|
179688
180546
|
"orgs.get",
|
|
179689
180547
|
"orgs.post"
|
|
@@ -179715,6 +180573,918 @@ Schema for the body of a User authentication request
|
|
|
179715
180573
|
|
|
179716
180574
|
<br/>
|
|
179717
180575
|
|
|
180576
|
+
## User OAuth Token
|
|
180577
|
+
|
|
180578
|
+
Schema for a single OAuth Token
|
|
180579
|
+
|
|
180580
|
+
### <a name="user-oauth-token-schema"></a> Schema
|
|
180581
|
+
|
|
180582
|
+
```json
|
|
180583
|
+
{
|
|
180584
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
180585
|
+
"type": "object",
|
|
180586
|
+
"properties": {
|
|
180587
|
+
"id": {
|
|
180588
|
+
"type": "string",
|
|
180589
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
180590
|
+
},
|
|
180591
|
+
"oauthTokenId": {
|
|
180592
|
+
"type": "string",
|
|
180593
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
180594
|
+
},
|
|
180595
|
+
"name": {
|
|
180596
|
+
"type": "string",
|
|
180597
|
+
"minLength": 1,
|
|
180598
|
+
"maxLength": 255
|
|
180599
|
+
},
|
|
180600
|
+
"description": {
|
|
180601
|
+
"type": "string",
|
|
180602
|
+
"maxLength": 32767
|
|
180603
|
+
},
|
|
180604
|
+
"creationDate": {
|
|
180605
|
+
"type": "string",
|
|
180606
|
+
"format": "date-time"
|
|
180607
|
+
},
|
|
180608
|
+
"lastUpdated": {
|
|
180609
|
+
"type": "string",
|
|
180610
|
+
"format": "date-time"
|
|
180611
|
+
},
|
|
180612
|
+
"expirationDate": {
|
|
180613
|
+
"type": "string",
|
|
180614
|
+
"format": "date-time"
|
|
180615
|
+
},
|
|
180616
|
+
"defaultRole": {
|
|
180617
|
+
"type": "string",
|
|
180618
|
+
"enum": [
|
|
180619
|
+
"admin",
|
|
180620
|
+
"edit",
|
|
180621
|
+
"collaborate",
|
|
180622
|
+
"view",
|
|
180623
|
+
"none"
|
|
180624
|
+
]
|
|
180625
|
+
},
|
|
180626
|
+
"orgRoles": {
|
|
180627
|
+
"type": "array",
|
|
180628
|
+
"items": {
|
|
180629
|
+
"type": "object",
|
|
180630
|
+
"properties": {
|
|
180631
|
+
"orgId": {
|
|
180632
|
+
"oneOf": [
|
|
180633
|
+
{
|
|
180634
|
+
"type": "string",
|
|
180635
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
180636
|
+
},
|
|
180637
|
+
{
|
|
180638
|
+
"type": "string",
|
|
180639
|
+
"enum": [
|
|
180640
|
+
"sandbox"
|
|
180641
|
+
]
|
|
180642
|
+
}
|
|
180643
|
+
]
|
|
180644
|
+
},
|
|
180645
|
+
"role": {
|
|
180646
|
+
"type": "string",
|
|
180647
|
+
"enum": [
|
|
180648
|
+
"admin",
|
|
180649
|
+
"edit",
|
|
180650
|
+
"collaborate",
|
|
180651
|
+
"view",
|
|
180652
|
+
"none"
|
|
180653
|
+
]
|
|
180654
|
+
},
|
|
180655
|
+
"applicationRoles": {
|
|
180656
|
+
"type": "array",
|
|
180657
|
+
"items": {
|
|
180658
|
+
"type": "object",
|
|
180659
|
+
"properties": {
|
|
180660
|
+
"resourceId": {
|
|
180661
|
+
"type": "string",
|
|
180662
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
180663
|
+
},
|
|
180664
|
+
"role": {
|
|
180665
|
+
"type": "string",
|
|
180666
|
+
"enum": [
|
|
180667
|
+
"collaborate",
|
|
180668
|
+
"view",
|
|
180669
|
+
"none"
|
|
180670
|
+
]
|
|
180671
|
+
}
|
|
180672
|
+
},
|
|
180673
|
+
"required": [
|
|
180674
|
+
"resourceId",
|
|
180675
|
+
"role"
|
|
180676
|
+
],
|
|
180677
|
+
"additionalProperties": false
|
|
180678
|
+
},
|
|
180679
|
+
"maxItems": 100
|
|
180680
|
+
},
|
|
180681
|
+
"dashboardRoles": {
|
|
180682
|
+
"type": "array",
|
|
180683
|
+
"items": {
|
|
180684
|
+
"type": "object",
|
|
180685
|
+
"properties": {
|
|
180686
|
+
"resourceId": {
|
|
180687
|
+
"type": "string",
|
|
180688
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
180689
|
+
},
|
|
180690
|
+
"role": {
|
|
180691
|
+
"type": "string",
|
|
180692
|
+
"enum": [
|
|
180693
|
+
"collaborate",
|
|
180694
|
+
"view",
|
|
180695
|
+
"none"
|
|
180696
|
+
]
|
|
180697
|
+
}
|
|
180698
|
+
},
|
|
180699
|
+
"required": [
|
|
180700
|
+
"resourceId",
|
|
180701
|
+
"role"
|
|
180702
|
+
],
|
|
180703
|
+
"additionalProperties": false
|
|
180704
|
+
},
|
|
180705
|
+
"maxItems": 100
|
|
180706
|
+
}
|
|
180707
|
+
},
|
|
180708
|
+
"required": [
|
|
180709
|
+
"orgId",
|
|
180710
|
+
"role"
|
|
180711
|
+
],
|
|
180712
|
+
"additionalProperties": false
|
|
180713
|
+
},
|
|
180714
|
+
"maxItems": 25
|
|
180715
|
+
},
|
|
180716
|
+
"scope": {
|
|
180717
|
+
"type": "array",
|
|
180718
|
+
"uniqueItems": true,
|
|
180719
|
+
"items": {
|
|
180720
|
+
"type": "string",
|
|
180721
|
+
"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.",
|
|
180722
|
+
"enum": [
|
|
180723
|
+
"all.Application.read",
|
|
180724
|
+
"all.Application.bounded",
|
|
180725
|
+
"only.Organization.read",
|
|
180726
|
+
"only.Organization.bounded",
|
|
180727
|
+
"all.Organization.read",
|
|
180728
|
+
"all.Organization.bounded",
|
|
180729
|
+
"only.User.read"
|
|
180730
|
+
]
|
|
180731
|
+
},
|
|
180732
|
+
"description": "API scopes for this OAuth client"
|
|
180733
|
+
},
|
|
180734
|
+
"status": {
|
|
180735
|
+
"type": "string",
|
|
180736
|
+
"enum": [
|
|
180737
|
+
"active",
|
|
180738
|
+
"inactive"
|
|
180739
|
+
]
|
|
180740
|
+
},
|
|
180741
|
+
"oauth": {
|
|
180742
|
+
"type": "object",
|
|
180743
|
+
"properties": {
|
|
180744
|
+
"client_id": {
|
|
180745
|
+
"type": "string",
|
|
180746
|
+
"minLength": 24,
|
|
180747
|
+
"maxLength": 1024,
|
|
180748
|
+
"description": "The registered OAuth client ID (ObjectId or HTTPS URL for CIMD)"
|
|
180749
|
+
},
|
|
180750
|
+
"client_name": {
|
|
180751
|
+
"type": "string",
|
|
180752
|
+
"maxLength": 255,
|
|
180753
|
+
"description": "Human-readable name of the OAuth client (from client registration)"
|
|
180754
|
+
},
|
|
180755
|
+
"client_uri": {
|
|
180756
|
+
"type": "string",
|
|
180757
|
+
"maxLength": 1024,
|
|
180758
|
+
"description": "Informational URL for the OAuth client's homepage (from client registration)"
|
|
180759
|
+
},
|
|
180760
|
+
"logo_uri": {
|
|
180761
|
+
"type": "string",
|
|
180762
|
+
"maxLength": 32768,
|
|
180763
|
+
"description": "Logo URL for the OAuth client (http(s) URL or data: URI, from client registration)"
|
|
180764
|
+
},
|
|
180765
|
+
"redirect_uri": {
|
|
180766
|
+
"type": "string",
|
|
180767
|
+
"format": "uri",
|
|
180768
|
+
"maxLength": 1024
|
|
180769
|
+
},
|
|
180770
|
+
"resource": {
|
|
180771
|
+
"type": "array",
|
|
180772
|
+
"items": {
|
|
180773
|
+
"type": "string",
|
|
180774
|
+
"format": "uri",
|
|
180775
|
+
"maxLength": 1024
|
|
180776
|
+
},
|
|
180777
|
+
"description": "Resource indicator(s) per RFC 8707 — audience(s) this token is bound to"
|
|
180778
|
+
},
|
|
180779
|
+
"authorizationStatus": {
|
|
180780
|
+
"type": "string",
|
|
180781
|
+
"enum": [
|
|
180782
|
+
"pending",
|
|
180783
|
+
"authorized"
|
|
180784
|
+
]
|
|
180785
|
+
}
|
|
180786
|
+
}
|
|
180787
|
+
}
|
|
180788
|
+
}
|
|
180789
|
+
}
|
|
180790
|
+
```
|
|
180791
|
+
### <a name="user-oauth-token-example"></a> Example
|
|
180792
|
+
|
|
180793
|
+
```json
|
|
180794
|
+
{
|
|
180795
|
+
"id": "575ec7417ae143cd83dc4a95",
|
|
180796
|
+
"oauthTokenId": "575ec7417ae143cd83dc4a95",
|
|
180797
|
+
"name": "My OAuth App",
|
|
180798
|
+
"description": "OAuth application for automation",
|
|
180799
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
|
180800
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
|
180801
|
+
"scope": [
|
|
180802
|
+
"only.User.read",
|
|
180803
|
+
"all.Application.read"
|
|
180804
|
+
],
|
|
180805
|
+
"defaultRole": "view",
|
|
180806
|
+
"orgRoles": [],
|
|
180807
|
+
"status": "active",
|
|
180808
|
+
"oauth": {
|
|
180809
|
+
"client_id": "575ec8687ae143cd83dc4a97",
|
|
180810
|
+
"client_name": "My OAuth Client",
|
|
180811
|
+
"client_uri": "https://example.com",
|
|
180812
|
+
"logo_uri": "https://example.com/logo.png",
|
|
180813
|
+
"redirect_uri": "https://example.com/callback",
|
|
180814
|
+
"authorizationStatus": "authorized"
|
|
180815
|
+
}
|
|
180816
|
+
}
|
|
180817
|
+
```
|
|
180818
|
+
|
|
180819
|
+
<br/>
|
|
180820
|
+
|
|
180821
|
+
## User OAuth Token Patch
|
|
180822
|
+
|
|
180823
|
+
Schema for the body of an OAuth Token modification request
|
|
180824
|
+
|
|
180825
|
+
### <a name="user-oauth-token-patch-schema"></a> Schema
|
|
180826
|
+
|
|
180827
|
+
```json
|
|
180828
|
+
{
|
|
180829
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
180830
|
+
"type": "object",
|
|
180831
|
+
"properties": {
|
|
180832
|
+
"name": {
|
|
180833
|
+
"type": "string",
|
|
180834
|
+
"minLength": 1,
|
|
180835
|
+
"maxLength": 255
|
|
180836
|
+
},
|
|
180837
|
+
"description": {
|
|
180838
|
+
"type": "string",
|
|
180839
|
+
"maxLength": 32767
|
|
180840
|
+
},
|
|
180841
|
+
"defaultRole": {
|
|
180842
|
+
"type": "string",
|
|
180843
|
+
"enum": [
|
|
180844
|
+
"admin",
|
|
180845
|
+
"edit",
|
|
180846
|
+
"collaborate",
|
|
180847
|
+
"view",
|
|
180848
|
+
"none"
|
|
180849
|
+
]
|
|
180850
|
+
},
|
|
180851
|
+
"orgRoles": {
|
|
180852
|
+
"type": "array",
|
|
180853
|
+
"items": {
|
|
180854
|
+
"type": "object",
|
|
180855
|
+
"properties": {
|
|
180856
|
+
"orgId": {
|
|
180857
|
+
"oneOf": [
|
|
180858
|
+
{
|
|
180859
|
+
"type": "string",
|
|
180860
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
180861
|
+
},
|
|
180862
|
+
{
|
|
180863
|
+
"type": "string",
|
|
180864
|
+
"enum": [
|
|
180865
|
+
"sandbox"
|
|
180866
|
+
]
|
|
180867
|
+
}
|
|
180868
|
+
]
|
|
180869
|
+
},
|
|
180870
|
+
"role": {
|
|
180871
|
+
"type": "string",
|
|
180872
|
+
"enum": [
|
|
180873
|
+
"admin",
|
|
180874
|
+
"edit",
|
|
180875
|
+
"collaborate",
|
|
180876
|
+
"view",
|
|
180877
|
+
"none"
|
|
180878
|
+
]
|
|
180879
|
+
},
|
|
180880
|
+
"applicationRoles": {
|
|
180881
|
+
"type": "array",
|
|
180882
|
+
"items": {
|
|
180883
|
+
"type": "object",
|
|
180884
|
+
"properties": {
|
|
180885
|
+
"resourceId": {
|
|
180886
|
+
"type": "string",
|
|
180887
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
180888
|
+
},
|
|
180889
|
+
"role": {
|
|
180890
|
+
"type": "string",
|
|
180891
|
+
"enum": [
|
|
180892
|
+
"collaborate",
|
|
180893
|
+
"view",
|
|
180894
|
+
"none"
|
|
180895
|
+
]
|
|
180896
|
+
}
|
|
180897
|
+
},
|
|
180898
|
+
"required": [
|
|
180899
|
+
"resourceId",
|
|
180900
|
+
"role"
|
|
180901
|
+
],
|
|
180902
|
+
"additionalProperties": false
|
|
180903
|
+
},
|
|
180904
|
+
"maxItems": 100
|
|
180905
|
+
},
|
|
180906
|
+
"dashboardRoles": {
|
|
180907
|
+
"type": "array",
|
|
180908
|
+
"items": {
|
|
180909
|
+
"type": "object",
|
|
180910
|
+
"properties": {
|
|
180911
|
+
"resourceId": {
|
|
180912
|
+
"type": "string",
|
|
180913
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
180914
|
+
},
|
|
180915
|
+
"role": {
|
|
180916
|
+
"type": "string",
|
|
180917
|
+
"enum": [
|
|
180918
|
+
"collaborate",
|
|
180919
|
+
"view",
|
|
180920
|
+
"none"
|
|
180921
|
+
]
|
|
180922
|
+
}
|
|
180923
|
+
},
|
|
180924
|
+
"required": [
|
|
180925
|
+
"resourceId",
|
|
180926
|
+
"role"
|
|
180927
|
+
],
|
|
180928
|
+
"additionalProperties": false
|
|
180929
|
+
},
|
|
180930
|
+
"maxItems": 100
|
|
180931
|
+
}
|
|
180932
|
+
},
|
|
180933
|
+
"required": [
|
|
180934
|
+
"orgId",
|
|
180935
|
+
"role"
|
|
180936
|
+
],
|
|
180937
|
+
"additionalProperties": false
|
|
180938
|
+
},
|
|
180939
|
+
"maxItems": 25
|
|
180940
|
+
},
|
|
180941
|
+
"status": {
|
|
180942
|
+
"type": "string",
|
|
180943
|
+
"enum": [
|
|
180944
|
+
"active",
|
|
180945
|
+
"inactive"
|
|
180946
|
+
]
|
|
180947
|
+
}
|
|
180948
|
+
},
|
|
180949
|
+
"additionalProperties": false
|
|
180950
|
+
}
|
|
180951
|
+
```
|
|
180952
|
+
### <a name="user-oauth-token-patch-example"></a> Example
|
|
180953
|
+
|
|
180954
|
+
```json
|
|
180955
|
+
{
|
|
180956
|
+
"name": "Updated OAuth App Name",
|
|
180957
|
+
"description": "Updated description",
|
|
180958
|
+
"defaultRole": "edit",
|
|
180959
|
+
"status": "inactive"
|
|
180960
|
+
}
|
|
180961
|
+
```
|
|
180962
|
+
|
|
180963
|
+
<br/>
|
|
180964
|
+
|
|
180965
|
+
## User OAuth Token Post
|
|
180966
|
+
|
|
180967
|
+
Schema for the body of an OAuth Token creation request
|
|
180968
|
+
|
|
180969
|
+
### <a name="user-oauth-token-post-schema"></a> Schema
|
|
180970
|
+
|
|
180971
|
+
```json
|
|
180972
|
+
{
|
|
180973
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
180974
|
+
"type": "object",
|
|
180975
|
+
"properties": {
|
|
180976
|
+
"name": {
|
|
180977
|
+
"type": "string",
|
|
180978
|
+
"minLength": 1,
|
|
180979
|
+
"maxLength": 255
|
|
180980
|
+
},
|
|
180981
|
+
"description": {
|
|
180982
|
+
"type": "string",
|
|
180983
|
+
"maxLength": 32767
|
|
180984
|
+
},
|
|
180985
|
+
"expirationDate": {
|
|
180986
|
+
"oneOf": [
|
|
180987
|
+
{
|
|
180988
|
+
"type": "string",
|
|
180989
|
+
"format": "date-time"
|
|
180990
|
+
},
|
|
180991
|
+
{
|
|
180992
|
+
"type": "null"
|
|
180993
|
+
}
|
|
180994
|
+
],
|
|
180995
|
+
"description": "Session expiration. Omit for the default 1-year session, pass an ISO date for a specific expiration, or pass null for a session that does not expire."
|
|
180996
|
+
},
|
|
180997
|
+
"oauth": {
|
|
180998
|
+
"type": "object",
|
|
180999
|
+
"properties": {
|
|
181000
|
+
"client_id": {
|
|
181001
|
+
"type": "string",
|
|
181002
|
+
"minLength": 24,
|
|
181003
|
+
"maxLength": 1024,
|
|
181004
|
+
"description": "The registered OAuth client ID (ObjectId or HTTPS URL for CIMD)"
|
|
181005
|
+
},
|
|
181006
|
+
"redirect_uri": {
|
|
181007
|
+
"type": "string",
|
|
181008
|
+
"format": "uri",
|
|
181009
|
+
"maxLength": 1024
|
|
181010
|
+
},
|
|
181011
|
+
"resource": {
|
|
181012
|
+
"type": "array",
|
|
181013
|
+
"maxItems": 10,
|
|
181014
|
+
"items": {
|
|
181015
|
+
"type": "string",
|
|
181016
|
+
"format": "uri",
|
|
181017
|
+
"maxLength": 1024
|
|
181018
|
+
},
|
|
181019
|
+
"description": "Resource indicator(s) per RFC 8707 — absolute URI(s) identifying the audience(s) this token is being requested for"
|
|
181020
|
+
},
|
|
181021
|
+
"code_challenge": {
|
|
181022
|
+
"type": "string",
|
|
181023
|
+
"minLength": 43,
|
|
181024
|
+
"maxLength": 128,
|
|
181025
|
+
"pattern": "^[A-Za-z0-9_-]+$",
|
|
181026
|
+
"description": "PKCE code challenge (RFC 7636 base64url, 43-128 chars)"
|
|
181027
|
+
},
|
|
181028
|
+
"code_challenge_method": {
|
|
181029
|
+
"type": "string",
|
|
181030
|
+
"enum": [
|
|
181031
|
+
"S256"
|
|
181032
|
+
],
|
|
181033
|
+
"description": "PKCE code challenge method"
|
|
181034
|
+
}
|
|
181035
|
+
},
|
|
181036
|
+
"additionalProperties": false,
|
|
181037
|
+
"required": [
|
|
181038
|
+
"client_id",
|
|
181039
|
+
"redirect_uri",
|
|
181040
|
+
"code_challenge",
|
|
181041
|
+
"code_challenge_method"
|
|
181042
|
+
]
|
|
181043
|
+
},
|
|
181044
|
+
"defaultRole": {
|
|
181045
|
+
"type": "string",
|
|
181046
|
+
"enum": [
|
|
181047
|
+
"admin",
|
|
181048
|
+
"edit",
|
|
181049
|
+
"collaborate",
|
|
181050
|
+
"view",
|
|
181051
|
+
"none"
|
|
181052
|
+
]
|
|
181053
|
+
},
|
|
181054
|
+
"orgRoles": {
|
|
181055
|
+
"type": "array",
|
|
181056
|
+
"items": {
|
|
181057
|
+
"type": "object",
|
|
181058
|
+
"properties": {
|
|
181059
|
+
"orgId": {
|
|
181060
|
+
"oneOf": [
|
|
181061
|
+
{
|
|
181062
|
+
"type": "string",
|
|
181063
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
181064
|
+
},
|
|
181065
|
+
{
|
|
181066
|
+
"type": "string",
|
|
181067
|
+
"enum": [
|
|
181068
|
+
"sandbox"
|
|
181069
|
+
]
|
|
181070
|
+
}
|
|
181071
|
+
]
|
|
181072
|
+
},
|
|
181073
|
+
"role": {
|
|
181074
|
+
"type": "string",
|
|
181075
|
+
"enum": [
|
|
181076
|
+
"admin",
|
|
181077
|
+
"edit",
|
|
181078
|
+
"collaborate",
|
|
181079
|
+
"view",
|
|
181080
|
+
"none"
|
|
181081
|
+
]
|
|
181082
|
+
},
|
|
181083
|
+
"applicationRoles": {
|
|
181084
|
+
"type": "array",
|
|
181085
|
+
"items": {
|
|
181086
|
+
"type": "object",
|
|
181087
|
+
"properties": {
|
|
181088
|
+
"resourceId": {
|
|
181089
|
+
"type": "string",
|
|
181090
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
181091
|
+
},
|
|
181092
|
+
"role": {
|
|
181093
|
+
"type": "string",
|
|
181094
|
+
"enum": [
|
|
181095
|
+
"collaborate",
|
|
181096
|
+
"view",
|
|
181097
|
+
"none"
|
|
181098
|
+
]
|
|
181099
|
+
}
|
|
181100
|
+
},
|
|
181101
|
+
"required": [
|
|
181102
|
+
"resourceId",
|
|
181103
|
+
"role"
|
|
181104
|
+
],
|
|
181105
|
+
"additionalProperties": false
|
|
181106
|
+
},
|
|
181107
|
+
"maxItems": 100
|
|
181108
|
+
},
|
|
181109
|
+
"dashboardRoles": {
|
|
181110
|
+
"type": "array",
|
|
181111
|
+
"items": {
|
|
181112
|
+
"type": "object",
|
|
181113
|
+
"properties": {
|
|
181114
|
+
"resourceId": {
|
|
181115
|
+
"type": "string",
|
|
181116
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
181117
|
+
},
|
|
181118
|
+
"role": {
|
|
181119
|
+
"type": "string",
|
|
181120
|
+
"enum": [
|
|
181121
|
+
"collaborate",
|
|
181122
|
+
"view",
|
|
181123
|
+
"none"
|
|
181124
|
+
]
|
|
181125
|
+
}
|
|
181126
|
+
},
|
|
181127
|
+
"required": [
|
|
181128
|
+
"resourceId",
|
|
181129
|
+
"role"
|
|
181130
|
+
],
|
|
181131
|
+
"additionalProperties": false
|
|
181132
|
+
},
|
|
181133
|
+
"maxItems": 100
|
|
181134
|
+
}
|
|
181135
|
+
},
|
|
181136
|
+
"required": [
|
|
181137
|
+
"orgId",
|
|
181138
|
+
"role"
|
|
181139
|
+
],
|
|
181140
|
+
"additionalProperties": false
|
|
181141
|
+
},
|
|
181142
|
+
"maxItems": 25
|
|
181143
|
+
},
|
|
181144
|
+
"scope": {
|
|
181145
|
+
"type": "array",
|
|
181146
|
+
"uniqueItems": true,
|
|
181147
|
+
"items": {
|
|
181148
|
+
"type": "string",
|
|
181149
|
+
"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.",
|
|
181150
|
+
"enum": [
|
|
181151
|
+
"all.Application.read",
|
|
181152
|
+
"all.Application.bounded",
|
|
181153
|
+
"only.Organization.read",
|
|
181154
|
+
"only.Organization.bounded",
|
|
181155
|
+
"all.Organization.read",
|
|
181156
|
+
"all.Organization.bounded",
|
|
181157
|
+
"only.User.read"
|
|
181158
|
+
]
|
|
181159
|
+
},
|
|
181160
|
+
"description": "API scopes for this OAuth client"
|
|
181161
|
+
}
|
|
181162
|
+
},
|
|
181163
|
+
"additionalProperties": false,
|
|
181164
|
+
"required": [
|
|
181165
|
+
"name",
|
|
181166
|
+
"oauth"
|
|
181167
|
+
]
|
|
181168
|
+
}
|
|
181169
|
+
```
|
|
181170
|
+
### <a name="user-oauth-token-post-example"></a> Example
|
|
181171
|
+
|
|
181172
|
+
```json
|
|
181173
|
+
{
|
|
181174
|
+
"name": "My OAuth App",
|
|
181175
|
+
"description": "OAuth application for automation",
|
|
181176
|
+
"scope": [
|
|
181177
|
+
"only.User.read",
|
|
181178
|
+
"all.Application.read"
|
|
181179
|
+
],
|
|
181180
|
+
"defaultRole": "view",
|
|
181181
|
+
"oauth": {
|
|
181182
|
+
"client_id": "575ec8687ae143cd83dc4a97",
|
|
181183
|
+
"redirect_uri": "https://example.com/callback",
|
|
181184
|
+
"code_challenge": "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM",
|
|
181185
|
+
"code_challenge_method": "S256"
|
|
181186
|
+
}
|
|
181187
|
+
}
|
|
181188
|
+
```
|
|
181189
|
+
|
|
181190
|
+
<br/>
|
|
181191
|
+
|
|
181192
|
+
## User OAuth Tokens
|
|
181193
|
+
|
|
181194
|
+
Schema for a collection of OAuth Tokens
|
|
181195
|
+
|
|
181196
|
+
### <a name="user-oauth-tokens-schema"></a> Schema
|
|
181197
|
+
|
|
181198
|
+
```json
|
|
181199
|
+
{
|
|
181200
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
181201
|
+
"type": "object",
|
|
181202
|
+
"properties": {
|
|
181203
|
+
"items": {
|
|
181204
|
+
"type": "array",
|
|
181205
|
+
"items": {
|
|
181206
|
+
"title": "User OAuth Token",
|
|
181207
|
+
"description": "Schema for a single OAuth Token",
|
|
181208
|
+
"type": "object",
|
|
181209
|
+
"properties": {
|
|
181210
|
+
"id": {
|
|
181211
|
+
"type": "string",
|
|
181212
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
181213
|
+
},
|
|
181214
|
+
"oauthTokenId": {
|
|
181215
|
+
"type": "string",
|
|
181216
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
181217
|
+
},
|
|
181218
|
+
"name": {
|
|
181219
|
+
"type": "string",
|
|
181220
|
+
"minLength": 1,
|
|
181221
|
+
"maxLength": 255
|
|
181222
|
+
},
|
|
181223
|
+
"description": {
|
|
181224
|
+
"type": "string",
|
|
181225
|
+
"maxLength": 32767
|
|
181226
|
+
},
|
|
181227
|
+
"creationDate": {
|
|
181228
|
+
"type": "string",
|
|
181229
|
+
"format": "date-time"
|
|
181230
|
+
},
|
|
181231
|
+
"lastUpdated": {
|
|
181232
|
+
"type": "string",
|
|
181233
|
+
"format": "date-time"
|
|
181234
|
+
},
|
|
181235
|
+
"expirationDate": {
|
|
181236
|
+
"type": "string",
|
|
181237
|
+
"format": "date-time"
|
|
181238
|
+
},
|
|
181239
|
+
"defaultRole": {
|
|
181240
|
+
"type": "string",
|
|
181241
|
+
"enum": [
|
|
181242
|
+
"admin",
|
|
181243
|
+
"edit",
|
|
181244
|
+
"collaborate",
|
|
181245
|
+
"view",
|
|
181246
|
+
"none"
|
|
181247
|
+
]
|
|
181248
|
+
},
|
|
181249
|
+
"orgRoles": {
|
|
181250
|
+
"type": "array",
|
|
181251
|
+
"items": {
|
|
181252
|
+
"type": "object",
|
|
181253
|
+
"properties": {
|
|
181254
|
+
"orgId": {
|
|
181255
|
+
"oneOf": [
|
|
181256
|
+
{
|
|
181257
|
+
"type": "string",
|
|
181258
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
181259
|
+
},
|
|
181260
|
+
{
|
|
181261
|
+
"type": "string",
|
|
181262
|
+
"enum": [
|
|
181263
|
+
"sandbox"
|
|
181264
|
+
]
|
|
181265
|
+
}
|
|
181266
|
+
]
|
|
181267
|
+
},
|
|
181268
|
+
"role": {
|
|
181269
|
+
"type": "string",
|
|
181270
|
+
"enum": [
|
|
181271
|
+
"admin",
|
|
181272
|
+
"edit",
|
|
181273
|
+
"collaborate",
|
|
181274
|
+
"view",
|
|
181275
|
+
"none"
|
|
181276
|
+
]
|
|
181277
|
+
},
|
|
181278
|
+
"applicationRoles": {
|
|
181279
|
+
"type": "array",
|
|
181280
|
+
"items": {
|
|
181281
|
+
"type": "object",
|
|
181282
|
+
"properties": {
|
|
181283
|
+
"resourceId": {
|
|
181284
|
+
"type": "string",
|
|
181285
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
181286
|
+
},
|
|
181287
|
+
"role": {
|
|
181288
|
+
"type": "string",
|
|
181289
|
+
"enum": [
|
|
181290
|
+
"collaborate",
|
|
181291
|
+
"view",
|
|
181292
|
+
"none"
|
|
181293
|
+
]
|
|
181294
|
+
}
|
|
181295
|
+
},
|
|
181296
|
+
"required": [
|
|
181297
|
+
"resourceId",
|
|
181298
|
+
"role"
|
|
181299
|
+
],
|
|
181300
|
+
"additionalProperties": false
|
|
181301
|
+
},
|
|
181302
|
+
"maxItems": 100
|
|
181303
|
+
},
|
|
181304
|
+
"dashboardRoles": {
|
|
181305
|
+
"type": "array",
|
|
181306
|
+
"items": {
|
|
181307
|
+
"type": "object",
|
|
181308
|
+
"properties": {
|
|
181309
|
+
"resourceId": {
|
|
181310
|
+
"type": "string",
|
|
181311
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
181312
|
+
},
|
|
181313
|
+
"role": {
|
|
181314
|
+
"type": "string",
|
|
181315
|
+
"enum": [
|
|
181316
|
+
"collaborate",
|
|
181317
|
+
"view",
|
|
181318
|
+
"none"
|
|
181319
|
+
]
|
|
181320
|
+
}
|
|
181321
|
+
},
|
|
181322
|
+
"required": [
|
|
181323
|
+
"resourceId",
|
|
181324
|
+
"role"
|
|
181325
|
+
],
|
|
181326
|
+
"additionalProperties": false
|
|
181327
|
+
},
|
|
181328
|
+
"maxItems": 100
|
|
181329
|
+
}
|
|
181330
|
+
},
|
|
181331
|
+
"required": [
|
|
181332
|
+
"orgId",
|
|
181333
|
+
"role"
|
|
181334
|
+
],
|
|
181335
|
+
"additionalProperties": false
|
|
181336
|
+
},
|
|
181337
|
+
"maxItems": 25
|
|
181338
|
+
},
|
|
181339
|
+
"scope": {
|
|
181340
|
+
"type": "array",
|
|
181341
|
+
"uniqueItems": true,
|
|
181342
|
+
"items": {
|
|
181343
|
+
"type": "string",
|
|
181344
|
+
"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.",
|
|
181345
|
+
"enum": [
|
|
181346
|
+
"all.Application.read",
|
|
181347
|
+
"all.Application.bounded",
|
|
181348
|
+
"only.Organization.read",
|
|
181349
|
+
"only.Organization.bounded",
|
|
181350
|
+
"all.Organization.read",
|
|
181351
|
+
"all.Organization.bounded",
|
|
181352
|
+
"only.User.read"
|
|
181353
|
+
]
|
|
181354
|
+
},
|
|
181355
|
+
"description": "API scopes for this OAuth client"
|
|
181356
|
+
},
|
|
181357
|
+
"status": {
|
|
181358
|
+
"type": "string",
|
|
181359
|
+
"enum": [
|
|
181360
|
+
"active",
|
|
181361
|
+
"inactive"
|
|
181362
|
+
]
|
|
181363
|
+
},
|
|
181364
|
+
"oauth": {
|
|
181365
|
+
"type": "object",
|
|
181366
|
+
"properties": {
|
|
181367
|
+
"client_id": {
|
|
181368
|
+
"type": "string",
|
|
181369
|
+
"minLength": 24,
|
|
181370
|
+
"maxLength": 1024,
|
|
181371
|
+
"description": "The registered OAuth client ID (ObjectId or HTTPS URL for CIMD)"
|
|
181372
|
+
},
|
|
181373
|
+
"client_name": {
|
|
181374
|
+
"type": "string",
|
|
181375
|
+
"maxLength": 255,
|
|
181376
|
+
"description": "Human-readable name of the OAuth client (from client registration)"
|
|
181377
|
+
},
|
|
181378
|
+
"client_uri": {
|
|
181379
|
+
"type": "string",
|
|
181380
|
+
"maxLength": 1024,
|
|
181381
|
+
"description": "Informational URL for the OAuth client's homepage (from client registration)"
|
|
181382
|
+
},
|
|
181383
|
+
"logo_uri": {
|
|
181384
|
+
"type": "string",
|
|
181385
|
+
"maxLength": 32768,
|
|
181386
|
+
"description": "Logo URL for the OAuth client (http(s) URL or data: URI, from client registration)"
|
|
181387
|
+
},
|
|
181388
|
+
"redirect_uri": {
|
|
181389
|
+
"type": "string",
|
|
181390
|
+
"format": "uri",
|
|
181391
|
+
"maxLength": 1024
|
|
181392
|
+
},
|
|
181393
|
+
"resource": {
|
|
181394
|
+
"type": "array",
|
|
181395
|
+
"items": {
|
|
181396
|
+
"type": "string",
|
|
181397
|
+
"format": "uri",
|
|
181398
|
+
"maxLength": 1024
|
|
181399
|
+
},
|
|
181400
|
+
"description": "Resource indicator(s) per RFC 8707 — audience(s) this token is bound to"
|
|
181401
|
+
},
|
|
181402
|
+
"authorizationStatus": {
|
|
181403
|
+
"type": "string",
|
|
181404
|
+
"enum": [
|
|
181405
|
+
"pending",
|
|
181406
|
+
"authorized"
|
|
181407
|
+
]
|
|
181408
|
+
}
|
|
181409
|
+
}
|
|
181410
|
+
}
|
|
181411
|
+
}
|
|
181412
|
+
}
|
|
181413
|
+
},
|
|
181414
|
+
"count": {
|
|
181415
|
+
"type": "integer"
|
|
181416
|
+
},
|
|
181417
|
+
"totalCount": {
|
|
181418
|
+
"type": "integer"
|
|
181419
|
+
},
|
|
181420
|
+
"perPage": {
|
|
181421
|
+
"type": "integer"
|
|
181422
|
+
},
|
|
181423
|
+
"page": {
|
|
181424
|
+
"type": "integer"
|
|
181425
|
+
},
|
|
181426
|
+
"filter": {
|
|
181427
|
+
"type": "string"
|
|
181428
|
+
},
|
|
181429
|
+
"filterField": {
|
|
181430
|
+
"type": "string"
|
|
181431
|
+
},
|
|
181432
|
+
"sortField": {
|
|
181433
|
+
"type": "string"
|
|
181434
|
+
},
|
|
181435
|
+
"sortDirection": {
|
|
181436
|
+
"type": "string",
|
|
181437
|
+
"enum": [
|
|
181438
|
+
"asc",
|
|
181439
|
+
"desc",
|
|
181440
|
+
"ASC",
|
|
181441
|
+
"DESC",
|
|
181442
|
+
""
|
|
181443
|
+
]
|
|
181444
|
+
}
|
|
181445
|
+
}
|
|
181446
|
+
}
|
|
181447
|
+
```
|
|
181448
|
+
### <a name="user-oauth-tokens-example"></a> Example
|
|
181449
|
+
|
|
181450
|
+
```json
|
|
181451
|
+
{
|
|
181452
|
+
"items": [
|
|
181453
|
+
{
|
|
181454
|
+
"id": "575ec7417ae143cd83dc4a95",
|
|
181455
|
+
"oauthTokenId": "575ec7417ae143cd83dc4a95",
|
|
181456
|
+
"name": "My OAuth App",
|
|
181457
|
+
"description": "OAuth application for automation",
|
|
181458
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
|
181459
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
|
181460
|
+
"scope": [
|
|
181461
|
+
"only.User.read",
|
|
181462
|
+
"all.Application.read"
|
|
181463
|
+
],
|
|
181464
|
+
"defaultRole": "view",
|
|
181465
|
+
"orgRoles": [],
|
|
181466
|
+
"status": "active",
|
|
181467
|
+
"oauth": {
|
|
181468
|
+
"client_id": "575ec8687ae143cd83dc4a97",
|
|
181469
|
+
"client_name": "My OAuth Client",
|
|
181470
|
+
"client_uri": "https://example.com",
|
|
181471
|
+
"logo_uri": "https://example.com/logo.png",
|
|
181472
|
+
"redirect_uri": "https://example.com/callback",
|
|
181473
|
+
"authorizationStatus": "authorized"
|
|
181474
|
+
}
|
|
181475
|
+
}
|
|
181476
|
+
],
|
|
181477
|
+
"count": 1,
|
|
181478
|
+
"totalCount": 1,
|
|
181479
|
+
"perPage": 1000,
|
|
181480
|
+
"page": 0,
|
|
181481
|
+
"sortField": "name",
|
|
181482
|
+
"sortDirection": "asc"
|
|
181483
|
+
}
|
|
181484
|
+
```
|
|
181485
|
+
|
|
181486
|
+
<br/>
|
|
181487
|
+
|
|
179718
181488
|
## User Post
|
|
179719
181489
|
|
|
179720
181490
|
Schema for the body of a User creation request
|
|
@@ -179809,6 +181579,7 @@ Schema for the body of a User creation request
|
|
|
179809
181579
|
"type": "string",
|
|
179810
181580
|
"enum": [
|
|
179811
181581
|
"all.Application",
|
|
181582
|
+
"all.Application.bounded",
|
|
179812
181583
|
"all.Application.read",
|
|
179813
181584
|
"all.Application.cli",
|
|
179814
181585
|
"all.Device",
|
|
@@ -180135,7 +181906,11 @@ Schema for the body of a User creation request
|
|
|
180135
181906
|
"type": "string",
|
|
180136
181907
|
"enum": [
|
|
180137
181908
|
"all.Organization",
|
|
181909
|
+
"all.Organization.bounded",
|
|
180138
181910
|
"all.Organization.read",
|
|
181911
|
+
"only.Organization",
|
|
181912
|
+
"only.Organization.bounded",
|
|
181913
|
+
"only.Organization.read",
|
|
180139
181914
|
"applications.*",
|
|
180140
181915
|
"auditLog.*",
|
|
180141
181916
|
"auditLogs.*",
|
|
@@ -180178,6 +181953,7 @@ Schema for the body of a User creation request
|
|
|
180178
181953
|
"type": "string",
|
|
180179
181954
|
"enum": [
|
|
180180
181955
|
"all.Instance",
|
|
181956
|
+
"all.Instance.bounded",
|
|
180181
181957
|
"all.Instance.read",
|
|
180182
181958
|
"instance.*",
|
|
180183
181959
|
"instance.get",
|
|
@@ -180266,8 +182042,12 @@ Schema for the body of a User creation request
|
|
|
180266
182042
|
"type": "string",
|
|
180267
182043
|
"enum": [
|
|
180268
182044
|
"all.User",
|
|
182045
|
+
"all.User.bounded",
|
|
180269
182046
|
"all.User.read",
|
|
180270
182047
|
"all.User.cli",
|
|
182048
|
+
"only.User",
|
|
182049
|
+
"only.User.bounded",
|
|
182050
|
+
"only.User.read",
|
|
180271
182051
|
"userApiToken.*",
|
|
180272
182052
|
"userApiToken.get",
|
|
180273
182053
|
"userApiToken.patch",
|
|
@@ -180275,6 +182055,13 @@ Schema for the body of a User creation request
|
|
|
180275
182055
|
"userApiTokens.*",
|
|
180276
182056
|
"userApiTokens.get",
|
|
180277
182057
|
"userApiTokens.post",
|
|
182058
|
+
"userOauthToken.*",
|
|
182059
|
+
"userOauthToken.get",
|
|
182060
|
+
"userOauthToken.patch",
|
|
182061
|
+
"userOauthToken.delete",
|
|
182062
|
+
"userOauthTokens.*",
|
|
182063
|
+
"userOauthTokens.get",
|
|
182064
|
+
"userOauthTokens.post",
|
|
180278
182065
|
"applicationTemplate.*",
|
|
180279
182066
|
"applicationTemplate.get",
|
|
180280
182067
|
"applicationTemplates.*",
|
|
@@ -180304,6 +182091,7 @@ Schema for the body of a User creation request
|
|
|
180304
182091
|
"me.invite",
|
|
180305
182092
|
"me.invites",
|
|
180306
182093
|
"me.respondToInvite",
|
|
182094
|
+
"me.refreshToken",
|
|
180307
182095
|
"orgs.*",
|
|
180308
182096
|
"orgs.get",
|
|
180309
182097
|
"orgs.post"
|