@itentialopensource/adapter-qualys 0.1.1

package/entities/PurgeAssetsIMPORTANTPurgingCannotBeReversed/schema.json

@@ -0,0 +1,41 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "step1DownloadaListofallHoststobePurgedForyourrecords",
+      "enum": [
+        "step1DownloadaListofallHoststobePurgedForyourrecords"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "echoRequest": {
+      "type": "number",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "echo_request"
+    },
+    "noVmScanSince": {
+      "type": "string",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "no_vm_scan_since"
+    }
+  },
+  "definitions": {}
+}

package/entities/SendReportResultsToSupport/action.json

@@ -0,0 +1,24 @@
+{
+  "actions": [
+    {
+      "name": "step1LaunchReportthatSupportRequested",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/2.0/fo/report?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/SendReportResultsToSupport/schema.json

@@ -0,0 +1,52 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "step1LaunchReportthatSupportRequested",
+      "enum": [
+        "step1LaunchReportthatSupportRequested"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "templateId": {
+      "type": "number",
+      "description": "(Required) The template ID of the report you want to\nlaunch. Use the /msp/report_template_list.php API to find the template ID you’re interested in",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "template_id"
+    },
+    "reportTitle": {
+      "type": "string",
+      "description": "(Optional) A user-defined report title. The title may have a maximum of 128 characters. For a PCI compliance report, the report title is provided by Qualys and cannot be ...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "report_title"
+    },
+    "outputFormat": {
+      "type": "string",
+      "description": "(Required) Support requires PDF Format.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "output_format"
+    }
+  },
+  "definitions": {}
+}

package/entities/Step1GenerateAPIGatewayTokenForAuth/action.json

@@ -0,0 +1,24 @@
+{
+  "actions": [
+    {
+      "name": "generateAuthenticateGenerateToken",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/auth?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/Step1GenerateAPIGatewayTokenForAuth/schema.json

@@ -0,0 +1,19 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "generateAuthenticateGenerateToken",
+      "enum": [
+        "generateAuthenticateGenerateToken"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/entities/Step3AddIPToAssetGroup/action.json

@@ -0,0 +1,24 @@
+{
+  "actions": [
+    {
+      "name": "optionalListallExistingAssetGroups",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/2.0/fo/asset/group?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/Step3AddIPToAssetGroup/schema.json

@@ -0,0 +1,41 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "optionalListallExistingAssetGroups",
+      "enum": [
+        "optionalListallExistingAssetGroups"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "outputFormat": {
+      "type": "string",
+      "description": "(Required) The requested output format: CSV or XML.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "output_format"
+    },
+    "truncationLimit": {
+      "type": "number",
+      "description": "(Optional) Specify the maximum number of asset group records to output. By default this is set to 1000 records. If you specify truncation_limit=0, the output is not pagin...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "truncation_limit"
+    }
+  },
+  "definitions": {}
+}

package/entities/Step3EnableVulnerabilityManagementAndOrPolicyComplianceForTheHostAsset/action.json

@@ -0,0 +1,24 @@
+{
+  "actions": [
+    {
+      "name": "enableVulnerabilityManagementandPolicyComplianceHostAssets",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/2.0/fo/asset/ip?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/Step3EnableVulnerabilityManagementAndOrPolicyComplianceForTheHostAsset/schema.json

@@ -0,0 +1,41 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "enableVulnerabilityManagementandPolicyComplianceHostAssets",
+      "enum": [
+        "enableVulnerabilityManagementandPolicyComplianceHostAssets"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "enableVm": {
+      "type": "number",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "enable_vm"
+    },
+    "enablePc": {
+      "type": "number",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "enable_pc"
+    }
+  },
+  "definitions": {}
+}

package/entities/Step4AddSiteToScheduledScan/action.json

@@ -0,0 +1,24 @@
+{
+  "actions": [
+    {
+      "name": "scheduleCertViewScanbyFQDNs",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/2.0/fo/schedule/scan?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/Step4AddSiteToScheduledScan/schema.json

@@ -0,0 +1,96 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "scheduleCertViewScanbyFQDNs",
+      "enum": [
+        "scheduleCertViewScanbyFQDNs"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "scanTitle": {
+      "type": "string",
+      "description": "(Optional) The scan title. This can be a maximum of 2000 characters (ascii).",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "scan_title"
+    },
+    "optionId": {
+      "type": "string",
+      "description": "Option Profile option_id or option_profile (one is required)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "option_id"
+    },
+    "scanType": {
+      "type": "string",
+      "description": "(Optional) Launch a CertView type scan. This option will be supported when CertView GA is released and enabled for your account.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "scan_type"
+    },
+    "frequencyWeeks": {
+      "type": "number",
+      "description": "frequency_days={value} Required for a daily scan. The scan will run every N number of days. Value is an integer from 1 to 365.\n\nfrequency_weeks={value} Required for a wee...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "frequency_weeks"
+    },
+    "startHour": {
+      "type": "number",
+      "description": "(Required) The hour when a scan will start. The hour is an integer from 0 to 23, where 0 represents 12 AM, 7 represents 7 AM, and 22 represents 10 PM.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "start_hour"
+    },
+    "startMinute": {
+      "type": "number",
+      "description": "(Required) The minute when a scan will start. A valid value is an integer from 0 to 59",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "start_minute"
+    },
+    "observeDst": {
+      "type": "string",
+      "description": "(Optional) Specify yes to observe Daylight Saving Time (DST). This parameter is valid when the time zone code specified in time_zone_code supports DST.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "observe_dst"
+    }
+  },
+  "definitions": {}
+}

package/entities/Step4AuthenticationRecords/action.json

@@ -0,0 +1,44 @@
+{
+  "actions": [
+    {
+      "name": "aPICommandstoaddIPaddressEsWindows",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/2.0/fo/auth/windows?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "aPICommandstoaddIPaddressEsUnixLinux",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/2.0/fo/auth/unix?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/Step4AuthenticationRecords/schema.json

@@ -0,0 +1,31 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "aPICommandstoaddIPaddressEsWindows",
+      "enum": [
+        "aPICommandstoaddIPaddressEsWindows",
+        "aPICommandstoaddIPaddressEsUnixLinux"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "addIps": {
+      "type": "string",
+      "description": "(Optional to update record) Add IPs and/or ranges to the IPs list for this record. Multiple IPs/ranges are comma separated. This parameter and the ips parameter cannot be...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "add_ips"
+    }
+  },
+  "definitions": {}
+}

package/entities/Step5GetCertificateScanResults/action.json

@@ -0,0 +1,24 @@
+{
+  "actions": [
+    {
+      "name": "retrievedetailedhostinstanceinformation",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/getEndpointData?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/Step5GetCertificateScanResults/schema.json

@@ -0,0 +1,19 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "retrievedetailedhostinstanceinformation",
+      "enum": [
+        "retrievedetailedhostinstanceinformation"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/entities/Step5LaunchScans/action.json

@@ -0,0 +1,44 @@
+{
+  "actions": [
+    {
+      "name": "launchVulnerabilityScan",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/2.0/fo/scan?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "launchPolicyComplianceScan",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/2.0/fo/scan/compliance?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/Step5LaunchScans/schema.json

@@ -0,0 +1,53 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "launchVulnerabilityScan",
+      "enum": [
+        "launchVulnerabilityScan",
+        "launchPolicyComplianceScan"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "iscannerId": {
+      "type": "number",
+      "description": "Scanner Appliance: iscanner_id or iscanner_name",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "iscanner_id"
+    },
+    "scanTitle": {
+      "type": "string",
+      "description": "(Optional) The scan title. This can be a maximum of 2000 characters (ascii).",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "scan_title"
+    },
+    "optionId": {
+      "type": "number",
+      "description": "Option Profile: option_id or option_title",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "option_id"
+    }
+  },
+  "definitions": {}
+}

package/entities/UserAccountManagement/action.json

@@ -0,0 +1,24 @@
+{
+  "actions": [
+    {
+      "name": "addUsersNotbulk",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/msp/user.php?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}