losant_rest 1.12.0 → 1.14.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +1 -1
- data/docs/_schemas.md +17509 -8097
- 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/events.md +3 -3
- 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 +41 -0
- data/docs/flowVersions.md +44 -0
- data/docs/instance.md +168 -0
- data/docs/instanceApiToken.md +133 -0
- data/docs/instanceApiTokens.md +91 -0
- data/docs/instanceMember.md +133 -0
- data/docs/instanceMembers.md +91 -0
- data/docs/instanceOrg.md +135 -0
- data/docs/instanceOrgInvite.md +139 -0
- data/docs/instanceOrgInvites.md +96 -0
- data/docs/instanceOrgMember.md +139 -0
- data/docs/instanceOrgMembers.md +96 -0
- data/docs/instanceOrgs.md +91 -0
- data/docs/instances.md +50 -0
- 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 +7 -7
- data/lib/losant_rest/application_api_token.rb +1 -1
- data/lib/losant_rest/application_api_tokens.rb +2 -2
- data/lib/losant_rest/application_certificate.rb +1 -1
- data/lib/losant_rest/application_certificate_authorities.rb +1 -1
- data/lib/losant_rest/application_certificate_authority.rb +1 -1
- data/lib/losant_rest/application_certificates.rb +1 -1
- data/lib/losant_rest/application_dashboard.rb +1 -1
- data/lib/losant_rest/application_dashboards.rb +1 -1
- data/lib/losant_rest/application_key.rb +1 -1
- data/lib/losant_rest/application_keys.rb +1 -1
- data/lib/losant_rest/application_template.rb +1 -1
- data/lib/losant_rest/application_templates.rb +1 -1
- data/lib/losant_rest/applications.rb +2 -2
- data/lib/losant_rest/audit_log.rb +1 -1
- data/lib/losant_rest/audit_logs.rb +1 -1
- data/lib/losant_rest/auth.rb +1 -1
- data/lib/losant_rest/client.rb +63 -3
- data/lib/losant_rest/dashboard.rb +1 -1
- data/lib/losant_rest/dashboards.rb +1 -1
- data/lib/losant_rest/data.rb +1 -1
- data/lib/losant_rest/data_table.rb +2 -2
- data/lib/losant_rest/data_table_row.rb +1 -1
- data/lib/losant_rest/data_table_rows.rb +2 -2
- data/lib/losant_rest/data_tables.rb +2 -2
- data/lib/losant_rest/device.rb +51 -1
- data/lib/losant_rest/device_recipe.rb +1 -1
- data/lib/losant_rest/device_recipes.rb +1 -1
- data/lib/losant_rest/devices.rb +49 -3
- data/lib/losant_rest/edge_deployment.rb +81 -0
- data/lib/losant_rest/edge_deployments.rb +1 -1
- data/lib/losant_rest/error.rb +1 -1
- data/lib/losant_rest/event.rb +1 -1
- data/lib/losant_rest/events.rb +4 -4
- data/lib/losant_rest/experience.rb +2 -2
- data/lib/losant_rest/experience_domain.rb +1 -1
- data/lib/losant_rest/experience_domains.rb +2 -2
- data/lib/losant_rest/experience_endpoint.rb +1 -1
- data/lib/losant_rest/experience_endpoints.rb +1 -1
- data/lib/losant_rest/experience_group.rb +5 -1
- data/lib/losant_rest/experience_groups.rb +1 -1
- data/lib/losant_rest/experience_slug.rb +1 -1
- data/lib/losant_rest/experience_slugs.rb +2 -2
- data/lib/losant_rest/experience_user.rb +1 -1
- data/lib/losant_rest/experience_users.rb +1 -1
- data/lib/losant_rest/experience_version.rb +4 -4
- data/lib/losant_rest/experience_versions.rb +3 -3
- data/lib/losant_rest/experience_view.rb +5 -5
- data/lib/losant_rest/experience_views.rb +3 -3
- data/lib/losant_rest/file.rb +5 -5
- data/lib/losant_rest/files.rb +3 -3
- data/lib/losant_rest/flow.rb +47 -1
- data/lib/losant_rest/flow_version.rb +1 -1
- data/lib/losant_rest/flow_versions.rb +51 -1
- data/lib/losant_rest/flows.rb +1 -1
- data/lib/losant_rest/instance.rb +227 -0
- 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 +176 -0
- data/lib/losant_rest/instance_members.rb +134 -0
- data/lib/losant_rest/instance_org.rb +180 -0
- 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 +182 -0
- data/lib/losant_rest/instance_org_members.rb +138 -0
- data/lib/losant_rest/instance_orgs.rb +139 -0
- data/lib/losant_rest/instances.rb +88 -0
- data/lib/losant_rest/integration.rb +1 -1
- data/lib/losant_rest/integrations.rb +1 -1
- data/lib/losant_rest/me.rb +2 -2
- data/lib/losant_rest/notebook.rb +1 -1
- data/lib/losant_rest/notebooks.rb +1 -1
- data/lib/losant_rest/org.rb +2 -2
- data/lib/losant_rest/org_invites.rb +1 -1
- data/lib/losant_rest/orgs.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/utils.rb +1 -1
- data/lib/losant_rest/version.rb +2 -2
- data/lib/losant_rest/webhook.rb +1 -1
- data/lib/losant_rest/webhooks.rb +1 -1
- data/lib/losant_rest.rb +16 -1
- data/schemas/advancedDeviceQuery.json +309 -0
- data/schemas/apiToken.json +2 -1
- data/schemas/apiTokenPost.json +431 -0
- data/schemas/apiTokens.json +4 -2
- data/schemas/applicationApiTokenPost.json +1 -0
- data/schemas/applicationDashboardPost.json +39 -17
- data/schemas/auditLog.json +4 -0
- data/schemas/auditLogFilter.json +4 -0
- data/schemas/auditLogs.json +4 -0
- data/schemas/bulkDeleteResponse.json +12 -0
- data/schemas/dashboard.json +39 -17
- data/schemas/dashboardPatch.json +39 -17
- data/schemas/dashboardPost.json +39 -17
- data/schemas/dashboardSendReport.json +4 -0
- data/schemas/dashboards.json +39 -17
- data/schemas/dataTableRowsDelete.json +1 -1
- data/schemas/devicePayloadCounts.json +24 -0
- data/schemas/devicesDeletePost.json +309 -0
- data/schemas/devicesExportPayloadCountPost.json +1350 -0
- data/schemas/devicesExportPost.json +309 -0
- data/schemas/devicesPatch.json +309 -0
- data/schemas/devicesRemoveDataPost.json +309 -0
- data/schemas/edgeDeployment.json +16 -0
- data/schemas/edgeDeployments.json +16 -0
- data/schemas/eventsDeleted.json +1 -1
- data/schemas/experienceGroup.json +6 -0
- data/schemas/experienceGroups.json +6 -0
- data/schemas/experienceLinkedResources.json +381 -6
- data/schemas/filePost.json +8 -2
- data/schemas/flow.json +127 -2
- data/schemas/flowPatch.json +127 -2
- data/schemas/flowPost.json +127 -2
- data/schemas/flowStorageMetadata.json +13 -0
- data/schemas/flowVersion.json +254 -4
- data/schemas/flowVersionPost.json +127 -2
- data/schemas/flowVersions.json +254 -4
- data/schemas/flowVersionsDeletePost.json +941 -0
- data/schemas/flows.json +127 -2
- data/schemas/flowsImportPost.json +254 -4
- data/schemas/flowsImportResult.json +381 -6
- data/schemas/githubLogin.json +64 -11
- data/schemas/historicalSummaries.json +43 -0
- data/schemas/historicalSummary.json +490 -0
- data/schemas/instance.json +60 -0
- data/schemas/instanceMember.json +41 -0
- data/schemas/instanceMemberPatch.json +17 -0
- data/schemas/instanceMemberPost.json +37 -0
- data/schemas/instanceMembers.json +77 -0
- data/schemas/instanceOrg.json +14 -0
- data/schemas/instanceOrgMember.json +45 -0
- data/schemas/instanceOrgMemberPatch.json +69 -0
- data/schemas/instanceOrgMemberPost.json +161 -0
- data/schemas/instanceOrgMembers.json +42 -0
- data/schemas/instanceOrgPatch.json +19 -0
- data/schemas/instanceOrgPost.json +177 -0
- data/schemas/instanceOrgs.json +18 -0
- data/schemas/instancePatch.json +67 -0
- data/schemas/instanceReportOptionsPost.json +41 -0
- data/schemas/me.json +30 -14
- data/schemas/multiDeviceCommand.json +309 -0
- 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 +30 -14
- data/schemas/orgInvite.json +90 -0
- data/schemas/orgInviteCollection.json +130 -0
- data/schemas/orgInvites.json +82 -77
- data/schemas/orgPatch.json +0 -9
- data/schemas/orgRoleInfo.json +69 -0
- data/schemas/orgs.json +30 -14
- data/schemas/payloadStats.json +126 -0
- data/schemas/userCredentials.json +64 -11
- data/schemas/userPost.json +64 -11
- data/schemas/validateContextError.json +34 -0
- data/schemas/validateContextSuccess.json +34 -0
- data/schemas/virtualButtonPress.json +4 -0
- metadata +55 -3
@@ -0,0 +1,91 @@
|
|
1
|
+
# Instance Orgs Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
Instance Orgs 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 organizations associated with the current instance
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
result = client.instance_orgs.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, instanceOrgs.*, or instanceOrgs.get.
|
28
|
+
|
29
|
+
#### Available Parameters
|
30
|
+
|
31
|
+
| Name | Type | Required | Description | Default | Example |
|
32
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
33
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
|
34
|
+
| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | 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 | | name |
|
39
|
+
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*org |
|
40
|
+
| summaryInclude | string | N | Comma-separated list of summary fields to include in org summary | | payloadCount |
|
41
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
42
|
+
|
43
|
+
#### Successful Responses
|
44
|
+
|
45
|
+
| Code | Type | Description |
|
46
|
+
| ---- | ---- | ----------- |
|
47
|
+
| 200 | [Instance Organizations](_schemas.md#instance-organizations) | A collection of organizations |
|
48
|
+
|
49
|
+
#### Error Responses
|
50
|
+
|
51
|
+
| Code | Type | Description |
|
52
|
+
| ---- | ---- | ----------- |
|
53
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
54
|
+
|
55
|
+
<br/>
|
56
|
+
|
57
|
+
## Post
|
58
|
+
|
59
|
+
Create a new organization
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
result = client.instance_orgs.post(instanceId: my_instance_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.User, instanceOrgs.*, or instanceOrgs.post.
|
71
|
+
|
72
|
+
#### Available Parameters
|
73
|
+
|
74
|
+
| Name | Type | Required | Description | Default | Example |
|
75
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
76
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
|
77
|
+
| summaryInclude | string | N | Comma-separated list of summary fields to include in org summary | | payloadCount |
|
78
|
+
| orgConfig | [Instance Owned Organization Post](_schemas.md#instance-owned-organization-post) | N | Object containing configurations for the new organization | | [Instance Owned Organization Post Example](_schemas.md#instance-owned-organization-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
|
+
| 200 | [Organization](_schemas.md#organization) | The newly created organization |
|
86
|
+
|
87
|
+
#### Error Responses
|
88
|
+
|
89
|
+
| Code | Type | Description |
|
90
|
+
| ---- | ---- | ----------- |
|
91
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
data/docs/instances.md
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
# Instances Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
Instances resource, including the expected
|
5
|
+
parameters and the potential responses.
|
6
|
+
|
7
|
+
##### Contents
|
8
|
+
|
9
|
+
* [Get](#get)
|
10
|
+
|
11
|
+
<br/>
|
12
|
+
|
13
|
+
## Get
|
14
|
+
|
15
|
+
Returns a collection of instances
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
result = client.instances.get(optional_params)
|
19
|
+
|
20
|
+
puts result
|
21
|
+
```
|
22
|
+
|
23
|
+
#### Authentication
|
24
|
+
The client must be configured with a valid api access token to call this
|
25
|
+
action. The token must include at least one of the following scopes:
|
26
|
+
all.User, all.User.read, instances.*, or instances.get.
|
27
|
+
|
28
|
+
#### Available Parameters
|
29
|
+
|
30
|
+
| Name | Type | Required | Description | Default | Example |
|
31
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
32
|
+
| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
|
33
|
+
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
34
|
+
| page | string | N | Which page of results to return | 0 | 0 |
|
35
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
36
|
+
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
37
|
+
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my * instance |
|
38
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
39
|
+
|
40
|
+
#### Successful Responses
|
41
|
+
|
42
|
+
| Code | Type | Description |
|
43
|
+
| ---- | ---- | ----------- |
|
44
|
+
| 200 | [Instances](_schemas.md#instances) | Collection of instances |
|
45
|
+
|
46
|
+
#### Error Responses
|
47
|
+
|
48
|
+
| Code | Type | Description |
|
49
|
+
| ---- | ---- | ----------- |
|
50
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
data/docs/me.md
CHANGED
@@ -376,7 +376,7 @@ all.User, all.User.read, me.*, or me.payloadCounts.
|
|
376
376
|
|
377
377
|
| Code | Type | Description |
|
378
378
|
| ---- | ---- | ----------- |
|
379
|
-
| 200 | [Payload
|
379
|
+
| 200 | [Payload Stats](_schemas.md#payload-stats) | Payload counts, by type and source |
|
380
380
|
|
381
381
|
#### Error Responses
|
382
382
|
|
data/docs/org.md
CHANGED
@@ -247,7 +247,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.
|
|
247
247
|
|
248
248
|
| Code | Type | Description |
|
249
249
|
| ---- | ---- | ----------- |
|
250
|
-
| 200 | [Payload
|
250
|
+
| 200 | [Payload Stats](_schemas.md#payload-stats) | Payload counts, by type and source |
|
251
251
|
|
252
252
|
#### Error Responses
|
253
253
|
|
@@ -0,0 +1,125 @@
|
|
1
|
+
# User Api Token Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
User 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.user_api_token.delete(apiTokenId: my_api_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, userApiToken.*, or userApiToken.delete.
|
29
|
+
|
30
|
+
#### Available Parameters
|
31
|
+
|
32
|
+
| Name | Type | Required | Description | Default | Example |
|
33
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
34
|
+
| apiTokenId | string | Y | ID associated with the API 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 API 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 API token was not found |
|
49
|
+
|
50
|
+
<br/>
|
51
|
+
|
52
|
+
## Get
|
53
|
+
|
54
|
+
Retrieves information on an API token
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
result = client.user_api_token.get(apiTokenId: my_api_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.read, userApiToken.*, or userApiToken.get.
|
66
|
+
|
67
|
+
#### Available Parameters
|
68
|
+
|
69
|
+
| Name | Type | Required | Description | Default | Example |
|
70
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
71
|
+
| apiTokenId | string | Y | ID associated with the API 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 | [API Token](_schemas.md#api-token) | API 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 API token was not found |
|
86
|
+
|
87
|
+
<br/>
|
88
|
+
|
89
|
+
## Patch
|
90
|
+
|
91
|
+
Updates information about an API token
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
result = client.user_api_token.patch(
|
95
|
+
apiTokenId: my_api_token_id,
|
96
|
+
apiToken: my_api_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, userApiToken.*, or userApiToken.patch.
|
105
|
+
|
106
|
+
#### Available Parameters
|
107
|
+
|
108
|
+
| Name | Type | Required | Description | Default | Example |
|
109
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
110
|
+
| apiTokenId | string | Y | ID associated with the API token | | 575ec7417ae143cd83dc4a95 |
|
111
|
+
| 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) |
|
112
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
113
|
+
|
114
|
+
#### Successful Responses
|
115
|
+
|
116
|
+
| Code | Type | Description |
|
117
|
+
| ---- | ---- | ----------- |
|
118
|
+
| 200 | [API Token](_schemas.md#api-token) | Updated API 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 API token was not found |
|
@@ -0,0 +1,87 @@
|
|
1
|
+
# User Api Tokens Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
User 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 a user
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
result = client.user_api_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.read, userApiTokens.*, or userApiTokens.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, expirationDate | 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, status | | key |
|
38
|
+
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*token |
|
39
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
40
|
+
|
41
|
+
#### Successful Responses
|
42
|
+
|
43
|
+
| Code | Type | Description |
|
44
|
+
| ---- | ---- | ----------- |
|
45
|
+
| 200 | [API Token](_schemas.md#api-token) | Collection of API 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 API token for an user
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
result = client.user_api_tokens.post(apiToken: my_api_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, userApiTokens.*, or userApiTokens.post.
|
69
|
+
|
70
|
+
#### Available Parameters
|
71
|
+
|
72
|
+
| Name | Type | Required | Description | Default | Example |
|
73
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
74
|
+
| apiToken | [API Token Post](_schemas.md#api-token-post) | Y | API token information | | [API Token Post Example](_schemas.md#api-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 | [API Token](_schemas.md#api-token) | The successfully created API token |
|
82
|
+
|
83
|
+
#### Error Responses
|
84
|
+
|
85
|
+
| Code | Type | Description |
|
86
|
+
| ---- | ---- | ----------- |
|
87
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
4
4
|
#
|
5
5
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
6
|
# of this software and associated documentation files (the "Software"), to deal
|
@@ -405,7 +405,7 @@ module LosantRest
|
|
405
405
|
# The client must be configured with a valid api
|
406
406
|
# access token to call this action. The token
|
407
407
|
# must include at least one of the following scopes:
|
408
|
-
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.get.
|
408
|
+
# all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, application.*, or application.get.
|
409
409
|
#
|
410
410
|
# Parameters:
|
411
411
|
# * {string} applicationId - ID of the associated application
|
@@ -453,7 +453,7 @@ module LosantRest
|
|
453
453
|
# The client must be configured with a valid api
|
454
454
|
# access token to call this action. The token
|
455
455
|
# must include at least one of the following scopes:
|
456
|
-
# all.Application, all.Organization, all.User, application.*, or application.patch.
|
456
|
+
# all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.
|
457
457
|
#
|
458
458
|
# Parameters:
|
459
459
|
# * {string} applicationId - ID of the associated application
|
@@ -547,7 +547,7 @@ module LosantRest
|
|
547
547
|
# The client must be configured with a valid api
|
548
548
|
# access token to call this action. The token
|
549
549
|
# must include at least one of the following scopes:
|
550
|
-
# all.Application, all.Organization, all.User, application.*, or application.patch.
|
550
|
+
# all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.
|
551
551
|
#
|
552
552
|
# Parameters:
|
553
553
|
# * {string} applicationId - ID of the associated application
|
@@ -610,7 +610,7 @@ module LosantRest
|
|
610
610
|
# * {boolean} _embedded - Return embedded resources in response
|
611
611
|
#
|
612
612
|
# Responses:
|
613
|
-
# * 200 - Payload counts, by type and source (https://api.losant.com/#/definitions/
|
613
|
+
# * 200 - Payload counts, by type and source (https://api.losant.com/#/definitions/payloadStats)
|
614
614
|
#
|
615
615
|
# Errors:
|
616
616
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
@@ -646,7 +646,7 @@ module LosantRest
|
|
646
646
|
# The client must be configured with a valid api
|
647
647
|
# access token to call this action. The token
|
648
648
|
# must include at least one of the following scopes:
|
649
|
-
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.get.
|
649
|
+
# all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, application.*, or application.get.
|
650
650
|
#
|
651
651
|
# Parameters:
|
652
652
|
# * {string} applicationId - ID of the associated application
|
@@ -690,7 +690,7 @@ module LosantRest
|
|
690
690
|
# The client must be configured with a valid api
|
691
691
|
# access token to call this action. The token
|
692
692
|
# must include at least one of the following scopes:
|
693
|
-
# all.Application, all.Organization, all.User, application.*, or application.patch.
|
693
|
+
# all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.
|
694
694
|
#
|
695
695
|
# Parameters:
|
696
696
|
# * {string} applicationId - ID of the associated application
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
4
4
|
#
|
5
5
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
6
|
# of this software and associated documentation files (the "Software"), to deal
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
4
4
|
#
|
5
5
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
6
|
# of this software and associated documentation files (the "Software"), to deal
|
@@ -96,7 +96,7 @@ module LosantRest
|
|
96
96
|
#
|
97
97
|
# Parameters:
|
98
98
|
# * {string} applicationId - ID associated with the application
|
99
|
-
# * {hash} apiToken - API token information (https://api.losant.com/#/definitions/
|
99
|
+
# * {hash} apiToken - API token information (https://api.losant.com/#/definitions/apiTokenPost)
|
100
100
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
101
101
|
# * {boolean} _actions - Return resource actions in response
|
102
102
|
# * {boolean} _links - Return resource link in response
|