losant_rest 1.0.8 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.ruby-version +1 -0
- data/.travis.yml +3 -2
- data/README.md +19 -8
- data/docs/_schemas.md +210 -184
- data/docs/application.md +20 -0
- data/docs/applicationApiToken.md +130 -0
- data/docs/applicationApiTokens.md +83 -0
- data/docs/applicationKey.md +15 -0
- data/docs/applicationKeys.md +10 -0
- data/docs/applications.md +10 -0
- data/docs/auditLog.md +5 -0
- data/docs/auditLogs.md +5 -0
- data/docs/auth.md +20 -8
- data/docs/dashboard.md +13 -0
- data/docs/dashboards.md +10 -0
- data/docs/data.md +10 -0
- data/docs/device.md +55 -0
- data/docs/deviceRecipe.md +20 -0
- data/docs/deviceRecipes.md +10 -0
- data/docs/devices.md +20 -0
- data/docs/event.md +15 -0
- data/docs/events.md +20 -0
- data/docs/flow.md +35 -0
- data/docs/flows.md +10 -0
- data/docs/me.md +61 -0
- data/docs/org.md +51 -0
- data/docs/orgInvites.md +6 -0
- data/docs/orgs.md +11 -0
- data/docs/solution.md +15 -0
- data/docs/solutionUser.md +15 -0
- data/docs/solutionUsers.md +10 -0
- data/docs/solutions.md +10 -0
- data/docs/webhook.md +15 -0
- data/docs/webhooks.md +10 -0
- data/lib/losant_rest.rb +2 -2
- data/lib/losant_rest/application.rb +24 -0
- data/lib/losant_rest/{access_token.rb → application_api_token.rb} +47 -23
- data/lib/losant_rest/{access_tokens.rb → application_api_tokens.rb} +27 -11
- data/lib/losant_rest/application_key.rb +18 -0
- data/lib/losant_rest/application_keys.rb +12 -0
- data/lib/losant_rest/applications.rb +12 -0
- data/lib/losant_rest/audit_log.rb +6 -0
- data/lib/losant_rest/audit_logs.rb +6 -0
- data/lib/losant_rest/auth.rb +20 -8
- data/lib/losant_rest/client.rb +8 -8
- data/lib/losant_rest/dashboard.rb +15 -0
- data/lib/losant_rest/dashboards.rb +12 -0
- data/lib/losant_rest/data.rb +12 -0
- data/lib/losant_rest/device.rb +66 -0
- data/lib/losant_rest/device_recipe.rb +24 -0
- data/lib/losant_rest/device_recipes.rb +12 -0
- data/lib/losant_rest/devices.rb +24 -0
- data/lib/losant_rest/event.rb +18 -0
- data/lib/losant_rest/events.rb +24 -0
- data/lib/losant_rest/flow.rb +42 -0
- data/lib/losant_rest/flows.rb +12 -0
- data/lib/losant_rest/me.rb +74 -0
- data/lib/losant_rest/org.rb +62 -0
- data/lib/losant_rest/org_invites.rb +6 -0
- data/lib/losant_rest/orgs.rb +14 -0
- data/lib/losant_rest/solution.rb +18 -0
- data/lib/losant_rest/solution_user.rb +18 -0
- data/lib/losant_rest/solution_users.rb +12 -0
- data/lib/losant_rest/solutions.rb +12 -0
- data/lib/losant_rest/version.rb +1 -1
- data/lib/losant_rest/webhook.rb +18 -0
- data/lib/losant_rest/webhooks.rb +12 -0
- data/losant_rest.gemspec +3 -3
- data/schemas/{accessToken.json → apiToken.json} +31 -3
- data/schemas/{accessTokenPatch.json → apiTokenPatch.json} +4 -0
- data/schemas/applicationApiTokenPost.json +116 -0
- data/schemas/auditLog.json +3 -1
- data/schemas/auditLogFilter.json +3 -1
- data/schemas/auditLogs.json +3 -1
- data/schemas/event.json +4 -2
- data/schemas/events.json +4 -2
- metadata +17 -19
- data/.rbenv-version +0 -1
- data/docs/accessToken.md +0 -107
- data/docs/accessTokens.md +0 -68
- data/schemas/accessTokenPost.json +0 -32
- data/schemas/accessTokens.json +0 -65
- data/schemas/deviceState.json +0 -31
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5b74c9b492d6498697feab633430ab0790eab2a7
|
4
|
+
data.tar.gz: fa8a9c085dbd15f77acab0e6eb412e70da18dd73
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fd011d46ecbeaf42c01e89927b7b264e424c4cfe5f481f31e408acd266265312fc91f51b3957f240dba4b4b02903cc291d33bbe71b77a7d8c6b430cd04d60409
|
7
|
+
data.tar.gz: 1ed1197464f09daa830f5f33a03811ebcce34e2d9eb0e8a148c2d1d950446f61e6e1ed50bd204df34768d28d82a39009759f70e851599f06eb246cafd7474663
|
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
2.4.0
|
data/.travis.yml
CHANGED
data/README.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
[![Build Status](https://travis-ci.org/Losant/losant-rest-ruby.svg?branch=master)](https://travis-ci.org/Losant/losant-rest-ruby) [![Gem Version](https://badge.fury.io/rb/losant_rest.svg)](https://badge.fury.io/rb/losant_rest)
|
4
4
|
|
5
5
|
The [Losant](https://www.losant.com) REST API client provides a simple way to
|
6
|
-
use the comprehensive Losant API.
|
6
|
+
use the comprehensive Losant API. You can authenticate either as a Losant
|
7
7
|
device or with your user account, and have access to all the functionality
|
8
8
|
of the Losant platform.
|
9
9
|
|
@@ -55,7 +55,7 @@ puts response
|
|
55
55
|
### LosantRest
|
56
56
|
|
57
57
|
LosantRest is the wrapping module, but it also acts as a singleton [Client](#losantrestclient)
|
58
|
-
instance.
|
58
|
+
instance. So if you only need a single client instance, you do not need to
|
59
59
|
instantiate one yourself - the LosantRest module will act exactly like an
|
60
60
|
instance of LosantRest::Client.
|
61
61
|
|
@@ -63,7 +63,7 @@ instance of LosantRest::Client.
|
|
63
63
|
|
64
64
|
### LosantRest::Client
|
65
65
|
|
66
|
-
A client is a single api instance.
|
66
|
+
A client is a single api instance. By default, it is unauthenticated, but can
|
67
67
|
be given an access token to perform authenticated requests.
|
68
68
|
|
69
69
|
#### Initializer
|
@@ -76,8 +76,9 @@ The ``Client()`` initializer takes the following arguments:
|
|
76
76
|
|
77
77
|
* auth_token
|
78
78
|
The access token to be used for authentication - by default there is no
|
79
|
-
access token.
|
80
|
-
[Auth](docs/auth.md) methods
|
79
|
+
access token. An access token can be acquired through any of the
|
80
|
+
[Auth](docs/auth.md) methods, or can be created for a particular application
|
81
|
+
through [application_api_tokens](docs/applicationApiTokens.md).
|
81
82
|
|
82
83
|
* url
|
83
84
|
The url of the Losant API - by default <https://api.losant.com>.
|
@@ -85,7 +86,7 @@ The url of the Losant API - by default <https://api.losant.com>.
|
|
85
86
|
#### Accessors
|
86
87
|
|
87
88
|
* auth_token
|
88
|
-
The
|
89
|
+
The access token can be accessed or changed after Client creation
|
89
90
|
through this accessor.
|
90
91
|
|
91
92
|
* url
|
@@ -95,9 +96,19 @@ through this accessor.
|
|
95
96
|
#### Resources
|
96
97
|
|
97
98
|
Each of the following is a method on the client object, and returns a wrapper
|
98
|
-
for the actions against that particular resource.
|
99
|
+
for the actions against that particular resource. See each resource
|
99
100
|
documentation file for more information.
|
100
101
|
|
102
|
+
* [application_api_token](docs/applicationApiToken.md)
|
103
|
+
Contains all the actions that can be performed against a single
|
104
|
+
Api Token beloging to an application - for instance, getting info
|
105
|
+
on a single token or revoking a token.
|
106
|
+
|
107
|
+
* [application_api_tokens](docs/applicationApiTokens.md)
|
108
|
+
Contains all of the actions that can be performed against the
|
109
|
+
collection of Api Tokens belonging to an Application - such
|
110
|
+
as listing all tokens or creating a new token.
|
111
|
+
|
101
112
|
* [application_key](docs/applicationKey.md)
|
102
113
|
Contains all the actions that can be performed against a single
|
103
114
|
[Application Key](https://docs.losant.com/applications/access-keys/) -
|
@@ -122,7 +133,7 @@ listing the applications or creating a new application.
|
|
122
133
|
|
123
134
|
* [auth](docs/auth.md)
|
124
135
|
Contains the actions used for authenticating against the api, either as a
|
125
|
-
user or as a device.
|
136
|
+
user or as a device. The result of authentication calls contain the auth_token
|
126
137
|
needed for authenticated calls - see the examples for more details.
|
127
138
|
|
128
139
|
* [dashboard](docs/dashboard.md)
|
data/docs/_schemas.md
CHANGED
@@ -1,10 +1,9 @@
|
|
1
1
|
# Schemas
|
2
2
|
|
3
|
-
* [
|
4
|
-
* [
|
5
|
-
* [Access Token Post](#access-token-post)
|
6
|
-
* [Access Tokens](#access-tokens)
|
3
|
+
* [API Token](#api-token)
|
4
|
+
* [API Token Patch](#api-token-patch)
|
7
5
|
* [Application](#application)
|
6
|
+
* [Application API Token Post](#application-api-token-post)
|
8
7
|
* [Application Key](#application-key)
|
9
8
|
* [Application Key Patch](#application-key-patch)
|
10
9
|
* [Application Key Post](#application-key-post)
|
@@ -93,11 +92,11 @@
|
|
93
92
|
* [Webhook Post](#webhook-post)
|
94
93
|
* [Webhooks](#webhooks)
|
95
94
|
|
96
|
-
##
|
95
|
+
## API Token
|
97
96
|
|
98
|
-
Schema for a single
|
97
|
+
Schema for a single API Token
|
99
98
|
|
100
|
-
### <a name="
|
99
|
+
### <a name="api-token-schema"></a> Schema
|
101
100
|
|
102
101
|
```json
|
103
102
|
{
|
@@ -108,19 +107,45 @@ Schema for a single Access Token
|
|
108
107
|
"type": "string",
|
109
108
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
110
109
|
},
|
111
|
-
"
|
110
|
+
"apiTokenId": {
|
112
111
|
"type": "string",
|
113
112
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
114
113
|
},
|
115
|
-
"
|
114
|
+
"ownerId": {
|
115
|
+
"type": "string",
|
116
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
117
|
+
},
|
118
|
+
"ownerType": {
|
119
|
+
"type": "string",
|
120
|
+
"enum": [
|
121
|
+
"application"
|
122
|
+
]
|
123
|
+
},
|
124
|
+
"creatorId": {
|
116
125
|
"type": "string",
|
117
126
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
118
127
|
},
|
128
|
+
"creatorType": {
|
129
|
+
"type": "string",
|
130
|
+
"enum": [
|
131
|
+
"apiToken",
|
132
|
+
"user",
|
133
|
+
"flow"
|
134
|
+
]
|
135
|
+
},
|
136
|
+
"creatorName": {
|
137
|
+
"type": "string",
|
138
|
+
"maxLength": 1024
|
139
|
+
},
|
119
140
|
"name": {
|
120
141
|
"type": "string",
|
121
142
|
"minLength": 1,
|
122
143
|
"maxLength": 255
|
123
144
|
},
|
145
|
+
"description": {
|
146
|
+
"type": "string",
|
147
|
+
"maxLength": 32767
|
148
|
+
},
|
124
149
|
"creationDate": {
|
125
150
|
"type": "string",
|
126
151
|
"format": "date-time"
|
@@ -136,7 +161,9 @@ Schema for a single Access Token
|
|
136
161
|
"scope": {
|
137
162
|
"type": "array",
|
138
163
|
"items": {
|
139
|
-
"type": "string"
|
164
|
+
"type": "string",
|
165
|
+
"minLength": 1,
|
166
|
+
"maxLength": 1024
|
140
167
|
}
|
141
168
|
},
|
142
169
|
"status": {
|
@@ -153,20 +180,22 @@ Schema for a single Access Token
|
|
153
180
|
}
|
154
181
|
}
|
155
182
|
```
|
156
|
-
### <a name="
|
183
|
+
### <a name="api-token-example"></a> Example
|
157
184
|
|
158
185
|
```json
|
159
186
|
{
|
160
187
|
"id": "575ec7417ae143cd83dc4a95",
|
161
|
-
"
|
162
|
-
"
|
163
|
-
"
|
188
|
+
"apiTokenId": "575ec7417ae143cd83dc4a95",
|
189
|
+
"creatorId": "575ed70c7ae143cd83dc4aa9",
|
190
|
+
"creatorType": "user",
|
191
|
+
"ownerId": "575ec8687ae143cd83dc4a97",
|
192
|
+
"ownerType": "application",
|
193
|
+
"name": "My API Token",
|
164
194
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
165
195
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
166
196
|
"expirationDate": "2017-06-13T04:00:00.000Z",
|
167
197
|
"scope": [
|
168
|
-
"
|
169
|
-
"devices.state"
|
198
|
+
"all.Application"
|
170
199
|
],
|
171
200
|
"status": "active",
|
172
201
|
"token": "the_actual_token_string"
|
@@ -175,11 +204,11 @@ Schema for a single Access Token
|
|
175
204
|
|
176
205
|
<br/>
|
177
206
|
|
178
|
-
##
|
207
|
+
## API Token Patch
|
179
208
|
|
180
|
-
Schema for the body of an
|
209
|
+
Schema for the body of an API Token modification request
|
181
210
|
|
182
|
-
### <a name="
|
211
|
+
### <a name="api-token-patch-schema"></a> Schema
|
183
212
|
|
184
213
|
```json
|
185
214
|
{
|
@@ -191,53 +220,9 @@ Schema for the body of an Access Token modification request
|
|
191
220
|
"minLength": 1,
|
192
221
|
"maxLength": 255
|
193
222
|
},
|
194
|
-
"
|
195
|
-
"type": "string",
|
196
|
-
"enum": [
|
197
|
-
"active",
|
198
|
-
"inactive"
|
199
|
-
]
|
200
|
-
}
|
201
|
-
},
|
202
|
-
"additionalProperties": false
|
203
|
-
}
|
204
|
-
```
|
205
|
-
### <a name="access-token-patch-example"></a> Example
|
206
|
-
|
207
|
-
```json
|
208
|
-
{
|
209
|
-
"name": "My Updated Access Token",
|
210
|
-
"status": "inactive"
|
211
|
-
}
|
212
|
-
```
|
213
|
-
|
214
|
-
<br/>
|
215
|
-
|
216
|
-
## Access Token Post
|
217
|
-
|
218
|
-
Schema for the body of an Access Token creation request
|
219
|
-
|
220
|
-
### <a name="access-token-post-schema"></a> Schema
|
221
|
-
|
222
|
-
```json
|
223
|
-
{
|
224
|
-
"$schema": "http://json-schema.org/draft-04/schema#",
|
225
|
-
"type": "object",
|
226
|
-
"properties": {
|
227
|
-
"name": {
|
228
|
-
"type": "string",
|
229
|
-
"minLength": 1,
|
230
|
-
"maxLength": 255
|
231
|
-
},
|
232
|
-
"expirationDate": {
|
223
|
+
"description": {
|
233
224
|
"type": "string",
|
234
|
-
"
|
235
|
-
},
|
236
|
-
"scope": {
|
237
|
-
"type": "array",
|
238
|
-
"items": {
|
239
|
-
"type": "string"
|
240
|
-
}
|
225
|
+
"maxLength": 32767
|
241
226
|
},
|
242
227
|
"status": {
|
243
228
|
"type": "string",
|
@@ -247,123 +232,15 @@ Schema for the body of an Access Token creation request
|
|
247
232
|
]
|
248
233
|
}
|
249
234
|
},
|
250
|
-
"additionalProperties": false
|
251
|
-
"required": [
|
252
|
-
"name"
|
253
|
-
]
|
254
|
-
}
|
255
|
-
```
|
256
|
-
### <a name="access-token-post-example"></a> Example
|
257
|
-
|
258
|
-
```json
|
259
|
-
{
|
260
|
-
"name": "My New Access Token",
|
261
|
-
"expirationDate": "2017-06-13T04:00:00.000Z",
|
262
|
-
"scope": [
|
263
|
-
"devices",
|
264
|
-
"devices.state"
|
265
|
-
],
|
266
|
-
"status": "active"
|
267
|
-
}
|
268
|
-
```
|
269
|
-
|
270
|
-
<br/>
|
271
|
-
|
272
|
-
## Access Tokens
|
273
|
-
|
274
|
-
Schema for a collection of Access Tokens
|
275
|
-
|
276
|
-
### <a name="access-tokens-schema"></a> Schema
|
277
|
-
|
278
|
-
```json
|
279
|
-
{
|
280
|
-
"$schema": "http://json-schema.org/draft-04/schema#",
|
281
|
-
"type": "object",
|
282
|
-
"properties": {
|
283
|
-
"items": {
|
284
|
-
"type": "array",
|
285
|
-
"items": {
|
286
|
-
"title": "Access Token",
|
287
|
-
"description": "Schema for a single Access Token",
|
288
|
-
"type": "object",
|
289
|
-
"properties": {
|
290
|
-
"id": {
|
291
|
-
"type": "string",
|
292
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
293
|
-
},
|
294
|
-
"accessTokenId": {
|
295
|
-
"type": "string",
|
296
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
297
|
-
},
|
298
|
-
"userId": {
|
299
|
-
"type": "string",
|
300
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
301
|
-
},
|
302
|
-
"name": {
|
303
|
-
"type": "string",
|
304
|
-
"minLength": 1,
|
305
|
-
"maxLength": 255
|
306
|
-
},
|
307
|
-
"creationDate": {
|
308
|
-
"type": "string",
|
309
|
-
"format": "date-time"
|
310
|
-
},
|
311
|
-
"lastUpdated": {
|
312
|
-
"type": "string",
|
313
|
-
"format": "date-time"
|
314
|
-
},
|
315
|
-
"expirationDate": {
|
316
|
-
"type": "string",
|
317
|
-
"format": "date-time"
|
318
|
-
},
|
319
|
-
"scope": {
|
320
|
-
"type": "array",
|
321
|
-
"items": {
|
322
|
-
"type": "string"
|
323
|
-
}
|
324
|
-
},
|
325
|
-
"status": {
|
326
|
-
"type": "string",
|
327
|
-
"enum": [
|
328
|
-
"active",
|
329
|
-
"inactive"
|
330
|
-
]
|
331
|
-
},
|
332
|
-
"token": {
|
333
|
-
"type": "string",
|
334
|
-
"minLength": 1
|
335
|
-
}
|
336
|
-
}
|
337
|
-
}
|
338
|
-
},
|
339
|
-
"count": {
|
340
|
-
"type": "integer"
|
341
|
-
}
|
342
|
-
}
|
235
|
+
"additionalProperties": false
|
343
236
|
}
|
344
237
|
```
|
345
|
-
### <a name="
|
238
|
+
### <a name="api-token-patch-example"></a> Example
|
346
239
|
|
347
240
|
```json
|
348
241
|
{
|
349
|
-
"
|
350
|
-
|
351
|
-
"id": "575ec7417ae143cd83dc4a95",
|
352
|
-
"accessTokenId": "575ec7417ae143cd83dc4a95",
|
353
|
-
"userId": "575ed70c7ae143cd83dc4aa9",
|
354
|
-
"name": "My Access Token",
|
355
|
-
"creationDate": "2016-06-13T04:00:00.000Z",
|
356
|
-
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
357
|
-
"expirationDate": "2017-06-13T04:00:00.000Z",
|
358
|
-
"scope": [
|
359
|
-
"devices",
|
360
|
-
"devices.state"
|
361
|
-
],
|
362
|
-
"status": "active",
|
363
|
-
"token": "the_actual_token_string"
|
364
|
-
}
|
365
|
-
],
|
366
|
-
"count": 1
|
242
|
+
"name": "My Updated API Token",
|
243
|
+
"status": "inactive"
|
367
244
|
}
|
368
245
|
```
|
369
246
|
|
@@ -467,6 +344,145 @@ Schema for a single Application
|
|
467
344
|
|
468
345
|
<br/>
|
469
346
|
|
347
|
+
## Application API Token Post
|
348
|
+
|
349
|
+
Schema for the body of an Application API Token creation request
|
350
|
+
|
351
|
+
### <a name="application-api-token-post-schema"></a> Schema
|
352
|
+
|
353
|
+
```json
|
354
|
+
{
|
355
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
356
|
+
"type": "object",
|
357
|
+
"properties": {
|
358
|
+
"name": {
|
359
|
+
"type": "string",
|
360
|
+
"minLength": 1,
|
361
|
+
"maxLength": 255
|
362
|
+
},
|
363
|
+
"description": {
|
364
|
+
"type": "string",
|
365
|
+
"maxLength": 32767
|
366
|
+
},
|
367
|
+
"expirationDate": {
|
368
|
+
"type": "string",
|
369
|
+
"format": "date-time"
|
370
|
+
},
|
371
|
+
"scope": {
|
372
|
+
"type": "array",
|
373
|
+
"items": {
|
374
|
+
"type": "string",
|
375
|
+
"enum": [
|
376
|
+
"all.Application",
|
377
|
+
"all.Application.read",
|
378
|
+
"all.Device",
|
379
|
+
"all.Device.read",
|
380
|
+
"application.*",
|
381
|
+
"applicationApiToken.*",
|
382
|
+
"applicationApiTokens.*",
|
383
|
+
"applicationKey.*",
|
384
|
+
"applicationKeys.*",
|
385
|
+
"data.*",
|
386
|
+
"device.*",
|
387
|
+
"deviceRecipe.*",
|
388
|
+
"deviceRecipes.*",
|
389
|
+
"devices.*",
|
390
|
+
"event.*",
|
391
|
+
"events.*",
|
392
|
+
"flow.*",
|
393
|
+
"flows.*",
|
394
|
+
"webhook.*",
|
395
|
+
"webhooks.*",
|
396
|
+
"application.delete",
|
397
|
+
"application.get",
|
398
|
+
"application.patch",
|
399
|
+
"application.payloadCounts",
|
400
|
+
"applicationApiToken.delete",
|
401
|
+
"applicationApiToken.get",
|
402
|
+
"applicationApiToken.patch",
|
403
|
+
"applicationApiTokens.get",
|
404
|
+
"applicationApiTokens.post",
|
405
|
+
"applicationKey.delete",
|
406
|
+
"applicationKey.get",
|
407
|
+
"applicationKey.patch",
|
408
|
+
"applicationKeys.get",
|
409
|
+
"applicationKeys.post",
|
410
|
+
"data.lastValueQuery",
|
411
|
+
"data.timeSeriesQuery",
|
412
|
+
"device.delete",
|
413
|
+
"device.export",
|
414
|
+
"device.get",
|
415
|
+
"device.getCommand",
|
416
|
+
"device.getCompositeState",
|
417
|
+
"device.getLogEntries",
|
418
|
+
"device.getState",
|
419
|
+
"device.patch",
|
420
|
+
"device.removeData",
|
421
|
+
"device.sendCommand",
|
422
|
+
"device.sendState",
|
423
|
+
"deviceRecipe.bulkCreate",
|
424
|
+
"deviceRecipe.delete",
|
425
|
+
"deviceRecipe.get",
|
426
|
+
"deviceRecipe.patch",
|
427
|
+
"deviceRecipes.get",
|
428
|
+
"deviceRecipes.post",
|
429
|
+
"devices.export",
|
430
|
+
"devices.get",
|
431
|
+
"devices.post",
|
432
|
+
"devices.sendCommand",
|
433
|
+
"event.delete",
|
434
|
+
"event.get",
|
435
|
+
"event.patch",
|
436
|
+
"events.get",
|
437
|
+
"events.mostRecentBySeverity",
|
438
|
+
"events.patch",
|
439
|
+
"events.post",
|
440
|
+
"flow.delete",
|
441
|
+
"flow.get",
|
442
|
+
"flow.getStorageEntries",
|
443
|
+
"flow.log",
|
444
|
+
"flow.patch",
|
445
|
+
"flow.pressVirtualButton",
|
446
|
+
"flow.setStorageEntry",
|
447
|
+
"flows.create",
|
448
|
+
"flows.get",
|
449
|
+
"webhook.delete",
|
450
|
+
"webhook.get",
|
451
|
+
"webhook.patch",
|
452
|
+
"webhooks.get",
|
453
|
+
"webhooks.post"
|
454
|
+
]
|
455
|
+
}
|
456
|
+
},
|
457
|
+
"status": {
|
458
|
+
"type": "string",
|
459
|
+
"enum": [
|
460
|
+
"active",
|
461
|
+
"inactive"
|
462
|
+
]
|
463
|
+
}
|
464
|
+
},
|
465
|
+
"additionalProperties": false,
|
466
|
+
"required": [
|
467
|
+
"name"
|
468
|
+
]
|
469
|
+
}
|
470
|
+
```
|
471
|
+
### <a name="application-api-token-post-example"></a> Example
|
472
|
+
|
473
|
+
```json
|
474
|
+
{
|
475
|
+
"name": "My New API Token",
|
476
|
+
"expirationDate": "2017-06-13T04:00:00.000Z",
|
477
|
+
"scope": [
|
478
|
+
"all.Application"
|
479
|
+
],
|
480
|
+
"status": "active"
|
481
|
+
}
|
482
|
+
```
|
483
|
+
|
484
|
+
<br/>
|
485
|
+
|
470
486
|
## Application Key
|
471
487
|
|
472
488
|
Schema for a single Application Key
|
@@ -1071,6 +1087,7 @@ Schema for a single Audit Log entry
|
|
1071
1087
|
"secondaryTargetType": {
|
1072
1088
|
"type": "string",
|
1073
1089
|
"enum": [
|
1090
|
+
"ApiToken",
|
1074
1091
|
"ApplicationKey",
|
1075
1092
|
"Device",
|
1076
1093
|
"DeviceRecipe",
|
@@ -1095,7 +1112,8 @@ Schema for a single Audit Log entry
|
|
1095
1112
|
"Device",
|
1096
1113
|
"Flow",
|
1097
1114
|
"SolutionUser",
|
1098
|
-
"User"
|
1115
|
+
"User",
|
1116
|
+
"ApiToken"
|
1099
1117
|
]
|
1100
1118
|
},
|
1101
1119
|
"actorName": {
|
@@ -1209,6 +1227,7 @@ Schema for the filter of an audit log query
|
|
1209
1227
|
"type": {
|
1210
1228
|
"type": "string",
|
1211
1229
|
"enum": [
|
1230
|
+
"ApiToken",
|
1212
1231
|
"ApplicationKey",
|
1213
1232
|
"Device",
|
1214
1233
|
"DeviceRecipe",
|
@@ -1242,7 +1261,8 @@ Schema for the filter of an audit log query
|
|
1242
1261
|
"Device",
|
1243
1262
|
"Flow",
|
1244
1263
|
"SolutionUser",
|
1245
|
-
"User"
|
1264
|
+
"User",
|
1265
|
+
"ApiToken"
|
1246
1266
|
]
|
1247
1267
|
},
|
1248
1268
|
"name": {
|
@@ -1364,6 +1384,7 @@ Schema for a collection of Audit Logs
|
|
1364
1384
|
"secondaryTargetType": {
|
1365
1385
|
"type": "string",
|
1366
1386
|
"enum": [
|
1387
|
+
"ApiToken",
|
1367
1388
|
"ApplicationKey",
|
1368
1389
|
"Device",
|
1369
1390
|
"DeviceRecipe",
|
@@ -1388,7 +1409,8 @@ Schema for a collection of Audit Logs
|
|
1388
1409
|
"Device",
|
1389
1410
|
"Flow",
|
1390
1411
|
"SolutionUser",
|
1391
|
-
"User"
|
1412
|
+
"User",
|
1413
|
+
"ApiToken"
|
1392
1414
|
]
|
1393
1415
|
},
|
1394
1416
|
"actorName": {
|
@@ -4104,7 +4126,8 @@ Schema for a single Event
|
|
4104
4126
|
"enum": [
|
4105
4127
|
"flow",
|
4106
4128
|
"user",
|
4107
|
-
"device"
|
4129
|
+
"device",
|
4130
|
+
"apiToken"
|
4108
4131
|
]
|
4109
4132
|
},
|
4110
4133
|
"sourceId": {
|
@@ -4148,7 +4171,8 @@ Schema for a single Event
|
|
4148
4171
|
"enum": [
|
4149
4172
|
"flow",
|
4150
4173
|
"user",
|
4151
|
-
"device"
|
4174
|
+
"device",
|
4175
|
+
"apiToken"
|
4152
4176
|
]
|
4153
4177
|
},
|
4154
4178
|
"sourceId": {
|
@@ -4354,7 +4378,8 @@ Schema for a collection of Events
|
|
4354
4378
|
"enum": [
|
4355
4379
|
"flow",
|
4356
4380
|
"user",
|
4357
|
-
"device"
|
4381
|
+
"device",
|
4382
|
+
"apiToken"
|
4358
4383
|
]
|
4359
4384
|
},
|
4360
4385
|
"sourceId": {
|
@@ -4398,7 +4423,8 @@ Schema for a collection of Events
|
|
4398
4423
|
"enum": [
|
4399
4424
|
"flow",
|
4400
4425
|
"user",
|
4401
|
-
"device"
|
4426
|
+
"device",
|
4427
|
+
"apiToken"
|
4402
4428
|
]
|
4403
4429
|
},
|
4404
4430
|
"sourceId": {
|