losant_rest 2.0.0 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/_schemas.md +140925 -67028
- data/docs/application.md +27 -27
- 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 +5 -4
- data/docs/applicationDashboard.md +5 -5
- 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 +5 -5
- data/docs/auditLog.md +1 -1
- data/docs/auditLogs.md +1 -1
- data/docs/auth.md +1 -1
- data/docs/credential.md +4 -4
- data/docs/credentials.md +2 -2
- data/docs/dashboard.md +4 -4
- data/docs/dashboards.md +3 -2
- data/docs/data.md +3 -3
- data/docs/dataTable.md +5 -5
- data/docs/dataTableRow.md +4 -4
- data/docs/dataTableRows.md +9 -9
- data/docs/dataTables.md +2 -2
- data/docs/device.md +15 -15
- 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 +7 -7
- data/docs/embeddedDeployment.md +1 -1
- data/docs/embeddedDeployments.md +8 -8
- data/docs/event.md +3 -3
- data/docs/events.md +6 -6
- data/docs/experience.md +3 -3
- 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 +9 -9
- data/docs/files.md +3 -3
- data/docs/flow.md +11 -11
- data/docs/flowVersion.md +6 -6
- data/docs/flowVersions.md +4 -4
- data/docs/flows.md +5 -5
- data/docs/instance.md +8 -8
- data/docs/instanceApiToken.md +1 -1
- data/docs/instanceApiTokens.md +2 -2
- 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 +2 -2
- data/docs/instanceMembers.md +1 -1
- data/docs/instanceNotificationRule.md +5 -5
- data/docs/instanceNotificationRules.md +2 -2
- data/docs/instanceOrg.md +8 -8
- data/docs/instanceOrgInvite.md +3 -3
- data/docs/instanceOrgInvites.md +2 -2
- data/docs/instanceOrgMember.md +1 -1
- data/docs/instanceOrgMembers.md +3 -2
- data/docs/instanceOrgs.md +3 -3
- 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 +21 -21
- data/docs/notebook.md +10 -10
- data/docs/notebooks.md +2 -2
- data/docs/org.md +14 -14
- data/docs/orgs.md +2 -2
- data/docs/privateFile.md +9 -9
- data/docs/privateFiles.md +3 -3
- data/docs/resourceJob.md +8 -8
- data/docs/resourceJobs.md +2 -2
- data/docs/userApiToken.md +3 -3
- data/docs/userApiTokens.md +4 -4
- 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 +21 -21
- 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 +7 -4
- data/lib/platform_rest/application_dashboard.rb +5 -5
- 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 +4 -4
- data/lib/platform_rest/dashboards.rb +3 -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 +4 -4
- data/lib/platform_rest/data_table_rows.rb +9 -9
- data/lib/platform_rest/data_tables.rb +2 -2
- data/lib/platform_rest/device.rb +15 -15
- 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 +7 -7
- data/lib/platform_rest/embedded_deployment.rb +1 -1
- data/lib/platform_rest/embedded_deployments.rb +8 -8
- data/lib/platform_rest/event.rb +3 -3
- data/lib/platform_rest/events.rb +6 -6
- data/lib/platform_rest/experience.rb +3 -3
- 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 +6 -6
- 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 +2 -2
- 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 +2 -2
- 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 +8 -8
- data/lib/platform_rest/instance_org_invite.rb +3 -3
- data/lib/platform_rest/instance_org_invites.rb +3 -3
- data/lib/platform_rest/instance_org_member.rb +1 -1
- data/lib/platform_rest/instance_org_members.rb +3 -2
- data/lib/platform_rest/instance_orgs.rb +3 -3
- 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 +21 -21
- data/lib/platform_rest/notebook.rb +9 -9
- data/lib/platform_rest/notebooks.rb +2 -2
- data/lib/platform_rest/org.rb +14 -14
- data/lib/platform_rest/orgs.rb +2 -2
- data/lib/platform_rest/private_file.rb +6 -6
- data/lib/platform_rest/private_files.rb +2 -2
- data/lib/platform_rest/resource_job.rb +8 -8
- 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 +4 -4
- 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/advancedApplicationCertQuery.json +1885 -0
- data/schemas/advancedApplicationKeyQuery.json +763 -763
- data/schemas/apiToken.json +110 -1
- data/schemas/apiTokenPatch.json +100 -0
- data/schemas/apiTokenPost.json +118 -0
- data/schemas/apiTokens.json +120 -2
- data/schemas/application.json +15 -2
- data/schemas/applicationCertificate.json +90 -58
- data/schemas/applicationCertificateAuthorities.json +24 -0
- data/schemas/applicationCertificateAuthority.json +24 -0
- data/schemas/applicationCertificatePatch.json +32 -4
- data/schemas/applicationCertificatePost.json +28 -30
- data/schemas/applicationCertificates.json +90 -58
- data/schemas/applicationCreationByTemplateResult.json +15 -2
- data/schemas/applicationDashboardPost.json +183 -128
- data/schemas/applicationImportExecutions.json +3 -5
- data/schemas/applicationImportResult.json +674 -0
- data/schemas/applicationJobLog.json +129 -123
- data/schemas/applicationJobLogs.json +129 -123
- data/schemas/applicationKey.json +41 -41
- data/schemas/applicationKeyPatch.json +4 -4
- data/schemas/applicationKeyPost.json +36 -29
- data/schemas/applicationKeys.json +41 -41
- data/schemas/applicationSearchResult.json +10 -10
- data/schemas/applicationTemplates.json +9 -2
- data/schemas/applications.json +15 -2
- data/schemas/auditLog.json +2 -6
- data/schemas/auditLogs.json +2 -6
- data/schemas/authedDevice.json +3 -0
- data/schemas/credential.json +7 -0
- data/schemas/credentialLinkedResources.json +19724 -344
- data/schemas/credentialPatch.json +3 -0
- data/schemas/credentialPost.json +3 -0
- data/schemas/credentials.json +7 -0
- data/schemas/dashboard.json +203 -128
- data/schemas/dashboardBlockSuggestCodePost.json +19 -0
- data/schemas/dashboardPatch.json +183 -128
- data/schemas/dashboardPost.json +183 -128
- data/schemas/dashboardUpdateEventsResult.json +266 -0
- data/schemas/dashboards.json +203 -128
- data/schemas/dataTable.json +11 -0
- data/schemas/dataTableRowPatch.json +16 -0
- data/schemas/dataTableRowPost.json +39 -0
- data/schemas/dataTableRowPostResult.json +54 -0
- data/schemas/dataTables.json +11 -0
- data/schemas/device.json +259 -107
- data/schemas/deviceConnectionStatus.json +4 -0
- data/schemas/deviceLog.json +3 -0
- data/schemas/deviceRecipe.json +259 -108
- data/schemas/deviceRecipes.json +259 -108
- data/schemas/devices.json +287 -116
- data/schemas/edgeDeploymentRelease.json +4252 -39
- data/schemas/edgeDeployments.json +28 -0
- data/schemas/embeddedDeploymentRelease.json +2073 -0
- data/schemas/embeddedDeployments.json +25 -0
- data/schemas/error.json +14 -0
- data/schemas/event.json +4 -1
- data/schemas/eventPlusNewCount.json +4 -1
- data/schemas/events.json +4 -1
- data/schemas/experienceDomains.json +19 -0
- data/schemas/experienceEndpoint.json +19 -0
- data/schemas/experienceEndpoints.json +24 -0
- data/schemas/experienceLinkedResources.json +19728 -313
- data/schemas/experienceSlugs.json +19 -0
- data/schemas/experienceUsers.json +16 -2
- data/schemas/experienceVersions.json +25 -0
- data/schemas/experienceView.json +5 -0
- data/schemas/experienceViews.json +10 -0
- data/schemas/fileUploadPostResponse.json +92 -103
- data/schemas/files.json +5 -1
- data/schemas/flow.json +211 -46
- data/schemas/flowPatch.json +199 -46
- data/schemas/flowPost.json +199 -46
- data/schemas/flowStorageMetadata.json +2 -2
- data/schemas/flowVersion.json +450 -101
- data/schemas/flowVersionPost.json +199 -46
- data/schemas/flowVersions.json +9903 -113
- data/schemas/flows.json +9637 -46
- data/schemas/flowsImportPost.json +398 -92
- data/schemas/flowsImportResult.json +661 -147
- data/schemas/githubLogin.json +18 -0
- data/schemas/historicalSummaries.json +3 -2
- data/schemas/historicalSummary.json +3 -2
- data/schemas/instanceAuditLog.json +2 -6
- data/schemas/instanceAuditLogs.json +90 -1
- data/schemas/instanceCustomNode.json +41 -2
- data/schemas/instanceCustomNodePatch.json +59 -6
- data/schemas/instanceCustomNodePost.json +59 -6
- data/schemas/instanceCustomNodes.json +41 -2
- data/schemas/instanceOrg.json +4 -1
- data/schemas/instanceOrgInvite.json +102 -0
- data/schemas/instanceOrgInviteSent.json +12 -0
- data/schemas/instanceOrgInvites.json +145 -0
- data/schemas/instanceOrgMember.json +52 -0
- data/schemas/instanceOrgMemberPatch.json +2 -2
- data/schemas/instanceOrgMemberPost.json +4 -4
- data/schemas/instanceOrgMembers.json +105 -1
- data/schemas/instanceOrgPost.json +5 -5
- data/schemas/instanceOrgs.json +5 -2
- data/schemas/instanceSandbox.json +5 -1
- data/schemas/instanceSandboxes.json +9 -1
- data/schemas/integration.json +38 -39
- data/schemas/integrationPatch.json +8 -8
- data/schemas/integrationPost.json +8 -8
- data/schemas/integrations.json +38 -39
- data/schemas/jobEnqueuedResult.json +1 -1
- data/schemas/me.json +685 -88
- data/schemas/notebook.json +33 -21
- data/schemas/notebookExecutionLogs.json +20 -0
- data/schemas/notebookMinuteCounts.json +1 -1
- data/schemas/notebookPatch.json +29 -21
- data/schemas/notebookPost.json +29 -21
- data/schemas/notebooks.json +33 -21
- data/schemas/notificationRule.json +4 -0
- data/schemas/notificationRules.json +8 -0
- 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 +16 -3
- data/schemas/orgInvite.json +2 -2
- data/schemas/orgInviteCollection.json +2 -2
- data/schemas/orgInvitePost.json +2 -2
- data/schemas/orgInvites.json +77 -82
- data/schemas/orgInvitesUser.json +44 -47
- data/schemas/orgMemberPatch.json +2 -2
- data/schemas/orgRoleInfo.json +2 -2
- data/schemas/orgs.json +16 -3
- data/schemas/paletteResponse.json +372 -364
- data/schemas/periodSummaries.json +1 -1
- data/schemas/recentItemList.json +226 -27
- data/schemas/resourceJob.json +33 -9
- data/schemas/resourceJobExecutionLogs.json +34 -20
- data/schemas/resourceJobExecutionOptions.json +1 -1
- data/schemas/resourceJobPatch.json +9 -9
- data/schemas/resourceJobPost.json +9 -9
- data/schemas/resourceJobs.json +33 -9
- data/schemas/samlResponse.json +18 -0
- data/schemas/tagValuesResponse.json +1 -2
- data/schemas/templateKeywords.json +1 -0
- data/schemas/timeSeriesData.json +36 -4
- data/schemas/userCredentials.json +18 -0
- data/schemas/userOauthToken.json +210 -0
- data/schemas/userOauthTokenPatch.json +123 -0
- data/schemas/userOauthTokenPost.json +197 -0
- data/schemas/userOauthTokens.json +251 -0
- data/schemas/userPost.json +18 -0
- data/schemas/validateContextError.json +71 -24
- data/schemas/validateContextSuccess.json +71 -24
- metadata +22 -1
data/docs/notebooks.md
CHANGED
|
@@ -24,7 +24,7 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, notebooks.*, or notebooks.get.
|
|
27
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, notebooks.*, or notebooks.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
@@ -69,7 +69,7 @@ puts result
|
|
|
69
69
|
#### Authentication
|
|
70
70
|
The client must be configured with a valid api access token to call this
|
|
71
71
|
action. The token must include at least one of the following scopes:
|
|
72
|
-
all.Application, all.Organization, all.User, notebooks.*, or notebooks.post.
|
|
72
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, notebooks.*, or notebooks.post.
|
|
73
73
|
|
|
74
74
|
#### Available Parameters
|
|
75
75
|
|
data/docs/org.md
CHANGED
|
@@ -35,7 +35,7 @@ puts result
|
|
|
35
35
|
#### Authentication
|
|
36
36
|
The client must be configured with a valid api access token to call this
|
|
37
37
|
action. The token must include at least one of the following scopes:
|
|
38
|
-
all.Organization, all.User, org.*, or org.delete.
|
|
38
|
+
all.Organization, all.Organization.bounded, all.User, all.User.bounded, only.Organization, only.Organization.bounded, org.*, or org.delete.
|
|
39
39
|
|
|
40
40
|
#### Available Parameters
|
|
41
41
|
|
|
@@ -72,7 +72,7 @@ puts result
|
|
|
72
72
|
#### Authentication
|
|
73
73
|
The client must be configured with a valid api access token to call this
|
|
74
74
|
action. The token must include at least one of the following scopes:
|
|
75
|
-
all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.deviceCounts.
|
|
75
|
+
all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, only.Organization, only.Organization.bounded, only.Organization.read, org.*, or org.deviceCounts.
|
|
76
76
|
|
|
77
77
|
#### Available Parameters
|
|
78
78
|
|
|
@@ -111,7 +111,7 @@ puts result
|
|
|
111
111
|
#### Authentication
|
|
112
112
|
The client must be configured with a valid api access token to call this
|
|
113
113
|
action. The token must include at least one of the following scopes:
|
|
114
|
-
all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.get.
|
|
114
|
+
all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, only.Organization, only.Organization.bounded, only.Organization.read, org.*, or org.get.
|
|
115
115
|
|
|
116
116
|
#### Available Parameters
|
|
117
117
|
|
|
@@ -152,7 +152,7 @@ puts result
|
|
|
152
152
|
#### Authentication
|
|
153
153
|
The client must be configured with a valid api access token to call this
|
|
154
154
|
action. The token must include at least one of the following scopes:
|
|
155
|
-
all.Organization, all.User, org.*, or org.inviteMember.
|
|
155
|
+
all.Organization, all.User, only.Organization, org.*, or org.inviteMember.
|
|
156
156
|
|
|
157
157
|
#### Available Parameters
|
|
158
158
|
|
|
@@ -192,7 +192,7 @@ puts result
|
|
|
192
192
|
#### Authentication
|
|
193
193
|
The client must be configured with a valid api access token to call this
|
|
194
194
|
action. The token must include at least one of the following scopes:
|
|
195
|
-
all.Organization, all.User, org.*, or org.modifyMember.
|
|
195
|
+
all.Organization, all.User, only.Organization, org.*, or org.modifyMember.
|
|
196
196
|
|
|
197
197
|
#### Available Parameters
|
|
198
198
|
|
|
@@ -232,7 +232,7 @@ puts result
|
|
|
232
232
|
#### Authentication
|
|
233
233
|
The client must be configured with a valid api access token to call this
|
|
234
234
|
action. The token must include at least one of the following scopes:
|
|
235
|
-
all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.notebookMinuteCounts.
|
|
235
|
+
all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, only.Organization, only.Organization.bounded, only.Organization.read, org.*, or org.notebookMinuteCounts.
|
|
236
236
|
|
|
237
237
|
#### Available Parameters
|
|
238
238
|
|
|
@@ -273,7 +273,7 @@ puts result
|
|
|
273
273
|
#### Authentication
|
|
274
274
|
The client must be configured with a valid api access token to call this
|
|
275
275
|
action. The token must include at least one of the following scopes:
|
|
276
|
-
all.Organization, all.User, org.*, or org.patch.
|
|
276
|
+
all.Organization, all.Organization.bounded, all.User, all.User.bounded, only.Organization, only.Organization.bounded, org.*, or org.patch.
|
|
277
277
|
|
|
278
278
|
#### Available Parameters
|
|
279
279
|
|
|
@@ -313,7 +313,7 @@ puts result
|
|
|
313
313
|
#### Authentication
|
|
314
314
|
The client must be configured with a valid api access token to call this
|
|
315
315
|
action. The token must include at least one of the following scopes:
|
|
316
|
-
all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.payloadCounts.
|
|
316
|
+
all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, only.Organization, only.Organization.bounded, only.Organization.read, org.*, or org.payloadCounts.
|
|
317
317
|
|
|
318
318
|
#### Available Parameters
|
|
319
319
|
|
|
@@ -342,7 +342,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.
|
|
|
342
342
|
|
|
343
343
|
## Payload Counts Breakdown
|
|
344
344
|
|
|
345
|
-
Returns payload counts per resolution in the time range specified for all
|
|
345
|
+
Returns payload counts per resolution in the time range specified for all applications this organization owns
|
|
346
346
|
|
|
347
347
|
```ruby
|
|
348
348
|
result = client.org.payload_counts_breakdown(orgId: my_org_id)
|
|
@@ -353,7 +353,7 @@ puts result
|
|
|
353
353
|
#### Authentication
|
|
354
354
|
The client must be configured with a valid api access token to call this
|
|
355
355
|
action. The token must include at least one of the following scopes:
|
|
356
|
-
all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.payloadCountsBreakdown.
|
|
356
|
+
all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, only.Organization, only.Organization.bounded, only.Organization.read, org.*, or org.payloadCountsBreakdown.
|
|
357
357
|
|
|
358
358
|
#### Available Parameters
|
|
359
359
|
|
|
@@ -395,7 +395,7 @@ puts result
|
|
|
395
395
|
#### Authentication
|
|
396
396
|
The client must be configured with a valid api access token to call this
|
|
397
397
|
action. The token must include at least one of the following scopes:
|
|
398
|
-
all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.pendingInvites.
|
|
398
|
+
all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, only.Organization, only.Organization.bounded, only.Organization.read, org.*, or org.pendingInvites.
|
|
399
399
|
|
|
400
400
|
#### Available Parameters
|
|
401
401
|
|
|
@@ -434,7 +434,7 @@ puts result
|
|
|
434
434
|
#### Authentication
|
|
435
435
|
The client must be configured with a valid api access token to call this
|
|
436
436
|
action. The token must include at least one of the following scopes:
|
|
437
|
-
all.Organization, all.User, org.*, or org.removeMember.
|
|
437
|
+
all.Organization, all.User, only.Organization, org.*, or org.removeMember.
|
|
438
438
|
|
|
439
439
|
#### Available Parameters
|
|
440
440
|
|
|
@@ -476,7 +476,7 @@ puts result
|
|
|
476
476
|
#### Authentication
|
|
477
477
|
The client must be configured with a valid api access token to call this
|
|
478
478
|
action. The token must include at least one of the following scopes:
|
|
479
|
-
all.Organization, all.User, org.*, or org.revokeInvite.
|
|
479
|
+
all.Organization, all.User, only.Organization, org.*, or org.revokeInvite.
|
|
480
480
|
|
|
481
481
|
#### Available Parameters
|
|
482
482
|
|
|
@@ -516,7 +516,7 @@ puts result
|
|
|
516
516
|
#### Authentication
|
|
517
517
|
The client must be configured with a valid api access token to call this
|
|
518
518
|
action. The token must include at least one of the following scopes:
|
|
519
|
-
all.Organization, all.User, org.*, or org.transferResources.
|
|
519
|
+
all.Organization, all.User, only.Organization, org.*, or org.transferResources.
|
|
520
520
|
|
|
521
521
|
#### Available Parameters
|
|
522
522
|
|
data/docs/orgs.md
CHANGED
|
@@ -24,7 +24,7 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.User, all.User.read, orgs.*, or orgs.get.
|
|
27
|
+
all.User, all.User.bounded, all.User.read, only.User, only.User.bounded, only.User.read, orgs.*, or orgs.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
@@ -67,7 +67,7 @@ puts result
|
|
|
67
67
|
#### Authentication
|
|
68
68
|
The client must be configured with a valid api access token to call this
|
|
69
69
|
action. The token must include at least one of the following scopes:
|
|
70
|
-
all.User, orgs.*, or orgs.post.
|
|
70
|
+
all.User, all.User.bounded, only.User, only.User.bounded, orgs.*, or orgs.post.
|
|
71
71
|
|
|
72
72
|
#### Available Parameters
|
|
73
73
|
|
data/docs/privateFile.md
CHANGED
|
@@ -29,7 +29,7 @@ puts result
|
|
|
29
29
|
#### Authentication
|
|
30
30
|
The client must be configured with a valid api access token to call this
|
|
31
31
|
action. The token must include at least one of the following scopes:
|
|
32
|
-
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, privateFile.*, or privateFile.delete.
|
|
32
|
+
all.Application, all.Application.bounded, all.Application.cli, all.Organization, all.Organization.bounded, all.User, all.User.bounded, all.User.cli, privateFile.*, or privateFile.delete.
|
|
33
33
|
|
|
34
34
|
#### Available Parameters
|
|
35
35
|
|
|
@@ -69,7 +69,7 @@ puts result
|
|
|
69
69
|
#### Authentication
|
|
70
70
|
The client must be configured with a valid api access token to call this
|
|
71
71
|
action. The token must include at least one of the following scopes:
|
|
72
|
-
all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, privateFile.*, or privateFile.get.
|
|
72
|
+
all.Application, all.Application.bounded, all.Application.cli, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.cli, all.User.read, privateFile.*, or privateFile.get.
|
|
73
73
|
|
|
74
74
|
#### Available Parameters
|
|
75
75
|
|
|
@@ -84,7 +84,7 @@ all.Application, all.Application.cli, all.Application.read, all.Organization, al
|
|
|
84
84
|
|
|
85
85
|
| Code | Type | Description |
|
|
86
86
|
| ---- | ---- | ----------- |
|
|
87
|
-
| 200 | [File
|
|
87
|
+
| 200 | [File](_schemas.md#file) | Private file information |
|
|
88
88
|
|
|
89
89
|
#### Error Responses
|
|
90
90
|
|
|
@@ -110,7 +110,7 @@ puts result
|
|
|
110
110
|
#### Authentication
|
|
111
111
|
The client must be configured with a valid api access token to call this
|
|
112
112
|
action. The token must include at least one of the following scopes:
|
|
113
|
-
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, privateFile.*, or privateFile.move.
|
|
113
|
+
all.Application, all.Application.bounded, all.Application.cli, all.Organization, all.Organization.bounded, all.User, all.User.bounded, all.User.cli, privateFile.*, or privateFile.move.
|
|
114
114
|
|
|
115
115
|
#### Available Parameters
|
|
116
116
|
|
|
@@ -127,7 +127,7 @@ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli,
|
|
|
127
127
|
|
|
128
128
|
| Code | Type | Description |
|
|
129
129
|
| ---- | ---- | ----------- |
|
|
130
|
-
| 201 | [File
|
|
130
|
+
| 201 | [File](_schemas.md#file) | Returns a new private file or directory that was created by the move, if a directory a job will kick off to move all the directory's children. |
|
|
131
131
|
|
|
132
132
|
#### Error Responses
|
|
133
133
|
|
|
@@ -154,7 +154,7 @@ puts result
|
|
|
154
154
|
#### Authentication
|
|
155
155
|
The client must be configured with a valid api access token to call this
|
|
156
156
|
action. The token must include at least one of the following scopes:
|
|
157
|
-
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, privateFile.*, or privateFile.patch.
|
|
157
|
+
all.Application, all.Application.bounded, all.Application.cli, all.Organization, all.Organization.bounded, all.User, all.User.bounded, all.User.cli, privateFile.*, or privateFile.patch.
|
|
158
158
|
|
|
159
159
|
#### Available Parameters
|
|
160
160
|
|
|
@@ -169,7 +169,7 @@ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli,
|
|
|
169
169
|
|
|
170
170
|
| Code | Type | Description |
|
|
171
171
|
| ---- | ---- | ----------- |
|
|
172
|
-
|
|
|
172
|
+
| 200 | [File Upload Post Response](_schemas.md#file-upload-post-response) | Successfully updated private file and the information needed to upload the file content |
|
|
173
173
|
|
|
174
174
|
#### Error Responses
|
|
175
175
|
|
|
@@ -196,7 +196,7 @@ puts result
|
|
|
196
196
|
#### Authentication
|
|
197
197
|
The client must be configured with a valid api access token to call this
|
|
198
198
|
action. The token must include at least one of the following scopes:
|
|
199
|
-
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, privateFile.*, or privateFile.upload.
|
|
199
|
+
all.Application, all.Application.bounded, all.Application.cli, all.Organization, all.Organization.bounded, all.User, all.User.bounded, all.User.cli, privateFile.*, or privateFile.upload.
|
|
200
200
|
|
|
201
201
|
#### Available Parameters
|
|
202
202
|
|
|
@@ -212,7 +212,7 @@ all.Application, all.Application.cli, all.Organization, all.User, all.User.cli,
|
|
|
212
212
|
|
|
213
213
|
| Code | Type | Description |
|
|
214
214
|
| ---- | ---- | ----------- |
|
|
215
|
-
| 200 | [File
|
|
215
|
+
| 200 | [File](_schemas.md#file) | Updated private file content |
|
|
216
216
|
|
|
217
217
|
#### Error Responses
|
|
218
218
|
|
data/docs/privateFiles.md
CHANGED
|
@@ -24,7 +24,7 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, privateFiles.*, or privateFiles.get.
|
|
27
|
+
all.Application, all.Application.bounded, all.Application.cli, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.cli, all.User.read, privateFiles.*, or privateFiles.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
@@ -47,7 +47,7 @@ all.Application, all.Application.cli, all.Application.read, all.Organization, al
|
|
|
47
47
|
|
|
48
48
|
| Code | Type | Description |
|
|
49
49
|
| ---- | ---- | ----------- |
|
|
50
|
-
| 200 | [Files
|
|
50
|
+
| 200 | [Files](_schemas.md#files) | Collection of private files |
|
|
51
51
|
|
|
52
52
|
#### Error Responses
|
|
53
53
|
|
|
@@ -73,7 +73,7 @@ puts result
|
|
|
73
73
|
#### Authentication
|
|
74
74
|
The client must be configured with a valid api access token to call this
|
|
75
75
|
action. The token must include at least one of the following scopes:
|
|
76
|
-
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, privateFiles.*, or privateFiles.post.
|
|
76
|
+
all.Application, all.Application.bounded, all.Application.cli, all.Organization, all.Organization.bounded, all.User, all.User.bounded, all.User.cli, privateFiles.*, or privateFiles.post.
|
|
77
77
|
|
|
78
78
|
#### Available Parameters
|
|
79
79
|
|
data/docs/resourceJob.md
CHANGED
|
@@ -31,7 +31,7 @@ puts result
|
|
|
31
31
|
#### Authentication
|
|
32
32
|
The client must be configured with a valid api access token to call this
|
|
33
33
|
action. The token must include at least one of the following scopes:
|
|
34
|
-
all.Application, all.Organization, all.User, resourceJob.*, or resourceJob.cancelExecution.
|
|
34
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, resourceJob.*, or resourceJob.cancelExecution.
|
|
35
35
|
|
|
36
36
|
#### Available Parameters
|
|
37
37
|
|
|
@@ -39,7 +39,7 @@ all.Application, all.Organization, all.User, resourceJob.*, or resourceJob.cance
|
|
|
39
39
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
|
40
40
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
|
41
41
|
| resourceJobId | string | Y | ID associated with the resource job | | 575ec8687ae143cd83dc4a97 |
|
|
42
|
-
| executionId |
|
|
42
|
+
| executionId | string | Y | The ID of the execution to cancel | | 632e18632f59592e773a4153 |
|
|
43
43
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
|
44
44
|
|
|
45
45
|
#### Successful Responses
|
|
@@ -72,7 +72,7 @@ puts result
|
|
|
72
72
|
#### Authentication
|
|
73
73
|
The client must be configured with a valid api access token to call this
|
|
74
74
|
action. The token must include at least one of the following scopes:
|
|
75
|
-
all.Application, all.Organization, all.User, resourceJob.*, or resourceJob.delete.
|
|
75
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, resourceJob.*, or resourceJob.delete.
|
|
76
76
|
|
|
77
77
|
#### Available Parameters
|
|
78
78
|
|
|
@@ -114,7 +114,7 @@ puts result
|
|
|
114
114
|
#### Authentication
|
|
115
115
|
The client must be configured with a valid api access token to call this
|
|
116
116
|
action. The token must include at least one of the following scopes:
|
|
117
|
-
all.Application, all.Organization, all.User, resourceJob.*, or resourceJob.execute.
|
|
117
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, resourceJob.*, or resourceJob.execute.
|
|
118
118
|
|
|
119
119
|
#### Available Parameters
|
|
120
120
|
|
|
@@ -155,7 +155,7 @@ puts result
|
|
|
155
155
|
#### Authentication
|
|
156
156
|
The client must be configured with a valid api access token to call this
|
|
157
157
|
action. The token must include at least one of the following scopes:
|
|
158
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, resourceJob.*, or resourceJob.get.
|
|
158
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, resourceJob.*, or resourceJob.get.
|
|
159
159
|
|
|
160
160
|
#### Available Parameters
|
|
161
161
|
|
|
@@ -195,7 +195,7 @@ puts result
|
|
|
195
195
|
#### Authentication
|
|
196
196
|
The client must be configured with a valid api access token to call this
|
|
197
197
|
action. The token must include at least one of the following scopes:
|
|
198
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, resourceJob.*, or resourceJob.logs.
|
|
198
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, resourceJob.*, or resourceJob.logs.
|
|
199
199
|
|
|
200
200
|
#### Available Parameters
|
|
201
201
|
|
|
@@ -238,7 +238,7 @@ puts result
|
|
|
238
238
|
#### Authentication
|
|
239
239
|
The client must be configured with a valid api access token to call this
|
|
240
240
|
action. The token must include at least one of the following scopes:
|
|
241
|
-
all.Application, all.Organization, all.User, resourceJob.*, or resourceJob.patch.
|
|
241
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, resourceJob.*, or resourceJob.patch.
|
|
242
242
|
|
|
243
243
|
#### Available Parameters
|
|
244
244
|
|
|
@@ -253,7 +253,7 @@ all.Application, all.Organization, all.User, resourceJob.*, or resourceJob.patch
|
|
|
253
253
|
|
|
254
254
|
| Code | Type | Description |
|
|
255
255
|
| ---- | ---- | ----------- |
|
|
256
|
-
|
|
|
256
|
+
| 200 | [Resource Job](_schemas.md#resource-job) | Successfully updated resource job |
|
|
257
257
|
|
|
258
258
|
#### Error Responses
|
|
259
259
|
|
data/docs/resourceJobs.md
CHANGED
|
@@ -24,7 +24,7 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, resourceJobs.*, or resourceJobs.get.
|
|
27
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, resourceJobs.*, or resourceJobs.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
@@ -69,7 +69,7 @@ puts result
|
|
|
69
69
|
#### Authentication
|
|
70
70
|
The client must be configured with a valid api access token to call this
|
|
71
71
|
action. The token must include at least one of the following scopes:
|
|
72
|
-
all.Application, all.Organization, all.User, resourceJobs.*, or resourceJobs.post.
|
|
72
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, resourceJobs.*, or resourceJobs.post.
|
|
73
73
|
|
|
74
74
|
#### Available Parameters
|
|
75
75
|
|
data/docs/userApiToken.md
CHANGED
|
@@ -25,7 +25,7 @@ puts result
|
|
|
25
25
|
#### Authentication
|
|
26
26
|
The client must be configured with a valid api access token to call this
|
|
27
27
|
action. The token must include at least one of the following scopes:
|
|
28
|
-
all.User, userApiToken.*, or userApiToken.delete.
|
|
28
|
+
all.User, only.User, userApiToken.*, or userApiToken.delete.
|
|
29
29
|
|
|
30
30
|
#### Available Parameters
|
|
31
31
|
|
|
@@ -62,7 +62,7 @@ puts result
|
|
|
62
62
|
#### Authentication
|
|
63
63
|
The client must be configured with a valid api access token to call this
|
|
64
64
|
action. The token must include at least one of the following scopes:
|
|
65
|
-
all.User, all.User.read, userApiToken.*, or userApiToken.get.
|
|
65
|
+
all.User, all.User.bounded, all.User.read, only.User, only.User.bounded, only.User.read, userApiToken.*, or userApiToken.get.
|
|
66
66
|
|
|
67
67
|
#### Available Parameters
|
|
68
68
|
|
|
@@ -101,7 +101,7 @@ puts result
|
|
|
101
101
|
#### Authentication
|
|
102
102
|
The client must be configured with a valid api access token to call this
|
|
103
103
|
action. The token must include at least one of the following scopes:
|
|
104
|
-
all.User, userApiToken.*, or userApiToken.patch.
|
|
104
|
+
all.User, only.User, userApiToken.*, or userApiToken.patch.
|
|
105
105
|
|
|
106
106
|
#### Available Parameters
|
|
107
107
|
|
data/docs/userApiTokens.md
CHANGED
|
@@ -24,7 +24,7 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.User, all.User.read, userApiTokens.*, or userApiTokens.get.
|
|
27
|
+
all.User, all.User.bounded, all.User.read, only.User, only.User.bounded, only.User.read, userApiTokens.*, or userApiTokens.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
@@ -42,7 +42,7 @@ all.User, all.User.read, userApiTokens.*, or userApiTokens.get.
|
|
|
42
42
|
|
|
43
43
|
| Code | Type | Description |
|
|
44
44
|
| ---- | ---- | ----------- |
|
|
45
|
-
| 200 | [API
|
|
45
|
+
| 200 | [API Tokens](_schemas.md#api-tokens) | Collection of API tokens |
|
|
46
46
|
|
|
47
47
|
#### Error Responses
|
|
48
48
|
|
|
@@ -54,7 +54,7 @@ all.User, all.User.read, userApiTokens.*, or userApiTokens.get.
|
|
|
54
54
|
|
|
55
55
|
## Post
|
|
56
56
|
|
|
57
|
-
Create a new API token for
|
|
57
|
+
Create a new API token for a user
|
|
58
58
|
|
|
59
59
|
```ruby
|
|
60
60
|
result = client.user_api_tokens.post(apiToken: my_api_token)
|
|
@@ -65,7 +65,7 @@ puts result
|
|
|
65
65
|
#### Authentication
|
|
66
66
|
The client must be configured with a valid api access token to call this
|
|
67
67
|
action. The token must include at least one of the following scopes:
|
|
68
|
-
all.User, userApiTokens.*, or userApiTokens.post.
|
|
68
|
+
all.User, only.User, userApiTokens.*, or userApiTokens.post.
|
|
69
69
|
|
|
70
70
|
#### Available Parameters
|
|
71
71
|
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
# User Oauth Token Actions
|
|
2
|
+
|
|
3
|
+
Details on the various actions that can be performed on the
|
|
4
|
+
User Oauth Token resource, including the expected
|
|
5
|
+
parameters and the potential responses.
|
|
6
|
+
|
|
7
|
+
##### Contents
|
|
8
|
+
|
|
9
|
+
* [Delete](#delete)
|
|
10
|
+
* [Get](#get)
|
|
11
|
+
* [Patch](#patch)
|
|
12
|
+
|
|
13
|
+
<br/>
|
|
14
|
+
|
|
15
|
+
## Delete
|
|
16
|
+
|
|
17
|
+
Deletes an OAuth Token
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
result = client.user_oauth_token.delete(oauthTokenId: my_oauth_token_id)
|
|
21
|
+
|
|
22
|
+
puts result
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
#### Authentication
|
|
26
|
+
The client must be configured with a valid api access token to call this
|
|
27
|
+
action. The token must include at least one of the following scopes:
|
|
28
|
+
all.User, only.User, userOauthToken.*, or userOauthToken.delete.
|
|
29
|
+
|
|
30
|
+
#### Available Parameters
|
|
31
|
+
|
|
32
|
+
| Name | Type | Required | Description | Default | Example |
|
|
33
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
|
34
|
+
| oauthTokenId | string | Y | ID associated with the OAuth token | | 575ec7417ae143cd83dc4a95 |
|
|
35
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
|
36
|
+
|
|
37
|
+
#### Successful Responses
|
|
38
|
+
|
|
39
|
+
| Code | Type | Description |
|
|
40
|
+
| ---- | ---- | ----------- |
|
|
41
|
+
| 200 | [Success](_schemas.md#success) | If OAuth token was successfully deleted |
|
|
42
|
+
|
|
43
|
+
#### Error Responses
|
|
44
|
+
|
|
45
|
+
| Code | Type | Description |
|
|
46
|
+
| ---- | ---- | ----------- |
|
|
47
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
|
48
|
+
| 404 | [Error](_schemas.md#error) | Error if OAuth token was not found |
|
|
49
|
+
|
|
50
|
+
<br/>
|
|
51
|
+
|
|
52
|
+
## Get
|
|
53
|
+
|
|
54
|
+
Retrieves information on an OAuth token
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
result = client.user_oauth_token.get(oauthTokenId: my_oauth_token_id)
|
|
58
|
+
|
|
59
|
+
puts result
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
#### Authentication
|
|
63
|
+
The client must be configured with a valid api access token to call this
|
|
64
|
+
action. The token must include at least one of the following scopes:
|
|
65
|
+
all.User, all.User.bounded, all.User.read, only.User, only.User.bounded, only.User.read, userOauthToken.*, or userOauthToken.get.
|
|
66
|
+
|
|
67
|
+
#### Available Parameters
|
|
68
|
+
|
|
69
|
+
| Name | Type | Required | Description | Default | Example |
|
|
70
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
|
71
|
+
| oauthTokenId | string | Y | ID associated with the OAuth token | | 575ec7417ae143cd83dc4a95 |
|
|
72
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
|
73
|
+
|
|
74
|
+
#### Successful Responses
|
|
75
|
+
|
|
76
|
+
| Code | Type | Description |
|
|
77
|
+
| ---- | ---- | ----------- |
|
|
78
|
+
| 200 | [User OAuth Token](_schemas.md#user-oauth-token) | OAuth token information |
|
|
79
|
+
|
|
80
|
+
#### Error Responses
|
|
81
|
+
|
|
82
|
+
| Code | Type | Description |
|
|
83
|
+
| ---- | ---- | ----------- |
|
|
84
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
|
85
|
+
| 404 | [Error](_schemas.md#error) | Error if OAuth token was not found |
|
|
86
|
+
|
|
87
|
+
<br/>
|
|
88
|
+
|
|
89
|
+
## Patch
|
|
90
|
+
|
|
91
|
+
Updates information about an OAuth token
|
|
92
|
+
|
|
93
|
+
```ruby
|
|
94
|
+
result = client.user_oauth_token.patch(
|
|
95
|
+
oauthTokenId: my_oauth_token_id,
|
|
96
|
+
oauthToken: my_oauth_token)
|
|
97
|
+
|
|
98
|
+
puts result
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
#### Authentication
|
|
102
|
+
The client must be configured with a valid api access token to call this
|
|
103
|
+
action. The token must include at least one of the following scopes:
|
|
104
|
+
all.User, only.User, userOauthToken.*, or userOauthToken.patch.
|
|
105
|
+
|
|
106
|
+
#### Available Parameters
|
|
107
|
+
|
|
108
|
+
| Name | Type | Required | Description | Default | Example |
|
|
109
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
|
110
|
+
| oauthTokenId | string | Y | ID associated with the OAuth token | | 575ec7417ae143cd83dc4a95 |
|
|
111
|
+
| oauthToken | [User OAuth Token Patch](_schemas.md#user-oauth-token-patch) | Y | Object containing new properties of the OAuth token | | [User OAuth Token Patch Example](_schemas.md#user-oauth-token-patch-example) |
|
|
112
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
|
113
|
+
|
|
114
|
+
#### Successful Responses
|
|
115
|
+
|
|
116
|
+
| Code | Type | Description |
|
|
117
|
+
| ---- | ---- | ----------- |
|
|
118
|
+
| 200 | [User OAuth Token](_schemas.md#user-oauth-token) | Updated OAuth token information |
|
|
119
|
+
|
|
120
|
+
#### Error Responses
|
|
121
|
+
|
|
122
|
+
| Code | Type | Description |
|
|
123
|
+
| ---- | ---- | ----------- |
|
|
124
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
|
125
|
+
| 404 | [Error](_schemas.md#error) | Error if OAuth token was not found |
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# User Oauth Tokens Actions
|
|
2
|
+
|
|
3
|
+
Details on the various actions that can be performed on the
|
|
4
|
+
User Oauth Tokens resource, including the expected
|
|
5
|
+
parameters and the potential responses.
|
|
6
|
+
|
|
7
|
+
##### Contents
|
|
8
|
+
|
|
9
|
+
* [Get](#get)
|
|
10
|
+
* [Post](#post)
|
|
11
|
+
|
|
12
|
+
<br/>
|
|
13
|
+
|
|
14
|
+
## Get
|
|
15
|
+
|
|
16
|
+
Returns the OAuth tokens for a user
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
result = client.user_oauth_tokens.get(optional_params)
|
|
20
|
+
|
|
21
|
+
puts result
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
#### Authentication
|
|
25
|
+
The client must be configured with a valid api access token to call this
|
|
26
|
+
action. The token must include at least one of the following scopes:
|
|
27
|
+
all.User, all.User.bounded, all.User.read, only.User, only.User.bounded, only.User.read, userOauthTokens.*, or userOauthTokens.get.
|
|
28
|
+
|
|
29
|
+
#### Available Parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Description | Default | Example |
|
|
32
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
|
33
|
+
| sortField | string | N | Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated | name | name |
|
|
34
|
+
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
|
35
|
+
| page | string | N | Which page of results to return | 0 | 0 |
|
|
36
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
|
37
|
+
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
|
38
|
+
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*app |
|
|
39
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
|
40
|
+
|
|
41
|
+
#### Successful Responses
|
|
42
|
+
|
|
43
|
+
| Code | Type | Description |
|
|
44
|
+
| ---- | ---- | ----------- |
|
|
45
|
+
| 200 | [User OAuth Tokens](_schemas.md#user-oauth-tokens) | Collection of OAuth tokens |
|
|
46
|
+
|
|
47
|
+
#### Error Responses
|
|
48
|
+
|
|
49
|
+
| Code | Type | Description |
|
|
50
|
+
| ---- | ---- | ----------- |
|
|
51
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
|
52
|
+
|
|
53
|
+
<br/>
|
|
54
|
+
|
|
55
|
+
## Post
|
|
56
|
+
|
|
57
|
+
Create a new OAuth token for a user
|
|
58
|
+
|
|
59
|
+
```ruby
|
|
60
|
+
result = client.user_oauth_tokens.post(oauthToken: my_oauth_token)
|
|
61
|
+
|
|
62
|
+
puts result
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
#### Authentication
|
|
66
|
+
The client must be configured with a valid api access token to call this
|
|
67
|
+
action. The token must include at least one of the following scopes:
|
|
68
|
+
all.User, only.User, userOauthTokens.*, or userOauthTokens.post.
|
|
69
|
+
|
|
70
|
+
#### Available Parameters
|
|
71
|
+
|
|
72
|
+
| Name | Type | Required | Description | Default | Example |
|
|
73
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
|
74
|
+
| oauthToken | [User OAuth Token Post](_schemas.md#user-oauth-token-post) | Y | OAuth token information | | [User OAuth Token Post Example](_schemas.md#user-oauth-token-post-example) |
|
|
75
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
|
76
|
+
|
|
77
|
+
#### Successful Responses
|
|
78
|
+
|
|
79
|
+
| Code | Type | Description |
|
|
80
|
+
| ---- | ---- | ----------- |
|
|
81
|
+
| 201 | [User OAuth Token](_schemas.md#user-oauth-token) | The successfully created OAuth token |
|
|
82
|
+
|
|
83
|
+
#### Error Responses
|
|
84
|
+
|
|
85
|
+
| Code | Type | Description |
|
|
86
|
+
| ---- | ---- | ----------- |
|
|
87
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
data/docs/webhook.md
CHANGED
|
@@ -27,7 +27,7 @@ puts result
|
|
|
27
27
|
#### Authentication
|
|
28
28
|
The client must be configured with a valid api access token to call this
|
|
29
29
|
action. The token must include at least one of the following scopes:
|
|
30
|
-
all.Application, all.Organization, all.User, webhook.*, or webhook.delete.
|
|
30
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, webhook.*, or webhook.delete.
|
|
31
31
|
|
|
32
32
|
#### Available Parameters
|
|
33
33
|
|
|
@@ -68,7 +68,7 @@ puts result
|
|
|
68
68
|
#### Authentication
|
|
69
69
|
The client must be configured with a valid api access token to call this
|
|
70
70
|
action. The token must include at least one of the following scopes:
|
|
71
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, webhook.*, or webhook.get.
|
|
71
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, webhook.*, or webhook.get.
|
|
72
72
|
|
|
73
73
|
#### Available Parameters
|
|
74
74
|
|
|
@@ -109,7 +109,7 @@ puts result
|
|
|
109
109
|
#### Authentication
|
|
110
110
|
The client must be configured with a valid api access token to call this
|
|
111
111
|
action. The token must include at least one of the following scopes:
|
|
112
|
-
all.Application, all.Organization, all.User, webhook.*, or webhook.patch.
|
|
112
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, webhook.*, or webhook.patch.
|
|
113
113
|
|
|
114
114
|
#### Available Parameters
|
|
115
115
|
|