@itentialopensource/adapter-zscaler 0.6.3 → 0.6.7
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/CHANGELOG.md +32 -0
- package/README.md +84 -11
- package/adapter.js +661 -123
- package/adapterBase.js +23 -1
- package/entities/.generic/action.json +5 -5
- package/entities/.system/action.json +5 -5
- package/entities/.system/schemaTokenReq.json +3 -4
- package/entities/.system/schemaTokenResp.json +2 -13
- package/error.json +6 -0
- package/package.json +18 -13
- package/pronghorn.json +312 -120
- package/propertiesSchema.json +20 -0
- package/refs?service=git-upload-pack +0 -0
- package/report/updateReport1642619799800.json +95 -0
- package/sampleProperties.json +5 -1
- package/test/integration/adapterTestBasicGet.js +1 -1
- package/test/integration/adapterTestIntegration.js +10 -2
- package/test/unit/adapterBaseTestUnit.js +6 -3
- package/test/unit/adapterTestUnit.js +489 -4
- package/utils/addAuth.js +94 -0
- package/utils/basicGet.js +1 -14
- package/utils/entitiesToDB.js +224 -0
- package/utils/modify.js +1 -1
- package/utils/packModificationScript.js +1 -1
- package/utils/patches2bundledDeps.js +90 -0
- package/utils/removeHooks.js +20 -0
- package/utils/tbScript.js +14 -8
- package/utils/tbUtils.js +98 -19
- package/utils/troubleshootingAdapter.js +2 -26
package/pronghorn.json
CHANGED
|
@@ -386,6 +386,198 @@
|
|
|
386
386
|
},
|
|
387
387
|
"task": true
|
|
388
388
|
},
|
|
389
|
+
{
|
|
390
|
+
"name": "moveEntitiesToDB",
|
|
391
|
+
"summary": "Moves entities from an adapter into the IAP database",
|
|
392
|
+
"description": "Moves entities from an adapter into the IAP database",
|
|
393
|
+
"input": [],
|
|
394
|
+
"output": {
|
|
395
|
+
"name": "res",
|
|
396
|
+
"type": "object",
|
|
397
|
+
"description": "A JSON Object containing status, code and the response from the mongo transaction",
|
|
398
|
+
"schema": {
|
|
399
|
+
"title": "res",
|
|
400
|
+
"type": "object"
|
|
401
|
+
}
|
|
402
|
+
},
|
|
403
|
+
"roles": [
|
|
404
|
+
"admin"
|
|
405
|
+
],
|
|
406
|
+
"route": {
|
|
407
|
+
"verb": "POST",
|
|
408
|
+
"path": "/moveEntitiesToDB"
|
|
409
|
+
},
|
|
410
|
+
"task": true
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
"name": "getDevice",
|
|
414
|
+
"summary": "Get the Appliance",
|
|
415
|
+
"description": "Get the Appliance",
|
|
416
|
+
"input": [
|
|
417
|
+
{
|
|
418
|
+
"name": "deviceName",
|
|
419
|
+
"type": "string",
|
|
420
|
+
"info": "An Appliance Device Name",
|
|
421
|
+
"required": true,
|
|
422
|
+
"schema": {
|
|
423
|
+
"title": "deviceName",
|
|
424
|
+
"type": "string"
|
|
425
|
+
}
|
|
426
|
+
}
|
|
427
|
+
],
|
|
428
|
+
"output": {
|
|
429
|
+
"name": "result",
|
|
430
|
+
"type": "object",
|
|
431
|
+
"description": "A JSON Object containing status, code and the result",
|
|
432
|
+
"schema": {
|
|
433
|
+
"title": "result",
|
|
434
|
+
"type": "object"
|
|
435
|
+
}
|
|
436
|
+
},
|
|
437
|
+
"roles": [
|
|
438
|
+
"admin"
|
|
439
|
+
],
|
|
440
|
+
"route": {
|
|
441
|
+
"verb": "POST",
|
|
442
|
+
"path": "/getDevice"
|
|
443
|
+
},
|
|
444
|
+
"task": false
|
|
445
|
+
},
|
|
446
|
+
{
|
|
447
|
+
"name": "getDevicesFiltered",
|
|
448
|
+
"summary": "Get Appliances that match the filter",
|
|
449
|
+
"description": "Get Appliances that match the filter",
|
|
450
|
+
"input": [
|
|
451
|
+
{
|
|
452
|
+
"name": "options",
|
|
453
|
+
"type": "object",
|
|
454
|
+
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
|
|
455
|
+
"required": true,
|
|
456
|
+
"schema": {
|
|
457
|
+
"title": "options",
|
|
458
|
+
"type": "object"
|
|
459
|
+
}
|
|
460
|
+
}
|
|
461
|
+
],
|
|
462
|
+
"output": {
|
|
463
|
+
"name": "result",
|
|
464
|
+
"type": "array",
|
|
465
|
+
"description": "A JSON Object containing status, code and the result",
|
|
466
|
+
"schema": {
|
|
467
|
+
"title": "result",
|
|
468
|
+
"type": "array"
|
|
469
|
+
}
|
|
470
|
+
},
|
|
471
|
+
"roles": [
|
|
472
|
+
"admin"
|
|
473
|
+
],
|
|
474
|
+
"route": {
|
|
475
|
+
"verb": "POST",
|
|
476
|
+
"path": "/getDevicesFiltered"
|
|
477
|
+
},
|
|
478
|
+
"task": false
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
"name": "isAlive",
|
|
482
|
+
"summary": "Checks the status for the provided Appliance",
|
|
483
|
+
"description": "Checks the status for the provided Appliance",
|
|
484
|
+
"input": [
|
|
485
|
+
{
|
|
486
|
+
"name": "deviceName",
|
|
487
|
+
"type": "string",
|
|
488
|
+
"info": "An Appliance Device Name",
|
|
489
|
+
"required": true,
|
|
490
|
+
"schema": {
|
|
491
|
+
"title": "deviceName",
|
|
492
|
+
"type": "string"
|
|
493
|
+
}
|
|
494
|
+
}
|
|
495
|
+
],
|
|
496
|
+
"output": {
|
|
497
|
+
"name": "result",
|
|
498
|
+
"type": "boolean",
|
|
499
|
+
"description": "A JSON Object containing status, code and the result",
|
|
500
|
+
"schema": {
|
|
501
|
+
"title": "result",
|
|
502
|
+
"type": "boolean"
|
|
503
|
+
}
|
|
504
|
+
},
|
|
505
|
+
"roles": [
|
|
506
|
+
"admin"
|
|
507
|
+
],
|
|
508
|
+
"route": {
|
|
509
|
+
"verb": "POST",
|
|
510
|
+
"path": "/isAlive"
|
|
511
|
+
},
|
|
512
|
+
"task": false
|
|
513
|
+
},
|
|
514
|
+
{
|
|
515
|
+
"name": "getConfig",
|
|
516
|
+
"summary": "Gets a config for the provided Appliance",
|
|
517
|
+
"description": "Gets a config for the provided Appliance",
|
|
518
|
+
"input": [
|
|
519
|
+
{
|
|
520
|
+
"name": "deviceName",
|
|
521
|
+
"type": "string",
|
|
522
|
+
"info": "An Appliance Device Name",
|
|
523
|
+
"required": true,
|
|
524
|
+
"schema": {
|
|
525
|
+
"title": "deviceName",
|
|
526
|
+
"type": "string"
|
|
527
|
+
}
|
|
528
|
+
},
|
|
529
|
+
{
|
|
530
|
+
"name": "format",
|
|
531
|
+
"type": "string",
|
|
532
|
+
"info": "The format to be returned - this is ignored as we always return json",
|
|
533
|
+
"required": false,
|
|
534
|
+
"schema": {
|
|
535
|
+
"title": "format",
|
|
536
|
+
"type": "string"
|
|
537
|
+
}
|
|
538
|
+
}
|
|
539
|
+
],
|
|
540
|
+
"output": {
|
|
541
|
+
"name": "result",
|
|
542
|
+
"type": "object",
|
|
543
|
+
"description": "A JSON Object containing status, code and the result",
|
|
544
|
+
"schema": {
|
|
545
|
+
"title": "result",
|
|
546
|
+
"type": "object"
|
|
547
|
+
}
|
|
548
|
+
},
|
|
549
|
+
"roles": [
|
|
550
|
+
"admin"
|
|
551
|
+
],
|
|
552
|
+
"route": {
|
|
553
|
+
"verb": "POST",
|
|
554
|
+
"path": "/getConfig"
|
|
555
|
+
},
|
|
556
|
+
"task": false
|
|
557
|
+
},
|
|
558
|
+
{
|
|
559
|
+
"name": "getCount",
|
|
560
|
+
"summary": "Gets a device count from the system",
|
|
561
|
+
"description": "Gets a device count from the system",
|
|
562
|
+
"input": [],
|
|
563
|
+
"output": {
|
|
564
|
+
"name": "result",
|
|
565
|
+
"type": "object",
|
|
566
|
+
"description": "A JSON Object containing status, code and the result",
|
|
567
|
+
"schema": {
|
|
568
|
+
"title": "result",
|
|
569
|
+
"type": "object"
|
|
570
|
+
}
|
|
571
|
+
},
|
|
572
|
+
"roles": [
|
|
573
|
+
"admin"
|
|
574
|
+
],
|
|
575
|
+
"route": {
|
|
576
|
+
"verb": "POST",
|
|
577
|
+
"path": "/getCount"
|
|
578
|
+
},
|
|
579
|
+
"task": false
|
|
580
|
+
},
|
|
389
581
|
{
|
|
390
582
|
"name": "getAuthenticatedSession",
|
|
391
583
|
"summary": "Checks if there is an authenticated session",
|
|
@@ -412,12 +604,12 @@
|
|
|
412
604
|
{
|
|
413
605
|
"name": "postAuthenticatedSession",
|
|
414
606
|
"summary": "Creates an authenticated session",
|
|
415
|
-
"description": "
|
|
607
|
+
"description": "Creates an authenticated session. The response returns a cookie in the header called JSESSIONID that must be used in subsequent requests.",
|
|
416
608
|
"input": [
|
|
417
609
|
{
|
|
418
610
|
"name": "credentials",
|
|
419
611
|
"type": "object",
|
|
420
|
-
"info": "
|
|
612
|
+
"info": "Creates an authenticated session. The response returns a cookie in the header called JSESSIONID that must be used in subsequent requests.",
|
|
421
613
|
"required": true,
|
|
422
614
|
"schema": {
|
|
423
615
|
"title": "credentials",
|
|
@@ -446,7 +638,7 @@
|
|
|
446
638
|
{
|
|
447
639
|
"name": "deleteAuthenticatedSession",
|
|
448
640
|
"summary": "Ends an authenticated session",
|
|
449
|
-
"description": "
|
|
641
|
+
"description": "Ends an authenticated session.",
|
|
450
642
|
"input": [],
|
|
451
643
|
"output": {
|
|
452
644
|
"name": "result",
|
|
@@ -469,7 +661,7 @@
|
|
|
469
661
|
{
|
|
470
662
|
"name": "getAuditReport",
|
|
471
663
|
"summary": "This endpoint is deprecated, use GET /auditlogEntryReport",
|
|
472
|
-
"description": "
|
|
664
|
+
"description": "Note: GET /auditReport is deprecated, use GET /auditlogEntryReport.",
|
|
473
665
|
"input": [],
|
|
474
666
|
"output": {
|
|
475
667
|
"name": "result",
|
|
@@ -492,7 +684,7 @@
|
|
|
492
684
|
{
|
|
493
685
|
"name": "postAuditReport",
|
|
494
686
|
"summary": "This endpoint is deprecated, use POST /auditlogEntryReport",
|
|
495
|
-
"description": "
|
|
687
|
+
"description": "Note: POST /auditReport is deprecated, use POST /auditlogEntryReport.",
|
|
496
688
|
"input": [],
|
|
497
689
|
"output": {
|
|
498
690
|
"name": "result",
|
|
@@ -515,7 +707,7 @@
|
|
|
515
707
|
{
|
|
516
708
|
"name": "deleteAuditReport",
|
|
517
709
|
"summary": "This endpoint is deprecated, use DELETE /auditlogEntryReport",
|
|
518
|
-
"description": "
|
|
710
|
+
"description": "Note: DELETE /auditReport is deprecated, use DELETE /auditlogEntryReport.",
|
|
519
711
|
"input": [],
|
|
520
712
|
"output": {
|
|
521
713
|
"name": "result",
|
|
@@ -538,7 +730,7 @@
|
|
|
538
730
|
{
|
|
539
731
|
"name": "getAuditReportdownload",
|
|
540
732
|
"summary": "This endpoint is deprecated, use GET /auditlogEntryReport/download",
|
|
541
|
-
"description": "
|
|
733
|
+
"description": "Note: GET /auditReport is deprecated, use GET /auditlogEntryReport/download.",
|
|
542
734
|
"input": [],
|
|
543
735
|
"output": {
|
|
544
736
|
"name": "result",
|
|
@@ -561,7 +753,7 @@
|
|
|
561
753
|
{
|
|
562
754
|
"name": "getAuditlogEntryReport",
|
|
563
755
|
"summary": "Gets the status of a request for an audit log report",
|
|
564
|
-
"description": "
|
|
756
|
+
"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
757
|
"input": [],
|
|
566
758
|
"output": {
|
|
567
759
|
"name": "result",
|
|
@@ -584,12 +776,12 @@
|
|
|
584
776
|
{
|
|
585
777
|
"name": "postAuditlogEntryReport",
|
|
586
778
|
"summary": "Creates an audit log report for the specified time period and saves it as a CSV file",
|
|
587
|
-
"description": "
|
|
779
|
+
"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
780
|
"input": [
|
|
589
781
|
{
|
|
590
782
|
"name": "request",
|
|
591
783
|
"type": "object",
|
|
592
|
-
"info": "
|
|
784
|
+
"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
785
|
"required": false,
|
|
594
786
|
"schema": {
|
|
595
787
|
"title": "request",
|
|
@@ -618,7 +810,7 @@
|
|
|
618
810
|
{
|
|
619
811
|
"name": "deleteAuditlogEntryReport",
|
|
620
812
|
"summary": "Cancels the request to create an audit log report",
|
|
621
|
-
"description": "
|
|
813
|
+
"description": "Cancels the request to create an audit log report.",
|
|
622
814
|
"input": [],
|
|
623
815
|
"output": {
|
|
624
816
|
"name": "result",
|
|
@@ -641,7 +833,7 @@
|
|
|
641
833
|
{
|
|
642
834
|
"name": "getAuditlogEntryReportdownload",
|
|
643
835
|
"summary": "Downloads the most recently created audit log report",
|
|
644
|
-
"description": "
|
|
836
|
+
"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
837
|
"input": [],
|
|
646
838
|
"output": {
|
|
647
839
|
"name": "result",
|
|
@@ -664,7 +856,7 @@
|
|
|
664
856
|
{
|
|
665
857
|
"name": "getDepartments",
|
|
666
858
|
"summary": "Gets a list of departments",
|
|
667
|
-
"description": "
|
|
859
|
+
"description": "Gets a list of departments. The search parameters find matching values within the \"name\" or \"comments\" attributes.",
|
|
668
860
|
"input": [],
|
|
669
861
|
"output": {
|
|
670
862
|
"name": "result",
|
|
@@ -687,12 +879,12 @@
|
|
|
687
879
|
{
|
|
688
880
|
"name": "getDepartmentsid",
|
|
689
881
|
"summary": "Gets the department for the specified ID",
|
|
690
|
-
"description": "
|
|
882
|
+
"description": "Gets the department for the specified ID.",
|
|
691
883
|
"input": [
|
|
692
884
|
{
|
|
693
885
|
"name": "id",
|
|
694
886
|
"type": "number",
|
|
695
|
-
"info": "
|
|
887
|
+
"info": "Gets the department for the specified ID.",
|
|
696
888
|
"required": true,
|
|
697
889
|
"schema": {
|
|
698
890
|
"title": "id",
|
|
@@ -721,12 +913,12 @@
|
|
|
721
913
|
{
|
|
722
914
|
"name": "getGroups",
|
|
723
915
|
"summary": "Gets a list of groups",
|
|
724
|
-
"description": "
|
|
916
|
+
"description": "Gets a list of groups. The search parameters find matching values in the \"name\" and \"comments\" attributes.",
|
|
725
917
|
"input": [
|
|
726
918
|
{
|
|
727
919
|
"name": "search",
|
|
728
920
|
"type": "string",
|
|
729
|
-
"info": "
|
|
921
|
+
"info": "Gets a list of groups. The search parameters find matching values in the \"name\" and \"comments\" attributes.",
|
|
730
922
|
"required": false,
|
|
731
923
|
"schema": {
|
|
732
924
|
"title": "search",
|
|
@@ -736,7 +928,7 @@
|
|
|
736
928
|
{
|
|
737
929
|
"name": "page",
|
|
738
930
|
"type": "number",
|
|
739
|
-
"info": "
|
|
931
|
+
"info": "Gets a list of groups. The search parameters find matching values in the \"name\" and \"comments\" attributes.",
|
|
740
932
|
"required": false,
|
|
741
933
|
"schema": {
|
|
742
934
|
"title": "page",
|
|
@@ -746,7 +938,7 @@
|
|
|
746
938
|
{
|
|
747
939
|
"name": "pageSize",
|
|
748
940
|
"type": "number",
|
|
749
|
-
"info": "
|
|
941
|
+
"info": "Gets a list of groups. The search parameters find matching values in the \"name\" and \"comments\" attributes.",
|
|
750
942
|
"required": false,
|
|
751
943
|
"schema": {
|
|
752
944
|
"title": "pageSize",
|
|
@@ -775,12 +967,12 @@
|
|
|
775
967
|
{
|
|
776
968
|
"name": "getGroupsgroupId",
|
|
777
969
|
"summary": "Gets the group for the specified ID",
|
|
778
|
-
"description": "
|
|
970
|
+
"description": "Gets the group for the specified ID.",
|
|
779
971
|
"input": [
|
|
780
972
|
{
|
|
781
973
|
"name": "groupId",
|
|
782
974
|
"type": "number",
|
|
783
|
-
"info": "
|
|
975
|
+
"info": "Gets the group for the specified ID.",
|
|
784
976
|
"required": true,
|
|
785
977
|
"schema": {
|
|
786
978
|
"title": "groupId",
|
|
@@ -809,12 +1001,12 @@
|
|
|
809
1001
|
{
|
|
810
1002
|
"name": "getUsers",
|
|
811
1003
|
"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>",
|
|
1004
|
+
"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
1005
|
"input": [
|
|
814
1006
|
{
|
|
815
1007
|
"name": "name",
|
|
816
1008
|
"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>",
|
|
1009
|
+
"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
1010
|
"required": false,
|
|
819
1011
|
"schema": {
|
|
820
1012
|
"title": "name",
|
|
@@ -824,7 +1016,7 @@
|
|
|
824
1016
|
{
|
|
825
1017
|
"name": "dept",
|
|
826
1018
|
"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>",
|
|
1019
|
+
"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
1020
|
"required": false,
|
|
829
1021
|
"schema": {
|
|
830
1022
|
"title": "dept",
|
|
@@ -834,7 +1026,7 @@
|
|
|
834
1026
|
{
|
|
835
1027
|
"name": "group",
|
|
836
1028
|
"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>",
|
|
1029
|
+
"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
1030
|
"required": false,
|
|
839
1031
|
"schema": {
|
|
840
1032
|
"title": "group",
|
|
@@ -844,7 +1036,7 @@
|
|
|
844
1036
|
{
|
|
845
1037
|
"name": "page",
|
|
846
1038
|
"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>",
|
|
1039
|
+
"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
1040
|
"required": false,
|
|
849
1041
|
"schema": {
|
|
850
1042
|
"title": "page",
|
|
@@ -854,7 +1046,7 @@
|
|
|
854
1046
|
{
|
|
855
1047
|
"name": "pageSize",
|
|
856
1048
|
"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>",
|
|
1049
|
+
"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
1050
|
"required": false,
|
|
859
1051
|
"schema": {
|
|
860
1052
|
"title": "pageSize",
|
|
@@ -883,12 +1075,12 @@
|
|
|
883
1075
|
{
|
|
884
1076
|
"name": "postUsers",
|
|
885
1077
|
"summary": "Adds a new user",
|
|
886
|
-
"description": "
|
|
1078
|
+
"description": "Adds a new user. A user can belong to multiple groups, but can only belong to one department.",
|
|
887
1079
|
"input": [
|
|
888
1080
|
{
|
|
889
1081
|
"name": "user",
|
|
890
1082
|
"type": "object",
|
|
891
|
-
"info": "
|
|
1083
|
+
"info": "Adds a new user. A user can belong to multiple groups, but can only belong to one department.",
|
|
892
1084
|
"required": false,
|
|
893
1085
|
"schema": {
|
|
894
1086
|
"title": "user",
|
|
@@ -917,12 +1109,12 @@
|
|
|
917
1109
|
{
|
|
918
1110
|
"name": "postUsersbulkDelete",
|
|
919
1111
|
"summary": "Bulk delete users up to a maximum of 500 users per request",
|
|
920
|
-
"description": "
|
|
1112
|
+
"description": "Bulk delete users up to a maximum of 500 users per request. The response returns the user IDs that were successfully deleted.",
|
|
921
1113
|
"input": [
|
|
922
1114
|
{
|
|
923
1115
|
"name": "userIds",
|
|
924
1116
|
"type": "object",
|
|
925
|
-
"info": "
|
|
1117
|
+
"info": "Bulk delete users up to a maximum of 500 users per request. The response returns the user IDs that were successfully deleted.",
|
|
926
1118
|
"required": false,
|
|
927
1119
|
"schema": {
|
|
928
1120
|
"title": "userIds",
|
|
@@ -951,12 +1143,12 @@
|
|
|
951
1143
|
{
|
|
952
1144
|
"name": "getUsersuserId",
|
|
953
1145
|
"summary": "Gets the user information for the specified ID",
|
|
954
|
-
"description": "
|
|
1146
|
+
"description": "Gets the user information for the specified ID.",
|
|
955
1147
|
"input": [
|
|
956
1148
|
{
|
|
957
1149
|
"name": "userId",
|
|
958
1150
|
"type": "number",
|
|
959
|
-
"info": "
|
|
1151
|
+
"info": "Gets the user information for the specified ID.",
|
|
960
1152
|
"required": true,
|
|
961
1153
|
"schema": {
|
|
962
1154
|
"title": "userId",
|
|
@@ -985,12 +1177,12 @@
|
|
|
985
1177
|
{
|
|
986
1178
|
"name": "putUsersuserId",
|
|
987
1179
|
"summary": "Updates the user information for the specified ID",
|
|
988
|
-
"description": "
|
|
1180
|
+
"description": "Updates the user information for the specified ID. However, the \"email\" attribute is read-only.",
|
|
989
1181
|
"input": [
|
|
990
1182
|
{
|
|
991
1183
|
"name": "userId",
|
|
992
1184
|
"type": "number",
|
|
993
|
-
"info": "
|
|
1185
|
+
"info": "Updates the user information for the specified ID. However, the \"email\" attribute is read-only.",
|
|
994
1186
|
"required": true,
|
|
995
1187
|
"schema": {
|
|
996
1188
|
"title": "userId",
|
|
@@ -1000,7 +1192,7 @@
|
|
|
1000
1192
|
{
|
|
1001
1193
|
"name": "user",
|
|
1002
1194
|
"type": "object",
|
|
1003
|
-
"info": "
|
|
1195
|
+
"info": "Updates the user information for the specified ID. However, the \"email\" attribute is read-only.",
|
|
1004
1196
|
"required": false,
|
|
1005
1197
|
"schema": {
|
|
1006
1198
|
"title": "user",
|
|
@@ -1029,12 +1221,12 @@
|
|
|
1029
1221
|
{
|
|
1030
1222
|
"name": "deleteUsersuserId",
|
|
1031
1223
|
"summary": "Deletes the user for the specified ID",
|
|
1032
|
-
"description": "
|
|
1224
|
+
"description": "Deletes the user for the specified ID.",
|
|
1033
1225
|
"input": [
|
|
1034
1226
|
{
|
|
1035
1227
|
"name": "userId",
|
|
1036
1228
|
"type": "number",
|
|
1037
|
-
"info": "
|
|
1229
|
+
"info": "Deletes the user for the specified ID.",
|
|
1038
1230
|
"required": true,
|
|
1039
1231
|
"schema": {
|
|
1040
1232
|
"title": "userId",
|
|
@@ -1063,7 +1255,7 @@
|
|
|
1063
1255
|
{
|
|
1064
1256
|
"name": "getSecurity",
|
|
1065
1257
|
"summary": "Gets a list of white-listed URLs",
|
|
1066
|
-
"description": "
|
|
1258
|
+
"description": "Gets a list of white-listed URLs",
|
|
1067
1259
|
"input": [],
|
|
1068
1260
|
"output": {
|
|
1069
1261
|
"name": "result",
|
|
@@ -1086,12 +1278,12 @@
|
|
|
1086
1278
|
{
|
|
1087
1279
|
"name": "putSecurity",
|
|
1088
1280
|
"summary": "Updates the list of white-listed URLs",
|
|
1089
|
-
"description": "
|
|
1281
|
+
"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
1282
|
"input": [
|
|
1091
1283
|
{
|
|
1092
1284
|
"name": "policy",
|
|
1093
1285
|
"type": "object",
|
|
1094
|
-
"info": "
|
|
1286
|
+
"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
1287
|
"required": false,
|
|
1096
1288
|
"schema": {
|
|
1097
1289
|
"title": "policy",
|
|
@@ -1120,7 +1312,7 @@
|
|
|
1120
1312
|
{
|
|
1121
1313
|
"name": "getSecurityadvanced",
|
|
1122
1314
|
"summary": "Gets a list of black-listed URLs",
|
|
1123
|
-
"description": "
|
|
1315
|
+
"description": "Gets a list of black-listed URLs.",
|
|
1124
1316
|
"input": [],
|
|
1125
1317
|
"output": {
|
|
1126
1318
|
"name": "result",
|
|
@@ -1143,12 +1335,12 @@
|
|
|
1143
1335
|
{
|
|
1144
1336
|
"name": "putSecurityadvanced",
|
|
1145
1337
|
"summary": "Updates the list of black-listed URLs",
|
|
1146
|
-
"description": "
|
|
1338
|
+
"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
1339
|
"input": [
|
|
1148
1340
|
{
|
|
1149
1341
|
"name": "advSettings",
|
|
1150
1342
|
"type": "object",
|
|
1151
|
-
"info": "
|
|
1343
|
+
"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
1344
|
"required": false,
|
|
1153
1345
|
"schema": {
|
|
1154
1346
|
"title": "advSettings",
|
|
@@ -1177,12 +1369,12 @@
|
|
|
1177
1369
|
{
|
|
1178
1370
|
"name": "postSecurityadvancedblacklistUrls",
|
|
1179
1371
|
"summary": "Adds a URL to or removes a URL from the black list",
|
|
1180
|
-
"description": "
|
|
1372
|
+
"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
1373
|
"input": [
|
|
1182
1374
|
{
|
|
1183
1375
|
"name": "action",
|
|
1184
1376
|
"type": "string",
|
|
1185
|
-
"info": "
|
|
1377
|
+
"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
1378
|
"required": true,
|
|
1187
1379
|
"schema": {
|
|
1188
1380
|
"title": "action",
|
|
@@ -1211,7 +1403,7 @@
|
|
|
1211
1403
|
{
|
|
1212
1404
|
"name": "deleteSslSettingscertchain",
|
|
1213
1405
|
"summary": "Deletes the intermediate certificate chain",
|
|
1214
|
-
"description": "
|
|
1406
|
+
"description": "Deletes the intermediate certificate chain.",
|
|
1215
1407
|
"input": [],
|
|
1216
1408
|
"output": {
|
|
1217
1409
|
"name": "result",
|
|
@@ -1234,7 +1426,7 @@
|
|
|
1234
1426
|
{
|
|
1235
1427
|
"name": "getSslSettingsdownloadcsr",
|
|
1236
1428
|
"summary": "Downloads a Certificate Signing Request (CSR)",
|
|
1237
|
-
"description": "
|
|
1429
|
+
"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
1430
|
"input": [],
|
|
1239
1431
|
"output": {
|
|
1240
1432
|
"name": "result",
|
|
@@ -1257,12 +1449,12 @@
|
|
|
1257
1449
|
{
|
|
1258
1450
|
"name": "postSslSettingsgeneratecsr",
|
|
1259
1451
|
"summary": "Generates a Certificate Signing Request (CSR)",
|
|
1260
|
-
"description": "
|
|
1452
|
+
"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
1453
|
"input": [
|
|
1262
1454
|
{
|
|
1263
1455
|
"name": "cert",
|
|
1264
1456
|
"type": "object",
|
|
1265
|
-
"info": "
|
|
1457
|
+
"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
1458
|
"required": true,
|
|
1267
1459
|
"schema": {
|
|
1268
1460
|
"title": "cert",
|
|
@@ -1291,7 +1483,7 @@
|
|
|
1291
1483
|
{
|
|
1292
1484
|
"name": "getSslSettingsshowcert",
|
|
1293
1485
|
"summary": "Shows information about the signed intermediate root certificate",
|
|
1294
|
-
"description": "
|
|
1486
|
+
"description": "Shows information about the signed intermediate root certificate.",
|
|
1295
1487
|
"input": [],
|
|
1296
1488
|
"output": {
|
|
1297
1489
|
"name": "result",
|
|
@@ -1314,12 +1506,12 @@
|
|
|
1314
1506
|
{
|
|
1315
1507
|
"name": "postSslSettingsuploadcerttext",
|
|
1316
1508
|
"summary": "Uploads a signed intermediate root certificate for clients that use iframe-based uploads whose content type is text/plain",
|
|
1317
|
-
"description": "
|
|
1509
|
+
"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
1510
|
"input": [
|
|
1319
1511
|
{
|
|
1320
1512
|
"name": "fileInputStream",
|
|
1321
1513
|
"type": "object",
|
|
1322
|
-
"info": "
|
|
1514
|
+
"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
1515
|
"required": false,
|
|
1324
1516
|
"schema": {
|
|
1325
1517
|
"title": "fileInputStream",
|
|
@@ -1348,12 +1540,12 @@
|
|
|
1348
1540
|
{
|
|
1349
1541
|
"name": "postSslSettingsuploadcertchaintext",
|
|
1350
1542
|
"summary": "Uploads the Intermediate Certificate Chain (PEM) for clients that use iframe-based uploads whose content type is text/plain",
|
|
1351
|
-
"description": "
|
|
1543
|
+
"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
1544
|
"input": [
|
|
1353
1545
|
{
|
|
1354
1546
|
"name": "fileInputStream",
|
|
1355
1547
|
"type": "object",
|
|
1356
|
-
"info": "
|
|
1548
|
+
"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
1549
|
"required": false,
|
|
1358
1550
|
"schema": {
|
|
1359
1551
|
"title": "fileInputStream",
|
|
@@ -1382,12 +1574,12 @@
|
|
|
1382
1574
|
{
|
|
1383
1575
|
"name": "getUrlCategories",
|
|
1384
1576
|
"summary": "Gets information about all or custom URL categories",
|
|
1385
|
-
"description": "
|
|
1577
|
+
"description": "Gets information about all or custom URL categories.",
|
|
1386
1578
|
"input": [
|
|
1387
1579
|
{
|
|
1388
1580
|
"name": "customOnly",
|
|
1389
1581
|
"type": "boolean",
|
|
1390
|
-
"info": "
|
|
1582
|
+
"info": "Gets information about all or custom URL categories.",
|
|
1391
1583
|
"required": false,
|
|
1392
1584
|
"schema": {
|
|
1393
1585
|
"title": "customOnly",
|
|
@@ -1416,12 +1608,12 @@
|
|
|
1416
1608
|
{
|
|
1417
1609
|
"name": "postUrlCategories",
|
|
1418
1610
|
"summary": "Adds a new custom URL category",
|
|
1419
|
-
"description": "
|
|
1611
|
+
"description": "Adds a new custom URL category.",
|
|
1420
1612
|
"input": [
|
|
1421
1613
|
{
|
|
1422
1614
|
"name": "customCategory",
|
|
1423
1615
|
"type": "object",
|
|
1424
|
-
"info": "
|
|
1616
|
+
"info": "Adds a new custom URL category.",
|
|
1425
1617
|
"required": false,
|
|
1426
1618
|
"schema": {
|
|
1427
1619
|
"title": "customCategory",
|
|
@@ -1450,7 +1642,7 @@
|
|
|
1450
1642
|
{
|
|
1451
1643
|
"name": "getUrlCategorieslite",
|
|
1452
1644
|
"summary": "Gets a lightweight key-value list of all or custom URL categories",
|
|
1453
|
-
"description": "
|
|
1645
|
+
"description": "Gets a lightweight key-value list of all or custom URL categories.",
|
|
1454
1646
|
"input": [],
|
|
1455
1647
|
"output": {
|
|
1456
1648
|
"name": "result",
|
|
@@ -1473,7 +1665,7 @@
|
|
|
1473
1665
|
{
|
|
1474
1666
|
"name": "getUrlCategoriesurlQuota",
|
|
1475
1667
|
"summary": "Gets the URL quota information for your organization",
|
|
1476
|
-
"description": "
|
|
1668
|
+
"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
1669
|
"input": [],
|
|
1478
1670
|
"output": {
|
|
1479
1671
|
"name": "result",
|
|
@@ -1496,12 +1688,12 @@
|
|
|
1496
1688
|
{
|
|
1497
1689
|
"name": "getUrlCategoriescategoryId",
|
|
1498
1690
|
"summary": "Gets the URL category information for the specified ID",
|
|
1499
|
-
"description": "
|
|
1691
|
+
"description": "Gets the URL category information for the specified ID.",
|
|
1500
1692
|
"input": [
|
|
1501
1693
|
{
|
|
1502
1694
|
"name": "categoryId",
|
|
1503
1695
|
"type": "string",
|
|
1504
|
-
"info": "
|
|
1696
|
+
"info": "Gets the URL category information for the specified ID.",
|
|
1505
1697
|
"required": true,
|
|
1506
1698
|
"schema": {
|
|
1507
1699
|
"title": "categoryId",
|
|
@@ -1530,12 +1722,12 @@
|
|
|
1530
1722
|
{
|
|
1531
1723
|
"name": "putUrlCategoriescategoryId",
|
|
1532
1724
|
"summary": "Updates the URL category for the specified ID",
|
|
1533
|
-
"description": "
|
|
1725
|
+
"description": "Updates the URL category for the specified ID.",
|
|
1534
1726
|
"input": [
|
|
1535
1727
|
{
|
|
1536
1728
|
"name": "categoryId",
|
|
1537
1729
|
"type": "string",
|
|
1538
|
-
"info": "
|
|
1730
|
+
"info": "Updates the URL category for the specified ID.",
|
|
1539
1731
|
"required": true,
|
|
1540
1732
|
"schema": {
|
|
1541
1733
|
"title": "categoryId",
|
|
@@ -1545,7 +1737,7 @@
|
|
|
1545
1737
|
{
|
|
1546
1738
|
"name": "action",
|
|
1547
1739
|
"type": "string",
|
|
1548
|
-
"info": "
|
|
1740
|
+
"info": "Updates the URL category for the specified ID.",
|
|
1549
1741
|
"required": false,
|
|
1550
1742
|
"schema": {
|
|
1551
1743
|
"title": "action",
|
|
@@ -1555,7 +1747,7 @@
|
|
|
1555
1747
|
{
|
|
1556
1748
|
"name": "customCategory",
|
|
1557
1749
|
"type": "object",
|
|
1558
|
-
"info": "
|
|
1750
|
+
"info": "Updates the URL category for the specified ID.",
|
|
1559
1751
|
"required": false,
|
|
1560
1752
|
"schema": {
|
|
1561
1753
|
"title": "customCategory",
|
|
@@ -1584,12 +1776,12 @@
|
|
|
1584
1776
|
{
|
|
1585
1777
|
"name": "deleteUrlCategoriescategoryId",
|
|
1586
1778
|
"summary": "Deletes the custom URL category for the specified ID",
|
|
1587
|
-
"description": "
|
|
1779
|
+
"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
1780
|
"input": [
|
|
1589
1781
|
{
|
|
1590
1782
|
"name": "categoryId",
|
|
1591
1783
|
"type": "string",
|
|
1592
|
-
"info": "
|
|
1784
|
+
"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
1785
|
"required": true,
|
|
1594
1786
|
"schema": {
|
|
1595
1787
|
"title": "categoryId",
|
|
@@ -1618,12 +1810,12 @@
|
|
|
1618
1810
|
{
|
|
1619
1811
|
"name": "postUrlLookup",
|
|
1620
1812
|
"summary": "Look up the categorization of the given set of URLs, e.g., ['abc.com', 'xyz.com']",
|
|
1621
|
-
"description": "
|
|
1813
|
+
"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
1814
|
"input": [
|
|
1623
1815
|
{
|
|
1624
1816
|
"name": "urls",
|
|
1625
1817
|
"type": "array",
|
|
1626
|
-
"info": "
|
|
1818
|
+
"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
1819
|
"required": false,
|
|
1628
1820
|
"schema": {
|
|
1629
1821
|
"title": "urls",
|
|
@@ -1652,12 +1844,12 @@
|
|
|
1652
1844
|
{
|
|
1653
1845
|
"name": "getVpnCredentials",
|
|
1654
1846
|
"summary": "Gets VPN credentials that can be associated to locations",
|
|
1655
|
-
"description": "
|
|
1847
|
+
"description": "Gets VPN credentials that can be associated to locations.",
|
|
1656
1848
|
"input": [
|
|
1657
1849
|
{
|
|
1658
1850
|
"name": "search",
|
|
1659
1851
|
"type": "string",
|
|
1660
|
-
"info": "
|
|
1852
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1661
1853
|
"required": false,
|
|
1662
1854
|
"schema": {
|
|
1663
1855
|
"title": "search",
|
|
@@ -1667,7 +1859,7 @@
|
|
|
1667
1859
|
{
|
|
1668
1860
|
"name": "type",
|
|
1669
1861
|
"type": "string",
|
|
1670
|
-
"info": "
|
|
1862
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1671
1863
|
"required": false,
|
|
1672
1864
|
"schema": {
|
|
1673
1865
|
"title": "type",
|
|
@@ -1677,7 +1869,7 @@
|
|
|
1677
1869
|
{
|
|
1678
1870
|
"name": "includeOnlyWithoutLocation",
|
|
1679
1871
|
"type": "boolean",
|
|
1680
|
-
"info": "
|
|
1872
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1681
1873
|
"required": false,
|
|
1682
1874
|
"schema": {
|
|
1683
1875
|
"title": "includeOnlyWithoutLocation",
|
|
@@ -1687,7 +1879,7 @@
|
|
|
1687
1879
|
{
|
|
1688
1880
|
"name": "locationId",
|
|
1689
1881
|
"type": "number",
|
|
1690
|
-
"info": "
|
|
1882
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1691
1883
|
"required": false,
|
|
1692
1884
|
"schema": {
|
|
1693
1885
|
"title": "locationId",
|
|
@@ -1697,7 +1889,7 @@
|
|
|
1697
1889
|
{
|
|
1698
1890
|
"name": "managedBy",
|
|
1699
1891
|
"type": "number",
|
|
1700
|
-
"info": "
|
|
1892
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1701
1893
|
"required": false,
|
|
1702
1894
|
"schema": {
|
|
1703
1895
|
"title": "managedBy",
|
|
@@ -1707,7 +1899,7 @@
|
|
|
1707
1899
|
{
|
|
1708
1900
|
"name": "page",
|
|
1709
1901
|
"type": "number",
|
|
1710
|
-
"info": "
|
|
1902
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1711
1903
|
"required": false,
|
|
1712
1904
|
"schema": {
|
|
1713
1905
|
"title": "page",
|
|
@@ -1717,7 +1909,7 @@
|
|
|
1717
1909
|
{
|
|
1718
1910
|
"name": "pageSize",
|
|
1719
1911
|
"type": "number",
|
|
1720
|
-
"info": "
|
|
1912
|
+
"info": "Gets VPN credentials that can be associated to locations.",
|
|
1721
1913
|
"required": false,
|
|
1722
1914
|
"schema": {
|
|
1723
1915
|
"title": "pageSize",
|
|
@@ -1746,12 +1938,12 @@
|
|
|
1746
1938
|
{
|
|
1747
1939
|
"name": "postVpnCredentials",
|
|
1748
1940
|
"summary": "Adds VPN credentials that can be associated to locations",
|
|
1749
|
-
"description": "
|
|
1941
|
+
"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
1942
|
"input": [
|
|
1751
1943
|
{
|
|
1752
1944
|
"name": "vpnCred",
|
|
1753
1945
|
"type": "object",
|
|
1754
|
-
"info": "
|
|
1946
|
+
"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
1947
|
"required": false,
|
|
1756
1948
|
"schema": {
|
|
1757
1949
|
"title": "vpnCred",
|
|
@@ -1780,12 +1972,12 @@
|
|
|
1780
1972
|
{
|
|
1781
1973
|
"name": "postVpnCredentialsbulkDelete",
|
|
1782
1974
|
"summary": "Bulk delete VPN credentials up to a maximum of 100 credentials per request",
|
|
1783
|
-
"description": "
|
|
1975
|
+
"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
1976
|
"input": [
|
|
1785
1977
|
{
|
|
1786
1978
|
"name": "ids",
|
|
1787
1979
|
"type": "object",
|
|
1788
|
-
"info": "
|
|
1980
|
+
"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
1981
|
"required": false,
|
|
1790
1982
|
"schema": {
|
|
1791
1983
|
"title": "ids",
|
|
@@ -1814,12 +2006,12 @@
|
|
|
1814
2006
|
{
|
|
1815
2007
|
"name": "getVpnCredentialsvpnId",
|
|
1816
2008
|
"summary": "Gets the VPN credentials for the specified ID",
|
|
1817
|
-
"description": "
|
|
2009
|
+
"description": "Gets the VPN credentials for the specified ID.",
|
|
1818
2010
|
"input": [
|
|
1819
2011
|
{
|
|
1820
2012
|
"name": "vpnId",
|
|
1821
2013
|
"type": "number",
|
|
1822
|
-
"info": "
|
|
2014
|
+
"info": "Gets the VPN credentials for the specified ID.",
|
|
1823
2015
|
"required": true,
|
|
1824
2016
|
"schema": {
|
|
1825
2017
|
"title": "vpnId",
|
|
@@ -1848,12 +2040,12 @@
|
|
|
1848
2040
|
{
|
|
1849
2041
|
"name": "putVpnCredentialsvpnId",
|
|
1850
2042
|
"summary": "Updates the VPN credentials for the specified ID",
|
|
1851
|
-
"description": "
|
|
2043
|
+
"description": "Updates the VPN credentials for the specified ID.",
|
|
1852
2044
|
"input": [
|
|
1853
2045
|
{
|
|
1854
2046
|
"name": "vpnId",
|
|
1855
2047
|
"type": "number",
|
|
1856
|
-
"info": "
|
|
2048
|
+
"info": "Updates the VPN credentials for the specified ID.",
|
|
1857
2049
|
"required": true,
|
|
1858
2050
|
"schema": {
|
|
1859
2051
|
"title": "vpnId",
|
|
@@ -1863,7 +2055,7 @@
|
|
|
1863
2055
|
{
|
|
1864
2056
|
"name": "vpnCred",
|
|
1865
2057
|
"type": "object",
|
|
1866
|
-
"info": "
|
|
2058
|
+
"info": "Updates the VPN credentials for the specified ID.",
|
|
1867
2059
|
"required": false,
|
|
1868
2060
|
"schema": {
|
|
1869
2061
|
"title": "vpnCred",
|
|
@@ -1892,12 +2084,12 @@
|
|
|
1892
2084
|
{
|
|
1893
2085
|
"name": "deleteVpnCredentialsvpnId",
|
|
1894
2086
|
"summary": "Deletes the VPN credentials for the specified ID",
|
|
1895
|
-
"description": "
|
|
2087
|
+
"description": "Deletes the VPN credentials for the specified ID.",
|
|
1896
2088
|
"input": [
|
|
1897
2089
|
{
|
|
1898
2090
|
"name": "vpnId",
|
|
1899
2091
|
"type": "number",
|
|
1900
|
-
"info": "
|
|
2092
|
+
"info": "Deletes the VPN credentials for the specified ID.",
|
|
1901
2093
|
"required": true,
|
|
1902
2094
|
"schema": {
|
|
1903
2095
|
"title": "vpnId",
|
|
@@ -1926,12 +2118,12 @@
|
|
|
1926
2118
|
{
|
|
1927
2119
|
"name": "getLocations",
|
|
1928
2120
|
"summary": "Gets information on locations",
|
|
1929
|
-
"description": "
|
|
2121
|
+
"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
2122
|
"input": [
|
|
1931
2123
|
{
|
|
1932
2124
|
"name": "search",
|
|
1933
2125
|
"type": "string",
|
|
1934
|
-
"info": "
|
|
2126
|
+
"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
2127
|
"required": false,
|
|
1936
2128
|
"schema": {
|
|
1937
2129
|
"title": "search",
|
|
@@ -1941,7 +2133,7 @@
|
|
|
1941
2133
|
{
|
|
1942
2134
|
"name": "sslScanEnabled",
|
|
1943
2135
|
"type": "boolean",
|
|
1944
|
-
"info": "
|
|
2136
|
+
"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
2137
|
"required": false,
|
|
1946
2138
|
"schema": {
|
|
1947
2139
|
"title": "sslScanEnabled",
|
|
@@ -1951,7 +2143,7 @@
|
|
|
1951
2143
|
{
|
|
1952
2144
|
"name": "xffEnabled",
|
|
1953
2145
|
"type": "boolean",
|
|
1954
|
-
"info": "
|
|
2146
|
+
"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
2147
|
"required": false,
|
|
1956
2148
|
"schema": {
|
|
1957
2149
|
"title": "xffEnabled",
|
|
@@ -1961,7 +2153,7 @@
|
|
|
1961
2153
|
{
|
|
1962
2154
|
"name": "authRequired",
|
|
1963
2155
|
"type": "boolean",
|
|
1964
|
-
"info": "
|
|
2156
|
+
"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
2157
|
"required": false,
|
|
1966
2158
|
"schema": {
|
|
1967
2159
|
"title": "authRequired",
|
|
@@ -1971,7 +2163,7 @@
|
|
|
1971
2163
|
{
|
|
1972
2164
|
"name": "bwEnforced",
|
|
1973
2165
|
"type": "boolean",
|
|
1974
|
-
"info": "
|
|
2166
|
+
"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
2167
|
"required": false,
|
|
1976
2168
|
"schema": {
|
|
1977
2169
|
"title": "bwEnforced",
|
|
@@ -1981,7 +2173,7 @@
|
|
|
1981
2173
|
{
|
|
1982
2174
|
"name": "page",
|
|
1983
2175
|
"type": "number",
|
|
1984
|
-
"info": "
|
|
2176
|
+
"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
2177
|
"required": false,
|
|
1986
2178
|
"schema": {
|
|
1987
2179
|
"title": "page",
|
|
@@ -1991,7 +2183,7 @@
|
|
|
1991
2183
|
{
|
|
1992
2184
|
"name": "pageSize",
|
|
1993
2185
|
"type": "number",
|
|
1994
|
-
"info": "
|
|
2186
|
+
"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
2187
|
"required": false,
|
|
1996
2188
|
"schema": {
|
|
1997
2189
|
"title": "pageSize",
|
|
@@ -2020,12 +2212,12 @@
|
|
|
2020
2212
|
{
|
|
2021
2213
|
"name": "postLocations",
|
|
2022
2214
|
"summary": "Adds a new location",
|
|
2023
|
-
"description": "
|
|
2215
|
+
"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
2216
|
"input": [
|
|
2025
2217
|
{
|
|
2026
2218
|
"name": "location",
|
|
2027
2219
|
"type": "object",
|
|
2028
|
-
"info": "
|
|
2220
|
+
"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
2221
|
"required": false,
|
|
2030
2222
|
"schema": {
|
|
2031
2223
|
"title": "location",
|
|
@@ -2054,12 +2246,12 @@
|
|
|
2054
2246
|
{
|
|
2055
2247
|
"name": "postLocationsbulkDelete",
|
|
2056
2248
|
"summary": "Bulk delete locations up to a maximum of 100 locations per request",
|
|
2057
|
-
"description": "
|
|
2249
|
+
"description": "Bulk delete locations up to a maximum of 100 users per request. The response returns the location IDs that were successfully deleted.",
|
|
2058
2250
|
"input": [
|
|
2059
2251
|
{
|
|
2060
2252
|
"name": "LocationIds",
|
|
2061
2253
|
"type": "object",
|
|
2062
|
-
"info": "
|
|
2254
|
+
"info": "Bulk delete locations up to a maximum of 100 users per request. The response returns the location IDs that were successfully deleted.",
|
|
2063
2255
|
"required": false,
|
|
2064
2256
|
"schema": {
|
|
2065
2257
|
"title": "LocationIds",
|
|
@@ -2088,12 +2280,12 @@
|
|
|
2088
2280
|
{
|
|
2089
2281
|
"name": "getLocationslite",
|
|
2090
2282
|
"summary": "Gets a lightweight list of locations",
|
|
2091
|
-
"description": "
|
|
2283
|
+
"description": "Gets a lightweight list of locations.",
|
|
2092
2284
|
"input": [
|
|
2093
2285
|
{
|
|
2094
2286
|
"name": "sslScanEnabled",
|
|
2095
2287
|
"type": "boolean",
|
|
2096
|
-
"info": "
|
|
2288
|
+
"info": "Gets a lightweight list of locations.",
|
|
2097
2289
|
"required": false,
|
|
2098
2290
|
"schema": {
|
|
2099
2291
|
"title": "sslScanEnabled",
|
|
@@ -2103,7 +2295,7 @@
|
|
|
2103
2295
|
{
|
|
2104
2296
|
"name": "search",
|
|
2105
2297
|
"type": "string",
|
|
2106
|
-
"info": "
|
|
2298
|
+
"info": "Gets a lightweight list of locations.",
|
|
2107
2299
|
"required": false,
|
|
2108
2300
|
"schema": {
|
|
2109
2301
|
"title": "search",
|
|
@@ -2113,7 +2305,7 @@
|
|
|
2113
2305
|
{
|
|
2114
2306
|
"name": "page",
|
|
2115
2307
|
"type": "number",
|
|
2116
|
-
"info": "
|
|
2308
|
+
"info": "Gets a lightweight list of locations.",
|
|
2117
2309
|
"required": false,
|
|
2118
2310
|
"schema": {
|
|
2119
2311
|
"title": "page",
|
|
@@ -2123,7 +2315,7 @@
|
|
|
2123
2315
|
{
|
|
2124
2316
|
"name": "pageSize",
|
|
2125
2317
|
"type": "number",
|
|
2126
|
-
"info": "
|
|
2318
|
+
"info": "Gets a lightweight list of locations.",
|
|
2127
2319
|
"required": false,
|
|
2128
2320
|
"schema": {
|
|
2129
2321
|
"title": "pageSize",
|
|
@@ -2152,12 +2344,12 @@
|
|
|
2152
2344
|
{
|
|
2153
2345
|
"name": "getLocationslocationId",
|
|
2154
2346
|
"summary": "Gets the location information for the specified ID",
|
|
2155
|
-
"description": "
|
|
2347
|
+
"description": "Gets the location information for the specified ID.",
|
|
2156
2348
|
"input": [
|
|
2157
2349
|
{
|
|
2158
2350
|
"name": "locationId",
|
|
2159
2351
|
"type": "number",
|
|
2160
|
-
"info": "
|
|
2352
|
+
"info": "Gets the location information for the specified ID.",
|
|
2161
2353
|
"required": true,
|
|
2162
2354
|
"schema": {
|
|
2163
2355
|
"title": "locationId",
|
|
@@ -2186,12 +2378,12 @@
|
|
|
2186
2378
|
{
|
|
2187
2379
|
"name": "putLocationslocationId",
|
|
2188
2380
|
"summary": "Updates the location information for the specified ID",
|
|
2189
|
-
"description": "
|
|
2381
|
+
"description": "Updates the location information for the specified ID.",
|
|
2190
2382
|
"input": [
|
|
2191
2383
|
{
|
|
2192
2384
|
"name": "locationId",
|
|
2193
2385
|
"type": "number",
|
|
2194
|
-
"info": "
|
|
2386
|
+
"info": "Updates the location information for the specified ID.",
|
|
2195
2387
|
"required": true,
|
|
2196
2388
|
"schema": {
|
|
2197
2389
|
"title": "locationId",
|
|
@@ -2201,7 +2393,7 @@
|
|
|
2201
2393
|
{
|
|
2202
2394
|
"name": "location",
|
|
2203
2395
|
"type": "object",
|
|
2204
|
-
"info": "
|
|
2396
|
+
"info": "Updates the location information for the specified ID.",
|
|
2205
2397
|
"required": false,
|
|
2206
2398
|
"schema": {
|
|
2207
2399
|
"title": "location",
|
|
@@ -2230,12 +2422,12 @@
|
|
|
2230
2422
|
{
|
|
2231
2423
|
"name": "deleteLocationslocationId",
|
|
2232
2424
|
"summary": "Deletes the location for the specified ID",
|
|
2233
|
-
"description": "
|
|
2425
|
+
"description": "Deletes the location for the specified ID.",
|
|
2234
2426
|
"input": [
|
|
2235
2427
|
{
|
|
2236
2428
|
"name": "locationId",
|
|
2237
2429
|
"type": "number",
|
|
2238
|
-
"info": "
|
|
2430
|
+
"info": "Deletes the location for the specified ID.",
|
|
2239
2431
|
"required": true,
|
|
2240
2432
|
"schema": {
|
|
2241
2433
|
"title": "locationId",
|
|
@@ -2264,7 +2456,7 @@
|
|
|
2264
2456
|
{
|
|
2265
2457
|
"name": "getSandboxreportquota",
|
|
2266
2458
|
"summary": "Gets the Sandbox Report API quota information for your organization",
|
|
2267
|
-
"description": "
|
|
2459
|
+
"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
2460
|
"input": [],
|
|
2269
2461
|
"output": {
|
|
2270
2462
|
"name": "result",
|
|
@@ -2287,12 +2479,12 @@
|
|
|
2287
2479
|
{
|
|
2288
2480
|
"name": "getSandboxreportmd5Hash",
|
|
2289
2481
|
"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": "
|
|
2482
|
+
"description": "Get a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox.",
|
|
2291
2483
|
"input": [
|
|
2292
2484
|
{
|
|
2293
2485
|
"name": "md5Hash",
|
|
2294
2486
|
"type": "string",
|
|
2295
|
-
"info": "
|
|
2487
|
+
"info": "Get a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox.",
|
|
2296
2488
|
"required": true,
|
|
2297
2489
|
"schema": {
|
|
2298
2490
|
"title": "md5Hash",
|
|
@@ -2302,7 +2494,7 @@
|
|
|
2302
2494
|
{
|
|
2303
2495
|
"name": "details",
|
|
2304
2496
|
"type": "string",
|
|
2305
|
-
"info": "
|
|
2497
|
+
"info": "Get a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox.",
|
|
2306
2498
|
"required": false,
|
|
2307
2499
|
"schema": {
|
|
2308
2500
|
"title": "details",
|
|
@@ -2331,7 +2523,7 @@
|
|
|
2331
2523
|
{
|
|
2332
2524
|
"name": "getStatus",
|
|
2333
2525
|
"summary": "Gets the activation status for a configuration change",
|
|
2334
|
-
"description": "
|
|
2526
|
+
"description": "Gets the activation status for a configuration change.",
|
|
2335
2527
|
"input": [],
|
|
2336
2528
|
"output": {
|
|
2337
2529
|
"name": "result",
|
|
@@ -2354,7 +2546,7 @@
|
|
|
2354
2546
|
{
|
|
2355
2547
|
"name": "postStatusactivate",
|
|
2356
2548
|
"summary": "Activates configuration changes",
|
|
2357
|
-
"description": "
|
|
2549
|
+
"description": "Activates configuration changes.",
|
|
2358
2550
|
"input": [],
|
|
2359
2551
|
"output": {
|
|
2360
2552
|
"name": "result",
|