@itentialopensource/adapter-zscaler 0.6.5 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AUTH.md +39 -0
- package/BROKER.md +199 -0
- package/CALLS.md +169 -0
- package/CHANGELOG.md +59 -25
- package/CODE_OF_CONDUCT.md +12 -17
- package/CONTRIBUTING.md +88 -74
- package/ENHANCE.md +69 -0
- package/PROPERTIES.md +641 -0
- package/README.md +221 -571
- package/SUMMARY.md +9 -0
- package/SYSTEMINFO.md +11 -0
- package/TROUBLESHOOT.md +47 -0
- package/adapter.js +433 -143
- package/adapterBase.js +1007 -253
- package/entities/.generic/action.json +105 -0
- package/entities/.generic/schema.json +6 -1
- package/entities/.system/action.json +2 -2
- package/error.json +6 -0
- package/package.json +5 -3
- package/pronghorn.json +762 -498
- package/propertiesDecorators.json +14 -0
- package/propertiesSchema.json +421 -0
- package/refs?service=git-upload-pack +0 -0
- package/report/adapterInfo.json +10 -0
- package/report/updateReport1642619799800.json +95 -0
- package/report/updateReport1653331963274.json +120 -0
- package/sampleProperties.json +90 -1
- package/test/integration/adapterTestBasicGet.js +1 -1
- package/test/integration/adapterTestIntegration.js +26 -102
- package/test/unit/adapterBaseTestUnit.js +30 -25
- package/test/unit/adapterTestUnit.js +168 -156
- package/utils/adapterInfo.js +206 -0
- package/utils/basicGet.js +0 -17
- package/utils/entitiesToDB.js +12 -57
- package/utils/modify.js +1 -1
- package/utils/patches2bundledDeps.js +90 -0
- package/utils/pre-commit.sh +3 -0
- package/utils/tbScript.js +38 -23
- package/utils/tbUtils.js +91 -28
- package/utils/testRunner.js +16 -16
- package/utils/troubleshootingAdapter.js +2 -26
package/pronghorn.json
CHANGED
|
@@ -8,384 +8,648 @@
|
|
|
8
8
|
"admin"
|
|
9
9
|
],
|
|
10
10
|
"methods": [
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
11
|
+
{
|
|
12
|
+
"name": "iapUpdateAdapterConfiguration",
|
|
13
|
+
"summary": "Updates the adapter configuration",
|
|
14
|
+
"description": "Updates the adapter configuration file with the provided changes",
|
|
15
|
+
"input": [
|
|
16
|
+
{
|
|
17
|
+
"name": "configFile",
|
|
18
|
+
"type": "string",
|
|
19
|
+
"info": "The name of the file to change",
|
|
20
|
+
"required": true,
|
|
21
|
+
"schema": {
|
|
22
|
+
"title": "configFile",
|
|
23
|
+
"type": "string"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"name": "changes",
|
|
28
|
+
"type": "object",
|
|
29
|
+
"info": "JSON object containing the configuration changes",
|
|
30
|
+
"required": true,
|
|
31
|
+
"schema": {
|
|
32
|
+
"title": "changes",
|
|
33
|
+
"type": "object"
|
|
34
|
+
}
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"name": "entity",
|
|
38
|
+
"type": "string",
|
|
39
|
+
"info": "The entity in which the changes are being made",
|
|
40
|
+
"required": false,
|
|
41
|
+
"schema": {
|
|
42
|
+
"title": "entity",
|
|
43
|
+
"type": "string"
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "type",
|
|
48
|
+
"type": "string",
|
|
49
|
+
"info": "The type of file to change - action, schema, or mock",
|
|
50
|
+
"required": false,
|
|
51
|
+
"schema": {
|
|
52
|
+
"title": "type",
|
|
53
|
+
"type": "string"
|
|
54
|
+
}
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"name": "action",
|
|
58
|
+
"type": "string",
|
|
59
|
+
"info": "The action to be changed",
|
|
60
|
+
"required": false,
|
|
61
|
+
"schema": {
|
|
62
|
+
"title": "action",
|
|
63
|
+
"type": "string"
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
],
|
|
67
|
+
"output": {
|
|
68
|
+
"name": "result",
|
|
69
|
+
"type": "object",
|
|
70
|
+
"description": "A JSON Object containing status, code and the result",
|
|
71
|
+
"schema": {
|
|
72
|
+
"title": "result",
|
|
73
|
+
"type": "object"
|
|
74
|
+
}
|
|
75
|
+
},
|
|
76
|
+
"roles": [
|
|
77
|
+
"admin"
|
|
78
|
+
],
|
|
79
|
+
"route": {
|
|
80
|
+
"verb": "POST",
|
|
81
|
+
"path": "/iapUpdateAdapterConfiguration"
|
|
82
|
+
},
|
|
83
|
+
"task": true
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"name": "iapFindAdapterPath",
|
|
87
|
+
"summary": "Provides the ability to see if a particular API path is supported by the adapter",
|
|
88
|
+
"description": "Provides the ability to see if a particular API path is supported by the adapter",
|
|
89
|
+
"input": [{
|
|
90
|
+
"name": "apiPath",
|
|
91
|
+
"type": "string",
|
|
92
|
+
"info": "The API Path you want to check - make sure to not include base path and version",
|
|
93
|
+
"description": "The API Path you want to check - make sure to not include base path and version",
|
|
94
|
+
"schema": {
|
|
95
|
+
"title": "apiPath",
|
|
96
|
+
"type": "string"
|
|
97
|
+
},
|
|
98
|
+
"required": true
|
|
99
|
+
}],
|
|
100
|
+
"output": {
|
|
101
|
+
"name": "result",
|
|
102
|
+
"type": "object",
|
|
103
|
+
"description": "A JSON Object containing the result",
|
|
104
|
+
"schema": {
|
|
105
|
+
"title": "result",
|
|
106
|
+
"type": "object"
|
|
107
|
+
}
|
|
108
|
+
},
|
|
109
|
+
"roles": [
|
|
110
|
+
"admin"
|
|
111
|
+
],
|
|
112
|
+
"route": {
|
|
113
|
+
"verb": "POST",
|
|
114
|
+
"path": "/iapFindAdapterPath"
|
|
115
|
+
},
|
|
116
|
+
"task": true
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
"name": "iapSuspendAdapter",
|
|
120
|
+
"summary": "Suspends the adapter",
|
|
121
|
+
"description": "Suspends the adapter",
|
|
122
|
+
"input": [{
|
|
123
|
+
"name": "mode",
|
|
124
|
+
"type": "enum",
|
|
125
|
+
"enumerals": ["pause", "error"],
|
|
126
|
+
"info": "How incoming requests are handled. Defaults to 'pause'",
|
|
127
|
+
"description": "How incoming requests are handled. Defaults to 'pause'",
|
|
128
|
+
"schema": {
|
|
129
|
+
"title": "mode",
|
|
130
|
+
"type": "string"
|
|
131
|
+
},
|
|
132
|
+
"required": false
|
|
133
|
+
}],
|
|
134
|
+
"output": {
|
|
135
|
+
"name": "result",
|
|
136
|
+
"type": "object",
|
|
137
|
+
"description": "A JSON Object containing the adapter suspended status",
|
|
138
|
+
"schema": {
|
|
139
|
+
"title": "result",
|
|
140
|
+
"type": "object"
|
|
141
|
+
}
|
|
142
|
+
},
|
|
143
|
+
"roles": [
|
|
144
|
+
"admin"
|
|
145
|
+
],
|
|
146
|
+
"route": {
|
|
147
|
+
"verb": "POST",
|
|
148
|
+
"path": "/iapSuspendAdapter"
|
|
149
|
+
},
|
|
150
|
+
"task": true
|
|
151
|
+
},
|
|
152
|
+
{
|
|
153
|
+
"name": "iapUnsuspendAdapter",
|
|
154
|
+
"summary": "Unsuspends the adapter",
|
|
155
|
+
"description": "Unsuspends the adapter",
|
|
156
|
+
"input": [],
|
|
157
|
+
"output": {
|
|
158
|
+
"name": "result",
|
|
159
|
+
"type": "object",
|
|
160
|
+
"description": "A JSON Object containing the adapter suspended status",
|
|
161
|
+
"schema": {
|
|
162
|
+
"title": "result",
|
|
163
|
+
"type": "object"
|
|
164
|
+
}
|
|
165
|
+
},
|
|
166
|
+
"roles": [
|
|
167
|
+
"admin"
|
|
168
|
+
],
|
|
169
|
+
"route": {
|
|
170
|
+
"verb": "POST",
|
|
171
|
+
"path": "/iapUnsuspendAdapter"
|
|
172
|
+
},
|
|
173
|
+
"task": true
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
"name": "iapGetAdapterQueue",
|
|
177
|
+
"summary": "Return the requests that are waiting in the queue if throttling is enabled",
|
|
178
|
+
"description": "Return the requests that are waiting in the queue if throttling is enabled",
|
|
179
|
+
"input": [],
|
|
180
|
+
"output": {
|
|
181
|
+
"name": "result",
|
|
182
|
+
"type": "object",
|
|
183
|
+
"description": "A JSON Object containing the adapter queue",
|
|
184
|
+
"schema": {
|
|
185
|
+
"title": "result",
|
|
186
|
+
"type": "object"
|
|
187
|
+
}
|
|
188
|
+
},
|
|
189
|
+
"roles": [
|
|
190
|
+
"admin"
|
|
191
|
+
],
|
|
192
|
+
"route": {
|
|
193
|
+
"verb": "POST",
|
|
194
|
+
"path": "/iapGetAdapterQueue"
|
|
195
|
+
},
|
|
196
|
+
"task": true
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"name": "iapTroubleshootAdapter",
|
|
200
|
+
"summary": "Runs troubleshoot script for adapter",
|
|
201
|
+
"description": "Runs troubleshoot script for adapter",
|
|
202
|
+
"input": [
|
|
203
|
+
{
|
|
204
|
+
"name": "props",
|
|
205
|
+
"type": "object",
|
|
206
|
+
"info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
|
|
207
|
+
"required": true,
|
|
208
|
+
"schema": {
|
|
209
|
+
"title": "props",
|
|
210
|
+
"type": "object"
|
|
211
|
+
}
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
"name": "persistFlag",
|
|
215
|
+
"type": "boolean",
|
|
216
|
+
"info": "Whether the input properties should be saved",
|
|
217
|
+
"required": true
|
|
218
|
+
}
|
|
219
|
+
],
|
|
220
|
+
"output": {
|
|
221
|
+
"name": "result",
|
|
222
|
+
"type": "object",
|
|
223
|
+
"description": "A JSON Object containing the test results",
|
|
224
|
+
"schema": {
|
|
225
|
+
"title": "result",
|
|
226
|
+
"type": "object"
|
|
227
|
+
}
|
|
228
|
+
},
|
|
229
|
+
"roles": [
|
|
230
|
+
"admin"
|
|
231
|
+
],
|
|
232
|
+
"route": {
|
|
233
|
+
"verb": "POST",
|
|
234
|
+
"path": "/iapTroubleshootAdapter"
|
|
235
|
+
},
|
|
236
|
+
"task": true
|
|
237
|
+
},
|
|
238
|
+
{
|
|
239
|
+
"name": "iapRunAdapterHealthcheck",
|
|
240
|
+
"summary": "Runs healthcheck script for adapter",
|
|
241
|
+
"description": "Runs healthcheck script for adapter",
|
|
242
|
+
"input": [],
|
|
243
|
+
"output": {
|
|
244
|
+
"name": "result",
|
|
245
|
+
"type": "boolean",
|
|
246
|
+
"description": "Whether healthcheck passed or failed"
|
|
247
|
+
},
|
|
248
|
+
"roles": [
|
|
249
|
+
"admin"
|
|
250
|
+
],
|
|
251
|
+
"route": {
|
|
252
|
+
"verb": "POST",
|
|
253
|
+
"path": "/iapRunAdapterHealthcheck"
|
|
254
|
+
},
|
|
255
|
+
"task": true
|
|
256
|
+
},
|
|
257
|
+
{
|
|
258
|
+
"name": "iapRunAdapterConnectivity",
|
|
259
|
+
"summary": "Runs connectivity check script for adapter",
|
|
260
|
+
"description": "Runs connectivity check script for adapter",
|
|
261
|
+
"input": [],
|
|
262
|
+
"output": {
|
|
263
|
+
"name": "result",
|
|
264
|
+
"type": "object",
|
|
265
|
+
"description": "A JSON Object containing the test results",
|
|
266
|
+
"schema": {
|
|
267
|
+
"title": "result",
|
|
268
|
+
"type": "object"
|
|
269
|
+
}
|
|
270
|
+
},
|
|
271
|
+
"roles": [
|
|
272
|
+
"admin"
|
|
273
|
+
],
|
|
274
|
+
"route": {
|
|
275
|
+
"verb": "POST",
|
|
276
|
+
"path": "/iapRunAdapterConnectivity"
|
|
277
|
+
},
|
|
278
|
+
"task": true
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
"name": "iapRunAdapterBasicGet",
|
|
282
|
+
"summary": "Runs basicGet script for adapter",
|
|
283
|
+
"description": "Runs basicGet script for adapter",
|
|
284
|
+
"input": [],
|
|
285
|
+
"output": {
|
|
286
|
+
"name": "result",
|
|
287
|
+
"type": "object",
|
|
288
|
+
"description": "A JSON Object containing the test results",
|
|
289
|
+
"schema": {
|
|
290
|
+
"title": "result",
|
|
291
|
+
"type": "object"
|
|
292
|
+
}
|
|
293
|
+
},
|
|
294
|
+
"roles": [
|
|
295
|
+
"admin"
|
|
296
|
+
],
|
|
297
|
+
"route": {
|
|
298
|
+
"verb": "POST",
|
|
299
|
+
"path": "/iapRunAdapterBasicGet"
|
|
300
|
+
},
|
|
301
|
+
"task": true
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"name": "iapMoveAdapterEntitiesToDB",
|
|
305
|
+
"summary": "Moves entities from an adapter into the IAP database",
|
|
306
|
+
"description": "Moves entities from an adapter into the IAP database",
|
|
307
|
+
"input": [],
|
|
308
|
+
"output": {
|
|
309
|
+
"name": "res",
|
|
310
|
+
"type": "object",
|
|
311
|
+
"description": "A JSON Object containing status, code and the response from the mongo transaction",
|
|
312
|
+
"schema": {
|
|
313
|
+
"title": "res",
|
|
314
|
+
"type": "object"
|
|
315
|
+
}
|
|
316
|
+
},
|
|
317
|
+
"roles": [
|
|
318
|
+
"admin"
|
|
319
|
+
],
|
|
320
|
+
"route": {
|
|
321
|
+
"verb": "POST",
|
|
322
|
+
"path": "/iapMoveAdapterEntitiesToDB"
|
|
323
|
+
},
|
|
324
|
+
"task": true
|
|
325
|
+
},
|
|
326
|
+
{
|
|
327
|
+
"name": "genericAdapterRequest",
|
|
328
|
+
"summary": "Makes the requested generic call",
|
|
329
|
+
"description": "Makes the requested generic call",
|
|
330
|
+
"input": [
|
|
331
|
+
{
|
|
332
|
+
"name": "uriPath",
|
|
333
|
+
"type": "string",
|
|
334
|
+
"info": "the path of the api call - do not include the host, port, base path or version",
|
|
335
|
+
"description": "the path of the api call",
|
|
336
|
+
"schema": {
|
|
337
|
+
"title": "uriPath",
|
|
338
|
+
"type": "string"
|
|
339
|
+
},
|
|
340
|
+
"required": true
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"name": "restMethod",
|
|
344
|
+
"type": "string",
|
|
345
|
+
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
346
|
+
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
347
|
+
"schema": {
|
|
348
|
+
"title": "restMethod",
|
|
349
|
+
"type": "string"
|
|
350
|
+
},
|
|
351
|
+
"required": true
|
|
352
|
+
},
|
|
353
|
+
{
|
|
354
|
+
"name": "queryData",
|
|
355
|
+
"type": "object",
|
|
356
|
+
"info": "the query parameters to be put on the url (optional)",
|
|
357
|
+
"description": "the query parameters to be put on the url (optional)",
|
|
358
|
+
"schema": {
|
|
359
|
+
"title": "queryData",
|
|
360
|
+
"type": "object"
|
|
361
|
+
},
|
|
362
|
+
"required": false
|
|
363
|
+
},
|
|
364
|
+
{
|
|
365
|
+
"name": "requestBody",
|
|
366
|
+
"type": "object",
|
|
367
|
+
"info": "the payload to be sent with the request (optional)",
|
|
368
|
+
"description": "the payload to be sent with the request (optional)",
|
|
369
|
+
"schema": {
|
|
370
|
+
"title": "requestBody",
|
|
371
|
+
"type": "object"
|
|
372
|
+
},
|
|
373
|
+
"required": false
|
|
374
|
+
},
|
|
375
|
+
{
|
|
376
|
+
"name": "addlHeaders",
|
|
377
|
+
"type": "object",
|
|
378
|
+
"info": "additional headers to be put on the call (optional)",
|
|
379
|
+
"description": "additional headers to be put on the call (optional)",
|
|
380
|
+
"schema": {
|
|
381
|
+
"title": "addlHeaders",
|
|
382
|
+
"type": "object"
|
|
383
|
+
},
|
|
384
|
+
"required": false
|
|
385
|
+
}
|
|
386
|
+
],
|
|
387
|
+
"output": {
|
|
388
|
+
"name": "result",
|
|
389
|
+
"type": "object",
|
|
390
|
+
"description": "A JSON Object containing status, code and the result",
|
|
391
|
+
"schema": {
|
|
392
|
+
"title": "result",
|
|
393
|
+
"type": "object"
|
|
394
|
+
}
|
|
395
|
+
},
|
|
396
|
+
"roles": [
|
|
397
|
+
"admin"
|
|
398
|
+
],
|
|
399
|
+
"route": {
|
|
400
|
+
"verb": "POST",
|
|
401
|
+
"path": "/genericAdapterRequest"
|
|
402
|
+
},
|
|
403
|
+
"task": true
|
|
404
|
+
},
|
|
405
|
+
{
|
|
406
|
+
"name": "genericAdapterRequestNoBasePath",
|
|
407
|
+
"summary": "Makes the requested generic call with no base path or version",
|
|
408
|
+
"description": "Makes the requested generic call with no base path or version",
|
|
409
|
+
"input": [
|
|
410
|
+
{
|
|
411
|
+
"name": "uriPath",
|
|
412
|
+
"type": "string",
|
|
413
|
+
"info": "the path of the api call - do not include the host, port, base path or version",
|
|
414
|
+
"description": "the path of the api call",
|
|
415
|
+
"schema": {
|
|
416
|
+
"title": "uriPath",
|
|
417
|
+
"type": "string"
|
|
418
|
+
},
|
|
419
|
+
"required": true
|
|
420
|
+
},
|
|
421
|
+
{
|
|
422
|
+
"name": "restMethod",
|
|
423
|
+
"type": "string",
|
|
424
|
+
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
425
|
+
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
426
|
+
"schema": {
|
|
427
|
+
"title": "restMethod",
|
|
428
|
+
"type": "string"
|
|
429
|
+
},
|
|
430
|
+
"required": true
|
|
431
|
+
},
|
|
432
|
+
{
|
|
433
|
+
"name": "queryData",
|
|
434
|
+
"type": "object",
|
|
435
|
+
"info": "the query parameters to be put on the url (optional)",
|
|
436
|
+
"description": "the query parameters to be put on the url (optional)",
|
|
437
|
+
"schema": {
|
|
438
|
+
"title": "queryData",
|
|
439
|
+
"type": "object"
|
|
440
|
+
},
|
|
441
|
+
"required": false
|
|
442
|
+
},
|
|
443
|
+
{
|
|
444
|
+
"name": "requestBody",
|
|
445
|
+
"type": "object",
|
|
446
|
+
"info": "the payload to be sent with the request (optional)",
|
|
447
|
+
"description": "the payload to be sent with the request (optional)",
|
|
448
|
+
"schema": {
|
|
449
|
+
"title": "requestBody",
|
|
450
|
+
"type": "object"
|
|
451
|
+
},
|
|
452
|
+
"required": false
|
|
453
|
+
},
|
|
454
|
+
{
|
|
455
|
+
"name": "addlHeaders",
|
|
456
|
+
"type": "object",
|
|
457
|
+
"info": "additional headers to be put on the call (optional)",
|
|
458
|
+
"description": "additional headers to be put on the call (optional)",
|
|
459
|
+
"schema": {
|
|
460
|
+
"title": "addlHeaders",
|
|
461
|
+
"type": "object"
|
|
462
|
+
},
|
|
463
|
+
"required": false
|
|
464
|
+
}
|
|
465
|
+
],
|
|
466
|
+
"output": {
|
|
467
|
+
"name": "result",
|
|
468
|
+
"type": "object",
|
|
469
|
+
"description": "A JSON Object containing status, code and the result",
|
|
470
|
+
"schema": {
|
|
471
|
+
"title": "result",
|
|
472
|
+
"type": "object"
|
|
473
|
+
}
|
|
474
|
+
},
|
|
475
|
+
"roles": [
|
|
476
|
+
"admin"
|
|
477
|
+
],
|
|
478
|
+
"route": {
|
|
479
|
+
"verb": "POST",
|
|
480
|
+
"path": "/genericAdapterRequestNoBasePath"
|
|
481
|
+
},
|
|
482
|
+
"task": true
|
|
483
|
+
},
|
|
484
|
+
{
|
|
485
|
+
"name": "getDevice",
|
|
486
|
+
"summary": "Get the Appliance",
|
|
487
|
+
"description": "Get the Appliance",
|
|
488
|
+
"input": [
|
|
489
|
+
{
|
|
490
|
+
"name": "deviceName",
|
|
491
|
+
"type": "string",
|
|
492
|
+
"info": "An Appliance Device Name",
|
|
493
|
+
"required": true,
|
|
494
|
+
"schema": {
|
|
495
|
+
"title": "deviceName",
|
|
496
|
+
"type": "string"
|
|
497
|
+
}
|
|
498
|
+
}
|
|
499
|
+
],
|
|
500
|
+
"output": {
|
|
501
|
+
"name": "result",
|
|
502
|
+
"type": "object",
|
|
503
|
+
"description": "A JSON Object containing status, code and the result",
|
|
504
|
+
"schema": {
|
|
505
|
+
"title": "result",
|
|
506
|
+
"type": "object"
|
|
507
|
+
}
|
|
508
|
+
},
|
|
509
|
+
"roles": [
|
|
510
|
+
"admin"
|
|
511
|
+
],
|
|
512
|
+
"route": {
|
|
513
|
+
"verb": "POST",
|
|
514
|
+
"path": "/getDevice"
|
|
515
|
+
},
|
|
516
|
+
"task": false
|
|
517
|
+
},
|
|
518
|
+
{
|
|
519
|
+
"name": "getDevicesFiltered",
|
|
520
|
+
"summary": "Get Appliances that match the filter",
|
|
521
|
+
"description": "Get Appliances that match the filter",
|
|
522
|
+
"input": [
|
|
523
|
+
{
|
|
524
|
+
"name": "options",
|
|
525
|
+
"type": "object",
|
|
526
|
+
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
|
|
527
|
+
"required": true,
|
|
528
|
+
"schema": {
|
|
529
|
+
"title": "options",
|
|
530
|
+
"type": "object"
|
|
531
|
+
}
|
|
532
|
+
}
|
|
533
|
+
],
|
|
534
|
+
"output": {
|
|
535
|
+
"name": "result",
|
|
536
|
+
"type": "array",
|
|
537
|
+
"description": "A JSON Object containing status, code and the result",
|
|
538
|
+
"schema": {
|
|
539
|
+
"title": "result",
|
|
540
|
+
"type": "array"
|
|
541
|
+
}
|
|
542
|
+
},
|
|
543
|
+
"roles": [
|
|
544
|
+
"admin"
|
|
545
|
+
],
|
|
546
|
+
"route": {
|
|
547
|
+
"verb": "POST",
|
|
548
|
+
"path": "/getDevicesFiltered"
|
|
549
|
+
},
|
|
550
|
+
"task": false
|
|
551
|
+
},
|
|
552
|
+
{
|
|
553
|
+
"name": "isAlive",
|
|
554
|
+
"summary": "Checks the status for the provided Appliance",
|
|
555
|
+
"description": "Checks the status for the provided Appliance",
|
|
556
|
+
"input": [
|
|
557
|
+
{
|
|
558
|
+
"name": "deviceName",
|
|
559
|
+
"type": "string",
|
|
560
|
+
"info": "An Appliance Device Name",
|
|
561
|
+
"required": true,
|
|
562
|
+
"schema": {
|
|
563
|
+
"title": "deviceName",
|
|
564
|
+
"type": "string"
|
|
565
|
+
}
|
|
566
|
+
}
|
|
567
|
+
],
|
|
568
|
+
"output": {
|
|
569
|
+
"name": "result",
|
|
570
|
+
"type": "boolean",
|
|
571
|
+
"description": "A JSON Object containing status, code and the result",
|
|
572
|
+
"schema": {
|
|
573
|
+
"title": "result",
|
|
574
|
+
"type": "boolean"
|
|
575
|
+
}
|
|
576
|
+
},
|
|
577
|
+
"roles": [
|
|
578
|
+
"admin"
|
|
579
|
+
],
|
|
580
|
+
"route": {
|
|
581
|
+
"verb": "POST",
|
|
582
|
+
"path": "/isAlive"
|
|
583
|
+
},
|
|
584
|
+
"task": false
|
|
585
|
+
},
|
|
586
|
+
{
|
|
587
|
+
"name": "getConfig",
|
|
588
|
+
"summary": "Gets a config for the provided Appliance",
|
|
589
|
+
"description": "Gets a config for the provided Appliance",
|
|
590
|
+
"input": [
|
|
591
|
+
{
|
|
592
|
+
"name": "deviceName",
|
|
593
|
+
"type": "string",
|
|
594
|
+
"info": "An Appliance Device Name",
|
|
595
|
+
"required": true,
|
|
596
|
+
"schema": {
|
|
597
|
+
"title": "deviceName",
|
|
598
|
+
"type": "string"
|
|
599
|
+
}
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
"name": "format",
|
|
603
|
+
"type": "string",
|
|
604
|
+
"info": "The format to be returned - this is ignored as we always return json",
|
|
605
|
+
"required": false,
|
|
606
|
+
"schema": {
|
|
607
|
+
"title": "format",
|
|
608
|
+
"type": "string"
|
|
609
|
+
}
|
|
610
|
+
}
|
|
611
|
+
],
|
|
612
|
+
"output": {
|
|
613
|
+
"name": "result",
|
|
614
|
+
"type": "object",
|
|
615
|
+
"description": "A JSON Object containing status, code and the result",
|
|
616
|
+
"schema": {
|
|
617
|
+
"title": "result",
|
|
618
|
+
"type": "object"
|
|
619
|
+
}
|
|
620
|
+
},
|
|
621
|
+
"roles": [
|
|
622
|
+
"admin"
|
|
623
|
+
],
|
|
624
|
+
"route": {
|
|
625
|
+
"verb": "POST",
|
|
626
|
+
"path": "/getConfig"
|
|
627
|
+
},
|
|
628
|
+
"task": false
|
|
629
|
+
},
|
|
630
|
+
{
|
|
631
|
+
"name": "iapGetDeviceCount",
|
|
632
|
+
"summary": "Gets a device count from the system",
|
|
633
|
+
"description": "Gets a device count from the system",
|
|
634
|
+
"input": [],
|
|
635
|
+
"output": {
|
|
636
|
+
"name": "result",
|
|
637
|
+
"type": "object",
|
|
638
|
+
"description": "A JSON Object containing status, code and the result",
|
|
639
|
+
"schema": {
|
|
640
|
+
"title": "result",
|
|
641
|
+
"type": "object"
|
|
642
|
+
}
|
|
643
|
+
},
|
|
644
|
+
"roles": [
|
|
645
|
+
"admin"
|
|
646
|
+
],
|
|
647
|
+
"route": {
|
|
648
|
+
"verb": "POST",
|
|
649
|
+
"path": "/iapGetDeviceCount"
|
|
650
|
+
},
|
|
651
|
+
"task": false
|
|
652
|
+
},
|
|
389
653
|
{
|
|
390
654
|
"name": "getAuthenticatedSession",
|
|
391
655
|
"summary": "Checks if there is an authenticated session",
|
|
@@ -412,12 +676,12 @@
|
|
|
412
676
|
{
|
|
413
677
|
"name": "postAuthenticatedSession",
|
|
414
678
|
"summary": "Creates an authenticated session",
|
|
415
|
-
"description": "
|
|
679
|
+
"description": "Creates an authenticated session. The response returns a cookie in the header called JSESSIONID that must be used in subsequent requests.",
|
|
416
680
|
"input": [
|
|
417
681
|
{
|
|
418
682
|
"name": "credentials",
|
|
419
683
|
"type": "object",
|
|
420
|
-
"info": "
|
|
684
|
+
"info": "Creates an authenticated session. The response returns a cookie in the header called JSESSIONID that must be used in subsequent requests.",
|
|
421
685
|
"required": true,
|
|
422
686
|
"schema": {
|
|
423
687
|
"title": "credentials",
|
|
@@ -446,7 +710,7 @@
|
|
|
446
710
|
{
|
|
447
711
|
"name": "deleteAuthenticatedSession",
|
|
448
712
|
"summary": "Ends an authenticated session",
|
|
449
|
-
"description": "
|
|
713
|
+
"description": "Ends an authenticated session.",
|
|
450
714
|
"input": [],
|
|
451
715
|
"output": {
|
|
452
716
|
"name": "result",
|
|
@@ -469,7 +733,7 @@
|
|
|
469
733
|
{
|
|
470
734
|
"name": "getAuditReport",
|
|
471
735
|
"summary": "This endpoint is deprecated, use GET /auditlogEntryReport",
|
|
472
|
-
"description": "
|
|
736
|
+
"description": "Note: GET /auditReport is deprecated, use GET /auditlogEntryReport.",
|
|
473
737
|
"input": [],
|
|
474
738
|
"output": {
|
|
475
739
|
"name": "result",
|
|
@@ -492,7 +756,7 @@
|
|
|
492
756
|
{
|
|
493
757
|
"name": "postAuditReport",
|
|
494
758
|
"summary": "This endpoint is deprecated, use POST /auditlogEntryReport",
|
|
495
|
-
"description": "
|
|
759
|
+
"description": "Note: POST /auditReport is deprecated, use POST /auditlogEntryReport.",
|
|
496
760
|
"input": [],
|
|
497
761
|
"output": {
|
|
498
762
|
"name": "result",
|
|
@@ -515,7 +779,7 @@
|
|
|
515
779
|
{
|
|
516
780
|
"name": "deleteAuditReport",
|
|
517
781
|
"summary": "This endpoint is deprecated, use DELETE /auditlogEntryReport",
|
|
518
|
-
"description": "
|
|
782
|
+
"description": "Note: DELETE /auditReport is deprecated, use DELETE /auditlogEntryReport.",
|
|
519
783
|
"input": [],
|
|
520
784
|
"output": {
|
|
521
785
|
"name": "result",
|
|
@@ -538,7 +802,7 @@
|
|
|
538
802
|
{
|
|
539
803
|
"name": "getAuditReportdownload",
|
|
540
804
|
"summary": "This endpoint is deprecated, use GET /auditlogEntryReport/download",
|
|
541
|
-
"description": "
|
|
805
|
+
"description": "Note: GET /auditReport is deprecated, use GET /auditlogEntryReport/download.",
|
|
542
806
|
"input": [],
|
|
543
807
|
"output": {
|
|
544
808
|
"name": "result",
|
|
@@ -561,7 +825,7 @@
|
|
|
561
825
|
{
|
|
562
826
|
"name": "getAuditlogEntryReport",
|
|
563
827
|
"summary": "Gets the status of a request for an audit log report",
|
|
564
|
-
"description": "
|
|
828
|
+
"description": "Gets the status of a request for an audit log report. After sending a POST request to /auditlogEntryReport to generate a report, you can continue to call GET /auditlogEntryReport to check whether the report has finished generating. Once the status is COMPLETE, you can send another GET request to /auditlogEntryReport/download to download the report as a CSV file.",
|
|
565
829
|
"input": [],
|
|
566
830
|
"output": {
|
|
567
831
|
"name": "result",
|
|
@@ -584,12 +848,12 @@
|
|
|
584
848
|
{
|
|
585
849
|
"name": "postAuditlogEntryReport",
|
|
586
850
|
"summary": "Creates an audit log report for the specified time period and saves it as a CSV file",
|
|
587
|
-
"description": "
|
|
851
|
+
"description": "Creates an audit log report for the specified time period and saves it as a CSV file. The report includes audit information for every call made to the cloud service API during the specified time period. Creating a new audit log report will overwrite a previously-generated report.",
|
|
588
852
|
"input": [
|
|
589
853
|
{
|
|
590
854
|
"name": "request",
|
|
591
855
|
"type": "object",
|
|
592
|
-
"info": "
|
|
856
|
+
"info": "Creates an audit log report for the specified time period and saves it as a CSV file. The report includes audit information for every call made to the cloud service API during the specified time period. Creating a new audit log report will overwrite a previously-generated report.",
|
|
593
857
|
"required": false,
|
|
594
858
|
"schema": {
|
|
595
859
|
"title": "request",
|
|
@@ -618,7 +882,7 @@
|
|
|
618
882
|
{
|
|
619
883
|
"name": "deleteAuditlogEntryReport",
|
|
620
884
|
"summary": "Cancels the request to create an audit log report",
|
|
621
|
-
"description": "
|
|
885
|
+
"description": "Cancels the request to create an audit log report.",
|
|
622
886
|
"input": [],
|
|
623
887
|
"output": {
|
|
624
888
|
"name": "result",
|
|
@@ -641,7 +905,7 @@
|
|
|
641
905
|
{
|
|
642
906
|
"name": "getAuditlogEntryReportdownload",
|
|
643
907
|
"summary": "Downloads the most recently created audit log report",
|
|
644
|
-
"description": "
|
|
908
|
+
"description": "Downloads the most recently created audit log report. After a call to GET /auditlogEntryReport indicates that the report (CSV file) was generated, you can send a GET request to /auditlogEntryReport/download to download the file.",
|
|
645
909
|
"input": [],
|
|
646
910
|
"output": {
|
|
647
911
|
"name": "result",
|
|
@@ -664,7 +928,7 @@
|
|
|
664
928
|
{
|
|
665
929
|
"name": "getDepartments",
|
|
666
930
|
"summary": "Gets a list of departments",
|
|
667
|
-
"description": "
|
|
931
|
+
"description": "Gets a list of departments. The search parameters find matching values within the \"name\" or \"comments\" attributes.",
|
|
668
932
|
"input": [],
|
|
669
933
|
"output": {
|
|
670
934
|
"name": "result",
|
|
@@ -687,12 +951,12 @@
|
|
|
687
951
|
{
|
|
688
952
|
"name": "getDepartmentsid",
|
|
689
953
|
"summary": "Gets the department for the specified ID",
|
|
690
|
-
"description": "
|
|
954
|
+
"description": "Gets the department for the specified ID.",
|
|
691
955
|
"input": [
|
|
692
956
|
{
|
|
693
957
|
"name": "id",
|
|
694
958
|
"type": "number",
|
|
695
|
-
"info": "
|
|
959
|
+
"info": "Gets the department for the specified ID.",
|
|
696
960
|
"required": true,
|
|
697
961
|
"schema": {
|
|
698
962
|
"title": "id",
|
|
@@ -721,12 +985,12 @@
|
|
|
721
985
|
{
|
|
722
986
|
"name": "getGroups",
|
|
723
987
|
"summary": "Gets a list of groups",
|
|
724
|
-
"description": "
|
|
988
|
+
"description": "Gets a list of groups. The search parameters find matching values in the \"name\" and \"comments\" attributes.",
|
|
725
989
|
"input": [
|
|
726
990
|
{
|
|
727
991
|
"name": "search",
|
|
728
992
|
"type": "string",
|
|
729
|
-
"info": "
|
|
993
|
+
"info": "Gets a list of groups. The search parameters find matching values in the \"name\" and \"comments\" attributes.",
|
|
730
994
|
"required": false,
|
|
731
995
|
"schema": {
|
|
732
996
|
"title": "search",
|
|
@@ -736,7 +1000,7 @@
|
|
|
736
1000
|
{
|
|
737
1001
|
"name": "page",
|
|
738
1002
|
"type": "number",
|
|
739
|
-
"info": "
|
|
1003
|
+
"info": "Gets a list of groups. The search parameters find matching values in the \"name\" and \"comments\" attributes.",
|
|
740
1004
|
"required": false,
|
|
741
1005
|
"schema": {
|
|
742
1006
|
"title": "page",
|
|
@@ -746,7 +1010,7 @@
|
|
|
746
1010
|
{
|
|
747
1011
|
"name": "pageSize",
|
|
748
1012
|
"type": "number",
|
|
749
|
-
"info": "
|
|
1013
|
+
"info": "Gets a list of groups. The search parameters find matching values in the \"name\" and \"comments\" attributes.",
|
|
750
1014
|
"required": false,
|
|
751
1015
|
"schema": {
|
|
752
1016
|
"title": "pageSize",
|
|
@@ -775,12 +1039,12 @@
|
|
|
775
1039
|
{
|
|
776
1040
|
"name": "getGroupsgroupId",
|
|
777
1041
|
"summary": "Gets the group for the specified ID",
|
|
778
|
-
"description": "
|
|
1042
|
+
"description": "Gets the group for the specified ID.",
|
|
779
1043
|
"input": [
|
|
780
1044
|
{
|
|
781
1045
|
"name": "groupId",
|
|
782
1046
|
"type": "number",
|
|
783
|
-
"info": "
|
|
1047
|
+
"info": "Gets the group for the specified ID.",
|
|
784
1048
|
"required": true,
|
|
785
1049
|
"schema": {
|
|
786
1050
|
"title": "groupId",
|
|
@@ -809,12 +1073,12 @@
|
|
|
809
1073
|
{
|
|
810
1074
|
"name": "getUsers",
|
|
811
1075
|
"summary": "Gets a list of all users and allows user filtering by name, department, or group",
|
|
812
|
-
"description": "<p>Gets a list of all users and allows user filtering by name, department, or group. The search parameters, \"dept\" and \"group\", perform a 'starts with' match.</p><br/><b>Sample Request (Python) - Get users by page and pageSize</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?page=1&pageSize=100", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 72548,<br/> "name": "test1",<br/> "email": "admin2@antest.com",<br/> "groups": [<br/> {<br/> "id": 75444,<br/> "name": "testgroup"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "comments": "test",<br/> "adminUser": true<br/> },<br/> ...<br/> {<br/> "id": 74959,<br/> "name": "auto-test-user-1317217",<br/> "email": "auto-test-user-1317217@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> } <br/>]</pre><br/><b>Sample Request (Python) - Get users by name</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?name=john%20smith", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 74479,<br/> "name": "john smith",<br/> "email": "auto-test-user-1338349@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> },<br/> ...<br/> {<br/> "id": 73289,<br/> "name": "john smith",<br/> "email": "auto-test-user-1342472@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> }<br/>]</pre><br/><b>Sample Request (Python) - Get users by group</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?group=guest-wifi", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b> <pre>[<br/> {<br/> "id": 75483,<br/> "name": "admin4",<br/> "email": "admin4@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> },<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> },<br/> {<br/> "id": 75481,<br/> "name": "test-sync1"<br/> },<br/> {<br/> "id": 75444,<br/> "name": "testgroup"<br/> },<br/> {<br/> "id": 75446,<br/> "name": "testsuper"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": true<br/> },<br/> ...<br/> {<br/> "id": 75617,<br/> "name": "ant1",<br/> "email": "ant1@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "comments": "guest wi-fi user",<br/> "adminUser": false<br/> }<br/>]</pre><br/><b>Sample Request (Python) - Get users by dept</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?dept=guests", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 82737,<br/> "name": "guest1234",<br/> "email": "guest89808@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "comments": "guest wi-fi user",<br/> "adminUser": false<br/> },<br/> ...<br/> {<br/> "id": 82738,<br/> "name": "no-pass",<br/> "email": "no-pass@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "adminUser": false<br/> }<br/>]</pre>",
|
|
1076
|
+
"description": "Gets a list of all users and allows user filtering by name, department, or group. The search parameters, \"dept\" and \"group\", perform a 'starts with' match.",
|
|
813
1077
|
"input": [
|
|
814
1078
|
{
|
|
815
1079
|
"name": "name",
|
|
816
1080
|
"type": "string",
|
|
817
|
-
"info": "<p>Gets a list of all users and allows user filtering by name, department, or group. The search parameters, \"dept\" and \"group\", perform a 'starts with' match.</p><br/><b>Sample Request (Python) - Get users by page and pageSize</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?page=1&pageSize=100", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 72548,<br/> "name": "test1",<br/> "email": "admin2@antest.com",<br/> "groups": [<br/> {<br/> "id": 75444,<br/> "name": "testgroup"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "comments": "test",<br/> "adminUser": true<br/> },<br/> ...<br/> {<br/> "id": 74959,<br/> "name": "auto-test-user-1317217",<br/> "email": "auto-test-user-1317217@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> } <br/>]</pre><br/><b>Sample Request (Python) - Get users by name</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?name=john%20smith", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 74479,<br/> "name": "john smith",<br/> "email": "auto-test-user-1338349@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> },<br/> ...<br/> {<br/> "id": 73289,<br/> "name": "john smith",<br/> "email": "auto-test-user-1342472@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> }<br/>]</pre><br/><b>Sample Request (Python) - Get users by group</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?group=guest-wifi", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b> <pre>[<br/> {<br/> "id": 75483,<br/> "name": "admin4",<br/> "email": "admin4@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> },<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> },<br/> {<br/> "id": 75481,<br/> "name": "test-sync1"<br/> },<br/> {<br/> "id": 75444,<br/> "name": "testgroup"<br/> },<br/> {<br/> "id": 75446,<br/> "name": "testsuper"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": true<br/> },<br/> ...<br/> {<br/> "id": 75617,<br/> "name": "ant1",<br/> "email": "ant1@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "comments": "guest wi-fi user",<br/> "adminUser": false<br/> }<br/>]</pre><br/><b>Sample Request (Python) - Get users by dept</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?dept=guests", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 82737,<br/> "name": "guest1234",<br/> "email": "guest89808@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "comments": "guest wi-fi user",<br/> "adminUser": false<br/> },<br/> ...<br/> {<br/> "id": 82738,<br/> "name": "no-pass",<br/> "email": "no-pass@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "adminUser": false<br/> }<br/>]</pre>",
|
|
1081
|
+
"info": "Gets a list of all users and allows user filtering by name, department, or group. The search parameters, \"dept\" and \"group\", perform a 'starts with' match.",
|
|
818
1082
|
"required": false,
|
|
819
1083
|
"schema": {
|
|
820
1084
|
"title": "name",
|
|
@@ -824,7 +1088,7 @@
|
|
|
824
1088
|
{
|
|
825
1089
|
"name": "dept",
|
|
826
1090
|
"type": "string",
|
|
827
|
-
"info": "<p>Gets a list of all users and allows user filtering by name, department, or group. The search parameters, \"dept\" and \"group\", perform a 'starts with' match.</p><br/><b>Sample Request (Python) - Get users by page and pageSize</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?page=1&pageSize=100", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 72548,<br/> "name": "test1",<br/> "email": "admin2@antest.com",<br/> "groups": [<br/> {<br/> "id": 75444,<br/> "name": "testgroup"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "comments": "test",<br/> "adminUser": true<br/> },<br/> ...<br/> {<br/> "id": 74959,<br/> "name": "auto-test-user-1317217",<br/> "email": "auto-test-user-1317217@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> } <br/>]</pre><br/><b>Sample Request (Python) - Get users by name</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?name=john%20smith", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 74479,<br/> "name": "john smith",<br/> "email": "auto-test-user-1338349@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> },<br/> ...<br/> {<br/> "id": 73289,<br/> "name": "john smith",<br/> "email": "auto-test-user-1342472@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> }<br/>]</pre><br/><b>Sample Request (Python) - Get users by group</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?group=guest-wifi", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b> <pre>[<br/> {<br/> "id": 75483,<br/> "name": "admin4",<br/> "email": "admin4@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> },<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> },<br/> {<br/> "id": 75481,<br/> "name": "test-sync1"<br/> },<br/> {<br/> "id": 75444,<br/> "name": "testgroup"<br/> },<br/> {<br/> "id": 75446,<br/> "name": "testsuper"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": true<br/> },<br/> ...<br/> {<br/> "id": 75617,<br/> "name": "ant1",<br/> "email": "ant1@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "comments": "guest wi-fi user",<br/> "adminUser": false<br/> }<br/>]</pre><br/><b>Sample Request (Python) - Get users by dept</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?dept=guests", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 82737,<br/> "name": "guest1234",<br/> "email": "guest89808@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "comments": "guest wi-fi user",<br/> "adminUser": false<br/> },<br/> ...<br/> {<br/> "id": 82738,<br/> "name": "no-pass",<br/> "email": "no-pass@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "adminUser": false<br/> }<br/>]</pre>",
|
|
1091
|
+
"info": "Gets a list of all users and allows user filtering by name, department, or group. The search parameters, \"dept\" and \"group\", perform a 'starts with' match.",
|
|
828
1092
|
"required": false,
|
|
829
1093
|
"schema": {
|
|
830
1094
|
"title": "dept",
|
|
@@ -834,7 +1098,7 @@
|
|
|
834
1098
|
{
|
|
835
1099
|
"name": "group",
|
|
836
1100
|
"type": "string",
|
|
837
|
-
"info": "<p>Gets a list of all users and allows user filtering by name, department, or group. The search parameters, \"dept\" and \"group\", perform a 'starts with' match.</p><br/><b>Sample Request (Python) - Get users by page and pageSize</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?page=1&pageSize=100", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 72548,<br/> "name": "test1",<br/> "email": "admin2@antest.com",<br/> "groups": [<br/> {<br/> "id": 75444,<br/> "name": "testgroup"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "comments": "test",<br/> "adminUser": true<br/> },<br/> ...<br/> {<br/> "id": 74959,<br/> "name": "auto-test-user-1317217",<br/> "email": "auto-test-user-1317217@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> } <br/>]</pre><br/><b>Sample Request (Python) - Get users by name</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?name=john%20smith", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 74479,<br/> "name": "john smith",<br/> "email": "auto-test-user-1338349@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> },<br/> ...<br/> {<br/> "id": 73289,<br/> "name": "john smith",<br/> "email": "auto-test-user-1342472@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> }<br/>]</pre><br/><b>Sample Request (Python) - Get users by group</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?group=guest-wifi", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b> <pre>[<br/> {<br/> "id": 75483,<br/> "name": "admin4",<br/> "email": "admin4@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> },<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> },<br/> {<br/> "id": 75481,<br/> "name": "test-sync1"<br/> },<br/> {<br/> "id": 75444,<br/> "name": "testgroup"<br/> },<br/> {<br/> "id": 75446,<br/> "name": "testsuper"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": true<br/> },<br/> ...<br/> {<br/> "id": 75617,<br/> "name": "ant1",<br/> "email": "ant1@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "comments": "guest wi-fi user",<br/> "adminUser": false<br/> }<br/>]</pre><br/><b>Sample Request (Python) - Get users by dept</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?dept=guests", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 82737,<br/> "name": "guest1234",<br/> "email": "guest89808@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "comments": "guest wi-fi user",<br/> "adminUser": false<br/> },<br/> ...<br/> {<br/> "id": 82738,<br/> "name": "no-pass",<br/> "email": "no-pass@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "adminUser": false<br/> }<br/>]</pre>",
|
|
1101
|
+
"info": "Gets a list of all users and allows user filtering by name, department, or group. The search parameters, \"dept\" and \"group\", perform a 'starts with' match.",
|
|
838
1102
|
"required": false,
|
|
839
1103
|
"schema": {
|
|
840
1104
|
"title": "group",
|
|
@@ -844,7 +1108,7 @@
|
|
|
844
1108
|
{
|
|
845
1109
|
"name": "page",
|
|
846
1110
|
"type": "number",
|
|
847
|
-
"info": "<p>Gets a list of all users and allows user filtering by name, department, or group. The search parameters, \"dept\" and \"group\", perform a 'starts with' match.</p><br/><b>Sample Request (Python) - Get users by page and pageSize</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?page=1&pageSize=100", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 72548,<br/> "name": "test1",<br/> "email": "admin2@antest.com",<br/> "groups": [<br/> {<br/> "id": 75444,<br/> "name": "testgroup"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "comments": "test",<br/> "adminUser": true<br/> },<br/> ...<br/> {<br/> "id": 74959,<br/> "name": "auto-test-user-1317217",<br/> "email": "auto-test-user-1317217@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> } <br/>]</pre><br/><b>Sample Request (Python) - Get users by name</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?name=john%20smith", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 74479,<br/> "name": "john smith",<br/> "email": "auto-test-user-1338349@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> },<br/> ...<br/> {<br/> "id": 73289,<br/> "name": "john smith",<br/> "email": "auto-test-user-1342472@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> }<br/>]</pre><br/><b>Sample Request (Python) - Get users by group</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?group=guest-wifi", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b> <pre>[<br/> {<br/> "id": 75483,<br/> "name": "admin4",<br/> "email": "admin4@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> },<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> },<br/> {<br/> "id": 75481,<br/> "name": "test-sync1"<br/> },<br/> {<br/> "id": 75444,<br/> "name": "testgroup"<br/> },<br/> {<br/> "id": 75446,<br/> "name": "testsuper"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": true<br/> },<br/> ...<br/> {<br/> "id": 75617,<br/> "name": "ant1",<br/> "email": "ant1@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "comments": "guest wi-fi user",<br/> "adminUser": false<br/> }<br/>]</pre><br/><b>Sample Request (Python) - Get users by dept</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?dept=guests", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 82737,<br/> "name": "guest1234",<br/> "email": "guest89808@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "comments": "guest wi-fi user",<br/> "adminUser": false<br/> },<br/> ...<br/> {<br/> "id": 82738,<br/> "name": "no-pass",<br/> "email": "no-pass@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "adminUser": false<br/> }<br/>]</pre>",
|
|
1111
|
+
"info": "Gets a list of all users and allows user filtering by name, department, or group. The search parameters, \"dept\" and \"group\", perform a 'starts with' match.",
|
|
848
1112
|
"required": false,
|
|
849
1113
|
"schema": {
|
|
850
1114
|
"title": "page",
|
|
@@ -854,7 +1118,7 @@
|
|
|
854
1118
|
{
|
|
855
1119
|
"name": "pageSize",
|
|
856
1120
|
"type": "number",
|
|
857
|
-
"info": "<p>Gets a list of all users and allows user filtering by name, department, or group. The search parameters, \"dept\" and \"group\", perform a 'starts with' match.</p><br/><b>Sample Request (Python) - Get users by page and pageSize</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?page=1&pageSize=100", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 72548,<br/> "name": "test1",<br/> "email": "admin2@antest.com",<br/> "groups": [<br/> {<br/> "id": 75444,<br/> "name": "testgroup"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "comments": "test",<br/> "adminUser": true<br/> },<br/> ...<br/> {<br/> "id": 74959,<br/> "name": "auto-test-user-1317217",<br/> "email": "auto-test-user-1317217@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> } <br/>]</pre><br/><b>Sample Request (Python) - Get users by name</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?name=john%20smith", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 74479,<br/> "name": "john smith",<br/> "email": "auto-test-user-1338349@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> },<br/> ...<br/> {<br/> "id": 73289,<br/> "name": "john smith",<br/> "email": "auto-test-user-1342472@antest.com",<br/> "groups": [<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": false<br/> }<br/>]</pre><br/><b>Sample Request (Python) - Get users by group</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?group=guest-wifi", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b> <pre>[<br/> {<br/> "id": 75483,<br/> "name": "admin4",<br/> "email": "admin4@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> },<br/> {<br/> "id": 72519,<br/> "name": "Service Admin"<br/> },<br/> {<br/> "id": 75481,<br/> "name": "test-sync1"<br/> },<br/> {<br/> "id": 75444,<br/> "name": "testgroup"<br/> },<br/> {<br/> "id": 75446,<br/> "name": "testsuper"<br/> }<br/> ],<br/> "department": {<br/> "id": 72520,<br/> "name": "Service Admin"<br/> },<br/> "adminUser": true<br/> },<br/> ...<br/> {<br/> "id": 75617,<br/> "name": "ant1",<br/> "email": "ant1@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "comments": "guest wi-fi user",<br/> "adminUser": false<br/> }<br/>]</pre><br/><b>Sample Request (Python) - Get users by dept</b><pre>import http.client<br/><br/>conn = http.client.HTTPSConnection("HOSTNAME")<br/><br/>headers = {<br/> 'content-type': "application/json",<br/> 'cache-control': "no-cache",<br/> 'cookie': "JSESSIONID=xxxxxxx"<br/> }<br/><br/>conn.request("GET", "/api/v1/users?dept=guests", headers=headers)<br/><br/>res = conn.getresponse()<br/>data = res.read()<br/><br/>print(data.decode("utf-8"))</pre><br/><b>Sample Response</b><pre>[<br/> {<br/> "id": 82737,<br/> "name": "guest1234",<br/> "email": "guest89808@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "comments": "guest wi-fi user",<br/> "adminUser": false<br/> },<br/> ...<br/> {<br/> "id": 82738,<br/> "name": "no-pass",<br/> "email": "no-pass@antest.com",<br/> "groups": [<br/> {<br/> "id": 75457,<br/> "name": "guest-wifi"<br/> }<br/> ],<br/> "department": {<br/> "id": 75458,<br/> "name": "guests"<br/> },<br/> "adminUser": false<br/> }<br/>]</pre>",
|
|
1121
|
+
"info": "Gets a list of all users and allows user filtering by name, department, or group. The search parameters, \"dept\" and \"group\", perform a 'starts with' match.",
|
|
858
1122
|
"required": false,
|
|
859
1123
|
"schema": {
|
|
860
1124
|
"title": "pageSize",
|
|
@@ -883,12 +1147,12 @@
|
|
|
883
1147
|
{
|
|
884
1148
|
"name": "postUsers",
|
|
885
1149
|
"summary": "Adds a new user",
|
|
886
|
-
"description": "
|
|
1150
|
+
"description": "Adds a new user. A user can belong to multiple groups, but can only belong to one department.",
|
|
887
1151
|
"input": [
|
|
888
1152
|
{
|
|
889
1153
|
"name": "user",
|
|
890
1154
|
"type": "object",
|
|
891
|
-
"info": "
|
|
1155
|
+
"info": "Adds a new user. A user can belong to multiple groups, but can only belong to one department.",
|
|
892
1156
|
"required": false,
|
|
893
1157
|
"schema": {
|
|
894
1158
|
"title": "user",
|
|
@@ -917,12 +1181,12 @@
|
|
|
917
1181
|
{
|
|
918
1182
|
"name": "postUsersbulkDelete",
|
|
919
1183
|
"summary": "Bulk delete users up to a maximum of 500 users per request",
|
|
920
|
-
"description": "
|
|
1184
|
+
"description": "Bulk delete users up to a maximum of 500 users per request. The response returns the user IDs that were successfully deleted.",
|
|
921
1185
|
"input": [
|
|
922
1186
|
{
|
|
923
1187
|
"name": "userIds",
|
|
924
1188
|
"type": "object",
|
|
925
|
-
"info": "
|
|
1189
|
+
"info": "Bulk delete users up to a maximum of 500 users per request. The response returns the user IDs that were successfully deleted.",
|
|
926
1190
|
"required": false,
|
|
927
1191
|
"schema": {
|
|
928
1192
|
"title": "userIds",
|
|
@@ -951,12 +1215,12 @@
|
|
|
951
1215
|
{
|
|
952
1216
|
"name": "getUsersuserId",
|
|
953
1217
|
"summary": "Gets the user information for the specified ID",
|
|
954
|
-
"description": "
|
|
1218
|
+
"description": "Gets the user information for the specified ID.",
|
|
955
1219
|
"input": [
|
|
956
1220
|
{
|
|
957
1221
|
"name": "userId",
|
|
958
1222
|
"type": "number",
|
|
959
|
-
"info": "
|
|
1223
|
+
"info": "Gets the user information for the specified ID.",
|
|
960
1224
|
"required": true,
|
|
961
1225
|
"schema": {
|
|
962
1226
|
"title": "userId",
|
|
@@ -985,12 +1249,12 @@
|
|
|
985
1249
|
{
|
|
986
1250
|
"name": "putUsersuserId",
|
|
987
1251
|
"summary": "Updates the user information for the specified ID",
|
|
988
|
-
"description": "
|
|
1252
|
+
"description": "Updates the user information for the specified ID. However, the \"email\" attribute is read-only.",
|
|
989
1253
|
"input": [
|
|
990
1254
|
{
|
|
991
1255
|
"name": "userId",
|
|
992
1256
|
"type": "number",
|
|
993
|
-
"info": "
|
|
1257
|
+
"info": "Updates the user information for the specified ID. However, the \"email\" attribute is read-only.",
|
|
994
1258
|
"required": true,
|
|
995
1259
|
"schema": {
|
|
996
1260
|
"title": "userId",
|
|
@@ -1000,7 +1264,7 @@
|
|
|
1000
1264
|
{
|
|
1001
1265
|
"name": "user",
|
|
1002
1266
|
"type": "object",
|
|
1003
|
-
"info": "
|
|
1267
|
+
"info": "Updates the user information for the specified ID. However, the \"email\" attribute is read-only.",
|
|
1004
1268
|
"required": false,
|
|
1005
1269
|
"schema": {
|
|
1006
1270
|
"title": "user",
|
|
@@ -1029,12 +1293,12 @@
|
|
|
1029
1293
|
{
|
|
1030
1294
|
"name": "deleteUsersuserId",
|
|
1031
1295
|
"summary": "Deletes the user for the specified ID",
|
|
1032
|
-
"description": "
|
|
1296
|
+
"description": "Deletes the user for the specified ID.",
|
|
1033
1297
|
"input": [
|
|
1034
1298
|
{
|
|
1035
1299
|
"name": "userId",
|
|
1036
1300
|
"type": "number",
|
|
1037
|
-
"info": "
|
|
1301
|
+
"info": "Deletes the user for the specified ID.",
|
|
1038
1302
|
"required": true,
|
|
1039
1303
|
"schema": {
|
|
1040
1304
|
"title": "userId",
|
|
@@ -1063,7 +1327,7 @@
|
|
|
1063
1327
|
{
|
|
1064
1328
|
"name": "getSecurity",
|
|
1065
1329
|
"summary": "Gets a list of white-listed URLs",
|
|
1066
|
-
"description": "
|
|
1330
|
+
"description": "Gets a list of white-listed URLs",
|
|
1067
1331
|
"input": [],
|
|
1068
1332
|
"output": {
|
|
1069
1333
|
"name": "result",
|
|
@@ -1086,12 +1350,12 @@
|
|
|
1086
1350
|
{
|
|
1087
1351
|
"name": "putSecurity",
|
|
1088
1352
|
"summary": "Updates the list of white-listed URLs",
|
|
1089
|
-
"description": "
|
|
1353
|
+
"description": "Updates the list of white-listed URLs. This will overwrite a previously-generated white list. If you need to completely erase the white list, submit an empty list.",
|
|
1090
1354
|
"input": [
|
|
1091
1355
|
{
|
|
1092
1356
|
"name": "policy",
|
|
1093
1357
|
"type": "object",
|
|
1094
|
-
"info": "
|
|
1358
|
+
"info": "Updates the list of white-listed URLs. This will overwrite a previously-generated white list. If you need to completely erase the white list, submit an empty list.",
|
|
1095
1359
|
"required": false,
|
|
1096
1360
|
"schema": {
|
|
1097
1361
|
"title": "policy",
|
|
@@ -1120,7 +1384,7 @@
|
|
|
1120
1384
|
{
|
|
1121
1385
|
"name": "getSecurityadvanced",
|
|
1122
1386
|
"summary": "Gets a list of black-listed URLs",
|
|
1123
|
-
"description": "
|
|
1387
|
+
"description": "Gets a list of black-listed URLs.",
|
|
1124
1388
|
"input": [],
|
|
1125
1389
|
"output": {
|
|
1126
1390
|
"name": "result",
|
|
@@ -1143,12 +1407,12 @@
|
|
|
1143
1407
|
{
|
|
1144
1408
|
"name": "putSecurityadvanced",
|
|
1145
1409
|
"summary": "Updates the list of black-listed URLs",
|
|
1146
|
-
"description": "
|
|
1410
|
+
"description": "Updates the list of black-listed URLs. This will overwrite a previously-generated black list. If you need to completely erase the black list, submit an empty list.",
|
|
1147
1411
|
"input": [
|
|
1148
1412
|
{
|
|
1149
1413
|
"name": "advSettings",
|
|
1150
1414
|
"type": "object",
|
|
1151
|
-
"info": "
|
|
1415
|
+
"info": "Updates the list of black-listed URLs. This will overwrite a previously-generated black list. If you need to completely erase the black list, submit an empty list.",
|
|
1152
1416
|
"required": false,
|
|
1153
1417
|
"schema": {
|
|
1154
1418
|
"title": "advSettings",
|
|
@@ -1177,12 +1441,12 @@
|
|
|
1177
1441
|
{
|
|
1178
1442
|
"name": "postSecurityadvancedblacklistUrls",
|
|
1179
1443
|
"summary": "Adds a URL to or removes a URL from the black list",
|
|
1180
|
-
"description": "
|
|
1444
|
+
"description": "Adds a URL to or removes a URL from the black list. To add a URL to the black list, set the action parameter to ADD_TO_LIST. To remove a URL, set action to REMOVE_FROM_LIST.",
|
|
1181
1445
|
"input": [
|
|
1182
1446
|
{
|
|
1183
1447
|
"name": "action",
|
|
1184
1448
|
"type": "string",
|
|
1185
|
-
"info": "
|
|
1449
|
+
"info": "Adds a URL to or removes a URL from the black list. To add a URL to the black list, set the action parameter to ADD_TO_LIST. To remove a URL, set action to REMOVE_FROM_LIST.",
|
|
1186
1450
|
"required": true,
|
|
1187
1451
|
"schema": {
|
|
1188
1452
|
"title": "action",
|
|
@@ -1211,7 +1475,7 @@
|
|
|
1211
1475
|
{
|
|
1212
1476
|
"name": "deleteSslSettingscertchain",
|
|
1213
1477
|
"summary": "Deletes the intermediate certificate chain",
|
|
1214
|
-
"description": "
|
|
1478
|
+
"description": "Deletes the intermediate certificate chain.",
|
|
1215
1479
|
"input": [],
|
|
1216
1480
|
"output": {
|
|
1217
1481
|
"name": "result",
|
|
@@ -1234,7 +1498,7 @@
|
|
|
1234
1498
|
{
|
|
1235
1499
|
"name": "getSslSettingsdownloadcsr",
|
|
1236
1500
|
"summary": "Downloads a Certificate Signing Request (CSR)",
|
|
1237
|
-
"description": "
|
|
1501
|
+
"description": "Downloads a Certificate Signing Request (CSR). Before you can download the CSR, you must send a POST request to /sslSettings/generatecsr to create it.",
|
|
1238
1502
|
"input": [],
|
|
1239
1503
|
"output": {
|
|
1240
1504
|
"name": "result",
|
|
@@ -1257,12 +1521,12 @@
|
|
|
1257
1521
|
{
|
|
1258
1522
|
"name": "postSslSettingsgeneratecsr",
|
|
1259
1523
|
"summary": "Generates a Certificate Signing Request (CSR)",
|
|
1260
|
-
"description": "
|
|
1524
|
+
"description": "Generates a Certificate Signing Request (CSR). If your organization uses a custom intermediate root certificate for SSL inspection, send a GET request to /sslSettings/generatecsr to generate a new CSR, then send the generated CSR to your Certificate Authority (CA) to sign as a subordinate CA certificate. The subordinate CA can be an intermediate or an issuing CA.",
|
|
1261
1525
|
"input": [
|
|
1262
1526
|
{
|
|
1263
1527
|
"name": "cert",
|
|
1264
1528
|
"type": "object",
|
|
1265
|
-
"info": "
|
|
1529
|
+
"info": "Generates a Certificate Signing Request (CSR). If your organization uses a custom intermediate root certificate for SSL inspection, send a GET request to /sslSettings/generatecsr to generate a new CSR, then send the generated CSR to your Certificate Authority (CA) to sign as a subordinate CA certificate. The subordinate CA can be an intermediate or an issuing CA.",
|
|
1266
1530
|
"required": true,
|
|
1267
1531
|
"schema": {
|
|
1268
1532
|
"title": "cert",
|
|
@@ -1291,7 +1555,7 @@
|
|
|
1291
1555
|
{
|
|
1292
1556
|
"name": "getSslSettingsshowcert",
|
|
1293
1557
|
"summary": "Shows information about the signed intermediate root certificate",
|
|
1294
|
-
"description": "
|
|
1558
|
+
"description": "Shows information about the signed intermediate root certificate.",
|
|
1295
1559
|
"input": [],
|
|
1296
1560
|
"output": {
|
|
1297
1561
|
"name": "result",
|
|
@@ -1314,12 +1578,12 @@
|
|
|
1314
1578
|
{
|
|
1315
1579
|
"name": "postSslSettingsuploadcerttext",
|
|
1316
1580
|
"summary": "Uploads a signed intermediate root certificate for clients that use iframe-based uploads whose content type is text/plain",
|
|
1317
|
-
"description": "
|
|
1581
|
+
"description": "Uploads a signed intermediate root certificate for clients that use iframe-based uploads whose content type is text/plain. To enable users' browsers to trust this intermediate root certificate and any certificate signed by it, install this root certificate on users' browsers. If you also want to upload a certificate chain, upload the signed intermediate root certificate before uploading the certificate chain.",
|
|
1318
1582
|
"input": [
|
|
1319
1583
|
{
|
|
1320
1584
|
"name": "fileInputStream",
|
|
1321
1585
|
"type": "object",
|
|
1322
|
-
"info": "
|
|
1586
|
+
"info": "Uploads a signed intermediate root certificate for clients that use iframe-based uploads whose content type is text/plain. To enable users' browsers to trust this intermediate root certificate and any certificate signed by it, install this root certificate on users' browsers. If you also want to upload a certificate chain, upload the signed intermediate root certificate before uploading the certificate chain.",
|
|
1323
1587
|
"required": false,
|
|
1324
1588
|
"schema": {
|
|
1325
1589
|
"title": "fileInputStream",
|
|
@@ -1348,12 +1612,12 @@
|
|
|
1348
1612
|
{
|
|
1349
1613
|
"name": "postSslSettingsuploadcertchaintext",
|
|
1350
1614
|
"summary": "Uploads the Intermediate Certificate Chain (PEM) for clients that use iframe-based uploads whose content type is text/plain",
|
|
1351
|
-
"description": "
|
|
1615
|
+
"description": "Uploads the Intermediate Certificate Chain (PEM) for clients that use iframe-based uploads whose content type is text/plain. Upload the certificate chain that includes any other intermediate certificates that complete the chain to the intermediate root certificate you want to upload.",
|
|
1352
1616
|
"input": [
|
|
1353
1617
|
{
|
|
1354
1618
|
"name": "fileInputStream",
|
|
1355
1619
|
"type": "object",
|
|
1356
|
-
"info": "
|
|
1620
|
+
"info": "Uploads the Intermediate Certificate Chain (PEM) for clients that use iframe-based uploads whose content type is text/plain. Upload the certificate chain that includes any other intermediate certificates that complete the chain to the intermediate root certificate you want to upload.",
|
|
1357
1621
|
"required": false,
|
|
1358
1622
|
"schema": {
|
|
1359
1623
|
"title": "fileInputStream",
|
|
@@ -1382,12 +1646,12 @@
|
|
|
1382
1646
|
{
|
|
1383
1647
|
"name": "getUrlCategories",
|
|
1384
1648
|
"summary": "Gets information about all or custom URL categories",
|
|
1385
|
-
"description": "
|
|
1649
|
+
"description": "Gets information about all or custom URL categories.",
|
|
1386
1650
|
"input": [
|
|
1387
1651
|
{
|
|
1388
1652
|
"name": "customOnly",
|
|
1389
1653
|
"type": "boolean",
|
|
1390
|
-
"info": "
|
|
1654
|
+
"info": "Gets information about all or custom URL categories.",
|
|
1391
1655
|
"required": false,
|
|
1392
1656
|
"schema": {
|
|
1393
1657
|
"title": "customOnly",
|
|
@@ -1416,12 +1680,12 @@
|
|
|
1416
1680
|
{
|
|
1417
1681
|
"name": "postUrlCategories",
|
|
1418
1682
|
"summary": "Adds a new custom URL category",
|
|
1419
|
-
"description": "
|
|
1683
|
+
"description": "Adds a new custom URL category.",
|
|
1420
1684
|
"input": [
|
|
1421
1685
|
{
|
|
1422
1686
|
"name": "customCategory",
|
|
1423
1687
|
"type": "object",
|
|
1424
|
-
"info": "
|
|
1688
|
+
"info": "Adds a new custom URL category.",
|
|
1425
1689
|
"required": false,
|
|
1426
1690
|
"schema": {
|
|
1427
1691
|
"title": "customCategory",
|
|
@@ -1450,7 +1714,7 @@
|
|
|
1450
1714
|
{
|
|
1451
1715
|
"name": "getUrlCategorieslite",
|
|
1452
1716
|
"summary": "Gets a lightweight key-value list of all or custom URL categories",
|
|
1453
|
-
"description": "
|
|
1717
|
+
"description": "Gets a lightweight key-value list of all or custom URL categories.",
|
|
1454
1718
|
"input": [],
|
|
1455
1719
|
"output": {
|
|
1456
1720
|
"name": "result",
|
|
@@ -1473,7 +1737,7 @@
|
|
|
1473
1737
|
{
|
|
1474
1738
|
"name": "getUrlCategoriesurlQuota",
|
|
1475
1739
|
"summary": "Gets the URL quota information for your organization",
|
|
1476
|
-
"description": "
|
|
1740
|
+
"description": "Gets information on the number of unique URLs that are currently provisioned for your organization as well as how many URLs you can add before reaching that number.",
|
|
1477
1741
|
"input": [],
|
|
1478
1742
|
"output": {
|
|
1479
1743
|
"name": "result",
|
|
@@ -1496,12 +1760,12 @@
|
|
|
1496
1760
|
{
|
|
1497
1761
|
"name": "getUrlCategoriescategoryId",
|
|
1498
1762
|
"summary": "Gets the URL category information for the specified ID",
|
|
1499
|
-
"description": "
|
|
1763
|
+
"description": "Gets the URL category information for the specified ID.",
|
|
1500
1764
|
"input": [
|
|
1501
1765
|
{
|
|
1502
1766
|
"name": "categoryId",
|
|
1503
1767
|
"type": "string",
|
|
1504
|
-
"info": "
|
|
1768
|
+
"info": "Gets the URL category information for the specified ID.",
|
|
1505
1769
|
"required": true,
|
|
1506
1770
|
"schema": {
|
|
1507
1771
|
"title": "categoryId",
|
|
@@ -1530,12 +1794,12 @@
|
|
|
1530
1794
|
{
|
|
1531
1795
|
"name": "putUrlCategoriescategoryId",
|
|
1532
1796
|
"summary": "Updates the URL category for the specified ID",
|
|
1533
|
-
"description": "
|
|
1797
|
+
"description": "Updates the URL category for the specified ID.",
|
|
1534
1798
|
"input": [
|
|
1535
1799
|
{
|
|
1536
1800
|
"name": "categoryId",
|
|
1537
1801
|
"type": "string",
|
|
1538
|
-
"info": "
|
|
1802
|
+
"info": "Updates the URL category for the specified ID.",
|
|
1539
1803
|
"required": true,
|
|
1540
1804
|
"schema": {
|
|
1541
1805
|
"title": "categoryId",
|
|
@@ -1545,7 +1809,7 @@
|
|
|
1545
1809
|
{
|
|
1546
1810
|
"name": "action",
|
|
1547
1811
|
"type": "string",
|
|
1548
|
-
"info": "
|
|
1812
|
+
"info": "Updates the URL category for the specified ID.",
|
|
1549
1813
|
"required": false,
|
|
1550
1814
|
"schema": {
|
|
1551
1815
|
"title": "action",
|
|
@@ -1555,7 +1819,7 @@
|
|
|
1555
1819
|
{
|
|
1556
1820
|
"name": "customCategory",
|
|
1557
1821
|
"type": "object",
|
|
1558
|
-
"info": "
|
|
1822
|
+
"info": "Updates the URL category for the specified ID.",
|
|
1559
1823
|
"required": false,
|
|
1560
1824
|
"schema": {
|
|
1561
1825
|
"title": "customCategory",
|
|
@@ -1584,12 +1848,12 @@
|
|
|
1584
1848
|
{
|
|
1585
1849
|
"name": "deleteUrlCategoriescategoryId",
|
|
1586
1850
|
"summary": "Deletes the custom URL category for the specified ID",
|
|
1587
|
-
"description": "
|
|
1851
|
+
"description": "Deletes the custom URL category for the specified ID. You cannot delete a custom category while it is being used by a URL policy or NSS feed. Also, predefined categories cannot be deleted.",
|
|
1588
1852
|
"input": [
|
|
1589
1853
|
{
|
|
1590
1854
|
"name": "categoryId",
|
|
1591
1855
|
"type": "string",
|
|
1592
|
-
"info": "
|
|
1856
|
+
"info": "Deletes the custom URL category for the specified ID. You cannot delete a custom category while it is being used by a URL policy or NSS feed. Also, predefined categories cannot be deleted.",
|
|
1593
1857
|
"required": true,
|
|
1594
1858
|
"schema": {
|
|
1595
1859
|
"title": "categoryId",
|
|
@@ -1618,12 +1882,12 @@
|
|
|
1618
1882
|
{
|
|
1619
1883
|
"name": "postUrlLookup",
|
|
1620
1884
|
"summary": "Look up the categorization of the given set of URLs, e.g., ['abc.com', 'xyz.com']",
|
|
1621
|
-
"description": "
|
|
1885
|
+
"description": "Look up the categorization of the given set of URLs, e.g., ['abc.com', 'xyz.com']. Up to 100 URLs can be looked up per request, and a URL cannot exceed 1024 characters.",
|
|
1622
1886
|
"input": [
|
|
1623
1887
|
{
|
|
1624
1888
|
"name": "urls",
|
|
1625
1889
|
"type": "array",
|
|
1626
|
-
"info": "
|
|
1890
|
+
"info": "Look up the categorization of the given set of URLs, e.g., ['abc.com', 'xyz.com']. Up to 100 URLs can be looked up per request, and a URL cannot exceed 1024 characters.",
|
|
1627
1891
|
"required": false,
|
|
1628
1892
|
"schema": {
|
|
1629
1893
|
"title": "urls",
|
|
@@ -1652,12 +1916,12 @@
|
|
|
1652
1916
|
{
|
|
1653
1917
|
"name": "getVpnCredentials",
|
|
1654
1918
|
"summary": "Gets VPN credentials that can be associated to locations",
|
|
1655
|
-
"description": "
|
|
1919
|
+
"description": "Gets VPN credentials that can be associated to locations.",
|
|
1656
1920
|
"input": [
|
|
1657
1921
|
{
|
|
1658
1922
|
"name": "search",
|
|
1659
1923
|
"type": "string",
|
|
1660
|
-
"info": "
|
|
1924
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1661
1925
|
"required": false,
|
|
1662
1926
|
"schema": {
|
|
1663
1927
|
"title": "search",
|
|
@@ -1667,7 +1931,7 @@
|
|
|
1667
1931
|
{
|
|
1668
1932
|
"name": "type",
|
|
1669
1933
|
"type": "string",
|
|
1670
|
-
"info": "
|
|
1934
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1671
1935
|
"required": false,
|
|
1672
1936
|
"schema": {
|
|
1673
1937
|
"title": "type",
|
|
@@ -1677,7 +1941,7 @@
|
|
|
1677
1941
|
{
|
|
1678
1942
|
"name": "includeOnlyWithoutLocation",
|
|
1679
1943
|
"type": "boolean",
|
|
1680
|
-
"info": "
|
|
1944
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1681
1945
|
"required": false,
|
|
1682
1946
|
"schema": {
|
|
1683
1947
|
"title": "includeOnlyWithoutLocation",
|
|
@@ -1687,7 +1951,7 @@
|
|
|
1687
1951
|
{
|
|
1688
1952
|
"name": "locationId",
|
|
1689
1953
|
"type": "number",
|
|
1690
|
-
"info": "
|
|
1954
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1691
1955
|
"required": false,
|
|
1692
1956
|
"schema": {
|
|
1693
1957
|
"title": "locationId",
|
|
@@ -1697,7 +1961,7 @@
|
|
|
1697
1961
|
{
|
|
1698
1962
|
"name": "managedBy",
|
|
1699
1963
|
"type": "number",
|
|
1700
|
-
"info": "
|
|
1964
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1701
1965
|
"required": false,
|
|
1702
1966
|
"schema": {
|
|
1703
1967
|
"title": "managedBy",
|
|
@@ -1707,7 +1971,7 @@
|
|
|
1707
1971
|
{
|
|
1708
1972
|
"name": "page",
|
|
1709
1973
|
"type": "number",
|
|
1710
|
-
"info": "
|
|
1974
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1711
1975
|
"required": false,
|
|
1712
1976
|
"schema": {
|
|
1713
1977
|
"title": "page",
|
|
@@ -1717,7 +1981,7 @@
|
|
|
1717
1981
|
{
|
|
1718
1982
|
"name": "pageSize",
|
|
1719
1983
|
"type": "number",
|
|
1720
|
-
"info": "
|
|
1984
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1721
1985
|
"required": false,
|
|
1722
1986
|
"schema": {
|
|
1723
1987
|
"title": "pageSize",
|
|
@@ -1746,12 +2010,12 @@
|
|
|
1746
2010
|
{
|
|
1747
2011
|
"name": "postVpnCredentials",
|
|
1748
2012
|
"summary": "Adds VPN credentials that can be associated to locations",
|
|
1749
|
-
"description": "
|
|
2013
|
+
"description": "Adds VPN credentials that can be associated to locations. When invoked with a partner API key, it automatically sets the managedBy attribute to the partner associated with the key.",
|
|
1750
2014
|
"input": [
|
|
1751
2015
|
{
|
|
1752
2016
|
"name": "vpnCred",
|
|
1753
2017
|
"type": "object",
|
|
1754
|
-
"info": "
|
|
2018
|
+
"info": "Adds VPN credentials that can be associated to locations. When invoked with a partner API key, it automatically sets the managedBy attribute to the partner associated with the key.",
|
|
1755
2019
|
"required": false,
|
|
1756
2020
|
"schema": {
|
|
1757
2021
|
"title": "vpnCred",
|
|
@@ -1780,12 +2044,12 @@
|
|
|
1780
2044
|
{
|
|
1781
2045
|
"name": "postVpnCredentialsbulkDelete",
|
|
1782
2046
|
"summary": "Bulk delete VPN credentials up to a maximum of 100 credentials per request",
|
|
1783
|
-
"description": "
|
|
2047
|
+
"description": "Bulk delete VPN credentials up to a maximum of 100 credentials per request. The response returns the VPN IDs that were successfully deleted.",
|
|
1784
2048
|
"input": [
|
|
1785
2049
|
{
|
|
1786
2050
|
"name": "ids",
|
|
1787
2051
|
"type": "object",
|
|
1788
|
-
"info": "
|
|
2052
|
+
"info": "Bulk delete VPN credentials up to a maximum of 100 credentials per request. The response returns the VPN IDs that were successfully deleted.",
|
|
1789
2053
|
"required": false,
|
|
1790
2054
|
"schema": {
|
|
1791
2055
|
"title": "ids",
|
|
@@ -1814,12 +2078,12 @@
|
|
|
1814
2078
|
{
|
|
1815
2079
|
"name": "getVpnCredentialsvpnId",
|
|
1816
2080
|
"summary": "Gets the VPN credentials for the specified ID",
|
|
1817
|
-
"description": "
|
|
2081
|
+
"description": "Gets the VPN credentials for the specified ID.",
|
|
1818
2082
|
"input": [
|
|
1819
2083
|
{
|
|
1820
2084
|
"name": "vpnId",
|
|
1821
2085
|
"type": "number",
|
|
1822
|
-
"info": "
|
|
2086
|
+
"info": "Gets the VPN credentials for the specified ID.",
|
|
1823
2087
|
"required": true,
|
|
1824
2088
|
"schema": {
|
|
1825
2089
|
"title": "vpnId",
|
|
@@ -1848,12 +2112,12 @@
|
|
|
1848
2112
|
{
|
|
1849
2113
|
"name": "putVpnCredentialsvpnId",
|
|
1850
2114
|
"summary": "Updates the VPN credentials for the specified ID",
|
|
1851
|
-
"description": "
|
|
2115
|
+
"description": "Updates the VPN credentials for the specified ID.",
|
|
1852
2116
|
"input": [
|
|
1853
2117
|
{
|
|
1854
2118
|
"name": "vpnId",
|
|
1855
2119
|
"type": "number",
|
|
1856
|
-
"info": "
|
|
2120
|
+
"info": "Updates the VPN credentials for the specified ID.",
|
|
1857
2121
|
"required": true,
|
|
1858
2122
|
"schema": {
|
|
1859
2123
|
"title": "vpnId",
|
|
@@ -1863,7 +2127,7 @@
|
|
|
1863
2127
|
{
|
|
1864
2128
|
"name": "vpnCred",
|
|
1865
2129
|
"type": "object",
|
|
1866
|
-
"info": "
|
|
2130
|
+
"info": "Updates the VPN credentials for the specified ID.",
|
|
1867
2131
|
"required": false,
|
|
1868
2132
|
"schema": {
|
|
1869
2133
|
"title": "vpnCred",
|
|
@@ -1892,12 +2156,12 @@
|
|
|
1892
2156
|
{
|
|
1893
2157
|
"name": "deleteVpnCredentialsvpnId",
|
|
1894
2158
|
"summary": "Deletes the VPN credentials for the specified ID",
|
|
1895
|
-
"description": "
|
|
2159
|
+
"description": "Deletes the VPN credentials for the specified ID.",
|
|
1896
2160
|
"input": [
|
|
1897
2161
|
{
|
|
1898
2162
|
"name": "vpnId",
|
|
1899
2163
|
"type": "number",
|
|
1900
|
-
"info": "
|
|
2164
|
+
"info": "Deletes the VPN credentials for the specified ID.",
|
|
1901
2165
|
"required": true,
|
|
1902
2166
|
"schema": {
|
|
1903
2167
|
"title": "vpnId",
|
|
@@ -1926,12 +2190,12 @@
|
|
|
1926
2190
|
{
|
|
1927
2191
|
"name": "getLocations",
|
|
1928
2192
|
"summary": "Gets information on locations",
|
|
1929
|
-
"description": "
|
|
2193
|
+
"description": "Gets locations only, not sub-locations. When a location matches the given search parameter criteria, only its parent location is included in the result set, not its sub-locations.",
|
|
1930
2194
|
"input": [
|
|
1931
2195
|
{
|
|
1932
2196
|
"name": "search",
|
|
1933
2197
|
"type": "string",
|
|
1934
|
-
"info": "
|
|
2198
|
+
"info": "Gets locations only, not sub-locations. When a location matches the given search parameter criteria, only its parent location is included in the result set, not its sub-locations.",
|
|
1935
2199
|
"required": false,
|
|
1936
2200
|
"schema": {
|
|
1937
2201
|
"title": "search",
|
|
@@ -1941,7 +2205,7 @@
|
|
|
1941
2205
|
{
|
|
1942
2206
|
"name": "sslScanEnabled",
|
|
1943
2207
|
"type": "boolean",
|
|
1944
|
-
"info": "
|
|
2208
|
+
"info": "Gets locations only, not sub-locations. When a location matches the given search parameter criteria, only its parent location is included in the result set, not its sub-locations.",
|
|
1945
2209
|
"required": false,
|
|
1946
2210
|
"schema": {
|
|
1947
2211
|
"title": "sslScanEnabled",
|
|
@@ -1951,7 +2215,7 @@
|
|
|
1951
2215
|
{
|
|
1952
2216
|
"name": "xffEnabled",
|
|
1953
2217
|
"type": "boolean",
|
|
1954
|
-
"info": "
|
|
2218
|
+
"info": "Gets locations only, not sub-locations. When a location matches the given search parameter criteria, only its parent location is included in the result set, not its sub-locations.",
|
|
1955
2219
|
"required": false,
|
|
1956
2220
|
"schema": {
|
|
1957
2221
|
"title": "xffEnabled",
|
|
@@ -1961,7 +2225,7 @@
|
|
|
1961
2225
|
{
|
|
1962
2226
|
"name": "authRequired",
|
|
1963
2227
|
"type": "boolean",
|
|
1964
|
-
"info": "
|
|
2228
|
+
"info": "Gets locations only, not sub-locations. When a location matches the given search parameter criteria, only its parent location is included in the result set, not its sub-locations.",
|
|
1965
2229
|
"required": false,
|
|
1966
2230
|
"schema": {
|
|
1967
2231
|
"title": "authRequired",
|
|
@@ -1971,7 +2235,7 @@
|
|
|
1971
2235
|
{
|
|
1972
2236
|
"name": "bwEnforced",
|
|
1973
2237
|
"type": "boolean",
|
|
1974
|
-
"info": "
|
|
2238
|
+
"info": "Gets locations only, not sub-locations. When a location matches the given search parameter criteria, only its parent location is included in the result set, not its sub-locations.",
|
|
1975
2239
|
"required": false,
|
|
1976
2240
|
"schema": {
|
|
1977
2241
|
"title": "bwEnforced",
|
|
@@ -1981,7 +2245,7 @@
|
|
|
1981
2245
|
{
|
|
1982
2246
|
"name": "page",
|
|
1983
2247
|
"type": "number",
|
|
1984
|
-
"info": "
|
|
2248
|
+
"info": "Gets locations only, not sub-locations. When a location matches the given search parameter criteria, only its parent location is included in the result set, not its sub-locations.",
|
|
1985
2249
|
"required": false,
|
|
1986
2250
|
"schema": {
|
|
1987
2251
|
"title": "page",
|
|
@@ -1991,7 +2255,7 @@
|
|
|
1991
2255
|
{
|
|
1992
2256
|
"name": "pageSize",
|
|
1993
2257
|
"type": "number",
|
|
1994
|
-
"info": "
|
|
2258
|
+
"info": "Gets locations only, not sub-locations. When a location matches the given search parameter criteria, only its parent location is included in the result set, not its sub-locations.",
|
|
1995
2259
|
"required": false,
|
|
1996
2260
|
"schema": {
|
|
1997
2261
|
"title": "pageSize",
|
|
@@ -2020,12 +2284,12 @@
|
|
|
2020
2284
|
{
|
|
2021
2285
|
"name": "postLocations",
|
|
2022
2286
|
"summary": "Adds a new location",
|
|
2023
|
-
"description": "
|
|
2287
|
+
"description": "Adds a new location. When invoked with a partner API key, it automatically sets the managedBy attribute to the partner associated with the key.",
|
|
2024
2288
|
"input": [
|
|
2025
2289
|
{
|
|
2026
2290
|
"name": "location",
|
|
2027
2291
|
"type": "object",
|
|
2028
|
-
"info": "
|
|
2292
|
+
"info": "Adds a new location. When invoked with a partner API key, it automatically sets the managedBy attribute to the partner associated with the key.",
|
|
2029
2293
|
"required": false,
|
|
2030
2294
|
"schema": {
|
|
2031
2295
|
"title": "location",
|
|
@@ -2054,12 +2318,12 @@
|
|
|
2054
2318
|
{
|
|
2055
2319
|
"name": "postLocationsbulkDelete",
|
|
2056
2320
|
"summary": "Bulk delete locations up to a maximum of 100 locations per request",
|
|
2057
|
-
"description": "
|
|
2321
|
+
"description": "Bulk delete locations up to a maximum of 100 users per request. The response returns the location IDs that were successfully deleted.",
|
|
2058
2322
|
"input": [
|
|
2059
2323
|
{
|
|
2060
2324
|
"name": "LocationIds",
|
|
2061
2325
|
"type": "object",
|
|
2062
|
-
"info": "
|
|
2326
|
+
"info": "Bulk delete locations up to a maximum of 100 users per request. The response returns the location IDs that were successfully deleted.",
|
|
2063
2327
|
"required": false,
|
|
2064
2328
|
"schema": {
|
|
2065
2329
|
"title": "LocationIds",
|
|
@@ -2088,12 +2352,12 @@
|
|
|
2088
2352
|
{
|
|
2089
2353
|
"name": "getLocationslite",
|
|
2090
2354
|
"summary": "Gets a lightweight list of locations",
|
|
2091
|
-
"description": "
|
|
2355
|
+
"description": "Gets a lightweight list of locations.",
|
|
2092
2356
|
"input": [
|
|
2093
2357
|
{
|
|
2094
2358
|
"name": "sslScanEnabled",
|
|
2095
2359
|
"type": "boolean",
|
|
2096
|
-
"info": "
|
|
2360
|
+
"info": "Gets a lightweight list of locations.",
|
|
2097
2361
|
"required": false,
|
|
2098
2362
|
"schema": {
|
|
2099
2363
|
"title": "sslScanEnabled",
|
|
@@ -2103,7 +2367,7 @@
|
|
|
2103
2367
|
{
|
|
2104
2368
|
"name": "search",
|
|
2105
2369
|
"type": "string",
|
|
2106
|
-
"info": "
|
|
2370
|
+
"info": "Gets a lightweight list of locations.",
|
|
2107
2371
|
"required": false,
|
|
2108
2372
|
"schema": {
|
|
2109
2373
|
"title": "search",
|
|
@@ -2113,7 +2377,7 @@
|
|
|
2113
2377
|
{
|
|
2114
2378
|
"name": "page",
|
|
2115
2379
|
"type": "number",
|
|
2116
|
-
"info": "
|
|
2380
|
+
"info": "Gets a lightweight list of locations.",
|
|
2117
2381
|
"required": false,
|
|
2118
2382
|
"schema": {
|
|
2119
2383
|
"title": "page",
|
|
@@ -2123,7 +2387,7 @@
|
|
|
2123
2387
|
{
|
|
2124
2388
|
"name": "pageSize",
|
|
2125
2389
|
"type": "number",
|
|
2126
|
-
"info": "
|
|
2390
|
+
"info": "Gets a lightweight list of locations.",
|
|
2127
2391
|
"required": false,
|
|
2128
2392
|
"schema": {
|
|
2129
2393
|
"title": "pageSize",
|
|
@@ -2152,12 +2416,12 @@
|
|
|
2152
2416
|
{
|
|
2153
2417
|
"name": "getLocationslocationId",
|
|
2154
2418
|
"summary": "Gets the location information for the specified ID",
|
|
2155
|
-
"description": "
|
|
2419
|
+
"description": "Gets the location information for the specified ID.",
|
|
2156
2420
|
"input": [
|
|
2157
2421
|
{
|
|
2158
2422
|
"name": "locationId",
|
|
2159
2423
|
"type": "number",
|
|
2160
|
-
"info": "
|
|
2424
|
+
"info": "Gets the location information for the specified ID.",
|
|
2161
2425
|
"required": true,
|
|
2162
2426
|
"schema": {
|
|
2163
2427
|
"title": "locationId",
|
|
@@ -2186,12 +2450,12 @@
|
|
|
2186
2450
|
{
|
|
2187
2451
|
"name": "putLocationslocationId",
|
|
2188
2452
|
"summary": "Updates the location information for the specified ID",
|
|
2189
|
-
"description": "
|
|
2453
|
+
"description": "Updates the location information for the specified ID.",
|
|
2190
2454
|
"input": [
|
|
2191
2455
|
{
|
|
2192
2456
|
"name": "locationId",
|
|
2193
2457
|
"type": "number",
|
|
2194
|
-
"info": "
|
|
2458
|
+
"info": "Updates the location information for the specified ID.",
|
|
2195
2459
|
"required": true,
|
|
2196
2460
|
"schema": {
|
|
2197
2461
|
"title": "locationId",
|
|
@@ -2201,7 +2465,7 @@
|
|
|
2201
2465
|
{
|
|
2202
2466
|
"name": "location",
|
|
2203
2467
|
"type": "object",
|
|
2204
|
-
"info": "
|
|
2468
|
+
"info": "Updates the location information for the specified ID.",
|
|
2205
2469
|
"required": false,
|
|
2206
2470
|
"schema": {
|
|
2207
2471
|
"title": "location",
|
|
@@ -2230,12 +2494,12 @@
|
|
|
2230
2494
|
{
|
|
2231
2495
|
"name": "deleteLocationslocationId",
|
|
2232
2496
|
"summary": "Deletes the location for the specified ID",
|
|
2233
|
-
"description": "
|
|
2497
|
+
"description": "Deletes the location for the specified ID.",
|
|
2234
2498
|
"input": [
|
|
2235
2499
|
{
|
|
2236
2500
|
"name": "locationId",
|
|
2237
2501
|
"type": "number",
|
|
2238
|
-
"info": "
|
|
2502
|
+
"info": "Deletes the location for the specified ID.",
|
|
2239
2503
|
"required": true,
|
|
2240
2504
|
"schema": {
|
|
2241
2505
|
"title": "locationId",
|
|
@@ -2264,7 +2528,7 @@
|
|
|
2264
2528
|
{
|
|
2265
2529
|
"name": "getSandboxreportquota",
|
|
2266
2530
|
"summary": "Gets the Sandbox Report API quota information for your organization",
|
|
2267
|
-
"description": "
|
|
2531
|
+
"description": "Resource access for retrieving Sandbox Reports is limited to 1000 requests per day. Use GET /sandbox/report/quota to retrieve details regarding your organization's daily Sandbox API resource usage (i.e., used quota, unused quota).",
|
|
2268
2532
|
"input": [],
|
|
2269
2533
|
"output": {
|
|
2270
2534
|
"name": "result",
|
|
@@ -2287,12 +2551,12 @@
|
|
|
2287
2551
|
{
|
|
2288
2552
|
"name": "getSandboxreportmd5Hash",
|
|
2289
2553
|
"summary": "Gets a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox",
|
|
2290
|
-
"description": "
|
|
2554
|
+
"description": "Get a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox.",
|
|
2291
2555
|
"input": [
|
|
2292
2556
|
{
|
|
2293
2557
|
"name": "md5Hash",
|
|
2294
2558
|
"type": "string",
|
|
2295
|
-
"info": "
|
|
2559
|
+
"info": "Get a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox.",
|
|
2296
2560
|
"required": true,
|
|
2297
2561
|
"schema": {
|
|
2298
2562
|
"title": "md5Hash",
|
|
@@ -2302,7 +2566,7 @@
|
|
|
2302
2566
|
{
|
|
2303
2567
|
"name": "details",
|
|
2304
2568
|
"type": "string",
|
|
2305
|
-
"info": "
|
|
2569
|
+
"info": "Get a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox.",
|
|
2306
2570
|
"required": false,
|
|
2307
2571
|
"schema": {
|
|
2308
2572
|
"title": "details",
|
|
@@ -2331,7 +2595,7 @@
|
|
|
2331
2595
|
{
|
|
2332
2596
|
"name": "getStatus",
|
|
2333
2597
|
"summary": "Gets the activation status for a configuration change",
|
|
2334
|
-
"description": "
|
|
2598
|
+
"description": "Gets the activation status for a configuration change.",
|
|
2335
2599
|
"input": [],
|
|
2336
2600
|
"output": {
|
|
2337
2601
|
"name": "result",
|
|
@@ -2354,7 +2618,7 @@
|
|
|
2354
2618
|
{
|
|
2355
2619
|
"name": "postStatusactivate",
|
|
2356
2620
|
"summary": "Activates configuration changes",
|
|
2357
|
-
"description": "
|
|
2621
|
+
"description": "Activates configuration changes.",
|
|
2358
2622
|
"input": [],
|
|
2359
2623
|
"output": {
|
|
2360
2624
|
"name": "result",
|