@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/adapter.js
CHANGED
|
@@ -4,7 +4,6 @@
|
|
|
4
4
|
/* eslint object-curly-newline: warn */
|
|
5
5
|
/* eslint no-underscore-dangle: warn */
|
|
6
6
|
/* eslint no-bitwise: warn */
|
|
7
|
-
/* eslint radix: warn */
|
|
8
7
|
|
|
9
8
|
// Set globals
|
|
10
9
|
/* global log */
|
|
@@ -83,10 +82,19 @@ class Zscaler extends AdapterBaseCl {
|
|
|
83
82
|
}
|
|
84
83
|
|
|
85
84
|
/**
|
|
86
|
-
* @
|
|
85
|
+
* @iapGetAdapterWorkflowFunctions
|
|
87
86
|
*/
|
|
88
|
-
|
|
89
|
-
let myIgnore = [
|
|
87
|
+
iapGetAdapterWorkflowFunctions(inIgnore) {
|
|
88
|
+
let myIgnore = [
|
|
89
|
+
'healthCheck',
|
|
90
|
+
'iapGetAdapterWorkflowFunctions',
|
|
91
|
+
'iapHasAdapterEntity',
|
|
92
|
+
'iapVerifyAdapterCapability',
|
|
93
|
+
'iapUpdateAdapterEntityCache',
|
|
94
|
+
'hasEntities',
|
|
95
|
+
'getAuthorization',
|
|
96
|
+
'getObfuscatedKey'
|
|
97
|
+
];
|
|
90
98
|
if (!inIgnore && Array.isArray(inIgnore)) {
|
|
91
99
|
myIgnore = inIgnore;
|
|
92
100
|
} else if (!inIgnore && typeof inIgnore === 'string') {
|
|
@@ -97,15 +105,15 @@ class Zscaler extends AdapterBaseCl {
|
|
|
97
105
|
// you can add specific methods that you do not want to be workflow functions to ignore like below
|
|
98
106
|
// myIgnore.push('myMethodNotInWorkflow');
|
|
99
107
|
|
|
100
|
-
return super.
|
|
108
|
+
return super.iapGetAdapterWorkflowFunctions(myIgnore);
|
|
101
109
|
}
|
|
102
110
|
|
|
103
111
|
/**
|
|
104
|
-
*
|
|
112
|
+
* iapUpdateAdapterConfiguration is used to update any of the adapter configuration files. This
|
|
105
113
|
* allows customers to make changes to adapter configuration without having to be on the
|
|
106
114
|
* file system.
|
|
107
115
|
*
|
|
108
|
-
* @function
|
|
116
|
+
* @function iapUpdateAdapterConfiguration
|
|
109
117
|
* @param {string} configFile - the name of the file being updated (required)
|
|
110
118
|
* @param {Object} changes - an object containing all of the changes = formatted like the configuration file (required)
|
|
111
119
|
* @param {string} entity - the entity to be changed, if an action, schema or mock data file (optional)
|
|
@@ -113,36 +121,42 @@ class Zscaler extends AdapterBaseCl {
|
|
|
113
121
|
* @param {string} action - the action to be changed, if an action, schema or mock data file (optional)
|
|
114
122
|
* @param {Callback} callback - The results of the call
|
|
115
123
|
*/
|
|
116
|
-
|
|
117
|
-
const
|
|
124
|
+
iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
|
|
125
|
+
const meth = 'adapter-iapUpdateAdapterConfiguration';
|
|
126
|
+
const origin = `${this.id}-${meth}`;
|
|
118
127
|
log.trace(origin);
|
|
119
|
-
|
|
128
|
+
|
|
129
|
+
super.iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback);
|
|
120
130
|
}
|
|
121
131
|
|
|
122
132
|
/**
|
|
123
133
|
* See if the API path provided is found in this adapter
|
|
124
134
|
*
|
|
125
|
-
* @function
|
|
135
|
+
* @function iapFindAdapterPath
|
|
126
136
|
* @param {string} apiPath - the api path to check on
|
|
127
137
|
* @param {Callback} callback - The results of the call
|
|
128
138
|
*/
|
|
129
|
-
|
|
130
|
-
const
|
|
139
|
+
iapFindAdapterPath(apiPath, callback) {
|
|
140
|
+
const meth = 'adapter-iapFindAdapterPath';
|
|
141
|
+
const origin = `${this.id}-${meth}`;
|
|
131
142
|
log.trace(origin);
|
|
132
|
-
|
|
143
|
+
|
|
144
|
+
super.iapFindAdapterPath(apiPath, callback);
|
|
133
145
|
}
|
|
134
146
|
|
|
135
147
|
/**
|
|
136
148
|
* @summary Suspends adapter
|
|
137
149
|
*
|
|
138
|
-
* @function
|
|
150
|
+
* @function iapSuspendAdapter
|
|
139
151
|
* @param {Callback} callback - callback function
|
|
140
152
|
*/
|
|
141
|
-
|
|
142
|
-
const
|
|
153
|
+
iapSuspendAdapter(mode, callback) {
|
|
154
|
+
const meth = 'adapter-iapSuspendAdapter';
|
|
155
|
+
const origin = `${this.id}-${meth}`;
|
|
143
156
|
log.trace(origin);
|
|
157
|
+
|
|
144
158
|
try {
|
|
145
|
-
return super.
|
|
159
|
+
return super.iapSuspendAdapter(mode, callback);
|
|
146
160
|
} catch (error) {
|
|
147
161
|
log.error(`${origin}: ${error}`);
|
|
148
162
|
return callback(null, error);
|
|
@@ -152,14 +166,16 @@ class Zscaler extends AdapterBaseCl {
|
|
|
152
166
|
/**
|
|
153
167
|
* @summary Unsuspends adapter
|
|
154
168
|
*
|
|
155
|
-
* @function
|
|
169
|
+
* @function iapUnsuspendAdapter
|
|
156
170
|
* @param {Callback} callback - callback function
|
|
157
171
|
*/
|
|
158
|
-
|
|
159
|
-
const
|
|
172
|
+
iapUnsuspendAdapter(callback) {
|
|
173
|
+
const meth = 'adapter-iapUnsuspendAdapter';
|
|
174
|
+
const origin = `${this.id}-${meth}`;
|
|
160
175
|
log.trace(origin);
|
|
176
|
+
|
|
161
177
|
try {
|
|
162
|
-
return super.
|
|
178
|
+
return super.iapUnsuspendAdapter(callback);
|
|
163
179
|
} catch (error) {
|
|
164
180
|
log.error(`${origin}: ${error}`);
|
|
165
181
|
return callback(null, error);
|
|
@@ -169,29 +185,33 @@ class Zscaler extends AdapterBaseCl {
|
|
|
169
185
|
/**
|
|
170
186
|
* @summary Get the Adaoter Queue
|
|
171
187
|
*
|
|
172
|
-
* @function
|
|
188
|
+
* @function iapGetAdapterQueue
|
|
173
189
|
* @param {Callback} callback - callback function
|
|
174
190
|
*/
|
|
175
|
-
|
|
176
|
-
const
|
|
191
|
+
iapGetAdapterQueue(callback) {
|
|
192
|
+
const meth = 'adapter-iapGetAdapterQueue';
|
|
193
|
+
const origin = `${this.id}-${meth}`;
|
|
177
194
|
log.trace(origin);
|
|
178
|
-
|
|
195
|
+
|
|
196
|
+
return super.iapGetAdapterQueue(callback);
|
|
179
197
|
}
|
|
180
198
|
|
|
181
199
|
/**
|
|
182
200
|
* @summary Runs troubleshoot scripts for adapter
|
|
183
201
|
*
|
|
184
|
-
* @function
|
|
202
|
+
* @function iapTroubleshootAdapter
|
|
185
203
|
* @param {Object} props - the connection, healthcheck and authentication properties
|
|
186
204
|
*
|
|
187
205
|
* @param {boolean} persistFlag - whether the adapter properties should be updated
|
|
188
206
|
* @param {Callback} callback - The results of the call
|
|
189
207
|
*/
|
|
190
|
-
|
|
191
|
-
const
|
|
208
|
+
iapTroubleshootAdapter(props, persistFlag, callback) {
|
|
209
|
+
const meth = 'adapter-iapTroubleshootAdapter';
|
|
210
|
+
const origin = `${this.id}-${meth}`;
|
|
192
211
|
log.trace(origin);
|
|
212
|
+
|
|
193
213
|
try {
|
|
194
|
-
return super.
|
|
214
|
+
return super.iapTroubleshootAdapter(props, persistFlag, this, callback);
|
|
195
215
|
} catch (error) {
|
|
196
216
|
log.error(`${origin}: ${error}`);
|
|
197
217
|
return callback(null, error);
|
|
@@ -201,15 +221,17 @@ class Zscaler extends AdapterBaseCl {
|
|
|
201
221
|
/**
|
|
202
222
|
* @summary runs healthcheck script for adapter
|
|
203
223
|
*
|
|
204
|
-
* @function
|
|
224
|
+
* @function iapRunAdapterHealthcheck
|
|
205
225
|
* @param {Adapter} adapter - adapter instance to troubleshoot
|
|
206
226
|
* @param {Callback} callback - callback function
|
|
207
227
|
*/
|
|
208
|
-
|
|
209
|
-
const
|
|
228
|
+
iapRunAdapterHealthcheck(callback) {
|
|
229
|
+
const meth = 'adapter-iapRunAdapterHealthcheck';
|
|
230
|
+
const origin = `${this.id}-${meth}`;
|
|
210
231
|
log.trace(origin);
|
|
232
|
+
|
|
211
233
|
try {
|
|
212
|
-
return super.
|
|
234
|
+
return super.iapRunAdapterHealthcheck(this, callback);
|
|
213
235
|
} catch (error) {
|
|
214
236
|
log.error(`${origin}: ${error}`);
|
|
215
237
|
return callback(null, error);
|
|
@@ -219,14 +241,16 @@ class Zscaler extends AdapterBaseCl {
|
|
|
219
241
|
/**
|
|
220
242
|
* @summary runs connectivity check script for adapter
|
|
221
243
|
*
|
|
222
|
-
* @function
|
|
244
|
+
* @function iapRunAdapterConnectivity
|
|
223
245
|
* @param {Callback} callback - callback function
|
|
224
246
|
*/
|
|
225
|
-
|
|
226
|
-
const
|
|
247
|
+
iapRunAdapterConnectivity(callback) {
|
|
248
|
+
const meth = 'adapter-iapRunAdapterConnectivity';
|
|
249
|
+
const origin = `${this.id}-${meth}`;
|
|
227
250
|
log.trace(origin);
|
|
251
|
+
|
|
228
252
|
try {
|
|
229
|
-
return super.
|
|
253
|
+
return super.iapRunAdapterConnectivity(callback);
|
|
230
254
|
} catch (error) {
|
|
231
255
|
log.error(`${origin}: ${error}`);
|
|
232
256
|
return callback(null, error);
|
|
@@ -236,44 +260,67 @@ class Zscaler extends AdapterBaseCl {
|
|
|
236
260
|
/**
|
|
237
261
|
* @summary runs basicGet script for adapter
|
|
238
262
|
*
|
|
239
|
-
* @function
|
|
263
|
+
* @function iapRunAdapterBasicGet
|
|
240
264
|
* @param {Callback} callback - callback function
|
|
241
265
|
*/
|
|
242
|
-
|
|
243
|
-
const
|
|
266
|
+
iapRunAdapterBasicGet(callback) {
|
|
267
|
+
const meth = 'adapter-iapRunAdapterBasicGet';
|
|
268
|
+
const origin = `${this.id}-${meth}`;
|
|
244
269
|
log.trace(origin);
|
|
270
|
+
|
|
245
271
|
try {
|
|
246
|
-
return super.
|
|
272
|
+
return super.iapRunAdapterBasicGet(callback);
|
|
247
273
|
} catch (error) {
|
|
248
274
|
log.error(`${origin}: ${error}`);
|
|
249
275
|
return callback(null, error);
|
|
250
276
|
}
|
|
251
277
|
}
|
|
252
278
|
|
|
279
|
+
/**
|
|
280
|
+
* @summary moves entites into Mongo DB
|
|
281
|
+
*
|
|
282
|
+
* @function iapMoveAdapterEntitiesToDB
|
|
283
|
+
* @param {getCallback} callback - a callback function to return the result (Generics)
|
|
284
|
+
* or the error
|
|
285
|
+
*/
|
|
286
|
+
iapMoveAdapterEntitiesToDB(callback) {
|
|
287
|
+
const meth = 'adapter-iapMoveAdapterEntitiesToDB';
|
|
288
|
+
const origin = `${this.id}-${meth}`;
|
|
289
|
+
log.trace(origin);
|
|
290
|
+
|
|
291
|
+
try {
|
|
292
|
+
return super.iapMoveAdapterEntitiesToDB(callback);
|
|
293
|
+
} catch (err) {
|
|
294
|
+
log.error(`${origin}: ${err}`);
|
|
295
|
+
return callback(null, err);
|
|
296
|
+
}
|
|
297
|
+
}
|
|
298
|
+
|
|
299
|
+
/* BROKER CALLS */
|
|
253
300
|
/**
|
|
254
301
|
* @summary Determines if this adapter supports the specific entity
|
|
255
302
|
*
|
|
256
|
-
* @function
|
|
303
|
+
* @function iapHasAdapterEntity
|
|
257
304
|
* @param {String} entityType - the entity type to check for
|
|
258
305
|
* @param {String/Array} entityId - the specific entity we are looking for
|
|
259
306
|
*
|
|
260
307
|
* @param {Callback} callback - An array of whether the adapter can has the
|
|
261
308
|
* desired capability or an error
|
|
262
309
|
*/
|
|
263
|
-
|
|
264
|
-
const origin = `${this.id}-adapter-
|
|
310
|
+
iapHasAdapterEntity(entityType, entityId, callback) {
|
|
311
|
+
const origin = `${this.id}-adapter-iapHasAdapterEntity`;
|
|
265
312
|
log.trace(origin);
|
|
266
313
|
|
|
267
314
|
// Make the call -
|
|
268
|
-
//
|
|
269
|
-
return this.
|
|
315
|
+
// iapVerifyAdapterCapability(entityType, actionType, entityId, callback)
|
|
316
|
+
return this.iapVerifyAdapterCapability(entityType, null, entityId, callback);
|
|
270
317
|
}
|
|
271
318
|
|
|
272
319
|
/**
|
|
273
320
|
* @summary Provides a way for the adapter to tell north bound integrations
|
|
274
321
|
* whether the adapter supports type, action and specific entity
|
|
275
322
|
*
|
|
276
|
-
* @function
|
|
323
|
+
* @function iapVerifyAdapterCapability
|
|
277
324
|
* @param {String} entityType - the entity type to check for
|
|
278
325
|
* @param {String} actionType - the action type to check for
|
|
279
326
|
* @param {String/Array} entityId - the specific entity we are looking for
|
|
@@ -281,15 +328,15 @@ class Zscaler extends AdapterBaseCl {
|
|
|
281
328
|
* @param {Callback} callback - An array of whether the adapter can has the
|
|
282
329
|
* desired capability or an error
|
|
283
330
|
*/
|
|
284
|
-
|
|
285
|
-
const meth = 'adapterBase-
|
|
331
|
+
iapVerifyAdapterCapability(entityType, actionType, entityId, callback) {
|
|
332
|
+
const meth = 'adapterBase-iapVerifyAdapterCapability';
|
|
286
333
|
const origin = `${this.id}-${meth}`;
|
|
287
334
|
log.trace(origin);
|
|
288
335
|
|
|
289
336
|
// if caching
|
|
290
337
|
if (this.caching) {
|
|
291
|
-
// Make the call -
|
|
292
|
-
return this.requestHandlerInst.
|
|
338
|
+
// Make the call - iapVerifyAdapterCapability(entityType, actionType, entityId, callback)
|
|
339
|
+
return this.requestHandlerInst.iapVerifyAdapterCapability(entityType, actionType, entityId, (results, error) => {
|
|
293
340
|
if (error) {
|
|
294
341
|
return callback(null, error);
|
|
295
342
|
}
|
|
@@ -307,7 +354,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
307
354
|
}
|
|
308
355
|
|
|
309
356
|
// need to check the cache again since it has been updated
|
|
310
|
-
return this.requestHandlerInst.
|
|
357
|
+
return this.requestHandlerInst.iapVerifyAdapterCapability(entityType, actionType, entityId, (vcapable, verror) => {
|
|
311
358
|
if (verror) {
|
|
312
359
|
return callback(null, verror);
|
|
313
360
|
}
|
|
@@ -340,7 +387,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
340
387
|
// if no entity id
|
|
341
388
|
if (!entityId) {
|
|
342
389
|
// need to check the cache again since it has been updated
|
|
343
|
-
return this.requestHandlerInst.
|
|
390
|
+
return this.requestHandlerInst.iapVerifyAdapterCapability(entityType, actionType, null, (vcapable, verror) => {
|
|
344
391
|
if (verror) {
|
|
345
392
|
return callback(null, verror);
|
|
346
393
|
}
|
|
@@ -361,7 +408,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
361
408
|
}
|
|
362
409
|
|
|
363
410
|
// need to check the cache again since it has been updated
|
|
364
|
-
return this.requestHandlerInst.
|
|
411
|
+
return this.requestHandlerInst.iapVerifyAdapterCapability(entityType, actionType, null, (vcapable, verror) => {
|
|
365
412
|
if (verror) {
|
|
366
413
|
return callback(null, verror);
|
|
367
414
|
}
|
|
@@ -402,11 +449,11 @@ class Zscaler extends AdapterBaseCl {
|
|
|
402
449
|
/**
|
|
403
450
|
* @summary Updates the cache for all entities by call the get All entity method
|
|
404
451
|
*
|
|
405
|
-
* @function
|
|
452
|
+
* @function iapUpdateAdapterEntityCache
|
|
406
453
|
*
|
|
407
454
|
*/
|
|
408
|
-
|
|
409
|
-
const origin = `${this.id}-adapter-
|
|
455
|
+
iapUpdateAdapterEntityCache() {
|
|
456
|
+
const origin = `${this.id}-adapter-iapUpdateAdapterEntityCache`;
|
|
410
457
|
log.trace(origin);
|
|
411
458
|
|
|
412
459
|
if (this.caching) {
|
|
@@ -419,6 +466,140 @@ class Zscaler extends AdapterBaseCl {
|
|
|
419
466
|
}
|
|
420
467
|
}
|
|
421
468
|
|
|
469
|
+
/**
|
|
470
|
+
* @summary Determines if this adapter supports any in a list of entities
|
|
471
|
+
*
|
|
472
|
+
* @function hasEntities
|
|
473
|
+
* @param {String} entityType - the entity type to check for
|
|
474
|
+
* @param {Array} entityList - the list of entities we are looking for
|
|
475
|
+
*
|
|
476
|
+
* @param {Callback} callback - A map where the entity is the key and the
|
|
477
|
+
* value is true or false
|
|
478
|
+
*/
|
|
479
|
+
hasEntities(entityType, entityList, callback) {
|
|
480
|
+
const meth = 'adapter-hasEntities';
|
|
481
|
+
const origin = `${this.id}-${meth}`;
|
|
482
|
+
log.trace(origin);
|
|
483
|
+
|
|
484
|
+
try {
|
|
485
|
+
return super.hasEntities(entityType, entityList, callback);
|
|
486
|
+
} catch (err) {
|
|
487
|
+
log.error(`${origin}: ${err}`);
|
|
488
|
+
return callback(null, err);
|
|
489
|
+
}
|
|
490
|
+
}
|
|
491
|
+
|
|
492
|
+
/**
|
|
493
|
+
* @summary Get Appliance that match the deviceName
|
|
494
|
+
*
|
|
495
|
+
* @function getDevice
|
|
496
|
+
* @param {String} deviceName - the deviceName to find (required)
|
|
497
|
+
*
|
|
498
|
+
* @param {getCallback} callback - a callback function to return the result
|
|
499
|
+
* (appliance) or the error
|
|
500
|
+
*/
|
|
501
|
+
getDevice(deviceName, callback) {
|
|
502
|
+
const meth = 'adapter-getDevice';
|
|
503
|
+
const origin = `${this.id}-${meth}`;
|
|
504
|
+
log.trace(origin);
|
|
505
|
+
|
|
506
|
+
try {
|
|
507
|
+
return super.getDevice(deviceName, callback);
|
|
508
|
+
} catch (err) {
|
|
509
|
+
log.error(`${origin}: ${err}`);
|
|
510
|
+
return callback(null, err);
|
|
511
|
+
}
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
/**
|
|
515
|
+
* @summary Get Appliances that match the filter
|
|
516
|
+
*
|
|
517
|
+
* @function getDevicesFiltered
|
|
518
|
+
* @param {Object} options - the data to use to filter the appliances (optional)
|
|
519
|
+
*
|
|
520
|
+
* @param {getCallback} callback - a callback function to return the result
|
|
521
|
+
* (appliances) or the error
|
|
522
|
+
*/
|
|
523
|
+
getDevicesFiltered(options, callback) {
|
|
524
|
+
const meth = 'adapter-getDevicesFiltered';
|
|
525
|
+
const origin = `${this.id}-${meth}`;
|
|
526
|
+
log.trace(origin);
|
|
527
|
+
|
|
528
|
+
try {
|
|
529
|
+
return super.getDevicesFiltered(options, callback);
|
|
530
|
+
} catch (err) {
|
|
531
|
+
log.error(`${origin}: ${err}`);
|
|
532
|
+
return callback(null, err);
|
|
533
|
+
}
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
/**
|
|
537
|
+
* @summary Gets the status for the provided appliance
|
|
538
|
+
*
|
|
539
|
+
* @function isAlive
|
|
540
|
+
* @param {String} deviceName - the deviceName of the appliance. (required)
|
|
541
|
+
*
|
|
542
|
+
* @param {configCallback} callback - callback function to return the result
|
|
543
|
+
* (appliance isAlive) or the error
|
|
544
|
+
*/
|
|
545
|
+
isAlive(deviceName, callback) {
|
|
546
|
+
const meth = 'adapter-isAlive';
|
|
547
|
+
const origin = `${this.id}-${meth}`;
|
|
548
|
+
log.trace(origin);
|
|
549
|
+
|
|
550
|
+
try {
|
|
551
|
+
return super.isAlive(deviceName, callback);
|
|
552
|
+
} catch (err) {
|
|
553
|
+
log.error(`${origin}: ${err}`);
|
|
554
|
+
return callback(null, err);
|
|
555
|
+
}
|
|
556
|
+
}
|
|
557
|
+
|
|
558
|
+
/**
|
|
559
|
+
* @summary Gets a config for the provided Appliance
|
|
560
|
+
*
|
|
561
|
+
* @function getConfig
|
|
562
|
+
* @param {String} deviceName - the deviceName of the appliance. (required)
|
|
563
|
+
* @param {String} format - the desired format of the config. (optional)
|
|
564
|
+
*
|
|
565
|
+
* @param {configCallback} callback - callback function to return the result
|
|
566
|
+
* (appliance config) or the error
|
|
567
|
+
*/
|
|
568
|
+
getConfig(deviceName, format, callback) {
|
|
569
|
+
const meth = 'adapter-getConfig';
|
|
570
|
+
const origin = `${this.id}-${meth}`;
|
|
571
|
+
log.trace(origin);
|
|
572
|
+
|
|
573
|
+
try {
|
|
574
|
+
return super.getConfig(deviceName, format, callback);
|
|
575
|
+
} catch (err) {
|
|
576
|
+
log.error(`${origin}: ${err}`);
|
|
577
|
+
return callback(null, err);
|
|
578
|
+
}
|
|
579
|
+
}
|
|
580
|
+
|
|
581
|
+
/**
|
|
582
|
+
* @summary Gets the device count from the system
|
|
583
|
+
*
|
|
584
|
+
* @function iapGetDeviceCount
|
|
585
|
+
*
|
|
586
|
+
* @param {getCallback} callback - callback function to return the result
|
|
587
|
+
* (count) or the error
|
|
588
|
+
*/
|
|
589
|
+
iapGetDeviceCount(callback) {
|
|
590
|
+
const meth = 'adapter-iapGetDeviceCount';
|
|
591
|
+
const origin = `${this.id}-${meth}`;
|
|
592
|
+
log.trace(origin);
|
|
593
|
+
|
|
594
|
+
try {
|
|
595
|
+
return super.iapGetDeviceCount(callback);
|
|
596
|
+
} catch (err) {
|
|
597
|
+
log.error(`${origin}: ${err}`);
|
|
598
|
+
return callback(null, err);
|
|
599
|
+
}
|
|
600
|
+
}
|
|
601
|
+
|
|
602
|
+
/* GENERIC ADAPTER REQUEST - allows extension of adapter without new calls being added */
|
|
422
603
|
/**
|
|
423
604
|
* Makes the requested generic call
|
|
424
605
|
*
|
|
@@ -481,8 +662,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
481
662
|
payload: bodyVars,
|
|
482
663
|
uriPathVars: pathVars,
|
|
483
664
|
uriQuery: queryParams,
|
|
484
|
-
uriOptions: {}
|
|
485
|
-
authData: this.getObfuscatedKey()
|
|
665
|
+
uriOptions: {}
|
|
486
666
|
};
|
|
487
667
|
// add headers if provided
|
|
488
668
|
if (addlHeaders) {
|
|
@@ -530,6 +710,116 @@ class Zscaler extends AdapterBaseCl {
|
|
|
530
710
|
}
|
|
531
711
|
}
|
|
532
712
|
|
|
713
|
+
/**
|
|
714
|
+
* Makes the requested generic call with no base path or version
|
|
715
|
+
*
|
|
716
|
+
* @function genericAdapterRequestNoBasePath
|
|
717
|
+
* @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (required)
|
|
718
|
+
* @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (required)
|
|
719
|
+
* @param {Object} queryData - the parameters to be put on the url (optional).
|
|
720
|
+
* Can be a stringified Object.
|
|
721
|
+
* @param {Object} requestBody - the body to add to the request (optional).
|
|
722
|
+
* Can be a stringified Object.
|
|
723
|
+
* @param {Object} addlHeaders - additional headers to be put on the call (optional).
|
|
724
|
+
* Can be a stringified Object.
|
|
725
|
+
* @param {getCallback} callback - a callback function to return the result (Generics)
|
|
726
|
+
* or the error
|
|
727
|
+
*/
|
|
728
|
+
genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
|
|
729
|
+
const meth = 'adapter-genericAdapterRequestNoBasePath';
|
|
730
|
+
const origin = `${this.id}-${meth}`;
|
|
731
|
+
log.trace(origin);
|
|
732
|
+
|
|
733
|
+
if (this.suspended && this.suspendMode === 'error') {
|
|
734
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
|
|
735
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
736
|
+
return callback(null, errorObj);
|
|
737
|
+
}
|
|
738
|
+
|
|
739
|
+
/* HERE IS WHERE YOU VALIDATE DATA */
|
|
740
|
+
if (uriPath === undefined || uriPath === null || uriPath === '') {
|
|
741
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['uriPath'], null, null, null);
|
|
742
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
743
|
+
return callback(null, errorObj);
|
|
744
|
+
}
|
|
745
|
+
if (restMethod === undefined || restMethod === null || restMethod === '') {
|
|
746
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['restMethod'], null, null, null);
|
|
747
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
748
|
+
return callback(null, errorObj);
|
|
749
|
+
}
|
|
750
|
+
|
|
751
|
+
/* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
|
|
752
|
+
// remove any leading / and split the uripath into path variables
|
|
753
|
+
let myPath = uriPath;
|
|
754
|
+
while (myPath.indexOf('/') === 0) {
|
|
755
|
+
myPath = myPath.substring(1);
|
|
756
|
+
}
|
|
757
|
+
const pathVars = myPath.split('/');
|
|
758
|
+
const queryParamsAvailable = queryData;
|
|
759
|
+
const queryParams = {};
|
|
760
|
+
const bodyVars = requestBody;
|
|
761
|
+
|
|
762
|
+
// loop in template. long callback arg name to avoid identifier conflicts
|
|
763
|
+
Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
|
|
764
|
+
if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
|
|
765
|
+
&& queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
|
|
766
|
+
queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
|
|
767
|
+
}
|
|
768
|
+
});
|
|
769
|
+
|
|
770
|
+
// set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders
|
|
771
|
+
const reqObj = {
|
|
772
|
+
payload: bodyVars,
|
|
773
|
+
uriPathVars: pathVars,
|
|
774
|
+
uriQuery: queryParams,
|
|
775
|
+
uriOptions: {}
|
|
776
|
+
};
|
|
777
|
+
// add headers if provided
|
|
778
|
+
if (addlHeaders) {
|
|
779
|
+
reqObj.addlHeaders = addlHeaders;
|
|
780
|
+
}
|
|
781
|
+
|
|
782
|
+
// determine the call and return flag
|
|
783
|
+
let action = 'getGenericsNoBase';
|
|
784
|
+
let returnF = true;
|
|
785
|
+
if (restMethod.toUpperCase() === 'POST') {
|
|
786
|
+
action = 'createGenericNoBase';
|
|
787
|
+
} else if (restMethod.toUpperCase() === 'PUT') {
|
|
788
|
+
action = 'updateGenericNoBase';
|
|
789
|
+
} else if (restMethod.toUpperCase() === 'PATCH') {
|
|
790
|
+
action = 'patchGenericNoBase';
|
|
791
|
+
} else if (restMethod.toUpperCase() === 'DELETE') {
|
|
792
|
+
action = 'deleteGenericNoBase';
|
|
793
|
+
returnF = false;
|
|
794
|
+
}
|
|
795
|
+
|
|
796
|
+
try {
|
|
797
|
+
// Make the call -
|
|
798
|
+
// identifyRequest(entity, action, requestObj, returnDataFlag, callback)
|
|
799
|
+
return this.requestHandlerInst.identifyRequest('.generic', action, reqObj, returnF, (irReturnData, irReturnError) => {
|
|
800
|
+
// if we received an error or their is no response on the results
|
|
801
|
+
// return an error
|
|
802
|
+
if (irReturnError) {
|
|
803
|
+
/* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
|
|
804
|
+
return callback(null, irReturnError);
|
|
805
|
+
}
|
|
806
|
+
if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
|
|
807
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['genericAdapterRequestNoBasePath'], null, null, null);
|
|
808
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
809
|
+
return callback(null, errorObj);
|
|
810
|
+
}
|
|
811
|
+
|
|
812
|
+
/* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
|
|
813
|
+
// return the response
|
|
814
|
+
return callback(irReturnData, null);
|
|
815
|
+
});
|
|
816
|
+
} catch (ex) {
|
|
817
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
|
|
818
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
819
|
+
return callback(null, errorObj);
|
|
820
|
+
}
|
|
821
|
+
}
|
|
822
|
+
|
|
533
823
|
/**
|
|
534
824
|
* @callback healthCallback
|
|
535
825
|
* @param {Object} result - the result of the get request (contains an id and a status)
|
|
@@ -562,29 +852,29 @@ class Zscaler extends AdapterBaseCl {
|
|
|
562
852
|
* @param {getCallback} callback - a callback function to return the result
|
|
563
853
|
*/
|
|
564
854
|
getObfuscatedKey() {
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
while (low.length < 6) {
|
|
573
|
-
low = `0${low}`;
|
|
574
|
-
}
|
|
855
|
+
const { allProps: { authentication: { apiKey } } } = this;
|
|
856
|
+
const timestamp = Date.now().toString();
|
|
857
|
+
if (!apiKey) {
|
|
858
|
+
return { apiKey: 'missingKey', timestamp };
|
|
859
|
+
}
|
|
860
|
+
const high = timestamp.substring(timestamp.length - 6);
|
|
575
861
|
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
}
|
|
862
|
+
let low = (parseInt(high, 10) >> 1).toString();
|
|
863
|
+
let obfuscatedApiKey = '';
|
|
579
864
|
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
865
|
+
while (low.length < 6) {
|
|
866
|
+
low = `0${low}`;
|
|
867
|
+
}
|
|
868
|
+
|
|
869
|
+
for (let i = 0; i < high.length; i += 1) {
|
|
870
|
+
obfuscatedApiKey += apiKey.charAt(parseInt(high.charAt(i), 10));
|
|
871
|
+
}
|
|
583
872
|
|
|
584
|
-
|
|
873
|
+
for (let j = 0; j < low.length; j += 1) {
|
|
874
|
+
obfuscatedApiKey += apiKey.charAt(parseInt(low.charAt(j), 10) + 2);
|
|
585
875
|
}
|
|
586
876
|
|
|
587
|
-
return
|
|
877
|
+
return { apiKey: obfuscatedApiKey, timestamp };
|
|
588
878
|
}
|
|
589
879
|
|
|
590
880
|
/**
|
|
@@ -642,7 +932,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
642
932
|
* @summary Creates an authenticated session
|
|
643
933
|
*
|
|
644
934
|
* @function postAuthenticatedSession
|
|
645
|
-
* @param {object} credentials -
|
|
935
|
+
* @param {object} credentials - Creates an authenticated session. The response returns a cookie in the header called JSESSIONID that must be used in subsequent requests.
|
|
646
936
|
* @param {getCallback} callback - a callback function to return the result
|
|
647
937
|
*/
|
|
648
938
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -1023,7 +1313,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
1023
1313
|
* @summary Creates an audit log report for the specified time period and saves it as a CSV file
|
|
1024
1314
|
*
|
|
1025
1315
|
* @function postAuditlogEntryReport
|
|
1026
|
-
* @param {object} request -
|
|
1316
|
+
* @param {object} request - 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.
|
|
1027
1317
|
* @param {getCallback} callback - a callback function to return the result
|
|
1028
1318
|
*/
|
|
1029
1319
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -1246,7 +1536,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
1246
1536
|
* @summary Gets the department for the specified ID
|
|
1247
1537
|
*
|
|
1248
1538
|
* @function getDepartmentsid
|
|
1249
|
-
* @param {number} id -
|
|
1539
|
+
* @param {number} id - Gets the department for the specified ID.
|
|
1250
1540
|
* @param {getCallback} callback - a callback function to return the result
|
|
1251
1541
|
*/
|
|
1252
1542
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -1321,9 +1611,9 @@ class Zscaler extends AdapterBaseCl {
|
|
|
1321
1611
|
* @summary Gets a list of groups
|
|
1322
1612
|
*
|
|
1323
1613
|
* @function getGroups
|
|
1324
|
-
* @param {string} search -
|
|
1325
|
-
* @param {number} page -
|
|
1326
|
-
* @param {number} pageSize -
|
|
1614
|
+
* @param {string} search - Gets a list of groups. The search parameters find matching values in the "name" and "comments" attributes.
|
|
1615
|
+
* @param {number} page - Gets a list of groups. The search parameters find matching values in the "name" and "comments" attributes.
|
|
1616
|
+
* @param {number} pageSize - Gets a list of groups. The search parameters find matching values in the "name" and "comments" attributes.
|
|
1327
1617
|
* @param {getCallback} callback - a callback function to return the result
|
|
1328
1618
|
*/
|
|
1329
1619
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -1393,7 +1683,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
1393
1683
|
* @summary Gets the group for the specified ID
|
|
1394
1684
|
*
|
|
1395
1685
|
* @function getGroupsgroupId
|
|
1396
|
-
* @param {number} groupId -
|
|
1686
|
+
* @param {number} groupId - Gets the group for the specified ID.
|
|
1397
1687
|
* @param {getCallback} callback - a callback function to return the result
|
|
1398
1688
|
*/
|
|
1399
1689
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -1468,11 +1758,11 @@ class Zscaler extends AdapterBaseCl {
|
|
|
1468
1758
|
* @summary Gets a list of all users and allows user filtering by name, department, or group
|
|
1469
1759
|
*
|
|
1470
1760
|
* @function getUsers
|
|
1471
|
-
* @param {string} name - <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>
|
|
1472
|
-
* @param {string} dept - <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>
|
|
1473
|
-
* @param {string} group - <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>
|
|
1474
|
-
* @param {number} page - <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>
|
|
1475
|
-
* @param {number} pageSize - <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>
|
|
1761
|
+
* @param {string} name - 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.
|
|
1762
|
+
* @param {string} dept - 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.
|
|
1763
|
+
* @param {string} group - 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.
|
|
1764
|
+
* @param {number} page - 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.
|
|
1765
|
+
* @param {number} pageSize - 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.
|
|
1476
1766
|
* @param {getCallback} callback - a callback function to return the result
|
|
1477
1767
|
*/
|
|
1478
1768
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -1542,7 +1832,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
1542
1832
|
* @summary Adds a new user
|
|
1543
1833
|
*
|
|
1544
1834
|
* @function postUsers
|
|
1545
|
-
* @param {object} user -
|
|
1835
|
+
* @param {object} user - Adds a new user. A user can belong to multiple groups, but can only belong to one department.
|
|
1546
1836
|
* @param {getCallback} callback - a callback function to return the result
|
|
1547
1837
|
*/
|
|
1548
1838
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -1612,7 +1902,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
1612
1902
|
* @summary Bulk delete users up to a maximum of 500 users per request
|
|
1613
1903
|
*
|
|
1614
1904
|
* @function postUsersbulkDelete
|
|
1615
|
-
* @param {object} userIds -
|
|
1905
|
+
* @param {object} userIds - Bulk delete users up to a maximum of 500 users per request. The response returns the user IDs that were successfully deleted.
|
|
1616
1906
|
* @param {getCallback} callback - a callback function to return the result
|
|
1617
1907
|
*/
|
|
1618
1908
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -1682,7 +1972,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
1682
1972
|
* @summary Gets the user information for the specified ID
|
|
1683
1973
|
*
|
|
1684
1974
|
* @function getUsersuserId
|
|
1685
|
-
* @param {number} userId -
|
|
1975
|
+
* @param {number} userId - Gets the user information for the specified ID.
|
|
1686
1976
|
* @param {getCallback} callback - a callback function to return the result
|
|
1687
1977
|
*/
|
|
1688
1978
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -1757,8 +2047,8 @@ class Zscaler extends AdapterBaseCl {
|
|
|
1757
2047
|
* @summary Updates the user information for the specified ID
|
|
1758
2048
|
*
|
|
1759
2049
|
* @function putUsersuserId
|
|
1760
|
-
* @param {number} userId -
|
|
1761
|
-
* @param {object} user -
|
|
2050
|
+
* @param {number} userId - Updates the user information for the specified ID. However, the "email" attribute is read-only.
|
|
2051
|
+
* @param {object} user - Updates the user information for the specified ID. However, the "email" attribute is read-only.
|
|
1762
2052
|
* @param {getCallback} callback - a callback function to return the result
|
|
1763
2053
|
*/
|
|
1764
2054
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -1833,7 +2123,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
1833
2123
|
* @summary Deletes the user for the specified ID
|
|
1834
2124
|
*
|
|
1835
2125
|
* @function deleteUsersuserId
|
|
1836
|
-
* @param {number} userId -
|
|
2126
|
+
* @param {number} userId - Deletes the user for the specified ID.
|
|
1837
2127
|
* @param {getCallback} callback - a callback function to return the result
|
|
1838
2128
|
*/
|
|
1839
2129
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -1959,7 +2249,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
1959
2249
|
* @summary Updates the list of white-listed URLs
|
|
1960
2250
|
*
|
|
1961
2251
|
* @function putSecurity
|
|
1962
|
-
* @param {object} policy -
|
|
2252
|
+
* @param {object} policy - 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.
|
|
1963
2253
|
* @param {getCallback} callback - a callback function to return the result
|
|
1964
2254
|
*/
|
|
1965
2255
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -2080,7 +2370,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
2080
2370
|
* @summary Updates the list of black-listed URLs
|
|
2081
2371
|
*
|
|
2082
2372
|
* @function putSecurityadvanced
|
|
2083
|
-
* @param {object} advSettings -
|
|
2373
|
+
* @param {object} advSettings - 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.
|
|
2084
2374
|
* @param {getCallback} callback - a callback function to return the result
|
|
2085
2375
|
*/
|
|
2086
2376
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -2150,7 +2440,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
2150
2440
|
* @summary Adds a URL to or removes a URL from the black list
|
|
2151
2441
|
*
|
|
2152
2442
|
* @function postSecurityadvancedblacklistUrls
|
|
2153
|
-
* @param {string} action -
|
|
2443
|
+
* @param {string} action - 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.
|
|
2154
2444
|
* @param {getCallback} callback - a callback function to return the result
|
|
2155
2445
|
*/
|
|
2156
2446
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -2327,7 +2617,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
2327
2617
|
* @summary Generates a Certificate Signing Request (CSR)
|
|
2328
2618
|
*
|
|
2329
2619
|
* @function postSslSettingsgeneratecsr
|
|
2330
|
-
* @param {object} cert -
|
|
2620
|
+
* @param {object} cert - 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.
|
|
2331
2621
|
* @param {getCallback} callback - a callback function to return the result
|
|
2332
2622
|
*/
|
|
2333
2623
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -2453,7 +2743,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
2453
2743
|
* @summary Uploads a signed intermediate root certificate for clients that use iframe-based uploads whose content type is text/plain
|
|
2454
2744
|
*
|
|
2455
2745
|
* @function postSslSettingsuploadcerttext
|
|
2456
|
-
* @param {object} fileInputStream -
|
|
2746
|
+
* @param {object} fileInputStream - 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.
|
|
2457
2747
|
* @param {getCallback} callback - a callback function to return the result
|
|
2458
2748
|
*/
|
|
2459
2749
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -2523,7 +2813,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
2523
2813
|
* @summary Uploads the Intermediate Certificate Chain (PEM) for clients that use iframe-based uploads whose content type is text/plain
|
|
2524
2814
|
*
|
|
2525
2815
|
* @function postSslSettingsuploadcertchaintext
|
|
2526
|
-
* @param {object} fileInputStream -
|
|
2816
|
+
* @param {object} fileInputStream - 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.
|
|
2527
2817
|
* @param {getCallback} callback - a callback function to return the result
|
|
2528
2818
|
*/
|
|
2529
2819
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -2593,7 +2883,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
2593
2883
|
* @summary Gets information about all or custom URL categories
|
|
2594
2884
|
*
|
|
2595
2885
|
* @function getUrlCategories
|
|
2596
|
-
* @param {boolean} customOnly -
|
|
2886
|
+
* @param {boolean} customOnly - Gets information about all or custom URL categories.
|
|
2597
2887
|
* @param {getCallback} callback - a callback function to return the result
|
|
2598
2888
|
*/
|
|
2599
2889
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -2663,7 +2953,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
2663
2953
|
* @summary Adds a new custom URL category
|
|
2664
2954
|
*
|
|
2665
2955
|
* @function postUrlCategories
|
|
2666
|
-
* @param {object} customCategory -
|
|
2956
|
+
* @param {object} customCategory - Adds a new custom URL category.
|
|
2667
2957
|
* @param {getCallback} callback - a callback function to return the result
|
|
2668
2958
|
*/
|
|
2669
2959
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -2835,7 +3125,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
2835
3125
|
* @summary Gets the URL category information for the specified ID
|
|
2836
3126
|
*
|
|
2837
3127
|
* @function getUrlCategoriescategoryId
|
|
2838
|
-
* @param {string} categoryId -
|
|
3128
|
+
* @param {string} categoryId - Gets the URL category information for the specified ID.
|
|
2839
3129
|
* @param {getCallback} callback - a callback function to return the result
|
|
2840
3130
|
*/
|
|
2841
3131
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -2910,9 +3200,9 @@ class Zscaler extends AdapterBaseCl {
|
|
|
2910
3200
|
* @summary Updates the URL category for the specified ID
|
|
2911
3201
|
*
|
|
2912
3202
|
* @function putUrlCategoriescategoryId
|
|
2913
|
-
* @param {string} categoryId -
|
|
2914
|
-
* @param {string} action -
|
|
2915
|
-
* @param {object} customCategory -
|
|
3203
|
+
* @param {string} categoryId - Updates the URL category for the specified ID.
|
|
3204
|
+
* @param {string} action - Updates the URL category for the specified ID.
|
|
3205
|
+
* @param {object} customCategory - Updates the URL category for the specified ID.
|
|
2916
3206
|
* @param {getCallback} callback - a callback function to return the result
|
|
2917
3207
|
*/
|
|
2918
3208
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -2987,7 +3277,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
2987
3277
|
* @summary Deletes the custom URL category for the specified ID
|
|
2988
3278
|
*
|
|
2989
3279
|
* @function deleteUrlCategoriescategoryId
|
|
2990
|
-
* @param {string} categoryId -
|
|
3280
|
+
* @param {string} categoryId - 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.
|
|
2991
3281
|
* @param {getCallback} callback - a callback function to return the result
|
|
2992
3282
|
*/
|
|
2993
3283
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -3062,7 +3352,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3062
3352
|
* @summary Look up the categorization of the given set of URLs, e.g., ['abc.com', 'xyz.com']
|
|
3063
3353
|
*
|
|
3064
3354
|
* @function postUrlLookup
|
|
3065
|
-
* @param {array} urls -
|
|
3355
|
+
* @param {array} urls - 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.
|
|
3066
3356
|
* @param {getCallback} callback - a callback function to return the result
|
|
3067
3357
|
*/
|
|
3068
3358
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -3083,7 +3373,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3083
3373
|
const queryParamsAvailable = {};
|
|
3084
3374
|
const queryParams = {};
|
|
3085
3375
|
const pathVars = [];
|
|
3086
|
-
const bodyVars =
|
|
3376
|
+
const bodyVars = urls;
|
|
3087
3377
|
|
|
3088
3378
|
// loop in template. long callback arg name to avoid identifier conflicts
|
|
3089
3379
|
Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
|
|
@@ -3132,13 +3422,13 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3132
3422
|
* @summary Gets VPN credentials that can be associated to locations
|
|
3133
3423
|
*
|
|
3134
3424
|
* @function getVpnCredentials
|
|
3135
|
-
* @param {string} search -
|
|
3136
|
-
* @param {string} type -
|
|
3137
|
-
* @param {boolean} includeOnlyWithoutLocation -
|
|
3138
|
-
* @param {number} locationId -
|
|
3139
|
-
* @param {number} managedBy -
|
|
3140
|
-
* @param {number} page -
|
|
3141
|
-
* @param {number} pageSize -
|
|
3425
|
+
* @param {string} search - Gets VPN credentials that can be associated to locations.
|
|
3426
|
+
* @param {string} type - Gets VPN credentials that can be associated to locations.
|
|
3427
|
+
* @param {boolean} includeOnlyWithoutLocation - Gets VPN credentials that can be associated to locations.
|
|
3428
|
+
* @param {number} locationId - Gets VPN credentials that can be associated to locations.
|
|
3429
|
+
* @param {number} managedBy - Gets VPN credentials that can be associated to locations.
|
|
3430
|
+
* @param {number} page - Gets VPN credentials that can be associated to locations.
|
|
3431
|
+
* @param {number} pageSize - Gets VPN credentials that can be associated to locations.
|
|
3142
3432
|
* @param {getCallback} callback - a callback function to return the result
|
|
3143
3433
|
*/
|
|
3144
3434
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -3208,7 +3498,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3208
3498
|
* @summary Adds VPN credentials that can be associated to locations
|
|
3209
3499
|
*
|
|
3210
3500
|
* @function postVpnCredentials
|
|
3211
|
-
* @param {object} vpnCred -
|
|
3501
|
+
* @param {object} vpnCred - 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.
|
|
3212
3502
|
* @param {getCallback} callback - a callback function to return the result
|
|
3213
3503
|
*/
|
|
3214
3504
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -3278,7 +3568,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3278
3568
|
* @summary Bulk delete VPN credentials up to a maximum of 100 credentials per request
|
|
3279
3569
|
*
|
|
3280
3570
|
* @function postVpnCredentialsbulkDelete
|
|
3281
|
-
* @param {object} ids -
|
|
3571
|
+
* @param {object} ids - Bulk delete VPN credentials up to a maximum of 100 credentials per request. The response returns the VPN IDs that were successfully deleted.
|
|
3282
3572
|
* @param {getCallback} callback - a callback function to return the result
|
|
3283
3573
|
*/
|
|
3284
3574
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -3348,7 +3638,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3348
3638
|
* @summary Gets the VPN credentials for the specified ID
|
|
3349
3639
|
*
|
|
3350
3640
|
* @function getVpnCredentialsvpnId
|
|
3351
|
-
* @param {number} vpnId -
|
|
3641
|
+
* @param {number} vpnId - Gets the VPN credentials for the specified ID.
|
|
3352
3642
|
* @param {getCallback} callback - a callback function to return the result
|
|
3353
3643
|
*/
|
|
3354
3644
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -3423,8 +3713,8 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3423
3713
|
* @summary Updates the VPN credentials for the specified ID
|
|
3424
3714
|
*
|
|
3425
3715
|
* @function putVpnCredentialsvpnId
|
|
3426
|
-
* @param {number} vpnId -
|
|
3427
|
-
* @param {object} vpnCred -
|
|
3716
|
+
* @param {number} vpnId - Updates the VPN credentials for the specified ID.
|
|
3717
|
+
* @param {object} vpnCred - Updates the VPN credentials for the specified ID.
|
|
3428
3718
|
* @param {getCallback} callback - a callback function to return the result
|
|
3429
3719
|
*/
|
|
3430
3720
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -3499,7 +3789,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3499
3789
|
* @summary Deletes the VPN credentials for the specified ID
|
|
3500
3790
|
*
|
|
3501
3791
|
* @function deleteVpnCredentialsvpnId
|
|
3502
|
-
* @param {number} vpnId -
|
|
3792
|
+
* @param {number} vpnId - Deletes the VPN credentials for the specified ID.
|
|
3503
3793
|
* @param {getCallback} callback - a callback function to return the result
|
|
3504
3794
|
*/
|
|
3505
3795
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -3574,13 +3864,13 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3574
3864
|
* @summary Gets information on locations
|
|
3575
3865
|
*
|
|
3576
3866
|
* @function getLocations
|
|
3577
|
-
* @param {string} search -
|
|
3578
|
-
* @param {boolean} sslScanEnabled -
|
|
3579
|
-
* @param {boolean} xffEnabled -
|
|
3580
|
-
* @param {boolean} authRequired -
|
|
3581
|
-
* @param {boolean} bwEnforced -
|
|
3582
|
-
* @param {number} page -
|
|
3583
|
-
* @param {number} pageSize -
|
|
3867
|
+
* @param {string} search - 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.
|
|
3868
|
+
* @param {boolean} sslScanEnabled - 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.
|
|
3869
|
+
* @param {boolean} xffEnabled - 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.
|
|
3870
|
+
* @param {boolean} authRequired - 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.
|
|
3871
|
+
* @param {boolean} bwEnforced - 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.
|
|
3872
|
+
* @param {number} page - 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.
|
|
3873
|
+
* @param {number} pageSize - 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.
|
|
3584
3874
|
* @param {getCallback} callback - a callback function to return the result
|
|
3585
3875
|
*/
|
|
3586
3876
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -3650,7 +3940,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3650
3940
|
* @summary Adds a new location
|
|
3651
3941
|
*
|
|
3652
3942
|
* @function postLocations
|
|
3653
|
-
* @param {object} location -
|
|
3943
|
+
* @param {object} location - Adds a new location. When invoked with a partner API key, it automatically sets the managedBy attribute to the partner associated with the key.
|
|
3654
3944
|
* @param {getCallback} callback - a callback function to return the result
|
|
3655
3945
|
*/
|
|
3656
3946
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -3720,7 +4010,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3720
4010
|
* @summary Bulk delete locations up to a maximum of 100 locations per request
|
|
3721
4011
|
*
|
|
3722
4012
|
* @function postLocationsbulkDelete
|
|
3723
|
-
* @param {object} LocationIds -
|
|
4013
|
+
* @param {object} LocationIds - Bulk delete locations up to a maximum of 100 users per request. The response returns the location IDs that were successfully deleted.
|
|
3724
4014
|
* @param {getCallback} callback - a callback function to return the result
|
|
3725
4015
|
*/
|
|
3726
4016
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -3790,10 +4080,10 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3790
4080
|
* @summary Gets a lightweight list of locations
|
|
3791
4081
|
*
|
|
3792
4082
|
* @function getLocationslite
|
|
3793
|
-
* @param {boolean} sslScanEnabled -
|
|
3794
|
-
* @param {string} search -
|
|
3795
|
-
* @param {number} page -
|
|
3796
|
-
* @param {number} pageSize -
|
|
4083
|
+
* @param {boolean} sslScanEnabled - Gets a lightweight list of locations.
|
|
4084
|
+
* @param {string} search - Gets a lightweight list of locations.
|
|
4085
|
+
* @param {number} page - Gets a lightweight list of locations.
|
|
4086
|
+
* @param {number} pageSize - Gets a lightweight list of locations.
|
|
3797
4087
|
* @param {getCallback} callback - a callback function to return the result
|
|
3798
4088
|
*/
|
|
3799
4089
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -3863,7 +4153,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3863
4153
|
* @summary Gets the location information for the specified ID
|
|
3864
4154
|
*
|
|
3865
4155
|
* @function getLocationslocationId
|
|
3866
|
-
* @param {number} locationId -
|
|
4156
|
+
* @param {number} locationId - Gets the location information for the specified ID.
|
|
3867
4157
|
* @param {getCallback} callback - a callback function to return the result
|
|
3868
4158
|
*/
|
|
3869
4159
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -3938,8 +4228,8 @@ class Zscaler extends AdapterBaseCl {
|
|
|
3938
4228
|
* @summary Updates the location information for the specified ID
|
|
3939
4229
|
*
|
|
3940
4230
|
* @function putLocationslocationId
|
|
3941
|
-
* @param {number} locationId -
|
|
3942
|
-
* @param {object} location -
|
|
4231
|
+
* @param {number} locationId - Updates the location information for the specified ID.
|
|
4232
|
+
* @param {object} location - Updates the location information for the specified ID.
|
|
3943
4233
|
* @param {getCallback} callback - a callback function to return the result
|
|
3944
4234
|
*/
|
|
3945
4235
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -4014,7 +4304,7 @@ class Zscaler extends AdapterBaseCl {
|
|
|
4014
4304
|
* @summary Deletes the location for the specified ID
|
|
4015
4305
|
*
|
|
4016
4306
|
* @function deleteLocationslocationId
|
|
4017
|
-
* @param {number} locationId -
|
|
4307
|
+
* @param {number} locationId - Deletes the location for the specified ID.
|
|
4018
4308
|
* @param {getCallback} callback - a callback function to return the result
|
|
4019
4309
|
*/
|
|
4020
4310
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
@@ -4140,8 +4430,8 @@ class Zscaler extends AdapterBaseCl {
|
|
|
4140
4430
|
* @summary Gets a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox
|
|
4141
4431
|
*
|
|
4142
4432
|
* @function getSandboxreportmd5Hash
|
|
4143
|
-
* @param {string} md5Hash -
|
|
4144
|
-
* @param {string} details -
|
|
4433
|
+
* @param {string} md5Hash - Get a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox.
|
|
4434
|
+
* @param {string} details - Get a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox.
|
|
4145
4435
|
* @param {getCallback} callback - a callback function to return the result
|
|
4146
4436
|
*/
|
|
4147
4437
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|