vanta-auditor-api-sdk 0.6.3 → 0.6.4
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/README.md +12 -0
- package/docs/sdks/audits/README.md +446 -0
- package/funcs/auditsGetVulnerableAssets.d.ts +18 -0
- package/funcs/auditsGetVulnerableAssets.d.ts.map +1 -0
- package/funcs/auditsGetVulnerableAssets.js +130 -0
- package/funcs/auditsGetVulnerableAssets.js.map +1 -0
- package/funcs/auditsListMonitoredComputersInAuditScope.d.ts +20 -0
- package/funcs/auditsListMonitoredComputersInAuditScope.d.ts.map +1 -0
- package/funcs/auditsListMonitoredComputersInAuditScope.js +129 -0
- package/funcs/auditsListMonitoredComputersInAuditScope.js.map +1 -0
- package/funcs/auditsListPeopleInAuditScope.d.ts +18 -0
- package/funcs/auditsListPeopleInAuditScope.d.ts.map +1 -0
- package/funcs/auditsListPeopleInAuditScope.js +129 -0
- package/funcs/auditsListPeopleInAuditScope.js.map +1 -0
- package/funcs/auditsListVendorsInAuditScope.d.ts +18 -0
- package/funcs/auditsListVendorsInAuditScope.d.ts.map +1 -0
- package/funcs/auditsListVendorsInAuditScope.js +126 -0
- package/funcs/auditsListVendorsInAuditScope.js.map +1 -0
- package/funcs/auditsListVulnerabilities.d.ts +18 -0
- package/funcs/auditsListVulnerabilities.d.ts.map +1 -0
- package/funcs/auditsListVulnerabilities.js +137 -0
- package/funcs/auditsListVulnerabilities.js.map +1 -0
- package/funcs/auditsListVulnerabilityRemediationsInAuditScope.d.ts +18 -0
- package/funcs/auditsListVulnerabilityRemediationsInAuditScope.d.ts.map +1 -0
- package/funcs/auditsListVulnerabilityRemediationsInAuditScope.js +132 -0
- package/funcs/auditsListVulnerabilityRemediationsInAuditScope.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/models/components/acceptpoliciestasksummary.d.ts +67 -0
- package/models/components/acceptpoliciestasksummary.d.ts.map +1 -0
- package/models/components/acceptpoliciestasksummary.js +83 -0
- package/models/components/acceptpoliciestasksummary.js.map +1 -0
- package/models/components/auditorapivulnerability.d.ts +119 -0
- package/models/components/auditorapivulnerability.d.ts.map +1 -0
- package/models/components/auditorapivulnerability.js +83 -0
- package/models/components/auditorapivulnerability.js.map +1 -0
- package/models/components/completebackgroundcheckstasksummary.d.ts +47 -0
- package/models/components/completebackgroundcheckstasksummary.d.ts.map +1 -0
- package/models/components/completebackgroundcheckstasksummary.js +65 -0
- package/models/components/completebackgroundcheckstasksummary.js.map +1 -0
- package/models/components/completecustomtaskstasksummary.d.ts +56 -0
- package/models/components/completecustomtaskstasksummary.d.ts.map +1 -0
- package/models/components/completecustomtaskstasksummary.js +68 -0
- package/models/components/completecustomtaskstasksummary.js.map +1 -0
- package/models/components/completeoffboardingcustomtaskstasksummary.d.ts +56 -0
- package/models/components/completeoffboardingcustomtaskstasksummary.d.ts.map +1 -0
- package/models/components/completeoffboardingcustomtaskstasksummary.js +68 -0
- package/models/components/completeoffboardingcustomtaskstasksummary.js.map +1 -0
- package/models/components/completetrainingstasksummary.d.ts +56 -0
- package/models/components/completetrainingstasksummary.d.ts.map +1 -0
- package/models/components/completetrainingstasksummary.js +68 -0
- package/models/components/completetrainingstasksummary.js.map +1 -0
- package/models/components/computerstatus.d.ts +23 -0
- package/models/components/computerstatus.d.ts.map +1 -0
- package/models/components/computerstatus.js +51 -0
- package/models/components/computerstatus.js.map +1 -0
- package/models/components/computerstatusfilter.d.ts +33 -0
- package/models/components/computerstatusfilter.d.ts.map +1 -0
- package/models/components/computerstatusfilter.js +60 -0
- package/models/components/computerstatusfilter.js.map +1 -0
- package/models/components/computerstatusoutcome.d.ts +30 -0
- package/models/components/computerstatusoutcome.d.ts.map +1 -0
- package/models/components/computerstatusoutcome.js +58 -0
- package/models/components/computerstatusoutcome.js.map +1 -0
- package/models/components/currencycode.d.ts +32 -0
- package/models/components/currencycode.d.ts.map +1 -0
- package/models/components/currencycode.js +69 -0
- package/models/components/currencycode.js.map +1 -0
- package/models/components/customtask.d.ts +13 -0
- package/models/components/customtask.d.ts.map +1 -0
- package/models/components/customtask.js +50 -0
- package/models/components/customtask.js.map +1 -0
- package/models/components/employmentstatus.d.ts +33 -0
- package/models/components/employmentstatus.d.ts.map +1 -0
- package/models/components/employmentstatus.js +60 -0
- package/models/components/employmentstatus.js.map +1 -0
- package/models/components/externalfindingseverity.d.ts +18 -0
- package/models/components/externalfindingseverity.d.ts.map +1 -0
- package/models/components/externalfindingseverity.js +52 -0
- package/models/components/externalfindingseverity.js.map +1 -0
- package/models/components/externalfindingseveritytype.d.ts +12 -0
- package/models/components/externalfindingseveritytype.d.ts.map +1 -0
- package/models/components/externalfindingseveritytype.js +49 -0
- package/models/components/externalfindingseveritytype.js.map +1 -0
- package/models/components/index.d.ts +50 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +50 -0
- package/models/components/index.js.map +1 -1
- package/models/components/installdevicemonitoringtasksummary.d.ts +47 -0
- package/models/components/installdevicemonitoringtasksummary.d.ts.map +1 -0
- package/models/components/installdevicemonitoringtasksummary.js +65 -0
- package/models/components/installdevicemonitoringtasksummary.js.map +1 -0
- package/models/components/integrationbasedpersoninfosource.d.ts +15 -0
- package/models/components/integrationbasedpersoninfosource.d.ts.map +1 -0
- package/models/components/integrationbasedpersoninfosource.js +52 -0
- package/models/components/integrationbasedpersoninfosource.js.map +1 -0
- package/models/components/keyvaluepair.d.ts +17 -0
- package/models/components/keyvaluepair.d.ts.map +1 -0
- package/models/components/keyvaluepair.js +51 -0
- package/models/components/keyvaluepair.js.map +1 -0
- package/models/components/leavestatus.d.ts +16 -0
- package/models/components/leavestatus.d.ts.map +1 -0
- package/models/components/leavestatus.js +51 -0
- package/models/components/leavestatus.js.map +1 -0
- package/models/components/monitoredcomputer.d.ts +91 -0
- package/models/components/monitoredcomputer.d.ts.map +1 -0
- package/models/components/monitoredcomputer.js +81 -0
- package/models/components/monitoredcomputer.js.map +1 -0
- package/models/components/operatingsystemtype.d.ts +17 -0
- package/models/components/operatingsystemtype.d.ts.map +1 -0
- package/models/components/operatingsystemtype.js +51 -0
- package/models/components/operatingsystemtype.js.map +1 -0
- package/models/components/paginatedresponseauditorapivulnerability.d.ts +22 -0
- package/models/components/paginatedresponseauditorapivulnerability.d.ts.map +1 -0
- package/models/components/paginatedresponseauditorapivulnerability.js +61 -0
- package/models/components/paginatedresponseauditorapivulnerability.js.map +1 -0
- package/models/components/paginatedresponsemonitoredcomputer.d.ts +22 -0
- package/models/components/paginatedresponsemonitoredcomputer.d.ts.map +1 -0
- package/models/components/paginatedresponsemonitoredcomputer.js +61 -0
- package/models/components/paginatedresponsemonitoredcomputer.js.map +1 -0
- package/models/components/paginatedresponseperson.d.ts +22 -0
- package/models/components/paginatedresponseperson.d.ts.map +1 -0
- package/models/components/paginatedresponseperson.js +61 -0
- package/models/components/paginatedresponseperson.js.map +1 -0
- package/models/components/paginatedresponsevendor.d.ts +22 -0
- package/models/components/paginatedresponsevendor.d.ts.map +1 -0
- package/models/components/paginatedresponsevendor.js +61 -0
- package/models/components/paginatedresponsevendor.js.map +1 -0
- package/models/components/paginatedresponsevulnerabilityremediation.d.ts +22 -0
- package/models/components/paginatedresponsevulnerabilityremediation.d.ts.map +1 -0
- package/models/components/paginatedresponsevulnerabilityremediation.js +61 -0
- package/models/components/paginatedresponsevulnerabilityremediation.js.map +1 -0
- package/models/components/paginatedresponsevulnerableasset.d.ts +22 -0
- package/models/components/paginatedresponsevulnerableasset.d.ts.map +1 -0
- package/models/components/paginatedresponsevulnerableasset.js +61 -0
- package/models/components/paginatedresponsevulnerableasset.js.map +1 -0
- package/models/components/person.d.ts +169 -0
- package/models/components/person.d.ts.map +1 -0
- package/models/components/person.js +125 -0
- package/models/components/person.js.map +1 -0
- package/models/components/personinfosource.d.ts +14 -0
- package/models/components/personinfosource.d.ts.map +1 -0
- package/models/components/personinfosource.js +55 -0
- package/models/components/personinfosource.js.map +1 -0
- package/models/components/personnelperson.d.ts +8 -8
- package/models/components/personnelperson.d.ts.map +1 -1
- package/models/components/personnelperson.js +11 -9
- package/models/components/personnelperson.js.map +1 -1
- package/models/components/scimbasedpersoninfosource.d.ts +13 -0
- package/models/components/scimbasedpersoninfosource.d.ts.map +1 -0
- package/models/components/scimbasedpersoninfosource.js +50 -0
- package/models/components/scimbasedpersoninfosource.js.map +1 -0
- package/models/components/taskssummarystatus.d.ts +44 -0
- package/models/components/taskssummarystatus.d.ts.map +1 -0
- package/models/components/taskssummarystatus.js +68 -0
- package/models/components/taskssummarystatus.js.map +1 -0
- package/models/components/taskstatus.d.ts +32 -0
- package/models/components/taskstatus.d.ts.map +1 -0
- package/models/components/taskstatus.js +61 -0
- package/models/components/taskstatus.js.map +1 -0
- package/models/components/tasksummarydetails.d.ts +42 -0
- package/models/components/tasksummarydetails.d.ts.map +1 -0
- package/models/components/tasksummarydetails.js +61 -0
- package/models/components/tasksummarydetails.js.map +1 -0
- package/models/components/tasktype.d.ts +34 -0
- package/models/components/tasktype.d.ts.map +1 -0
- package/models/components/tasktype.js +62 -0
- package/models/components/tasktype.js.map +1 -0
- package/models/components/tasktypeacceptpolicies.d.ts +9 -0
- package/models/components/tasktypeacceptpolicies.d.ts.map +1 -0
- package/models/components/tasktypeacceptpolicies.js +46 -0
- package/models/components/tasktypeacceptpolicies.js.map +1 -0
- package/models/components/tasktypecompletebackgroundchecks.d.ts +9 -0
- package/models/components/tasktypecompletebackgroundchecks.d.ts.map +1 -0
- package/models/components/tasktypecompletebackgroundchecks.js +46 -0
- package/models/components/tasktypecompletebackgroundchecks.js.map +1 -0
- package/models/components/tasktypecompletecustomoffboardingtasks.d.ts +9 -0
- package/models/components/tasktypecompletecustomoffboardingtasks.d.ts.map +1 -0
- package/models/components/tasktypecompletecustomoffboardingtasks.js +46 -0
- package/models/components/tasktypecompletecustomoffboardingtasks.js.map +1 -0
- package/models/components/tasktypecompletecustomtasks.d.ts +9 -0
- package/models/components/tasktypecompletecustomtasks.d.ts.map +1 -0
- package/models/components/tasktypecompletecustomtasks.js +46 -0
- package/models/components/tasktypecompletecustomtasks.js.map +1 -0
- package/models/components/tasktypecompletetrainings.d.ts +9 -0
- package/models/components/tasktypecompletetrainings.d.ts.map +1 -0
- package/models/components/tasktypecompletetrainings.js +46 -0
- package/models/components/tasktypecompletetrainings.js.map +1 -0
- package/models/components/tasktypeinstalldevicemonitoring.d.ts +9 -0
- package/models/components/tasktypeinstalldevicemonitoring.d.ts.map +1 -0
- package/models/components/tasktypeinstalldevicemonitoring.js +46 -0
- package/models/components/tasktypeinstalldevicemonitoring.js.map +1 -0
- package/models/components/training.d.ts +13 -0
- package/models/components/training.d.ts.map +1 -0
- package/models/components/training.js +50 -0
- package/models/components/training.js.map +1 -0
- package/models/components/vantabasedpersoninfosource.d.ts +13 -0
- package/models/components/vantabasedpersoninfosource.d.ts.map +1 -0
- package/models/components/vantabasedpersoninfosource.js +50 -0
- package/models/components/vantabasedpersoninfosource.js.map +1 -0
- package/models/components/vendor.d.ts +498 -0
- package/models/components/vendor.d.ts.map +1 -0
- package/models/components/vendor.js +408 -0
- package/models/components/vendor.js.map +1 -0
- package/models/components/vendordecisionstatus.d.ts +11 -0
- package/models/components/vendordecisionstatus.d.ts.map +1 -0
- package/models/components/vendordecisionstatus.js +48 -0
- package/models/components/vendordecisionstatus.js.map +1 -0
- package/models/components/vendorrisklevel.d.ts +33 -0
- package/models/components/vendorrisklevel.d.ts.map +1 -0
- package/models/components/vendorrisklevel.js +60 -0
- package/models/components/vendorrisklevel.js.map +1 -0
- package/models/components/vendorstatus.d.ts +27 -0
- package/models/components/vendorstatus.d.ts.map +1 -0
- package/models/components/vendorstatus.js +56 -0
- package/models/components/vendorstatus.js.map +1 -0
- package/models/components/vulnerabilityremediation.d.ts +37 -0
- package/models/components/vulnerabilityremediation.d.ts.map +1 -0
- package/models/components/vulnerabilityremediation.js +56 -0
- package/models/components/vulnerabilityremediation.js.map +1 -0
- package/models/components/vulnerabilitytype.d.ts +11 -0
- package/models/components/vulnerabilitytype.d.ts.map +1 -0
- package/models/components/vulnerabilitytype.js +48 -0
- package/models/components/vulnerabilitytype.js.map +1 -0
- package/models/components/vulnerableasset.d.ts +35 -0
- package/models/components/vulnerableasset.d.ts.map +1 -0
- package/models/components/vulnerableasset.js +57 -0
- package/models/components/vulnerableasset.js.map +1 -0
- package/models/components/vulnerableassetscanner.d.ts +70 -0
- package/models/components/vulnerableassetscanner.d.ts.map +1 -0
- package/models/components/vulnerableassetscanner.js +65 -0
- package/models/components/vulnerableassetscanner.js.map +1 -0
- package/models/components/vulnerableassettype.d.ts +25 -0
- package/models/components/vulnerableassettype.d.ts.map +1 -0
- package/models/components/vulnerableassettype.js +59 -0
- package/models/components/vulnerableassettype.js.map +1 -0
- package/models/operations/getvulnerableassets.d.ts +40 -0
- package/models/operations/getvulnerableassets.d.ts.map +1 -0
- package/models/operations/getvulnerableassets.js +56 -0
- package/models/operations/getvulnerableassets.js.map +1 -0
- package/models/operations/index.d.ts +6 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +6 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/listmonitoredcomputersinauditscope.d.ts +22 -0
- package/models/operations/listmonitoredcomputersinauditscope.d.ts.map +1 -0
- package/models/operations/listmonitoredcomputersinauditscope.js +53 -0
- package/models/operations/listmonitoredcomputersinauditscope.js.map +1 -0
- package/models/operations/listpeopleinauditscope.d.ts +38 -0
- package/models/operations/listpeopleinauditscope.d.ts.map +1 -0
- package/models/operations/listpeopleinauditscope.js +56 -0
- package/models/operations/listpeopleinauditscope.js.map +1 -0
- package/models/operations/listvendorsinauditscope.d.ts +16 -0
- package/models/operations/listvendorsinauditscope.d.ts.map +1 -0
- package/models/operations/listvendorsinauditscope.js +51 -0
- package/models/operations/listvendorsinauditscope.js.map +1 -0
- package/models/operations/listvulnerabilities.d.ts +75 -0
- package/models/operations/listvulnerabilities.d.ts.map +1 -0
- package/models/operations/listvulnerabilities.js +63 -0
- package/models/operations/listvulnerabilities.js.map +1 -0
- package/models/operations/listvulnerabilityremediationsinauditscope.d.ts +45 -0
- package/models/operations/listvulnerabilityremediationsinauditscope.d.ts.map +1 -0
- package/models/operations/listvulnerabilityremediationsinauditscope.js +57 -0
- package/models/operations/listvulnerabilityremediationsinauditscope.js.map +1 -0
- package/package.json +1 -1
- package/sdk/audits.d.ts +44 -0
- package/sdk/audits.d.ts.map +1 -1
- package/sdk/audits.js +62 -0
- package/sdk/audits.js.map +1 -1
- package/src/funcs/auditsGetVulnerableAssets.ts +179 -0
- package/src/funcs/auditsListMonitoredComputersInAuditScope.ts +181 -0
- package/src/funcs/auditsListPeopleInAuditScope.ts +178 -0
- package/src/funcs/auditsListVendorsInAuditScope.ts +175 -0
- package/src/funcs/auditsListVulnerabilities.ts +190 -0
- package/src/funcs/auditsListVulnerabilityRemediationsInAuditScope.ts +186 -0
- package/src/lib/config.ts +3 -3
- package/src/models/components/acceptpoliciestasksummary.ts +155 -0
- package/src/models/components/auditorapivulnerability.ts +200 -0
- package/src/models/components/completebackgroundcheckstasksummary.ts +107 -0
- package/src/models/components/completecustomtaskstasksummary.ts +111 -0
- package/src/models/components/completeoffboardingcustomtaskstasksummary.ts +125 -0
- package/src/models/components/completetrainingstasksummary.ts +108 -0
- package/src/models/components/computerstatus.ts +47 -0
- package/src/models/components/computerstatusfilter.ts +40 -0
- package/src/models/components/computerstatusoutcome.ts +37 -0
- package/src/models/components/currencycode.ts +38 -0
- package/src/models/components/customtask.ts +34 -0
- package/src/models/components/employmentstatus.ts +40 -0
- package/src/models/components/externalfindingseverity.ts +27 -0
- package/src/models/components/externalfindingseveritytype.ts +21 -0
- package/src/models/components/index.ts +50 -0
- package/src/models/components/installdevicemonitoringtasksummary.ts +104 -0
- package/src/models/components/integrationbasedpersoninfosource.ts +38 -0
- package/src/models/components/keyvaluepair.ts +39 -0
- package/src/models/components/leavestatus.ts +22 -0
- package/src/models/components/monitoredcomputer.ts +167 -0
- package/src/models/components/operatingsystemtype.ts +24 -0
- package/src/models/components/paginatedresponseauditorapivulnerability.ts +79 -0
- package/src/models/components/paginatedresponsemonitoredcomputer.ts +73 -0
- package/src/models/components/paginatedresponseperson.ts +61 -0
- package/src/models/components/paginatedresponsevendor.ts +61 -0
- package/src/models/components/paginatedresponsevulnerabilityremediation.ts +79 -0
- package/src/models/components/paginatedresponsevulnerableasset.ts +70 -0
- package/src/models/components/person.ts +323 -0
- package/src/models/components/personinfosource.ts +49 -0
- package/src/models/components/personnelperson.ts +20 -16
- package/src/models/components/scimbasedpersoninfosource.ts +34 -0
- package/src/models/components/taskssummarystatus.ts +53 -0
- package/src/models/components/taskstatus.ts +39 -0
- package/src/models/components/tasksummarydetails.ts +87 -0
- package/src/models/components/tasktype.ts +40 -0
- package/src/models/components/tasktypeacceptpolicies.ts +16 -0
- package/src/models/components/tasktypecompletebackgroundchecks.ts +18 -0
- package/src/models/components/tasktypecompletecustomoffboardingtasks.ts +19 -0
- package/src/models/components/tasktypecompletecustomtasks.ts +18 -0
- package/src/models/components/tasktypecompletetrainings.ts +18 -0
- package/src/models/components/tasktypeinstalldevicemonitoring.ts +18 -0
- package/src/models/components/training.ts +34 -0
- package/src/models/components/vantabasedpersoninfosource.ts +34 -0
- package/src/models/components/vendor.ts +669 -0
- package/src/models/components/vendordecisionstatus.ts +18 -0
- package/src/models/components/vendorrisklevel.ts +40 -0
- package/src/models/components/vendorstatus.ts +33 -0
- package/src/models/components/vulnerabilityremediation.ts +70 -0
- package/src/models/components/vulnerabilitytype.ts +18 -0
- package/src/models/components/vulnerableasset.ts +67 -0
- package/src/models/components/vulnerableassetscanner.ts +107 -0
- package/src/models/components/vulnerableassettype.ts +34 -0
- package/src/models/operations/getvulnerableassets.ts +65 -0
- package/src/models/operations/index.ts +6 -0
- package/src/models/operations/listmonitoredcomputersinauditscope.ts +52 -0
- package/src/models/operations/listpeopleinauditscope.ts +69 -0
- package/src/models/operations/listvendorsinauditscope.ts +39 -0
- package/src/models/operations/listvulnerabilities.ts +107 -0
- package/src/models/operations/listvulnerabilityremediationsinauditscope.ts +75 -0
- package/src/sdk/audits.ts +110 -0
package/README.md
CHANGED
|
@@ -171,6 +171,8 @@ run();
|
|
|
171
171
|
* [listAuditIssues](docs/sdks/audits/README.md#listauditissues) - List snapshotted issues for an audit
|
|
172
172
|
* [listAuditSnapshots](docs/sdks/audits/README.md#listauditsnapshots) - List snapshotted issues for an audit
|
|
173
173
|
* [listVendors](docs/sdks/audits/README.md#listvendors) - List vendors for an audit
|
|
174
|
+
* [listMonitoredComputersInAuditScope](docs/sdks/audits/README.md#listmonitoredcomputersinauditscope) - List monitored computers
|
|
175
|
+
* [listPeopleInAuditScope](docs/sdks/audits/README.md#listpeopleinauditscope) - List of people who are in scope for this audit
|
|
174
176
|
* [listAccountAccessServices](docs/sdks/audits/README.md#listaccountaccessservices) - List account access services for an audit
|
|
175
177
|
* [listPersonnelAccountAccess](docs/sdks/audits/README.md#listpersonnelaccountaccess) - List account access records for an audit
|
|
176
178
|
* [listPersonnelGroups](docs/sdks/audits/README.md#listpersonnelgroups) - List groups for an audit
|
|
@@ -178,6 +180,10 @@ run();
|
|
|
178
180
|
* [listRiskSnapshots](docs/sdks/audits/README.md#listrisksnapshots) - List risk snapshots for an audit
|
|
179
181
|
* [listAuditRisks](docs/sdks/audits/README.md#listauditrisks) - List risks for an audit
|
|
180
182
|
* [shareInformationRequestList](docs/sdks/audits/README.md#shareinformationrequestlist) - Share information request list with customer
|
|
183
|
+
* [listVendorsInAuditScope](docs/sdks/audits/README.md#listvendorsinauditscope) - List of vendors who are in scope for this audit
|
|
184
|
+
* [listVulnerabilities](docs/sdks/audits/README.md#listvulnerabilities) - List vulnerabilities within the scope of a given audit
|
|
185
|
+
* [listVulnerabilityRemediationsInAuditScope](docs/sdks/audits/README.md#listvulnerabilityremediationsinauditscope) - List vulnerability remediations that are in scope for this audit
|
|
186
|
+
* [getVulnerableAssets](docs/sdks/audits/README.md#getvulnerableassets) - List assets associated with vulnerabilities
|
|
181
187
|
|
|
182
188
|
</details>
|
|
183
189
|
<!-- End Available Resources and Operations [operations] -->
|
|
@@ -212,6 +218,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
212
218
|
- [`auditsGetFrameworkCodes`](docs/sdks/audits/README.md#getframeworkcodes) - Get framework codes for an audit
|
|
213
219
|
- [`auditsGetInformationRequest`](docs/sdks/audits/README.md#getinformationrequest) - Get an information request by ID
|
|
214
220
|
- [`auditsGetInformationRequestTestSnapshotEvidenceDetail`](docs/sdks/audits/README.md#getinformationrequesttestsnapshotevidencedetail) - Get test snapshot detail for an evidence row
|
|
221
|
+
- [`auditsGetVulnerableAssets`](docs/sdks/audits/README.md#getvulnerableassets) - List assets associated with vulnerabilities
|
|
215
222
|
- [`auditsList`](docs/sdks/audits/README.md#list) - List audits
|
|
216
223
|
- [`auditsListAccountAccessServices`](docs/sdks/audits/README.md#listaccountaccessservices) - List account access services for an audit
|
|
217
224
|
- [`auditsListAuditIssues`](docs/sdks/audits/README.md#listauditissues) - List snapshotted issues for an audit
|
|
@@ -226,11 +233,16 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
226
233
|
- [`auditsListInformationRequestEvidence`](docs/sdks/audits/README.md#listinformationrequestevidence) - List evidence for an information request
|
|
227
234
|
- [`auditsListInformationRequests`](docs/sdks/audits/README.md#listinformationrequests) - List information requests for an audit
|
|
228
235
|
- [`auditsListInformationRequestsForControl`](docs/sdks/audits/README.md#listinformationrequestsforcontrol) - List information requests linked to a control within an audit
|
|
236
|
+
- [`auditsListMonitoredComputersInAuditScope`](docs/sdks/audits/README.md#listmonitoredcomputersinauditscope) - List monitored computers
|
|
237
|
+
- [`auditsListPeopleInAuditScope`](docs/sdks/audits/README.md#listpeopleinauditscope) - List of people who are in scope for this audit
|
|
229
238
|
- [`auditsListPersonnelAccountAccess`](docs/sdks/audits/README.md#listpersonnelaccountaccess) - List account access records for an audit
|
|
230
239
|
- [`auditsListPersonnelGroups`](docs/sdks/audits/README.md#listpersonnelgroups) - List groups for an audit
|
|
231
240
|
- [`auditsListPersonnelPeople`](docs/sdks/audits/README.md#listpersonnelpeople) - List people for an audit
|
|
232
241
|
- [`auditsListRiskSnapshots`](docs/sdks/audits/README.md#listrisksnapshots) - List risk snapshots for an audit
|
|
233
242
|
- [`auditsListVendors`](docs/sdks/audits/README.md#listvendors) - List vendors for an audit
|
|
243
|
+
- [`auditsListVendorsInAuditScope`](docs/sdks/audits/README.md#listvendorsinauditscope) - List of vendors who are in scope for this audit
|
|
244
|
+
- [`auditsListVulnerabilities`](docs/sdks/audits/README.md#listvulnerabilities) - List vulnerabilities within the scope of a given audit
|
|
245
|
+
- [`auditsListVulnerabilityRemediationsInAuditScope`](docs/sdks/audits/README.md#listvulnerabilityremediationsinauditscope) - List vulnerability remediations that are in scope for this audit
|
|
234
246
|
- [`auditsShareInformationRequestList`](docs/sdks/audits/README.md#shareinformationrequestlist) - Share information request list with customer
|
|
235
247
|
- [`auditsUpdateCommentForInformationRequest`](docs/sdks/audits/README.md#updatecommentforinformationrequest) - Update a comment for an information request
|
|
236
248
|
- [`auditsUpdateEvidence`](docs/sdks/audits/README.md#updateevidence) - Update audit evidence
|
|
@@ -34,6 +34,8 @@
|
|
|
34
34
|
* [listAuditIssues](#listauditissues) - List snapshotted issues for an audit
|
|
35
35
|
* [listAuditSnapshots](#listauditsnapshots) - List snapshotted issues for an audit
|
|
36
36
|
* [listVendors](#listvendors) - List vendors for an audit
|
|
37
|
+
* [listMonitoredComputersInAuditScope](#listmonitoredcomputersinauditscope) - List monitored computers
|
|
38
|
+
* [listPeopleInAuditScope](#listpeopleinauditscope) - List of people who are in scope for this audit
|
|
37
39
|
* [listAccountAccessServices](#listaccountaccessservices) - List account access services for an audit
|
|
38
40
|
* [listPersonnelAccountAccess](#listpersonnelaccountaccess) - List account access records for an audit
|
|
39
41
|
* [listPersonnelGroups](#listpersonnelgroups) - List groups for an audit
|
|
@@ -41,6 +43,10 @@
|
|
|
41
43
|
* [listRiskSnapshots](#listrisksnapshots) - List risk snapshots for an audit
|
|
42
44
|
* [listAuditRisks](#listauditrisks) - List risks for an audit
|
|
43
45
|
* [shareInformationRequestList](#shareinformationrequestlist) - Share information request list with customer
|
|
46
|
+
* [listVendorsInAuditScope](#listvendorsinauditscope) - List of vendors who are in scope for this audit
|
|
47
|
+
* [listVulnerabilities](#listvulnerabilities) - List vulnerabilities within the scope of a given audit
|
|
48
|
+
* [listVulnerabilityRemediationsInAuditScope](#listvulnerabilityremediationsinauditscope) - List vulnerability remediations that are in scope for this audit
|
|
49
|
+
* [getVulnerableAssets](#getvulnerableassets) - List assets associated with vulnerabilities
|
|
44
50
|
|
|
45
51
|
## list
|
|
46
52
|
|
|
@@ -2621,6 +2627,154 @@ run();
|
|
|
2621
2627
|
| --------------- | --------------- | --------------- |
|
|
2622
2628
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
2623
2629
|
|
|
2630
|
+
## listMonitoredComputersInAuditScope
|
|
2631
|
+
|
|
2632
|
+
Returns a list of computers monitored by an MDM (with an integration built
|
|
2633
|
+
by Vanta) or by the Vanta Agent. Currently this list does not include
|
|
2634
|
+
resources from partner or customer-built integrations.
|
|
2635
|
+
|
|
2636
|
+
### Example Usage
|
|
2637
|
+
|
|
2638
|
+
<!-- UsageSnippet language="typescript" operationID="ListMonitoredComputersInAuditScope" method="get" path="/audits/{auditId}/monitored-computers" example="Example 1" -->
|
|
2639
|
+
```typescript
|
|
2640
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
2641
|
+
|
|
2642
|
+
const vanta = new Vanta({
|
|
2643
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
2644
|
+
});
|
|
2645
|
+
|
|
2646
|
+
async function run() {
|
|
2647
|
+
const result = await vanta.audits.listMonitoredComputersInAuditScope({
|
|
2648
|
+
auditId: "<id>",
|
|
2649
|
+
});
|
|
2650
|
+
|
|
2651
|
+
console.log(result);
|
|
2652
|
+
}
|
|
2653
|
+
|
|
2654
|
+
run();
|
|
2655
|
+
```
|
|
2656
|
+
|
|
2657
|
+
### Standalone function
|
|
2658
|
+
|
|
2659
|
+
The standalone function version of this method:
|
|
2660
|
+
|
|
2661
|
+
```typescript
|
|
2662
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
2663
|
+
import { auditsListMonitoredComputersInAuditScope } from "vanta-auditor-api-sdk/funcs/auditsListMonitoredComputersInAuditScope.js";
|
|
2664
|
+
|
|
2665
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
2666
|
+
// You can create one instance of it to use across an application.
|
|
2667
|
+
const vanta = new VantaCore({
|
|
2668
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
2669
|
+
});
|
|
2670
|
+
|
|
2671
|
+
async function run() {
|
|
2672
|
+
const res = await auditsListMonitoredComputersInAuditScope(vanta, {
|
|
2673
|
+
auditId: "<id>",
|
|
2674
|
+
});
|
|
2675
|
+
if (res.ok) {
|
|
2676
|
+
const { value: result } = res;
|
|
2677
|
+
console.log(result);
|
|
2678
|
+
} else {
|
|
2679
|
+
console.log("auditsListMonitoredComputersInAuditScope failed:", res.error);
|
|
2680
|
+
}
|
|
2681
|
+
}
|
|
2682
|
+
|
|
2683
|
+
run();
|
|
2684
|
+
```
|
|
2685
|
+
|
|
2686
|
+
### Parameters
|
|
2687
|
+
|
|
2688
|
+
| Parameter | Type | Required | Description |
|
|
2689
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2690
|
+
| `request` | [operations.ListMonitoredComputersInAuditScopeRequest](../../models/operations/listmonitoredcomputersinauditscoperequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2691
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2692
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2693
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2694
|
+
|
|
2695
|
+
### Response
|
|
2696
|
+
|
|
2697
|
+
**Promise\<[components.PaginatedResponseMonitoredComputer](../../models/components/paginatedresponsemonitoredcomputer.md)\>**
|
|
2698
|
+
|
|
2699
|
+
### Errors
|
|
2700
|
+
|
|
2701
|
+
| Error Type | Status Code | Content Type |
|
|
2702
|
+
| --------------- | --------------- | --------------- |
|
|
2703
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
2704
|
+
|
|
2705
|
+
## listPeopleInAuditScope
|
|
2706
|
+
|
|
2707
|
+
Returns a list of people who are in scope for this audit.
|
|
2708
|
+
|
|
2709
|
+
### Example Usage
|
|
2710
|
+
|
|
2711
|
+
<!-- UsageSnippet language="typescript" operationID="ListPeopleInAuditScope" method="get" path="/audits/{auditId}/people" example="Example 1" -->
|
|
2712
|
+
```typescript
|
|
2713
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
2714
|
+
|
|
2715
|
+
const vanta = new Vanta({
|
|
2716
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
2717
|
+
});
|
|
2718
|
+
|
|
2719
|
+
async function run() {
|
|
2720
|
+
const result = await vanta.audits.listPeopleInAuditScope({
|
|
2721
|
+
auditId: "<id>",
|
|
2722
|
+
});
|
|
2723
|
+
|
|
2724
|
+
console.log(result);
|
|
2725
|
+
}
|
|
2726
|
+
|
|
2727
|
+
run();
|
|
2728
|
+
```
|
|
2729
|
+
|
|
2730
|
+
### Standalone function
|
|
2731
|
+
|
|
2732
|
+
The standalone function version of this method:
|
|
2733
|
+
|
|
2734
|
+
```typescript
|
|
2735
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
2736
|
+
import { auditsListPeopleInAuditScope } from "vanta-auditor-api-sdk/funcs/auditsListPeopleInAuditScope.js";
|
|
2737
|
+
|
|
2738
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
2739
|
+
// You can create one instance of it to use across an application.
|
|
2740
|
+
const vanta = new VantaCore({
|
|
2741
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
2742
|
+
});
|
|
2743
|
+
|
|
2744
|
+
async function run() {
|
|
2745
|
+
const res = await auditsListPeopleInAuditScope(vanta, {
|
|
2746
|
+
auditId: "<id>",
|
|
2747
|
+
});
|
|
2748
|
+
if (res.ok) {
|
|
2749
|
+
const { value: result } = res;
|
|
2750
|
+
console.log(result);
|
|
2751
|
+
} else {
|
|
2752
|
+
console.log("auditsListPeopleInAuditScope failed:", res.error);
|
|
2753
|
+
}
|
|
2754
|
+
}
|
|
2755
|
+
|
|
2756
|
+
run();
|
|
2757
|
+
```
|
|
2758
|
+
|
|
2759
|
+
### Parameters
|
|
2760
|
+
|
|
2761
|
+
| Parameter | Type | Required | Description |
|
|
2762
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2763
|
+
| `request` | [operations.ListPeopleInAuditScopeRequest](../../models/operations/listpeopleinauditscoperequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2764
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2765
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2766
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2767
|
+
|
|
2768
|
+
### Response
|
|
2769
|
+
|
|
2770
|
+
**Promise\<[components.PaginatedResponsePerson](../../models/components/paginatedresponseperson.md)\>**
|
|
2771
|
+
|
|
2772
|
+
### Errors
|
|
2773
|
+
|
|
2774
|
+
| Error Type | Status Code | Content Type |
|
|
2775
|
+
| --------------- | --------------- | --------------- |
|
|
2776
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
2777
|
+
|
|
2624
2778
|
## listAccountAccessServices
|
|
2625
2779
|
|
|
2626
2780
|
Retrieves connected account access services for an audit.
|
|
@@ -3262,6 +3416,298 @@ run();
|
|
|
3262
3416
|
|
|
3263
3417
|
### Errors
|
|
3264
3418
|
|
|
3419
|
+
| Error Type | Status Code | Content Type |
|
|
3420
|
+
| --------------- | --------------- | --------------- |
|
|
3421
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
3422
|
+
|
|
3423
|
+
## listVendorsInAuditScope
|
|
3424
|
+
|
|
3425
|
+
Returns a list of vendors who are in scope for this audit.
|
|
3426
|
+
|
|
3427
|
+
### Example Usage
|
|
3428
|
+
|
|
3429
|
+
<!-- UsageSnippet language="typescript" operationID="ListVendorsInAuditScope" method="get" path="/audits/{auditId}/vendors" example="Example 1" -->
|
|
3430
|
+
```typescript
|
|
3431
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
3432
|
+
|
|
3433
|
+
const vanta = new Vanta({
|
|
3434
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3435
|
+
});
|
|
3436
|
+
|
|
3437
|
+
async function run() {
|
|
3438
|
+
const result = await vanta.audits.listVendorsInAuditScope({
|
|
3439
|
+
auditId: "<id>",
|
|
3440
|
+
});
|
|
3441
|
+
|
|
3442
|
+
console.log(result);
|
|
3443
|
+
}
|
|
3444
|
+
|
|
3445
|
+
run();
|
|
3446
|
+
```
|
|
3447
|
+
|
|
3448
|
+
### Standalone function
|
|
3449
|
+
|
|
3450
|
+
The standalone function version of this method:
|
|
3451
|
+
|
|
3452
|
+
```typescript
|
|
3453
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
3454
|
+
import { auditsListVendorsInAuditScope } from "vanta-auditor-api-sdk/funcs/auditsListVendorsInAuditScope.js";
|
|
3455
|
+
|
|
3456
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
3457
|
+
// You can create one instance of it to use across an application.
|
|
3458
|
+
const vanta = new VantaCore({
|
|
3459
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3460
|
+
});
|
|
3461
|
+
|
|
3462
|
+
async function run() {
|
|
3463
|
+
const res = await auditsListVendorsInAuditScope(vanta, {
|
|
3464
|
+
auditId: "<id>",
|
|
3465
|
+
});
|
|
3466
|
+
if (res.ok) {
|
|
3467
|
+
const { value: result } = res;
|
|
3468
|
+
console.log(result);
|
|
3469
|
+
} else {
|
|
3470
|
+
console.log("auditsListVendorsInAuditScope failed:", res.error);
|
|
3471
|
+
}
|
|
3472
|
+
}
|
|
3473
|
+
|
|
3474
|
+
run();
|
|
3475
|
+
```
|
|
3476
|
+
|
|
3477
|
+
### Parameters
|
|
3478
|
+
|
|
3479
|
+
| Parameter | Type | Required | Description |
|
|
3480
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3481
|
+
| `request` | [operations.ListVendorsInAuditScopeRequest](../../models/operations/listvendorsinauditscoperequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3482
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3483
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
3484
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3485
|
+
|
|
3486
|
+
### Response
|
|
3487
|
+
|
|
3488
|
+
**Promise\<[components.PaginatedResponseVendor](../../models/components/paginatedresponsevendor.md)\>**
|
|
3489
|
+
|
|
3490
|
+
### Errors
|
|
3491
|
+
|
|
3492
|
+
| Error Type | Status Code | Content Type |
|
|
3493
|
+
| --------------- | --------------- | --------------- |
|
|
3494
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
3495
|
+
|
|
3496
|
+
## listVulnerabilities
|
|
3497
|
+
|
|
3498
|
+
List all vulnerabilities based on selected filters.
|
|
3499
|
+
|
|
3500
|
+
### Example Usage
|
|
3501
|
+
|
|
3502
|
+
<!-- UsageSnippet language="typescript" operationID="ListVulnerabilities" method="get" path="/audits/{auditId}/vulnerabilities" example="Example 1" -->
|
|
3503
|
+
```typescript
|
|
3504
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
3505
|
+
|
|
3506
|
+
const vanta = new Vanta({
|
|
3507
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3508
|
+
});
|
|
3509
|
+
|
|
3510
|
+
async function run() {
|
|
3511
|
+
const result = await vanta.audits.listVulnerabilities({
|
|
3512
|
+
auditId: "<id>",
|
|
3513
|
+
});
|
|
3514
|
+
|
|
3515
|
+
console.log(result);
|
|
3516
|
+
}
|
|
3517
|
+
|
|
3518
|
+
run();
|
|
3519
|
+
```
|
|
3520
|
+
|
|
3521
|
+
### Standalone function
|
|
3522
|
+
|
|
3523
|
+
The standalone function version of this method:
|
|
3524
|
+
|
|
3525
|
+
```typescript
|
|
3526
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
3527
|
+
import { auditsListVulnerabilities } from "vanta-auditor-api-sdk/funcs/auditsListVulnerabilities.js";
|
|
3528
|
+
|
|
3529
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
3530
|
+
// You can create one instance of it to use across an application.
|
|
3531
|
+
const vanta = new VantaCore({
|
|
3532
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3533
|
+
});
|
|
3534
|
+
|
|
3535
|
+
async function run() {
|
|
3536
|
+
const res = await auditsListVulnerabilities(vanta, {
|
|
3537
|
+
auditId: "<id>",
|
|
3538
|
+
});
|
|
3539
|
+
if (res.ok) {
|
|
3540
|
+
const { value: result } = res;
|
|
3541
|
+
console.log(result);
|
|
3542
|
+
} else {
|
|
3543
|
+
console.log("auditsListVulnerabilities failed:", res.error);
|
|
3544
|
+
}
|
|
3545
|
+
}
|
|
3546
|
+
|
|
3547
|
+
run();
|
|
3548
|
+
```
|
|
3549
|
+
|
|
3550
|
+
### Parameters
|
|
3551
|
+
|
|
3552
|
+
| Parameter | Type | Required | Description |
|
|
3553
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3554
|
+
| `request` | [operations.ListVulnerabilitiesRequest](../../models/operations/listvulnerabilitiesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3555
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3556
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
3557
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3558
|
+
|
|
3559
|
+
### Response
|
|
3560
|
+
|
|
3561
|
+
**Promise\<[components.PaginatedResponseAuditorApiVulnerability](../../models/components/paginatedresponseauditorapivulnerability.md)\>**
|
|
3562
|
+
|
|
3563
|
+
### Errors
|
|
3564
|
+
|
|
3565
|
+
| Error Type | Status Code | Content Type |
|
|
3566
|
+
| --------------- | --------------- | --------------- |
|
|
3567
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
3568
|
+
|
|
3569
|
+
## listVulnerabilityRemediationsInAuditScope
|
|
3570
|
+
|
|
3571
|
+
List all vulnerability remediations based on selected filters that are in scope for this audit.
|
|
3572
|
+
|
|
3573
|
+
### Example Usage
|
|
3574
|
+
|
|
3575
|
+
<!-- UsageSnippet language="typescript" operationID="ListVulnerabilityRemediationsInAuditScope" method="get" path="/audits/{auditId}/vulnerability-remediations" example="Example 1" -->
|
|
3576
|
+
```typescript
|
|
3577
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
3578
|
+
|
|
3579
|
+
const vanta = new Vanta({
|
|
3580
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3581
|
+
});
|
|
3582
|
+
|
|
3583
|
+
async function run() {
|
|
3584
|
+
const result = await vanta.audits.listVulnerabilityRemediationsInAuditScope({
|
|
3585
|
+
auditId: "<id>",
|
|
3586
|
+
});
|
|
3587
|
+
|
|
3588
|
+
console.log(result);
|
|
3589
|
+
}
|
|
3590
|
+
|
|
3591
|
+
run();
|
|
3592
|
+
```
|
|
3593
|
+
|
|
3594
|
+
### Standalone function
|
|
3595
|
+
|
|
3596
|
+
The standalone function version of this method:
|
|
3597
|
+
|
|
3598
|
+
```typescript
|
|
3599
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
3600
|
+
import { auditsListVulnerabilityRemediationsInAuditScope } from "vanta-auditor-api-sdk/funcs/auditsListVulnerabilityRemediationsInAuditScope.js";
|
|
3601
|
+
|
|
3602
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
3603
|
+
// You can create one instance of it to use across an application.
|
|
3604
|
+
const vanta = new VantaCore({
|
|
3605
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3606
|
+
});
|
|
3607
|
+
|
|
3608
|
+
async function run() {
|
|
3609
|
+
const res = await auditsListVulnerabilityRemediationsInAuditScope(vanta, {
|
|
3610
|
+
auditId: "<id>",
|
|
3611
|
+
});
|
|
3612
|
+
if (res.ok) {
|
|
3613
|
+
const { value: result } = res;
|
|
3614
|
+
console.log(result);
|
|
3615
|
+
} else {
|
|
3616
|
+
console.log("auditsListVulnerabilityRemediationsInAuditScope failed:", res.error);
|
|
3617
|
+
}
|
|
3618
|
+
}
|
|
3619
|
+
|
|
3620
|
+
run();
|
|
3621
|
+
```
|
|
3622
|
+
|
|
3623
|
+
### Parameters
|
|
3624
|
+
|
|
3625
|
+
| Parameter | Type | Required | Description |
|
|
3626
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3627
|
+
| `request` | [operations.ListVulnerabilityRemediationsInAuditScopeRequest](../../models/operations/listvulnerabilityremediationsinauditscoperequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3628
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3629
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
3630
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3631
|
+
|
|
3632
|
+
### Response
|
|
3633
|
+
|
|
3634
|
+
**Promise\<[components.PaginatedResponseVulnerabilityRemediation](../../models/components/paginatedresponsevulnerabilityremediation.md)\>**
|
|
3635
|
+
|
|
3636
|
+
### Errors
|
|
3637
|
+
|
|
3638
|
+
| Error Type | Status Code | Content Type |
|
|
3639
|
+
| --------------- | --------------- | --------------- |
|
|
3640
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
3641
|
+
|
|
3642
|
+
## getVulnerableAssets
|
|
3643
|
+
|
|
3644
|
+
List assets that Vanta monitors that are associated with vulnerabilities.
|
|
3645
|
+
|
|
3646
|
+
### Example Usage
|
|
3647
|
+
|
|
3648
|
+
<!-- UsageSnippet language="typescript" operationID="GetVulnerableAssets" method="get" path="/audits/{auditId}/vulnerable-assets" example="Example 1" -->
|
|
3649
|
+
```typescript
|
|
3650
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
3651
|
+
|
|
3652
|
+
const vanta = new Vanta({
|
|
3653
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3654
|
+
});
|
|
3655
|
+
|
|
3656
|
+
async function run() {
|
|
3657
|
+
const result = await vanta.audits.getVulnerableAssets({
|
|
3658
|
+
auditId: "<id>",
|
|
3659
|
+
});
|
|
3660
|
+
|
|
3661
|
+
console.log(result);
|
|
3662
|
+
}
|
|
3663
|
+
|
|
3664
|
+
run();
|
|
3665
|
+
```
|
|
3666
|
+
|
|
3667
|
+
### Standalone function
|
|
3668
|
+
|
|
3669
|
+
The standalone function version of this method:
|
|
3670
|
+
|
|
3671
|
+
```typescript
|
|
3672
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
3673
|
+
import { auditsGetVulnerableAssets } from "vanta-auditor-api-sdk/funcs/auditsGetVulnerableAssets.js";
|
|
3674
|
+
|
|
3675
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
3676
|
+
// You can create one instance of it to use across an application.
|
|
3677
|
+
const vanta = new VantaCore({
|
|
3678
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3679
|
+
});
|
|
3680
|
+
|
|
3681
|
+
async function run() {
|
|
3682
|
+
const res = await auditsGetVulnerableAssets(vanta, {
|
|
3683
|
+
auditId: "<id>",
|
|
3684
|
+
});
|
|
3685
|
+
if (res.ok) {
|
|
3686
|
+
const { value: result } = res;
|
|
3687
|
+
console.log(result);
|
|
3688
|
+
} else {
|
|
3689
|
+
console.log("auditsGetVulnerableAssets failed:", res.error);
|
|
3690
|
+
}
|
|
3691
|
+
}
|
|
3692
|
+
|
|
3693
|
+
run();
|
|
3694
|
+
```
|
|
3695
|
+
|
|
3696
|
+
### Parameters
|
|
3697
|
+
|
|
3698
|
+
| Parameter | Type | Required | Description |
|
|
3699
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3700
|
+
| `request` | [operations.GetVulnerableAssetsRequest](../../models/operations/getvulnerableassetsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3701
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3702
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
3703
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3704
|
+
|
|
3705
|
+
### Response
|
|
3706
|
+
|
|
3707
|
+
**Promise\<[components.PaginatedResponseVulnerableAsset](../../models/components/paginatedresponsevulnerableasset.md)\>**
|
|
3708
|
+
|
|
3709
|
+
### Errors
|
|
3710
|
+
|
|
3265
3711
|
| Error Type | Status Code | Content Type |
|
|
3266
3712
|
| --------------- | --------------- | --------------- |
|
|
3267
3713
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { VantaCore } from "../core.js";
|
|
2
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
+
import * as components from "../models/components/index.js";
|
|
4
|
+
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
|
|
5
|
+
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
|
|
6
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
7
|
+
import { VantaError } from "../models/errors/vantaerror.js";
|
|
8
|
+
import * as operations from "../models/operations/index.js";
|
|
9
|
+
import { APIPromise } from "../types/async.js";
|
|
10
|
+
import { Result } from "../types/fp.js";
|
|
11
|
+
/**
|
|
12
|
+
* List assets associated with vulnerabilities
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
* List assets that Vanta monitors that are associated with vulnerabilities.
|
|
16
|
+
*/
|
|
17
|
+
export declare function auditsGetVulnerableAssets(client: VantaCore, request: operations.GetVulnerableAssetsRequest, options?: RequestOptions): APIPromise<Result<components.PaginatedResponseVulnerableAsset, VantaError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
|
+
//# sourceMappingURL=auditsGetVulnerableAssets.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"auditsGetVulnerableAssets.d.ts","sourceRoot":"","sources":["../src/funcs/auditsGetVulnerableAssets.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAMvC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,gCAAgC,EACzC,UAAU,GACV,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
|