@itentialopensource/adapter-algosec_firewall 0.1.1 → 0.1.2

package/CALLS.md

@@ -166,5 +166,1086 @@ Specific adapter calls are built based on the API of the Algosec_firewall. The A
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
   </tr>
+  <tr>
+    <td style="padding:15px">getDevicesUsingGET1(domain, includeBlueCoat, onlyFireflowSupportedDevices, callback)</td>
+    <td style="padding:15px">Get a list of devices and policy details, with options to include only FireFlow-supported devices, and to exclude Symantec Blue Coat devices.</td>
+    <td style="padding:15px">{base_path}/{version}/allowedDevices?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDevicesByPolicyUsingPOST(policy, callback)</td>
+    <td style="padding:15px">Get devices configured with the provided policy</td>
+    <td style="padding:15px">{base_path}/{version}/deviceByPolicy?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDevicesByPolicyGroupsUsingPOST(anyPolicy, data, callback)</td>
+    <td style="padding:15px">Get a list of devices that match the defined policy group</td>
+    <td style="padding:15px">{base_path}/{version}/deviceByPolicyGroup?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getNumberOfDevicesSharingPolicyUsingGET(deviceDomain, parent, policy, callback)</td>
+    <td style="padding:15px">Get the number of devices that match the defined policy group.</td>
+    <td style="padding:15px">{base_path}/{version}/numberOfDevicesSharingPolicy?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">analyzeUsingPOST(entity, entityType, callback)</td>
+    <td style="padding:15px">Start Analysis on a device, group, or matrix</td>
+    <td style="padding:15px">{base_path}/{version}/analysis/start?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAnalyzeStatusUsingGET(entity, entityType, callback)</td>
+    <td style="padding:15px">Analysis status</td>
+    <td style="padding:15px">{base_path}/{version}/analysis/status?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCurrentAnalyzeTaskStatusesUsingGET(callback)</td>
+    <td style="padding:15px">Get the status of all currently running analyses</td>
+    <td style="padding:15px">{base_path}/{version}/analyzeTask/status?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCurrentAnalyzeTaskStatusesOfDeviceUsingGET(device, callback)</td>
+    <td style="padding:15px">Get the analysis status for a specified device</td>
+    <td style="padding:15px">{base_path}/{version}/analyzeTask/status/device?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByCanonizedNameContainingUsingGET(appName, deviceName, direction = DESC, domain, entityName, group, isExact, isOnlyApplicationsWithDefaultServices, isUnique, matrix, page, size, sort = id, callback)</td>
+    <td style="padding:15px">Get a list of device applications that match defined parameters.</td>
+    <td style="padding:15px">{base_path}/{version}/applications/findByOriginalNameContaining?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByOriginalOrCanonizedNameUsingPOST(applicationNames, deviceName, domain, callback)</td>
+    <td style="padding:15px">Device applications are returned only if the names match the search names exactly.</td>
+    <td style="padding:15px">{base_path}/{version}/applications/findByOriginalOrCanonizedName?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByOriginalOrCanonizedNameAndDeviceGroupObjectsUsingPOST(applicationNames, deviceName, useDeviceGroupObjects, callback)</td>
+    <td style="padding:15px">Device applications are returned only if the names match the search names exactly.</td>
+    <td style="padding:15px">{base_path}/{version}/applications/findByOriginalOrCanonizedNameAndDeviceGroupObjects?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByOriginalOrCanonizedNameAndDevicesUsingPOST(domain, searchRequest, callback)</td>
+    <td style="padding:15px">Device applications are returned only if the names match the search names exactly.</td>
+    <td style="padding:15px">{base_path}/{version}/applications/findByOriginalOrCanonizedNameAndDevices?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByUnitsUsingPOST(applicationUnits, deviceName, sortAscendingByObjectContainerLevel, callback)</td>
+    <td style="padding:15px">Get a list of device applications by service definitions.</td>
+    <td style="padding:15px">{base_path}/{version}/applications/findByUnits?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findExactMatchContainingAllApplicationsUsingPOST(request, callback)</td>
+    <td style="padding:15px">Get a list of device applications that contain exactly matched sub-application original or canonized names</td>
+    <td style="padding:15px">{base_path}/{version}/applications/findExactMatchContainingAllApplications?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getGroupMembersUsingPOST(request, callback)</td>
+    <td style="padding:15px">getGroupMembers</td>
+    <td style="padding:15px">{base_path}/{version}/applications/search/getGroupMembersByNameAndContainer?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getBaselineComplianceUsingGET(device, callback)</td>
+    <td style="padding:15px">Get the latest baseline compliance report for a device</td>
+    <td style="padding:15px">{base_path}/{version}/baseline_compliance?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getBrandPropertiesByDeviceUsingGET(deviceName, callback)</td>
+    <td style="padding:15px">Get brand information for a specified device</td>
+    <td style="padding:15px">{base_path}/{version}/brandConfig/properties/byDeviceName/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">downloadSupportZipUsingPOST(domain, minimal, singlenode, user, callback)</td>
+    <td style="padding:15px">Download support zip file</td>
+    <td style="padding:15px">{base_path}/{version}/bridge/download/supportZip?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDevicesUsingGET(callback)</td>
+    <td style="padding:15px">Returns device information of all cloud devices in AFA</td>
+    <td style="padding:15px">{base_path}/{version}/cloudDB/device?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDevicesBySecuritySegmentUsingGET(account, region, securitySegment, callback)</td>
+    <td style="padding:15px">To get request parameter values for a specific device, use GET /cloudDB/device method from the cloud-db-external-controller.</td>
+    <td style="padding:15px">{base_path}/{version}/cloudDB/getDevicesBySecuritySegment?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getContainerInstancesUsingGET(container, callback)</td>
+    <td style="padding:15px">Get a list of AFA cloud instances for the specified security container</td>
+    <td style="padding:15px">{base_path}/{version}/cloudDB/getInstances?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getInstancesBySecurityGroupUsingGET(account, region, securitySegment, callback)</td>
+    <td style="padding:15px">To get request parameter values for a specific cloud instance, use GET /cloudDB/getInstances method from the cloud-db-external-controller.</td>
+    <td style="padding:15px">{base_path}/{version}/cloudDB/getInstancesBySecuritySegment?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSecuritySegmentCapacityUsingGET(account, brand, region, securitySegment, callback)</td>
+    <td style="padding:15px">To get request parameter values for a specific cloud instance, use GET /cloudDB/getInstances method from the cloud-db-external-controller.</td>
+    <td style="padding:15px">{base_path}/{version}/cloudDB/getSecuritySegmentCapacity?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSecuritySegmentCapacityPerDirectionUsingGET(account, brand, region, securitySegment, callback)</td>
+    <td style="padding:15px">To get request parameter values for a specific cloud instance, use GET /cloudDB/getInstances method from the cloud-db-external-controller.</td>
+    <td style="padding:15px">{base_path}/{version}/cloudDB/getSecuritySegmentCapacityPerDirection?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSecuritySegmentByNameAndContainerUsingGET(container, securitySegment, type, callback)</td>
+    <td style="padding:15px">Get a security segment ID by security segment name and security container</td>
+    <td style="padding:15px">{base_path}/{version}/cloudDB/getSecuritySegmentIdByName?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSecuritySegmentInstancesAmountUsingGET(account, region, securitySegment, callback)</td>
+    <td style="padding:15px">To get request parameter values for a specific cloud instance, use GET /cloudDB/getInstances method from the cloud-db-external-controller.</td>
+    <td style="padding:15px">{base_path}/{version}/cloudDB/getSecuritySegmentInstancesAmount?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSecuritySegmentRulesNumberUsingGET(account, region, securitySegment, callback)</td>
+    <td style="padding:15px">To get request parameter values for a specific cloud instance, use GET /cloudDB/getInstances method from the cloud-db-external-controller.</td>
+    <td style="padding:15px">{base_path}/{version}/cloudDB/getSecuritySegmentRulesNumber?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getContainerSecurityGroupUsingGET(container, callback)</td>
+    <td style="padding:15px">Get a list of security segments for the specified security container</td>
+    <td style="padding:15px">{base_path}/{version}/cloudDB/getSecuritySegments?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllUsingGET(domain, callback)</td>
+    <td style="padding:15px">Get all home page parameters and values for current user</td>
+    <td style="padding:15px">{base_path}/{version}/config?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">configureProxyServerUsingPOST(proxyParams, callback)</td>
+    <td style="padding:15px">If you do not know the proxy settings in your organization, contact your local network administrator.
+For more information see: [Define a device proxy](https://www.algosec.com/docs/en/asms/latest/asms-help/content/afa-admin/proxy.htm)</td>
+    <td style="padding:15px">{base_path}/{version}/config/proxy?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getUiParametersUsingGET(callback)</td>
+    <td style="padding:15px">getUiParameters</td>
+    <td style="padding:15px">{base_path}/{version}/config/uiParameters?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">setConfigValuesUsingPOST(configs, domain, callback)</td>
+    <td style="padding:15px">setConfigValues</td>
+    <td style="padding:15px">{base_path}/{version}/config/values?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getConfigUsingGET(domain, key, callback)</td>
+    <td style="padding:15px">Get the value of homepage parameter of current user</td>
+    <td style="padding:15px">{base_path}/{version}/config/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">exportChangesToExcelFileUsingGET(deviceName, endTime, startTime, timeZone, callback)</td>
+    <td style="padding:15px">Export Summary Report Changes To Excel File based on a device name
+Use the device-setup-controller API GET /devices method to return the firewall name.
+
+For a range of dates,specify start and end times.
+For a specific date you need to specify the same time for start and end time.
+Times are in milliseconds can be taken from https://currentmillis.com/
+
+By default the maximum number of characters in the exported excel is 155.
+You can make maximum number of characters smaller by setting the Max_Char...(description truncated)</td>
+    <td style="padding:15px">{base_path}/{version}/device/exportChanges/xls?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">searchChildrenDevicesByParentsUsingPOST(domain, parents, callback)</td>
+    <td style="padding:15px">Get a list of child devices for a specified list of parent devices</td>
+    <td style="padding:15px">{base_path}/{version}/device/getChildren?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">searchDeviceGroupHierarchyTreeUsingPOST(devices, callback)</td>
+    <td style="padding:15px">Returns a hierarchy tree of the specified devices. The tree includes parent devices, siblings and all levels of child devices.</td>
+    <td style="padding:15px">{base_path}/{version}/device/getDeviceGroupHierarchyTree?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDevicesLastUpdateTimeUsingPOST(devices, callback)</td>
+    <td style="padding:15px">Time format: UNIX time.Milliseconds from 1.1.1970. See: https://currentmillis.com.</td>
+    <td style="padding:15px">{base_path}/{version}/device/getLastUpdateTime?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">searchLeafChildrenDevicesByParentsUsingPOST(parents, callback)</td>
+    <td style="padding:15px">Get the lowest level child devices of specified devices</td>
+    <td style="padding:15px">{base_path}/{version}/device/getLeafChildren?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">searchParentsDevicesByChildrenUsingPOST(children, domain, callback)</td>
+    <td style="padding:15px">Get a list of parent devices for a specified list of child devices</td>
+    <td style="padding:15px">{base_path}/{version}/device/getParents?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDeviceUpdateTimeFormattedUsingGET(device, callback)</td>
+    <td style="padding:15px">Get last update time for single device</td>
+    <td style="padding:15px">{base_path}/{version}/device/getUpdateTimeFormatted/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">searchDeviceInterfacesAndRoutedUsingPOST(deviceInformationRequest, callback)</td>
+    <td style="padding:15px">searchDeviceInterfacesAndRouted</td>
+    <td style="padding:15px">{base_path}/{version}/device/interfacesWithConnectedVRs?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getNumberOfRulesUsingPOST(deviceInformationRequest, callback)</td>
+    <td style="padding:15px">Get device rules count</td>
+    <td style="padding:15px">{base_path}/{version}/device/numberOfRules?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRealNameUsingPOST(deviceInformationRequest, domain, callback)</td>
+    <td style="padding:15px">Get device hostname or IP address</td>
+    <td style="padding:15px">{base_path}/{version}/device/realName?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSectionHeadersUsingGET(device, callback)</td>
+    <td style="padding:15px">Get device's policy section headers (relevant only for Check Point devices)</td>
+    <td style="padding:15px">{base_path}/{version}/device/sectionHeaders/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSecurityProfileGroupsUsingGET(device, callback)</td>
+    <td style="padding:15px">Get device security groups (for Palo Alto devices)</td>
+    <td style="padding:15px">{base_path}/{version}/device/securityProfileGroups?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDeviceSummaryUsingGET(deviceName, callback)</td>
+    <td style="padding:15px">getDeviceSummary</td>
+    <td style="padding:15px">{base_path}/{version}/device/summary/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDeviceUsingGET(device, callback)</td>
+    <td style="padding:15px">Get the device details (including the last report ID and the list of the device's children) by device name.</td>
+    <td style="padding:15px">{base_path}/{version}/device/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">statusUsingGET(uuid, callback)</td>
+    <td style="padding:15px">Check relocation progress</td>
+    <td style="padding:15px">{base_path}/{version}/device/relocation?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">executeUsingPOST(deviceRelocationRequest, callback)</td>
+    <td style="padding:15px">Relocate devices between nodes</td>
+    <td style="padding:15px">{base_path}/{version}/device/relocation?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">cancelUsingDELETE(uuid, callback)</td>
+    <td style="padding:15px">Cancel relocation process</td>
+    <td style="padding:15px">{base_path}/{version}/device/relocation?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">isRunningUsingGET(callback)</td>
+    <td style="padding:15px">Check if there is a relocation in progress, in case of running relocation the UUID will be returned</td>
+    <td style="padding:15px">{base_path}/{version}/device/relocation/checkRunning?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">enableDevicesUsingPUT(treeNames, callback)</td>
+    <td style="padding:15px">Enable monitoring, scheduled analysis, and syslog messaging for defined devices
+To get the Device Name from its GUI display name, use the following API: /devices/{deviceName}</td>
+    <td style="padding:15px">{base_path}/{version}/device/relocation/enableDevices?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">enableDevicesOnRemoteAgentUsingPUT(node, callback)</td>
+    <td style="padding:15px">Enable monitoring, scheduled analysis, and syslog messaging for all devices managed by a defined Remote Agent</td>
+    <td style="padding:15px">{base_path}/{version}/device/relocation/enableDevicesOnRemoteAgent?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDeviceZonesUsingGET(device, callback)</td>
+    <td style="padding:15px">Get zones data for specified device</td>
+    <td style="padding:15px">{base_path}/{version}/deviceZones?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllDevicesDetailsUsingGET(callback)</td>
+    <td style="padding:15px">Lists details of all devices in AFA that the current user has permissions to view.</td>
+    <td style="padding:15px">{base_path}/{version}/devices?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createUsingPOST(addChildren, firewallData, testMode, callback)</td>
+    <td style="padding:15px">Add a new device</td>
+    <td style="padding:15px">{base_path}/{version}/devices?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateUsingPUT(addChildren, firewallData, testMode, callback)</td>
+    <td style="padding:15px">Edit a device</td>
+    <td style="padding:15px">{base_path}/{version}/devices?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getExampleUsingGET(brandName = aws, requiredOnly, callback)</td>
+    <td style="padding:15px">Use this method for the Add/Edit device methods of the device-setup-controller.
+This method uses brand name codes as follows:
+
+| Brand | Brand Name code |
+|------------------------------------------------|-------------------------|
+| Web Services (AWS) EC2 | aws |
+| Azure | azure |
+| Cisco Application Centric Infrastructure (ACI) | ciscoaci |
+| Cisco ASA | pix |
+| Cisco Identity Services Engine (ISE) | ciscoise |
+| Cisco IOS | ios |
+| Cisco Nexus Router | nexus |
+| Checkpoint Smart Center | cma ...(description truncated)</td>
+    <td style="padding:15px">{base_path}/{version}/devices/examples/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createExternalUsingPOST(firewallData, testMode, callback)</td>
+    <td style="padding:15px">Add a new device with external data collection</td>
+    <td style="padding:15px">{base_path}/{version}/devices/external?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateExternalUsingPUT(firewallData, testMode, callback)</td>
+    <td style="padding:15px">Edit a device with external data collection</td>
+    <td style="padding:15px">{base_path}/{version}/devices/external?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCmaManagedDevicesUsingPOST(cmaConfiguration, callback)</td>
+    <td style="padding:15px">Use this method for the Add/Edit device methods of the device-setup-controller.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/managedDevices/cma?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getFortimangerManagedDevicesUsingPOST(fortimanagerData, callback)</td>
+    <td style="padding:15px">Use this method for the Add/Edit device methods of the device-setup-controller.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/managedDevices/fortimanager?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getManagedDevicesUsingPOST(managedDevicesRequest, callback)</td>
+    <td style="padding:15px">Use this method for the Add/Edit device methods of the device-setup-controller.
+This method use brand name codes as follows:
+
+| Brand | Brand Name code |
+|--------------------|-------------------------|
+| Palo Alto Panorama | panorama |
+| Cisco FirePower | firepower |
+| Juniper Space | space_security_director |
+| Cisco Meraki | ciscomeraki |</td>
+    <td style="padding:15px">{base_path}/{version}/devices/managedDevices/genericDevices?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getPv1ManagedDevicesUsingPOST(pv1Configuration, callback)</td>
+    <td style="padding:15px">Use this method for the Add/Edit device methods of the device-setup-controller.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/managedDevices/pv1?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCmaManagedDevicesInPv1ModeUsingPOST(pv1Configuration, callback)</td>
+    <td style="padding:15px">Use this method for the Add/Edit device methods of the device-setup-controller.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/managedDevices/pv1/cma?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDeviceDetailsUsingGET(deviceName, displayName, callback)</td>
+    <td style="padding:15px">Get device details</td>
+    <td style="padding:15px">{base_path}/{version}/devices/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteUsingDELETE(deviceName, callback)</td>
+    <td style="padding:15px">Delete a device</td>
+    <td style="padding:15px">{base_path}/{version}/devices/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">dnsLookupUsingGET(hostname, callback)</td>
+    <td style="padding:15px">dnsLookup</td>
+    <td style="padding:15px">{base_path}/{version}/dnslookup?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">bulkUpdateCloudAccountsUsingPUT(cloudAccountBulkUpdateRequests, domain, callback)</td>
+    <td style="padding:15px">Bulk update keys of AWS Cloud accounts</td>
+    <td style="padding:15px">{base_path}/{version}/firewallData/bulkUpdateCloudAccounts?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllBrothersDevicesUsingGET(deviceName, domain, callback)</td>
+    <td style="padding:15px">Return all devices with the same parent device as the specified device</td>
+    <td style="padding:15px">{base_path}/{version}/firewallData/getAllBrothersDevices?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllLeafMembersNamesUsingPOST(devicesNames, domain, callback)</td>
+    <td style="padding:15px">Get a list of lowest level child devices of the specified devices</td>
+    <td style="padding:15px">{base_path}/{version}/firewallData/getAllLeafMembersNames?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getEntityTypeByNameUsingGET(displayNameOnly, domain, entityName, callback)</td>
+    <td style="padding:15px">Entity type can be one of the following: Device / Group / Matrix / DR Set</td>
+    <td style="padding:15px">{base_path}/{version}/firewallData/getEntityTypeByName?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getOriginalNamesUsingPOST(devicesTreeNames, domain, callback)</td>
+    <td style="padding:15px">Get a list of devices’ original names from their tree names</td>
+    <td style="padding:15px">{base_path}/{version}/firewallData/getOriginalNames?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getTreeAndDisplayOfContainingGroupsUsingGET(name, callback)</td>
+    <td style="padding:15px">Get the list of groups that the specified device is part of.</td>
+    <td style="padding:15px">{base_path}/{version}/firewallData/getTreeAndDisplayContainingGroups?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getInterfacesUsingGET(entity, entityType, vrfName, callback)</td>
+    <td style="padding:15px">Retrieves the interfaces of a device or a group/matrix of devices, along with their IP addresses</td>
+    <td style="padding:15px">{base_path}/{version}/interfaces?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateInterfacesUsingPOST(request, callback)</td>
+    <td style="padding:15px">Update zone types of device interfaces for specified firewall</td>
+    <td style="padding:15px">{base_path}/{version}/interfaces?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSessionIdUsingGET(callback)</td>
+    <td style="padding:15px">returns the session path, composed of /afa/session- + (Session ID) + /firewalls/</td>
+    <td style="padding:15px">{base_path}/{version}/issues_center/session_path?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllUsingGET1(domain, callback)</td>
+    <td style="padding:15px">Get details for the current license, including all details shown in the UI's License Information dialog.</td>
+    <td style="padding:15px">{base_path}/{version}/license?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">reloadAllLicenseUsingDELETE(callback)</td>
+    <td style="padding:15px">Reload all licenses</td>
+    <td style="padding:15px">{base_path}/{version}/license?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">isLicenseExceededUsingGET(domain, callback)</td>
+    <td style="padding:15px">Returns 'true' if license usage is exceeded and 'false' if not.</td>
+    <td style="padding:15px">{base_path}/{version}/license/isExceeded?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">isLicenseGoingToBeExpiredUsingGET(domain, callback)</td>
+    <td style="padding:15px">Returns 'true' if license expiration date is close, and 'false' if not.</td>
+    <td style="padding:15px">{base_path}/{version}/license/isGoingToBeExpired?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">licenseUsageCountUsingGET(domain, callback)</td>
+    <td style="padding:15px">Fetch license usage count for firewall and router, not including public cloud usage.
+this include license usage for the default domain only.</td>
+    <td style="padding:15px">{base_path}/{version}/license/licenseUsageCount?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getConfigUsingGET2(domain, key, callback)</td>
+    <td style="padding:15px">Get the value of a specified parameter in the current user's license</td>
+    <td style="padding:15px">{base_path}/{version}/license/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">exportLicenseUsageUsingGET(callback)</td>
+    <td style="padding:15px">Export license usage to CSV, not including public cloud usage.</td>
+    <td style="padding:15px">{base_path}/{version}/licensing/exportLicenseUsage?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">exportPublicCloudUsageUsingGET(callback)</td>
+    <td style="padding:15px">Export public cloud license usage to XLSX, including the number of average instances.</td>
+    <td style="padding:15px">{base_path}/{version}/licensing/exportPublicCloudUsage?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByContainerNameAndNameUsingGET(containerName, objectName, callback)</td>
+    <td style="padding:15px">findByContainerNameAndName</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/noauth/search/byNameAndContainer?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getApplicationProfilesUsingGET(deviceName, pageNumber, pageSize, callback)</td>
+    <td style="padding:15px">Return list of application profiles names for a specific device</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/applicationProfiles?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByNameAndContainerNameUsingGET(containerName, objectName, callback)</td>
+    <td style="padding:15px">Get a list of matching network objects by object name and container name.</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/byNameAndContainer?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">isObjectContainerObjectsGroupUsingGET(objectContainer, objectNames, callback)</td>
+    <td style="padding:15px">map each given object, as relates to the given object container, whether it is a group object or not</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/container/{pathv1}/objects/groupMembership?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">doesAddressExistsOnDeviceUsingGET(deviceName, name, callback)</td>
+    <td style="padding:15px">Get the number of matching network objects, by device name and network object name.</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/doesAddressExistsOnDevice?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByDeviceNameUsingGET(deviceNames, pageNumber, pageSize, callback)</td>
+    <td style="padding:15px">Get a list of network objects for specified devices.</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/findByDeviceName?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByIpRangesUsingPOST(request, callback)</td>
+    <td style="padding:15px">Get a list of all network objects whose IP ranges exactly match the defined list of IPv4 ranges.</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/findByIpRanges?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByCanonizedNameContainingUsingGET1(deviceName, direction = DESC, domain, ipType = Null, isUnique, objectContainer, page, query, size, sort, callback)</td>
+    <td style="padding:15px">Get a list of matching network objects by multiple parameters.</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/findByOriginalNameContaining?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByOriginalOrCanonizedNameUsingPOST1(deviceName, networkObjectNames, useDeviceGroup, callback)</td>
+    <td style="padding:15px">Get matching network objects by original or canonized name</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/findByOriginalOrCanonizedName?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByOriginalOrCanonizedNameAndDevicesWithoutDeviceMappingUsingPOST(searchRequest, callback)</td>
+    <td style="padding:15px">Get a list of network objects, by original or canonized names and device names.</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/findByOriginalOrCanonizedNameAndDevicesWithoutDeviceMapping?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByOriginalOrCanonizedNameAndDevicesUsingPOST1(searchRequest, callback)</td>
+    <td style="padding:15px">Get a map of network objects by original or canonized names and device names.</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/findByOriginalOrCanonizedNamesAndDevices?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByOriginalOrCanonizedNamesAndDevicesMappingUsingPOST(searchRequest, callback)</td>
+    <td style="padding:15px">Search objects by device name and object canonized name or object original name</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/findByOriginalOrCanonizedNamesAndDevicesMapping?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findContainingAllIpRangesUsingPOST(request, callback)</td>
+    <td style="padding:15px">Get a list of all network objects that contain exactly all of the defined IPv4 ranges.</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/findContainingAllIpRanges?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findNetworkObjectsForQueryUsingPOST(deviceName, networkObjectNames, callback)</td>
+    <td style="padding:15px">Get a list of network objects by original or canonized name, for a specified device.</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/findNetworkObjectsForQuery?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">isNetworkObjectsExistUsingPOST(deviceName, networkObjects, callback)</td>
+    <td style="padding:15px">returns whether or not objects exist for a specific device</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/isNetworkObjectsExist?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getObjectsUsingGET(deviceTreeName, excludeObjectTypes, hierarchyMode = HYBRID, objectNames, objectTypes, callback)</td>
+    <td style="padding:15px">getObjects</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/{pathv1}/objects?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">isDeviceObjectsGroupUsingGET(deviceTreeName, objectNames, callback)</td>
+    <td style="padding:15px">Returns if specified objects of a device are group objects or not</td>
+    <td style="padding:15px">{base_path}/{version}/networkObject/search/{pathv1}/objects/groupMembership?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getNetworkServicesUsingGET(entity, entityType, page, size, callback)</td>
+    <td style="padding:15px">Returns a list of all the service objects of a specified entity (firewall/group/matrix). Includes the content of each object.</td>
+    <td style="padding:15px">{base_path}/{version}/network_services?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getUrlCategoriesUsingGET(brand = panorama, callback)</td>
+    <td style="padding:15px">Get a list of URL categories from the URL Categories override file. Currently only Panorama devices are supported.
+
+>**Note**\: Before you use this API, make sure to create the override file by copying the file /usr/share/fa/data/plugins/panorama/url_categories.json to this location: /home/afa/.fa/plugins/panorama/.</td>
+    <td style="padding:15px">{base_path}/{version}/plugins/{pathv1}/URLCategory/?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">addUrlCategoriesUsingPUT(body, brand = panorama, callback)</td>
+    <td style="padding:15px">Create list of URL categories in the override URL Category file for the device. Currently only Panorama devices are supported.
+
+>**Note**\: Before you use this API, make sure to create the override file by copying the file /usr/share/fa/data/plugins/panorama/url_categories.json to this location: /home/afa/.fa/plugins/panorama/.</td>
+    <td style="padding:15px">{base_path}/{version}/plugins/{pathv1}/URLCategory/?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteUrlCategoriesUsingDELETE(body, brand = panorama, callback)</td>
+    <td style="padding:15px">Delete URL categories in the URL Categories override file. Currently only Panorama devices are supported.
+
+>**Note**\: Before you use this API, make sure to create the override file by copying the file /usr/share/fa/data/plugins/panorama/url_categories.json to this location: /home/afa/.fa/plugins/panorama/.</td>
+    <td style="padding:15px">{base_path}/{version}/plugins/{pathv1}/URLCategory/?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getUrlCategoryUsingGET(brand = panorama, category, callback)</td>
+    <td style="padding:15px">Get the URL of a specified URL Category from the URL Categories override file. Currently only Panorama devices are supported. Use the URL-categories-controller API GET /{category} method to return the list of available URL Categories.
+
+>**Note**\: Before you use this API, make sure to create the override file by copying the file /usr/share/fa/data/plugins/panorama/url_categories.json to this location: /home/afa/.fa/plugins/panorama/.</td>
+    <td style="padding:15px">{base_path}/{version}/plugins/{pathv1}/URLCategory/{pathv2}/?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">renameUrlCategoryUsingPUT(body, brand = panorama, category, callback)</td>
+    <td style="padding:15px">Rename a specified URL Category in the URL Categories override file. Currently only Panorama devices are supported. Use the URL-categories-controller API GET /{category} method to return the list of available URL Categories.
+
+>**Note**\: Before you use this API, make sure to create the override file by copying the file /usr/share/fa/data/plugins/panorama/url_categories.json to this location: /home/afa/.fa/plugins/panorama/.</td>
+    <td style="padding:15px">{base_path}/{version}/plugins/{pathv1}/URLCategory/{pathv2}/?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">addUrlToCategoryUsingPUT(body, brand = panorama, category, callback)</td>
+    <td style="padding:15px">Add URLs to a specified URL Category n the URL Categories override file.Currently only Panorama devices are supported. Use the URL-categories-controller API GET /{category} method to return the list of available URL Categories.
+
+>**Note**\: Before you use this API, make sure to create the override file by copying the file /usr/share/fa/data/plugins/panorama/url_categories.json to this location: /home/afa/.fa/plugins/panorama/.</td>
+    <td style="padding:15px">{base_path}/{version}/plugins/{pathv1}/URLCategory/{pathv2}/URL/?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">removeUrlToCategoryUsingDELETE(body, brand = panorama, category, callback)</td>
+    <td style="padding:15px">Remove URLs from a specified URL Category. Currently only Panorama devices are supported. Use the URL-categories-controller API GET /{category} method to return the list of available URL Categories.
+
+>**Note**\: Before you use this API, make sure to create the override file by copying the file /usr/share/fa/data/plugins/panorama/url_categories.json to this location: /home/afa/.fa/plugins/panorama/.</td>
+    <td style="padding:15px">{base_path}/{version}/plugins/{pathv1}/URLCategory/{pathv2}/URL/?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">addUrlToCategoryUsingPUT1(body, brand = panorama, category, url, callback)</td>
+    <td style="padding:15px">Edit the URL of a specified URL Category in the URL Categories override file. Currently only Panorama devices are supported. Use the URL-categories-controller API GET /{category} method to return the list of available URL Categories.
+
+>**Note**\: Before you use this API, make sure to create the override file by copying the file /usr/share/fa/data/plugins/panorama/url_categories.json to this location: /home/afa/.fa/plugins/panorama/.</td>
+    <td style="padding:15px">{base_path}/{version}/plugins/{pathv1}/URLCategory/{pathv2}/URL/{pathv3}/?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getUrlIpsUsingGET(brand = panorama, category, url, callback)</td>
+    <td style="padding:15px">Get the IPs of a specified URL in the URL Categories override file. Currently only Panorama devices are supported. Use the URL-categories-controller API GET /{category} method to return the list of available URL Categories.
+
+>**Note**\: Before you use this API, make sure to create the override file by copying the file /usr/share/fa/data/plugins/panorama/url_categories.json to this location: /home/afa/.fa/plugins/panorama/.</td>
+    <td style="padding:15px">{base_path}/{version}/plugins/{pathv1}/URLCategory/{pathv2}/URL/{pathv3}/IP/?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">addIpToUrlUsingPUT(body, brand = panorama, category, url, callback)</td>
+    <td style="padding:15px">Add IPs to URL in the URL Categories override file. Currently only Panorama devices are supported. Use the URL-categories-controller API GET /{category} method to return the list of available URL Categories.
+
+>**Note**\: Before you use this API, make sure to create the override file by copying the file /usr/share/fa/data/plugins/panorama/url_categories.json to this location: /home/afa/.fa/plugins/panorama/.</td>
+    <td style="padding:15px">{base_path}/{version}/plugins/{pathv1}/URLCategory/{pathv2}/URL/{pathv3}/IP/?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">removeIpFromUrlUsingDELETE(body, brand = panorama, category, url, callback)</td>
+    <td style="padding:15px">Delete IPs from URL in the URL Categories override file. Currently only Panorama devices are supported. Use the URL-categories-controller API GET /{category} method to return the list of available URL Categories.
+
+>**Note**\: Before you use this API, make sure to create the override file by copying the file /usr/share/fa/data/plugins/panorama/url_categories.json to this location: /home/afa/.fa/plugins/panorama/.</td>
+    <td style="padding:15px">{base_path}/{version}/plugins/{pathv1}/URLCategory/{pathv2}/URL/{pathv3}/IP/?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">trafficSimulationQueryUsingPOST(trafficSimulationQueryRequest, callback)</td>
+    <td style="padding:15px">Performs a batch traffic simulation query on a single device or groups of devices.</td>
+    <td style="padding:15px">{base_path}/{version}/query?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getReportIdsUsingGET(deviceName, fromDate, callback)</td>
+    <td style="padding:15px">Get all reports for a device from specified date until current date</td>
+    <td style="padding:15px">{base_path}/{version}/report/findAllReports?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findLastCompletedReportUsingPOST(devices, callback)</td>
+    <td style="padding:15px">Get data of the last completed report of specified devices</td>
+    <td style="padding:15px">{base_path}/{version}/report/findLastCompletedReport?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findLastReportUsingGET(device, callback)</td>
+    <td style="padding:15px">Get data of the last report of specified device</td>
+    <td style="padding:15px">{base_path}/{version}/report/findLastReport?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">isReportHasChangesUsingGET(report, callback)</td>
+    <td style="padding:15px">Is report has changes</td>
+    <td style="padding:15px">{base_path}/{version}/report/isReportHasChanges/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">calculateRisksUsingPOST(riskCheckRequest, riskprofile, callback)</td>
+    <td style="padding:15px">Calculate risk check for requested traffic</td>
+    <td style="padding:15px">{base_path}/{version}/riskcheck/calculate?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">importRisksUsingPOST(file, inheritStandard, profile, callback)</td>
+    <td style="padding:15px">Import risk profile from spreadsheet</td>
+    <td style="padding:15px">{base_path}/{version}/riskcheck/import/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRiskyRulesUsingGET(entity, entityType, responseType, callback)</td>
+    <td style="padding:15px">Get Risky Rules of specified device, group or matrix</td>
+    <td style="padding:15px">{base_path}/{version}/risks/riskyRules?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRiskyRulesByReportUsingGET(reportName, callback)</td>
+    <td style="padding:15px">Get risky rules information for specified report</td>
+    <td style="padding:15px">{base_path}/{version}/riskyRules/getByReport?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getLatestRiskyRulesByDeviceUsingGET(deviceName, callback)</td>
+    <td style="padding:15px">Get latest risky rules information for specified device</td>
+    <td style="padding:15px">{base_path}/{version}/riskyRules/getLatestByDevice?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRulesUsingPOST(device, ruleIds, ruleType = BASIC, callback)</td>
+    <td style="padding:15px">Get a list of rule objects for specified rule IDs</td>
+    <td style="padding:15px">{base_path}/{version}/rule?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">runAdvancedRuleSearchWithSlimResponseUsingPOST(exactMatch, includeAny, includeContainment, ruleSearchQuery, treeName, callback)</td>
+    <td style="padding:15px">This endpoint returns a basic response. For an extended version of the search with more informationon the rules, see POST advancedsearch/full/{treename}.</td>
+    <td style="padding:15px">{base_path}/{version}/rule/advancedsearch/basic/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">runAdvancedRuleSearchUsingPOST(exactMatch, includeAny, includeContainment, ruleSearchQuery, treeName, callback)</td>
+    <td style="padding:15px">This endpoint returns a full response. For a narrow version of the search with less informationon the rules, see POST advancedsearch/basic/{treename}.</td>
+    <td style="padding:15px">{base_path}/{version}/rule/advancedsearch/full/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">saveRuleDocUsingPOST(requestBody, callback)</td>
+    <td style="padding:15px">Edit rule documentation</td>
+    <td style="padding:15px">{base_path}/{version}/rule/createDocumentation?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findByRuleIdAndDeviceUsingGET(device, ruleId, callback)</td>
+    <td style="padding:15px">Get rule by rule ID and device name</td>
+    <td style="padding:15px">{base_path}/{version}/rule/findByRuleIdAndDevice?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findRuleIdByRuleNumberUsingPOST(device, orderedLayerNum, ruleNumber, callback)</td>
+    <td style="padding:15px">Get rule ID by rule number and device name</td>
+    <td style="padding:15px">{base_path}/{version}/rule/findRuleIdByRuleNumber?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">firstOfGlobalSectionUsingPOST(orderedLayerIndex, orderedLayerNum, singleRuleRequest, callback)</td>
+    <td style="padding:15px">Only relevant for devices with a GLOBAL column, such as Fortinet FortiManager.</td>
+    <td style="padding:15px">{base_path}/{version}/rule/firstOfGlobalSection?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">firstOfSectionUsingPOST(orderedLayerIndex, orderedLayerNum, request, callback)</td>
+    <td style="padding:15px">Relevant only for devices with a SECTION_HEADER column, such as Check Point R80.</td>
+    <td style="padding:15px">{base_path}/{version}/rule/firstOfSection?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getIntersectingRulesUsingPOST(intersectingRulesRequest, callback)</td>
+    <td style="padding:15px">Get a list of intersecting rules that match request parameters.</td>
+    <td style="padding:15px">{base_path}/{version}/rule/intersecting?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">isGlobalRuleExistUsingPOST(singleRuleRequest, callback)</td>
+    <td style="padding:15px">Relevant only for devices with GLOBAL column, such as Fortinet FortiManager.</td>
+    <td style="padding:15px">{base_path}/{version}/rule/isGlobalRuleExist?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRuleDocUsingGET(columnId, deviceId, pageNumber, pageSize, ruleId, callback)</td>
+    <td style="padding:15px">Get a rule's documentation data</td>
+    <td style="padding:15px">{base_path}/{version}/rule/ruleDocumentation?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllRulesUsingGET(device, ruleType = BASIC, callback)</td>
+    <td style="padding:15px">Retrieve all device's rules</td>
+    <td style="padding:15px">{base_path}/{version}/rule/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDisabledRulesUsingGET(deviceTreeName, pageNumber, pageSize, ruleDisplayType = BASIC, callback)</td>
+    <td style="padding:15px">Get a list of disabled rules</td>
+    <td style="padding:15px">{base_path}/{version}/rule/policy-optimization/{pathv1}/disabledrules?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRulesWithoutCommentsUsingGET(deviceTreeName, pageNumber, pageSize, ruleDisplayType = BASIC, callback)</td>
+    <td style="padding:15px">Get all rules without any comments.</td>
+    <td style="padding:15px">{base_path}/{version}/rule/policy-optimization/{pathv1}/withoutcomment?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRulesWithoutLoggingUsingGET(deviceTreeName, pageNumber, pageSize, ruleDisplayType = BASIC, callback)</td>
+    <td style="padding:15px">Get all rules without logging.</td>
+    <td style="padding:15px">{base_path}/{version}/rule/policy-optimization/{pathv1}/withoutlogging?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRulesByContextUsingPOST(request, callback)</td>
+    <td style="padding:15px">Get rules for specified device and context</td>
+    <td style="padding:15px">{base_path}/{version}/ruleIdentifier/byContext?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRulesUsingGET(entity, entityType, callback)</td>
+    <td style="padding:15px">Retrieves all the rules in a device's or group's policy</td>
+    <td style="padding:15px">{base_path}/{version}/rules?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getProfileZonesUsingGET1(domain, callback)</td>
+    <td style="padding:15px">Get security zones of all risk profiles</td>
+    <td style="padding:15px">{base_path}/{version}/security_zones?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getProfilesListUsingGET(callback)</td>
+    <td style="padding:15px">Get risk profile names</td>
+    <td style="padding:15px">{base_path}/{version}/security_zones/get_profiles_list?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getProfileZonesUsingGET(profileName, callback)</td>
+    <td style="padding:15px">Get the security zones of a risk profile</td>
+    <td style="padding:15px">{base_path}/{version}/security_zones/{pathv1}/get_zones?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">listConfigUsingGET(callback)</td>
+    <td style="padding:15px">Get current user's configuration details. Returns a map of keys (parameters) and values.</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/adminConfig?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">setConfigUsingPOST(configParams, callback)</td>
+    <td style="padding:15px">Change or create current user's configurations</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/adminConfig?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getConfigUsingGET1(key, callback)</td>
+    <td style="padding:15px">Get the value of a key in the current user's configuration</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/adminConfig/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getBrandMappingUsingGET(callback)</td>
+    <td style="padding:15px">Returns the brand information (manufacturer name and display title) per brand name.</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/brandConfig/mapping?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRulesColumnsUsingGET(device, tableType, callback)</td>
+    <td style="padding:15px">This API returns column contents data for the Rules or the NAT Rule Columns for a specific device</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/brandConfig/{pathv1}/rulesColumns?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getChangesOverTimeChartUsingGET(deviceName, endDate, callback)</td>
+    <td style="padding:15px">Get all changes made to device until specified date</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/journal/changesOverTimeChart/{pathv1}/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getChangesOverTimeChartUsingGET1(id, callback)</td>
+    <td style="padding:15px">Get all changes made in report over time</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/journal/changesOverTimeReportChart/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllChangesReportUsingGET(pdfMode, report, callback)</td>
+    <td style="padding:15px">Get all changes made to host groups, services, applications or rules</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/journal/report/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllChangesIntervalUsingGET(deviceName, endTime, pdfMode, startTime, callback)</td>
+    <td style="padding:15px">returns all changes (scores changes, rules changes, risk changes etc) made to host groups, services, applications or rules over period specified.</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/journal/{pathv1}/interval/{pathv2}/{pathv3}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getMachineSetupUsingGET(callback)</td>
+    <td style="padding:15px">Get the current machine's configuration data</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/login/setup?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllApplicationsUsingGET(page, size, callback)</td>
+    <td style="padding:15px">Get all applications defined in AFA</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/objects/applications?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getNetworkObjectsUsingGET(deviceTreeName, excludeObjectTypes, hierarchyMode = HYBRID, objectNames, objectTypes, callback)</td>
+    <td style="padding:15px">Get detailed information on all the devices in the group specified</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/objects/{pathv1}/networkObjects?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getServiceObjectsUsingGET(deviceTreeName, excludeObjectTypes, hierarchyMode = HYBRID, objectNames, objectTypes, callback)</td>
+    <td style="padding:15px">Get detailed information on all service objects in the group specified</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/objects/{pathv1}/serviceObjects?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSecurityRatingOverTimeUsingGET(reportId, callback)</td>
+    <td style="padding:15px">Get the security rating for devices in the specified report for a 6 month period</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/report/securityRatingOverTime/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">downloadUsingGET(id, callback)</td>
+    <td style="padding:15px">Downloads report into zip file</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/report/{pathv1}/download?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">exportPdfUsingPOST(expandedMode, id, isForPrint, pagesToExportRequest, callback)</td>
+    <td style="padding:15px">Export a report to pdf</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/report/{pathv1}/export/pdf?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getReportRisksUsingGET(reportId, callback)</td>
+    <td style="padding:15px">Get risk profiles for specified report</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/report/{pathv1}/risks_list?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">statisticsUsingGET(report, callback)</td>
+    <td style="padding:15px">Get the statistics of the report (risky rules, compliance etc.).</td>
+    <td style="padding:15px">{base_path}/{version}/seikan/report/{pathv1}/statistics?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">addTrustedTrafficDataUsingPOST(addNewTrustedTrafficRequest, callback)</td>
+    <td style="padding:15px">Add a new trusted traffic</td>
+    <td style="padding:15px">{base_path}/{version}/trustedTraffic?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getTrustedTrafficDataUsingGET(firewallName, pageNo, pageSize, callback)</td>
+    <td style="padding:15px">Get trusted traffic data related to a firewall name</td>
+    <td style="padding:15px">{base_path}/{version}/trustedTraffic/firewalls/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">exportTrustedTrafficUsingGET(exportFormat = CSV, firewallName, includeSubEntities, pageNo, pageSize, callback)</td>
+    <td style="padding:15px">Export trusted traffic by firewallName.</td>
+    <td style="padding:15px">{base_path}/{version}/trustedTraffic/firewalls/{pathv1}/export?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">trustRiskRuleUsingPOST(trustedTrafficRiskyRulesRequestwrapper, useEffectiveDestination, callback)</td>
+    <td style="padding:15px">Trust an existing rule</td>
+    <td style="padding:15px">{base_path}/{version}/trustedTraffic/trustRiskyRule?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">importTrustedTrafficFromFileUsingPOST(excelFile, callback)</td>
+    <td style="padding:15px">Excel file can only have one worksheet. To see example file use the GET /export method
+When the value of the last column Use_Existing_Trusted_Traffic_ID is false, data in the Trusted_Traffic_ID column is read-only.
+End of file will be the first empty line in the file.</td>
+    <td style="padding:15px">{base_path}/{version}/trustedTraffic/uploadTrustedTrafficFile?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">editTrustedTrafficDataUsingPUT(addNewTrustedTrafficRequest, trustedTrafficId, callback)</td>
+    <td style="padding:15px">Edit an existing trusted traffic request using trusted traffic ID. (Parameter: trusted_traffic_id)</td>
+    <td style="padding:15px">{base_path}/{version}/trustedTraffic/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteTrustedTrafficUsingDELETE(trustedTrafficId, callback)</td>
+    <td style="padding:15px">Delete trusted traffic data using trusted traffic id.</td>
+    <td style="padding:15px">{base_path}/{version}/trustedTraffic/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getUsersUsingGET(domain, callback)</td>
+    <td style="padding:15px">Get a list of AFA users</td>
+    <td style="padding:15px">{base_path}/{version}/users?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRolesUsingGET(domain, callback)</td>
+    <td style="padding:15px">Get list of user roles</td>
+    <td style="padding:15px">{base_path}/{version}/users/roles?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
 </table>
 <br>

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.1.2 [06-07-2023]
+
+* fixed login endpoint
+
+See merge request itentialopensource/adapters/security/adapter-algosec_firewall!1
+
+---
+
 ## 0.1.1 [04-18-2023]
 
 * Bug fixes and performance improvements
@@ -6,4 +14,3 @@
 See commit def2c39
 
 ---
-

package/entities/.system/action.json

@@ -4,7 +4,7 @@
       "name": "getToken",
       "protocol": "REST",
       "method": "POST",
-      "entitypath": "{base_path}/{version}/connection/login",
+      "entitypath": "/fa/server/connection/login",
       "requestSchema": "schemaTokenReq.json",
       "responseSchema": "schemaTokenResp.json",
       "timeout": 0,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-algosec_firewall",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "This adapter integrates with system described as: Algosec Firewall Analyzer.",
   "main": "adapter.js",
   "wizardVersion": "2.44.15",
@@ -53,7 +53,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/security/adapter-algosec_firewall#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^4.48.13",
+    "@itentialopensource/adapter-utils": "^4.49.0",
     "ajv": "^6.12.0",
     "axios": "^0.21.0",
     "commander": "^2.20.0",

package/report/adapterInfo.json

@@ -0,0 +1,10 @@
+{
+  "version": "0.1.1",
+  "configLines": 18318,
+  "scriptLines": 1795,
+  "codeLines": 17132,
+  "testLines": 12936,
+  "testCases": 651,
+  "totalCodeLines": 31863,
+  "wfTasks": 188
+}