losant_rest 1.13.0 → 1.15.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/_schemas.md +19437 -10622
- data/docs/application.md +6 -6
- data/docs/applicationApiTokens.md +1 -1
- data/docs/applications.md +1 -1
- data/docs/dataTable.md +1 -1
- data/docs/dataTableRows.md +1 -1
- data/docs/dataTables.md +1 -1
- data/docs/device.md +43 -0
- data/docs/devices.md +41 -2
- data/docs/edgeDeployment.md +49 -0
- data/docs/embeddedDeployment.md +49 -0
- data/docs/embeddedDeployments.md +215 -0
- data/docs/experience.md +1 -1
- data/docs/experienceDomains.md +1 -1
- data/docs/experienceGroup.md +2 -0
- data/docs/experienceSlugs.md +1 -1
- 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 +3 -3
- data/docs/flowVersions.md +44 -0
- data/docs/flows.md +2 -2
- data/docs/instance.md +40 -0
- data/docs/instanceApiToken.md +133 -0
- data/docs/instanceApiTokens.md +91 -0
- data/docs/instanceMembers.md +1 -1
- data/docs/instanceOrg.md +2 -0
- data/docs/instanceOrgInvite.md +139 -0
- data/docs/instanceOrgInvites.md +96 -0
- data/docs/instanceOrgMembers.md +3 -3
- data/docs/instanceOrgs.md +1 -1
- data/docs/me.md +1 -1
- data/docs/org.md +1 -1
- data/docs/userApiToken.md +125 -0
- data/docs/userApiTokens.md +87 -0
- data/lib/losant_rest/application.rb +5 -5
- data/lib/losant_rest/application_api_tokens.rb +1 -1
- data/lib/losant_rest/applications.rb +1 -1
- data/lib/losant_rest/client.rb +38 -2
- data/lib/losant_rest/data_table.rb +1 -1
- data/lib/losant_rest/data_table_rows.rb +1 -1
- data/lib/losant_rest/data_tables.rb +1 -1
- data/lib/losant_rest/device.rb +50 -0
- data/lib/losant_rest/devices.rb +48 -2
- data/lib/losant_rest/edge_deployment.rb +81 -0
- data/lib/losant_rest/embedded_deployment.rb +81 -0
- data/lib/losant_rest/embedded_deployments.rb +280 -0
- data/lib/losant_rest/experience.rb +1 -1
- data/lib/losant_rest/experience_domains.rb +1 -1
- data/lib/losant_rest/experience_group.rb +4 -0
- data/lib/losant_rest/experience_slugs.rb +1 -1
- data/lib/losant_rest/experience_version.rb +3 -3
- data/lib/losant_rest/experience_versions.rb +2 -2
- data/lib/losant_rest/experience_view.rb +4 -4
- data/lib/losant_rest/experience_views.rb +2 -2
- data/lib/losant_rest/file.rb +4 -4
- data/lib/losant_rest/files.rb +2 -2
- data/lib/losant_rest/flow.rb +3 -3
- data/lib/losant_rest/flow_versions.rb +50 -0
- data/lib/losant_rest/flows.rb +2 -2
- data/lib/losant_rest/instance.rb +47 -1
- data/lib/losant_rest/instance_api_token.rb +176 -0
- data/lib/losant_rest/instance_api_tokens.rb +136 -0
- data/lib/losant_rest/instance_member.rb +1 -1
- data/lib/losant_rest/instance_members.rb +2 -2
- data/lib/losant_rest/instance_org.rb +5 -1
- data/lib/losant_rest/instance_org_invite.rb +182 -0
- data/lib/losant_rest/instance_org_invites.rb +138 -0
- data/lib/losant_rest/instance_org_member.rb +1 -1
- data/lib/losant_rest/instance_org_members.rb +4 -4
- data/lib/losant_rest/instance_orgs.rb +3 -3
- data/lib/losant_rest/instances.rb +1 -1
- data/lib/losant_rest/user_api_token.rb +170 -0
- data/lib/losant_rest/user_api_tokens.rb +132 -0
- data/lib/losant_rest/version.rb +1 -1
- data/lib/losant_rest.rb +9 -0
- data/schemas/apiToken.json +2 -1
- data/schemas/apiTokenPost.json +439 -0
- data/schemas/apiTokens.json +4 -2
- data/schemas/application.json +32 -32
- data/schemas/applicationCreationByTemplateResult.json +32 -32
- data/schemas/applicationDashboardPost.json +28 -21
- data/schemas/applicationPatch.json +13 -13
- data/schemas/applicationPost.json +13 -13
- data/schemas/applicationTemplate.json +16 -16
- data/schemas/applicationTemplates.json +16 -16
- data/schemas/applications.json +32 -32
- data/schemas/auditLog.json +4 -0
- data/schemas/auditLogFilter.json +4 -0
- data/schemas/auditLogs.json +4 -0
- data/schemas/authedDevice.json +2 -1
- data/schemas/bulkDeleteResponse.json +12 -0
- data/schemas/dashboard.json +28 -21
- data/schemas/dashboardPatch.json +28 -21
- data/schemas/dashboardPost.json +28 -21
- data/schemas/dashboardSendReport.json +9 -5
- data/schemas/dashboards.json +28 -21
- data/schemas/dataTableRowsDelete.json +1 -1
- data/schemas/device.json +2 -1
- data/schemas/deviceClassFilter.json +4 -2
- data/schemas/devicePatch.json +2 -1
- data/schemas/devicePayloadCounts.json +24 -0
- data/schemas/devicePost.json +2 -1
- data/schemas/deviceRecipe.json +2 -1
- data/schemas/deviceRecipePatch.json +2 -1
- data/schemas/deviceRecipePost.json +2 -1
- data/schemas/deviceRecipes.json +2 -1
- data/schemas/devices.json +4 -2
- data/schemas/devicesExportPayloadCountPost.json +1350 -0
- data/schemas/devicesPatch.json +4 -2
- data/schemas/edgeDeployment.json +20 -0
- data/schemas/edgeDeployments.json +20 -0
- data/schemas/embeddedDeployment.json +179 -0
- data/schemas/embeddedDeploymentExport.json +44 -0
- data/schemas/embeddedDeploymentRelease.json +58 -0
- data/schemas/embeddedDeploymentRemove.json +25 -0
- data/schemas/embeddedDeploymentReplace.json +29 -0
- data/schemas/embeddedDeployments.json +212 -0
- data/schemas/eventsDeleted.json +1 -1
- data/schemas/experienceEndpoint.json +6 -8
- data/schemas/experienceEndpointPatch.json +6 -8
- data/schemas/experienceEndpointPost.json +6 -8
- data/schemas/experienceEndpoints.json +6 -8
- data/schemas/experienceGroup.json +6 -0
- data/schemas/experienceGroups.json +6 -0
- data/schemas/experienceLinkedResources.json +790 -85
- data/schemas/flow.json +252 -16
- data/schemas/flowPatch.json +251 -16
- data/schemas/flowPost.json +252 -16
- data/schemas/flowVersion.json +503 -33
- data/schemas/flowVersionPost.json +251 -16
- data/schemas/flowVersions.json +503 -33
- data/schemas/flowVersionsDeletePost.json +941 -0
- data/schemas/flows.json +253 -16
- data/schemas/flowsImportPost.json +503 -32
- data/schemas/flowsImportResult.json +785 -79
- data/schemas/githubLogin.json +38 -1
- data/schemas/historicalSummary.json +150 -102
- data/schemas/instance.json +150 -77
- data/schemas/instanceMember.json +10 -0
- data/schemas/instanceMemberPost.json +18 -3
- data/schemas/instanceMembers.json +14 -0
- data/schemas/instanceOrg.json +87 -74
- data/schemas/instanceOrgMember.json +14 -0
- data/schemas/instanceOrgMembers.json +8 -0
- data/schemas/instanceOrgPatch.json +64 -26
- data/schemas/instanceOrgPost.json +229 -25
- data/schemas/instanceOrgs.json +91 -74
- data/schemas/instancePatch.json +67 -0
- data/schemas/instanceReportOptionsPost.json +1 -0
- data/schemas/me.json +134 -105
- data/schemas/notebook.json +45 -0
- data/schemas/notebookPatch.json +30 -0
- data/schemas/notebookPost.json +30 -0
- data/schemas/notebooks.json +45 -0
- data/schemas/org.json +145 -110
- data/schemas/orgInvite.json +90 -0
- data/schemas/orgInviteCollection.json +130 -0
- data/schemas/orgInvites.json +82 -77
- data/schemas/orgRoleInfo.json +69 -0
- data/schemas/orgs.json +145 -110
- data/schemas/payloadStats.json +28 -12
- data/schemas/userCredentials.json +38 -1
- data/schemas/userPost.json +38 -1
- data/schemas/validateContextError.json +34 -0
- data/schemas/validateContextSuccess.json +34 -0
- data/schemas/virtualButtonPress.json +4 -0
- metadata +39 -6
data/docs/experienceViews.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, experienceViews.*, or experienceViews.get.
|
27
|
+
all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceViews.*, or experienceViews.get.
|
28
28
|
|
29
29
|
#### Available Parameters
|
30
30
|
|
@@ -71,7 +71,7 @@ puts result
|
|
71
71
|
#### Authentication
|
72
72
|
The client must be configured with a valid api access token to call this
|
73
73
|
action. The token must include at least one of the following scopes:
|
74
|
-
all.Application, all.Organization, all.User, experienceViews.*, or experienceViews.post.
|
74
|
+
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, experienceViews.*, or experienceViews.post.
|
75
75
|
|
76
76
|
#### Available Parameters
|
77
77
|
|
data/docs/file.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.Organization, all.User, file.*, or file.delete.
|
32
|
+
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, file.*, or file.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.read, all.Organization, all.Organization.read, all.User, all.User.read, file.*, or file.get.
|
72
|
+
all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, file.*, or file.get.
|
73
73
|
|
74
74
|
#### Available Parameters
|
75
75
|
|
@@ -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, file.*, or file.move.
|
112
|
+
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, file.*, or file.move.
|
113
113
|
|
114
114
|
#### Available Parameters
|
115
115
|
|
@@ -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.Application, all.Organization, all.User, file.*, or file.patch.
|
155
|
+
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, file.*, or file.patch.
|
156
156
|
|
157
157
|
#### Available Parameters
|
158
158
|
|
@@ -194,7 +194,7 @@ puts result
|
|
194
194
|
#### Authentication
|
195
195
|
The client must be configured with a valid api access token to call this
|
196
196
|
action. The token must include at least one of the following scopes:
|
197
|
-
all.Application, all.Organization, all.User, file.*, or file.upload.
|
197
|
+
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, file.*, or file.upload.
|
198
198
|
|
199
199
|
#### Available Parameters
|
200
200
|
|
data/docs/files.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, files.*, or files.get.
|
27
|
+
all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, files.*, or files.get.
|
28
28
|
|
29
29
|
#### Available Parameters
|
30
30
|
|
@@ -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, files.*, or files.post.
|
75
|
+
all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, files.*, or files.post.
|
76
76
|
|
77
77
|
#### Available Parameters
|
78
78
|
|
data/docs/flow.md
CHANGED
@@ -128,7 +128,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
128
128
|
| limit | string | N | Maximum number of errors to return | 25 | 25 |
|
129
129
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | desc |
|
130
130
|
| flowVersion | string | N | Flow version name or ID. When not included, will be errors for all versions. Pass develop for just the develop version. | | develop |
|
131
|
-
| deviceId | string | N | For edge workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
|
131
|
+
| deviceId | string | N | For edge or embedded workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
|
132
132
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
133
133
|
|
134
134
|
#### Successful Responses
|
@@ -284,7 +284,7 @@ puts result
|
|
284
284
|
#### Authentication
|
285
285
|
The client must be configured with a valid api access token to call this
|
286
286
|
action. The token must include at least one of the following scopes:
|
287
|
-
all.Application, all.Organization, all.User, flow.*, or flow.getStorageEntriesMetadata.
|
287
|
+
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.getStorageEntriesMetadata.
|
288
288
|
|
289
289
|
#### Available Parameters
|
290
290
|
|
@@ -463,7 +463,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
463
463
|
| end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
|
464
464
|
| resolution | string | N | Resolution in milliseconds | 3600000 | 3600000 |
|
465
465
|
| flowVersion | string | N | Flow version name or ID. When not included, will be aggregate for all versions. Pass develop for just the develop version. | | develop |
|
466
|
-
| deviceId | string | N | For edge workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
|
466
|
+
| deviceId | string | N | For edge or embedded workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
|
467
467
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
468
468
|
|
469
469
|
#### Successful Responses
|
data/docs/flowVersions.md
CHANGED
@@ -6,11 +6,55 @@ parameters and the potential responses.
|
|
6
6
|
|
7
7
|
##### Contents
|
8
8
|
|
9
|
+
* [Delete](#delete)
|
9
10
|
* [Get](#get)
|
10
11
|
* [Post](#post)
|
11
12
|
|
12
13
|
<br/>
|
13
14
|
|
15
|
+
## Delete
|
16
|
+
|
17
|
+
Delete flow versions
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
result = client.flow_versions.delete(
|
21
|
+
applicationId: my_application_id,
|
22
|
+
flowId: my_flow_id,
|
23
|
+
options: my_options)
|
24
|
+
|
25
|
+
puts result
|
26
|
+
```
|
27
|
+
|
28
|
+
#### Authentication
|
29
|
+
The client must be configured with a valid api access token to call this
|
30
|
+
action. The token must include at least one of the following scopes:
|
31
|
+
all.Application, all.Organization, all.User, flowVersions.*, or flowVersions.delete.
|
32
|
+
|
33
|
+
#### Available Parameters
|
34
|
+
|
35
|
+
| Name | Type | Required | Description | Default | Example |
|
36
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
37
|
+
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
38
|
+
| flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
|
39
|
+
| options | [Flow Versions Delete Post](_schemas.md#flow-versions-delete-post) | Y | Object containing flow version deletion options | | [Flow Versions Delete Post Example](_schemas.md#flow-versions-delete-post-example) |
|
40
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
41
|
+
|
42
|
+
#### Successful Responses
|
43
|
+
|
44
|
+
| Code | Type | Description |
|
45
|
+
| ---- | ---- | ----------- |
|
46
|
+
| 200 | [Bulk Deletion Response](_schemas.md#bulk-deletion-response) | Object indicating number of flow versions deleted or failed |
|
47
|
+
| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If a job was enqueued for the flow versions to be deleted |
|
48
|
+
|
49
|
+
#### Error Responses
|
50
|
+
|
51
|
+
| Code | Type | Description |
|
52
|
+
| ---- | ---- | ----------- |
|
53
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
54
|
+
| 404 | [Error](_schemas.md#error) | Error if application was not found |
|
55
|
+
|
56
|
+
<br/>
|
57
|
+
|
14
58
|
## Get
|
15
59
|
|
16
60
|
Returns the flow versions for a flow
|
data/docs/flows.md
CHANGED
@@ -39,7 +39,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
39
39
|
| perPage | string | N | How many items to return per page | 100 | 10 |
|
40
40
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
41
41
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*flow |
|
42
|
-
| flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience | cloud | cloud |
|
42
|
+
| flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience | cloud | cloud |
|
43
43
|
| triggerFilter | [Workflow Trigger Filter](_schemas.md#workflow-trigger-filter) | N | Array of triggers to filter by - always filters against default flow version. | | [Workflow Trigger Filter Example](_schemas.md#workflow-trigger-filter-example) |
|
44
44
|
| includeCustomNodes | string | N | If the result of the request should also include the details of any custom nodes referenced by the returned workflows | false | true |
|
45
45
|
| query | [Advanced Workflow Query](_schemas.md#advanced-workflow-query) | N | Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. | | [Advanced Workflow Query Example](_schemas.md#advanced-workflow-query-example) |
|
@@ -89,7 +89,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
89
89
|
| perPage | string | N | How many items to return per page | 100 | 10 |
|
90
90
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
91
91
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*flow |
|
92
|
-
| flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience | cloud | cloud |
|
92
|
+
| flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience | cloud | cloud |
|
93
93
|
| version | string | Y | Return the workflow versions for the given version. | | myVersion |
|
94
94
|
| triggerFilter | [Workflow Trigger Filter](_schemas.md#workflow-trigger-filter) | N | Array of triggers to filter by - always filters against default flow version. | | [Workflow Trigger Filter Example](_schemas.md#workflow-trigger-filter-example) |
|
95
95
|
| includeCustomNodes | string | N | If the result of the request should also include the details of any custom nodes referenced by the returned workflows | false | true |
|
data/docs/instance.md
CHANGED
@@ -9,6 +9,7 @@ parameters and the potential responses.
|
|
9
9
|
* [Generate Report](#generate-report)
|
10
10
|
* [Get](#get)
|
11
11
|
* [Historical Summaries](#historical-summaries)
|
12
|
+
* [Patch](#patch)
|
12
13
|
|
13
14
|
<br/>
|
14
15
|
|
@@ -126,3 +127,42 @@ all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instanc
|
|
126
127
|
| Code | Type | Description |
|
127
128
|
| ---- | ---- | ----------- |
|
128
129
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
130
|
+
|
131
|
+
<br/>
|
132
|
+
|
133
|
+
## Patch
|
134
|
+
|
135
|
+
Updates information about an instance
|
136
|
+
|
137
|
+
```ruby
|
138
|
+
result = client.instance.patch(
|
139
|
+
instanceId: my_instance_id,
|
140
|
+
instance: my_instance)
|
141
|
+
|
142
|
+
puts result
|
143
|
+
```
|
144
|
+
|
145
|
+
#### Authentication
|
146
|
+
The client must be configured with a valid api access token to call this
|
147
|
+
action. The token must include at least one of the following scopes:
|
148
|
+
all.Instance, all.User, instance.*, or instance.patch.
|
149
|
+
|
150
|
+
#### Available Parameters
|
151
|
+
|
152
|
+
| Name | Type | Required | Description | Default | Example |
|
153
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
154
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
|
155
|
+
| instance | [Instance Patch](_schemas.md#instance-patch) | Y | Updated instance information | | [Instance Patch Example](_schemas.md#instance-patch-example) |
|
156
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
157
|
+
|
158
|
+
#### Successful Responses
|
159
|
+
|
160
|
+
| Code | Type | Description |
|
161
|
+
| ---- | ---- | ----------- |
|
162
|
+
| 200 | [Instance](_schemas.md#instance) | The updated instance object |
|
163
|
+
|
164
|
+
#### Error Responses
|
165
|
+
|
166
|
+
| Code | Type | Description |
|
167
|
+
| ---- | ---- | ----------- |
|
168
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
@@ -0,0 +1,133 @@
|
|
1
|
+
# Instance Api Token Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
Instance Api 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 API Token
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
result = client.instance_api_token.delete(
|
21
|
+
instanceId: my_instance_id,
|
22
|
+
apiTokenId: my_api_token_id)
|
23
|
+
|
24
|
+
puts result
|
25
|
+
```
|
26
|
+
|
27
|
+
#### Authentication
|
28
|
+
The client must be configured with a valid api access token to call this
|
29
|
+
action. The token must include at least one of the following scopes:
|
30
|
+
all.Instance, all.User, instanceApiToken.*, or instanceApiToken.delete.
|
31
|
+
|
32
|
+
#### Available Parameters
|
33
|
+
|
34
|
+
| Name | Type | Required | Description | Default | Example |
|
35
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
36
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec7417ae143cd83dc4a96 |
|
37
|
+
| apiTokenId | string | Y | ID associated with the API token | | 575ec7417ae143cd83dc4a95 |
|
38
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
39
|
+
|
40
|
+
#### Successful Responses
|
41
|
+
|
42
|
+
| Code | Type | Description |
|
43
|
+
| ---- | ---- | ----------- |
|
44
|
+
| 200 | [Success](_schemas.md#success) | If API token was successfully deleted |
|
45
|
+
|
46
|
+
#### Error Responses
|
47
|
+
|
48
|
+
| Code | Type | Description |
|
49
|
+
| ---- | ---- | ----------- |
|
50
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
51
|
+
| 404 | [Error](_schemas.md#error) | Error if API token was not found |
|
52
|
+
|
53
|
+
<br/>
|
54
|
+
|
55
|
+
## Get
|
56
|
+
|
57
|
+
Retrieves information on an API token
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
result = client.instance_api_token.get(
|
61
|
+
instanceId: my_instance_id,
|
62
|
+
apiTokenId: my_api_token_id)
|
63
|
+
|
64
|
+
puts result
|
65
|
+
```
|
66
|
+
|
67
|
+
#### Authentication
|
68
|
+
The client must be configured with a valid api access token to call this
|
69
|
+
action. The token must include at least one of the following scopes:
|
70
|
+
all.Instance, all.Instance.read, all.User, all.User.read, instanceApiToken.*, or instanceApiToken.get.
|
71
|
+
|
72
|
+
#### Available Parameters
|
73
|
+
|
74
|
+
| Name | Type | Required | Description | Default | Example |
|
75
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
76
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec7417ae143cd83dc4a96 |
|
77
|
+
| apiTokenId | string | Y | ID associated with the API token | | 575ec7417ae143cd83dc4a95 |
|
78
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
79
|
+
|
80
|
+
#### Successful Responses
|
81
|
+
|
82
|
+
| Code | Type | Description |
|
83
|
+
| ---- | ---- | ----------- |
|
84
|
+
| 200 | [API Token](_schemas.md#api-token) | API token information |
|
85
|
+
|
86
|
+
#### Error Responses
|
87
|
+
|
88
|
+
| Code | Type | Description |
|
89
|
+
| ---- | ---- | ----------- |
|
90
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
91
|
+
| 404 | [Error](_schemas.md#error) | Error if API token was not found |
|
92
|
+
|
93
|
+
<br/>
|
94
|
+
|
95
|
+
## Patch
|
96
|
+
|
97
|
+
Updates information about an API token
|
98
|
+
|
99
|
+
```ruby
|
100
|
+
result = client.instance_api_token.patch(
|
101
|
+
instanceId: my_instance_id,
|
102
|
+
apiTokenId: my_api_token_id,
|
103
|
+
apiToken: my_api_token)
|
104
|
+
|
105
|
+
puts result
|
106
|
+
```
|
107
|
+
|
108
|
+
#### Authentication
|
109
|
+
The client must be configured with a valid api access token to call this
|
110
|
+
action. The token must include at least one of the following scopes:
|
111
|
+
all.Instance, all.User, instanceApiToken.*, or instanceApiToken.patch.
|
112
|
+
|
113
|
+
#### Available Parameters
|
114
|
+
|
115
|
+
| Name | Type | Required | Description | Default | Example |
|
116
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
117
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec7417ae143cd83dc4a96 |
|
118
|
+
| apiTokenId | string | Y | ID associated with the API token | | 575ec7417ae143cd83dc4a95 |
|
119
|
+
| apiToken | [API Token Patch](_schemas.md#api-token-patch) | Y | Object containing new properties of the API token | | [API Token Patch Example](_schemas.md#api-token-patch-example) |
|
120
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
121
|
+
|
122
|
+
#### Successful Responses
|
123
|
+
|
124
|
+
| Code | Type | Description |
|
125
|
+
| ---- | ---- | ----------- |
|
126
|
+
| 200 | [API Token](_schemas.md#api-token) | Updated API token information |
|
127
|
+
|
128
|
+
#### Error Responses
|
129
|
+
|
130
|
+
| Code | Type | Description |
|
131
|
+
| ---- | ---- | ----------- |
|
132
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
133
|
+
| 404 | [Error](_schemas.md#error) | Error if API token was not found |
|
@@ -0,0 +1,91 @@
|
|
1
|
+
# Instance Api Tokens Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
Instance Api 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 API tokens for an instance
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
result = client.instance_api_tokens.get(instanceId: my_instance_id)
|
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.Instance, all.Instance.read, all.User, all.User.read, instanceApiTokens.*, or instanceApiTokens.get.
|
28
|
+
|
29
|
+
#### Available Parameters
|
30
|
+
|
31
|
+
| Name | Type | Required | Description | Default | Example |
|
32
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
33
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec7417ae143cd83dc4a96 |
|
34
|
+
| sortField | string | N | Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated, expirationDate | name | name |
|
35
|
+
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
36
|
+
| page | string | N | Which page of results to return | 0 | 0 |
|
37
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
38
|
+
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, status | | key |
|
39
|
+
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*token |
|
40
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
41
|
+
|
42
|
+
#### Successful Responses
|
43
|
+
|
44
|
+
| Code | Type | Description |
|
45
|
+
| ---- | ---- | ----------- |
|
46
|
+
| 200 | [API Token](_schemas.md#api-token) | Collection of API tokens |
|
47
|
+
|
48
|
+
#### Error Responses
|
49
|
+
|
50
|
+
| Code | Type | Description |
|
51
|
+
| ---- | ---- | ----------- |
|
52
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
53
|
+
|
54
|
+
<br/>
|
55
|
+
|
56
|
+
## Post
|
57
|
+
|
58
|
+
Create a new API token for an instance
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
result = client.instance_api_tokens.post(
|
62
|
+
instanceId: my_instance_id,
|
63
|
+
apiToken: my_api_token)
|
64
|
+
|
65
|
+
puts result
|
66
|
+
```
|
67
|
+
|
68
|
+
#### Authentication
|
69
|
+
The client must be configured with a valid api access token to call this
|
70
|
+
action. The token must include at least one of the following scopes:
|
71
|
+
all.Instance, all.User, instanceApiTokens.*, or instanceApiTokens.post.
|
72
|
+
|
73
|
+
#### Available Parameters
|
74
|
+
|
75
|
+
| Name | Type | Required | Description | Default | Example |
|
76
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
77
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec7417ae143cd83dc4a96 |
|
78
|
+
| apiToken | [API Token Post](_schemas.md#api-token-post) | Y | API token information | | [API Token Post Example](_schemas.md#api-token-post-example) |
|
79
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
80
|
+
|
81
|
+
#### Successful Responses
|
82
|
+
|
83
|
+
| Code | Type | Description |
|
84
|
+
| ---- | ---- | ----------- |
|
85
|
+
| 201 | [API Token](_schemas.md#api-token) | The successfully created API token |
|
86
|
+
|
87
|
+
#### Error Responses
|
88
|
+
|
89
|
+
| Code | Type | Description |
|
90
|
+
| ---- | ---- | ----------- |
|
91
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
data/docs/instanceMembers.md
CHANGED
data/docs/instanceOrg.md
CHANGED
@@ -75,6 +75,7 @@ all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or inst
|
|
75
75
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
76
76
|
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
|
77
77
|
| orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
|
78
|
+
| summaryInclude | string | N | Comma-separated list of summary fields to include in org summary | | payloadCount |
|
78
79
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
79
80
|
|
80
81
|
#### Successful Responses
|
@@ -116,6 +117,7 @@ all.Instance, all.User, instanceOrg.*, or instanceOrg.patch.
|
|
116
117
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
117
118
|
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
|
118
119
|
| orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
|
120
|
+
| summaryInclude | string | N | Comma-separated list of summary fields to include in org summary | | payloadCount |
|
119
121
|
| organization | [Instance Owned Organization Patch](_schemas.md#instance-owned-organization-patch) | Y | Object containing new organization properties | | [Instance Owned Organization Patch Example](_schemas.md#instance-owned-organization-patch-example) |
|
120
122
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
121
123
|
|
@@ -0,0 +1,139 @@
|
|
1
|
+
# Instance Org Invite Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
Instance Org Invite resource, including the expected
|
5
|
+
parameters and the potential responses.
|
6
|
+
|
7
|
+
##### Contents
|
8
|
+
|
9
|
+
* [Delete](#delete)
|
10
|
+
* [Get](#get)
|
11
|
+
* [Resend Invite](#resend-invite)
|
12
|
+
|
13
|
+
<br/>
|
14
|
+
|
15
|
+
## Delete
|
16
|
+
|
17
|
+
Revokes an instance org invitation
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
result = client.instance_org_invite.delete(
|
21
|
+
instanceId: my_instance_id,
|
22
|
+
orgId: my_org_id,
|
23
|
+
inviteId: my_invite_id)
|
24
|
+
|
25
|
+
puts result
|
26
|
+
```
|
27
|
+
|
28
|
+
#### Authentication
|
29
|
+
The client must be configured with a valid api access token to call this
|
30
|
+
action. The token must include at least one of the following scopes:
|
31
|
+
all.Instance, all.User, instanceOrgInvite.*, or instanceOrgInvite.delete.
|
32
|
+
|
33
|
+
#### Available Parameters
|
34
|
+
|
35
|
+
| Name | Type | Required | Description | Default | Example |
|
36
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
37
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a95 |
|
38
|
+
| orgId | string | Y | ID associated with the organization | | 575ec8687ae143cd83dc4a97 |
|
39
|
+
| inviteId | string | Y | ID associated with the organization invite | | 575ec8687ae143cd83dc4a94 |
|
40
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
41
|
+
|
42
|
+
#### Successful Responses
|
43
|
+
|
44
|
+
| Code | Type | Description |
|
45
|
+
| ---- | ---- | ----------- |
|
46
|
+
| 200 | [Success](_schemas.md#success) | If an invite was successfully deleted |
|
47
|
+
|
48
|
+
#### Error Responses
|
49
|
+
|
50
|
+
| Code | Type | Description |
|
51
|
+
| ---- | ---- | ----------- |
|
52
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
53
|
+
| 404 | [Error](_schemas.md#error) | Error if instance, organization or invite was not found |
|
54
|
+
|
55
|
+
<br/>
|
56
|
+
|
57
|
+
## Get
|
58
|
+
|
59
|
+
Returns an organization invite
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
result = client.instance_org_invite.get(
|
63
|
+
instanceId: my_instance_id,
|
64
|
+
orgId: my_org_id,
|
65
|
+
inviteId: my_invite_id)
|
66
|
+
|
67
|
+
puts result
|
68
|
+
```
|
69
|
+
|
70
|
+
#### Authentication
|
71
|
+
The client must be configured with a valid api access token to call this
|
72
|
+
action. The token must include at least one of the following scopes:
|
73
|
+
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgInvite.*, or instanceOrgInvite.get.
|
74
|
+
|
75
|
+
#### Available Parameters
|
76
|
+
|
77
|
+
| Name | Type | Required | Description | Default | Example |
|
78
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
79
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a95 |
|
80
|
+
| orgId | string | Y | ID associated with the organization | | 575ec8687ae143cd83dc4a97 |
|
81
|
+
| inviteId | string | Y | ID associated with the organization invite | | 575ec8687ae143cd83dc4a94 |
|
82
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
83
|
+
|
84
|
+
#### Successful Responses
|
85
|
+
|
86
|
+
| Code | Type | Description |
|
87
|
+
| ---- | ---- | ----------- |
|
88
|
+
| 200 | [Organization Invitation](_schemas.md#organization-invitation) | A single organization invite |
|
89
|
+
|
90
|
+
#### Error Responses
|
91
|
+
|
92
|
+
| Code | Type | Description |
|
93
|
+
| ---- | ---- | ----------- |
|
94
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
95
|
+
| 404 | [Error](_schemas.md#error) | Error if instance, organization, or invite was not found |
|
96
|
+
|
97
|
+
<br/>
|
98
|
+
|
99
|
+
## Resend Invite
|
100
|
+
|
101
|
+
Resend an organization invite with modified role info
|
102
|
+
|
103
|
+
```ruby
|
104
|
+
result = client.instance_org_invite.resend_invite(
|
105
|
+
instanceId: my_instance_id,
|
106
|
+
orgId: my_org_id,
|
107
|
+
inviteId: my_invite_id,
|
108
|
+
roleInfo: my_role_info)
|
109
|
+
|
110
|
+
puts result
|
111
|
+
```
|
112
|
+
|
113
|
+
#### Authentication
|
114
|
+
The client must be configured with a valid api access token to call this
|
115
|
+
action. The token must include at least one of the following scopes:
|
116
|
+
all.Instance, all.User, instanceOrgInvite.*, or instanceOrgInvite.resendInvite.
|
117
|
+
|
118
|
+
#### Available Parameters
|
119
|
+
|
120
|
+
| Name | Type | Required | Description | Default | Example |
|
121
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
122
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a95 |
|
123
|
+
| orgId | string | Y | ID associated with the organization | | 575ec8687ae143cd83dc4a97 |
|
124
|
+
| inviteId | string | Y | ID associated with the organization invite | | 575ec8687ae143cd83dc4a94 |
|
125
|
+
| roleInfo | [Organization Role Info](_schemas.md#organization-role-info) | Y | Object containing updated role info | | [Organization Role Info Example](_schemas.md#organization-role-info-example) |
|
126
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
127
|
+
|
128
|
+
#### Successful Responses
|
129
|
+
|
130
|
+
| Code | Type | Description |
|
131
|
+
| ---- | ---- | ----------- |
|
132
|
+
| 201 | [Organization Invitation](_schemas.md#organization-invitation) | The new org invite |
|
133
|
+
|
134
|
+
#### Error Responses
|
135
|
+
|
136
|
+
| Code | Type | Description |
|
137
|
+
| ---- | ---- | ----------- |
|
138
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
139
|
+
| 404 | [Error](_schemas.md#error) | Error if instance, organization, or invite was not found |
|