vanta-auditor-api-sdk 0.6.3 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/docs/sdks/audits/README.md +470 -0
- package/funcs/auditsGetVulnerableAssets.d.ts +22 -0
- package/funcs/auditsGetVulnerableAssets.d.ts.map +1 -0
- package/funcs/auditsGetVulnerableAssets.js +134 -0
- package/funcs/auditsGetVulnerableAssets.js.map +1 -0
- package/funcs/auditsListMonitoredComputersInAuditScope.d.ts +24 -0
- package/funcs/auditsListMonitoredComputersInAuditScope.d.ts.map +1 -0
- package/funcs/auditsListMonitoredComputersInAuditScope.js +133 -0
- package/funcs/auditsListMonitoredComputersInAuditScope.js.map +1 -0
- package/funcs/auditsListPeopleInAuditScope.d.ts +22 -0
- package/funcs/auditsListPeopleInAuditScope.d.ts.map +1 -0
- package/funcs/auditsListPeopleInAuditScope.js +133 -0
- package/funcs/auditsListPeopleInAuditScope.js.map +1 -0
- package/funcs/auditsListVendorsInAuditScope.d.ts +22 -0
- package/funcs/auditsListVendorsInAuditScope.d.ts.map +1 -0
- package/funcs/auditsListVendorsInAuditScope.js +130 -0
- package/funcs/auditsListVendorsInAuditScope.js.map +1 -0
- package/funcs/auditsListVulnerabilities.d.ts +22 -0
- package/funcs/auditsListVulnerabilities.d.ts.map +1 -0
- package/funcs/auditsListVulnerabilities.js +141 -0
- package/funcs/auditsListVulnerabilities.js.map +1 -0
- package/funcs/auditsListVulnerabilityRemediationsInAuditScope.d.ts +22 -0
- package/funcs/auditsListVulnerabilityRemediationsInAuditScope.d.ts.map +1 -0
- package/funcs/auditsListVulnerabilityRemediationsInAuditScope.js +136 -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 +68 -0
- package/sdk/audits.d.ts.map +1 -1
- package/sdk/audits.js +86 -0
- package/sdk/audits.js.map +1 -1
- package/src/funcs/auditsGetVulnerableAssets.ts +183 -0
- package/src/funcs/auditsListMonitoredComputersInAuditScope.ts +185 -0
- package/src/funcs/auditsListPeopleInAuditScope.ts +182 -0
- package/src/funcs/auditsListVendorsInAuditScope.ts +179 -0
- package/src/funcs/auditsListVulnerabilities.ts +194 -0
- package/src/funcs/auditsListVulnerabilityRemediationsInAuditScope.ts +190 -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 +134 -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 :warning: **Deprecated**
|
|
175
|
+
* [~~listPeopleInAuditScope~~](docs/sdks/audits/README.md#listpeopleinauditscope) - List of people who are in scope for this audit :warning: **Deprecated**
|
|
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 :warning: **Deprecated**
|
|
184
|
+
* [~~listVulnerabilities~~](docs/sdks/audits/README.md#listvulnerabilities) - List vulnerabilities within the scope of a given audit :warning: **Deprecated**
|
|
185
|
+
* [~~listVulnerabilityRemediationsInAuditScope~~](docs/sdks/audits/README.md#listvulnerabilityremediationsinauditscope) - List vulnerability remediations that are in scope for this audit :warning: **Deprecated**
|
|
186
|
+
* [~~getVulnerableAssets~~](docs/sdks/audits/README.md#getvulnerableassets) - List assets associated with vulnerabilities :warning: **Deprecated**
|
|
181
187
|
|
|
182
188
|
</details>
|
|
183
189
|
<!-- End Available Resources and Operations [operations] -->
|
|
@@ -235,6 +241,12 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
235
241
|
- [`auditsUpdateCommentForInformationRequest`](docs/sdks/audits/README.md#updatecommentforinformationrequest) - Update a comment for an information request
|
|
236
242
|
- [`auditsUpdateEvidence`](docs/sdks/audits/README.md#updateevidence) - Update audit evidence
|
|
237
243
|
- [`auditsUpdateInformationRequest`](docs/sdks/audits/README.md#updateinformationrequest) - Update an information request for an audit
|
|
244
|
+
- ~~[`auditsGetVulnerableAssets`](docs/sdks/audits/README.md#getvulnerableassets)~~ - List assets associated with vulnerabilities :warning: **Deprecated**
|
|
245
|
+
- ~~[`auditsListMonitoredComputersInAuditScope`](docs/sdks/audits/README.md#listmonitoredcomputersinauditscope)~~ - List monitored computers :warning: **Deprecated**
|
|
246
|
+
- ~~[`auditsListPeopleInAuditScope`](docs/sdks/audits/README.md#listpeopleinauditscope)~~ - List of people who are in scope for this audit :warning: **Deprecated**
|
|
247
|
+
- ~~[`auditsListVendorsInAuditScope`](docs/sdks/audits/README.md#listvendorsinauditscope)~~ - List of vendors who are in scope for this audit :warning: **Deprecated**
|
|
248
|
+
- ~~[`auditsListVulnerabilities`](docs/sdks/audits/README.md#listvulnerabilities)~~ - List vulnerabilities within the scope of a given audit :warning: **Deprecated**
|
|
249
|
+
- ~~[`auditsListVulnerabilityRemediationsInAuditScope`](docs/sdks/audits/README.md#listvulnerabilityremediationsinauditscope)~~ - List vulnerability remediations that are in scope for this audit :warning: **Deprecated**
|
|
238
250
|
|
|
239
251
|
</details>
|
|
240
252
|
<!-- End Standalone functions [standalone-funcs] -->
|
|
@@ -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 :warning: **Deprecated**
|
|
38
|
+
* [~~listPeopleInAuditScope~~](#listpeopleinauditscope) - List of people who are in scope for this audit :warning: **Deprecated**
|
|
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 :warning: **Deprecated**
|
|
47
|
+
* [~~listVulnerabilities~~](#listvulnerabilities) - List vulnerabilities within the scope of a given audit :warning: **Deprecated**
|
|
48
|
+
* [~~listVulnerabilityRemediationsInAuditScope~~](#listvulnerabilityremediationsinauditscope) - List vulnerability remediations that are in scope for this audit :warning: **Deprecated**
|
|
49
|
+
* [~~getVulnerableAssets~~](#getvulnerableassets) - List assets associated with vulnerabilities :warning: **Deprecated**
|
|
44
50
|
|
|
45
51
|
## list
|
|
46
52
|
|
|
@@ -2621,6 +2627,162 @@ 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
|
+
End of life — this endpoint works for legacy audits only and does not support controlled audit view.
|
|
2637
|
+
|
|
2638
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
2639
|
+
|
|
2640
|
+
### Example Usage
|
|
2641
|
+
|
|
2642
|
+
<!-- UsageSnippet language="typescript" operationID="ListMonitoredComputersInAuditScope" method="get" path="/audits/{auditId}/monitored-computers" example="Example 1" -->
|
|
2643
|
+
```typescript
|
|
2644
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
2645
|
+
|
|
2646
|
+
const vanta = new Vanta({
|
|
2647
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
2648
|
+
});
|
|
2649
|
+
|
|
2650
|
+
async function run() {
|
|
2651
|
+
const result = await vanta.audits.listMonitoredComputersInAuditScope({
|
|
2652
|
+
auditId: "<id>",
|
|
2653
|
+
});
|
|
2654
|
+
|
|
2655
|
+
console.log(result);
|
|
2656
|
+
}
|
|
2657
|
+
|
|
2658
|
+
run();
|
|
2659
|
+
```
|
|
2660
|
+
|
|
2661
|
+
### Standalone function
|
|
2662
|
+
|
|
2663
|
+
The standalone function version of this method:
|
|
2664
|
+
|
|
2665
|
+
```typescript
|
|
2666
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
2667
|
+
import { auditsListMonitoredComputersInAuditScope } from "vanta-auditor-api-sdk/funcs/auditsListMonitoredComputersInAuditScope.js";
|
|
2668
|
+
|
|
2669
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
2670
|
+
// You can create one instance of it to use across an application.
|
|
2671
|
+
const vanta = new VantaCore({
|
|
2672
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
2673
|
+
});
|
|
2674
|
+
|
|
2675
|
+
async function run() {
|
|
2676
|
+
const res = await auditsListMonitoredComputersInAuditScope(vanta, {
|
|
2677
|
+
auditId: "<id>",
|
|
2678
|
+
});
|
|
2679
|
+
if (res.ok) {
|
|
2680
|
+
const { value: result } = res;
|
|
2681
|
+
console.log(result);
|
|
2682
|
+
} else {
|
|
2683
|
+
console.log("auditsListMonitoredComputersInAuditScope failed:", res.error);
|
|
2684
|
+
}
|
|
2685
|
+
}
|
|
2686
|
+
|
|
2687
|
+
run();
|
|
2688
|
+
```
|
|
2689
|
+
|
|
2690
|
+
### Parameters
|
|
2691
|
+
|
|
2692
|
+
| Parameter | Type | Required | Description |
|
|
2693
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2694
|
+
| `request` | [operations.ListMonitoredComputersInAuditScopeRequest](../../models/operations/listmonitoredcomputersinauditscoperequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2695
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2696
|
+
| `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. |
|
|
2697
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2698
|
+
|
|
2699
|
+
### Response
|
|
2700
|
+
|
|
2701
|
+
**Promise\<[components.PaginatedResponseMonitoredComputer](../../models/components/paginatedresponsemonitoredcomputer.md)\>**
|
|
2702
|
+
|
|
2703
|
+
### Errors
|
|
2704
|
+
|
|
2705
|
+
| Error Type | Status Code | Content Type |
|
|
2706
|
+
| --------------- | --------------- | --------------- |
|
|
2707
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
2708
|
+
|
|
2709
|
+
## ~~listPeopleInAuditScope~~
|
|
2710
|
+
|
|
2711
|
+
Returns a list of people who are in scope for this audit.
|
|
2712
|
+
|
|
2713
|
+
End of life — this endpoint works for legacy audits only and does not support controlled audit view.
|
|
2714
|
+
|
|
2715
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
2716
|
+
|
|
2717
|
+
### Example Usage
|
|
2718
|
+
|
|
2719
|
+
<!-- UsageSnippet language="typescript" operationID="ListPeopleInAuditScope" method="get" path="/audits/{auditId}/people" example="Example 1" -->
|
|
2720
|
+
```typescript
|
|
2721
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
2722
|
+
|
|
2723
|
+
const vanta = new Vanta({
|
|
2724
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
2725
|
+
});
|
|
2726
|
+
|
|
2727
|
+
async function run() {
|
|
2728
|
+
const result = await vanta.audits.listPeopleInAuditScope({
|
|
2729
|
+
auditId: "<id>",
|
|
2730
|
+
});
|
|
2731
|
+
|
|
2732
|
+
console.log(result);
|
|
2733
|
+
}
|
|
2734
|
+
|
|
2735
|
+
run();
|
|
2736
|
+
```
|
|
2737
|
+
|
|
2738
|
+
### Standalone function
|
|
2739
|
+
|
|
2740
|
+
The standalone function version of this method:
|
|
2741
|
+
|
|
2742
|
+
```typescript
|
|
2743
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
2744
|
+
import { auditsListPeopleInAuditScope } from "vanta-auditor-api-sdk/funcs/auditsListPeopleInAuditScope.js";
|
|
2745
|
+
|
|
2746
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
2747
|
+
// You can create one instance of it to use across an application.
|
|
2748
|
+
const vanta = new VantaCore({
|
|
2749
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
2750
|
+
});
|
|
2751
|
+
|
|
2752
|
+
async function run() {
|
|
2753
|
+
const res = await auditsListPeopleInAuditScope(vanta, {
|
|
2754
|
+
auditId: "<id>",
|
|
2755
|
+
});
|
|
2756
|
+
if (res.ok) {
|
|
2757
|
+
const { value: result } = res;
|
|
2758
|
+
console.log(result);
|
|
2759
|
+
} else {
|
|
2760
|
+
console.log("auditsListPeopleInAuditScope failed:", res.error);
|
|
2761
|
+
}
|
|
2762
|
+
}
|
|
2763
|
+
|
|
2764
|
+
run();
|
|
2765
|
+
```
|
|
2766
|
+
|
|
2767
|
+
### Parameters
|
|
2768
|
+
|
|
2769
|
+
| Parameter | Type | Required | Description |
|
|
2770
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2771
|
+
| `request` | [operations.ListPeopleInAuditScopeRequest](../../models/operations/listpeopleinauditscoperequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2772
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2773
|
+
| `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. |
|
|
2774
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2775
|
+
|
|
2776
|
+
### Response
|
|
2777
|
+
|
|
2778
|
+
**Promise\<[components.PaginatedResponsePerson](../../models/components/paginatedresponseperson.md)\>**
|
|
2779
|
+
|
|
2780
|
+
### Errors
|
|
2781
|
+
|
|
2782
|
+
| Error Type | Status Code | Content Type |
|
|
2783
|
+
| --------------- | --------------- | --------------- |
|
|
2784
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
2785
|
+
|
|
2624
2786
|
## listAccountAccessServices
|
|
2625
2787
|
|
|
2626
2788
|
Retrieves connected account access services for an audit.
|
|
@@ -3262,6 +3424,314 @@ run();
|
|
|
3262
3424
|
|
|
3263
3425
|
### Errors
|
|
3264
3426
|
|
|
3427
|
+
| Error Type | Status Code | Content Type |
|
|
3428
|
+
| --------------- | --------------- | --------------- |
|
|
3429
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
3430
|
+
|
|
3431
|
+
## ~~listVendorsInAuditScope~~
|
|
3432
|
+
|
|
3433
|
+
Returns a list of vendors who are in scope for this audit.
|
|
3434
|
+
|
|
3435
|
+
End of life — this endpoint works for legacy audits only and does not support controlled audit view.
|
|
3436
|
+
|
|
3437
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
3438
|
+
|
|
3439
|
+
### Example Usage
|
|
3440
|
+
|
|
3441
|
+
<!-- UsageSnippet language="typescript" operationID="ListVendorsInAuditScope" method="get" path="/audits/{auditId}/vendors" example="Example 1" -->
|
|
3442
|
+
```typescript
|
|
3443
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
3444
|
+
|
|
3445
|
+
const vanta = new Vanta({
|
|
3446
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3447
|
+
});
|
|
3448
|
+
|
|
3449
|
+
async function run() {
|
|
3450
|
+
const result = await vanta.audits.listVendorsInAuditScope({
|
|
3451
|
+
auditId: "<id>",
|
|
3452
|
+
});
|
|
3453
|
+
|
|
3454
|
+
console.log(result);
|
|
3455
|
+
}
|
|
3456
|
+
|
|
3457
|
+
run();
|
|
3458
|
+
```
|
|
3459
|
+
|
|
3460
|
+
### Standalone function
|
|
3461
|
+
|
|
3462
|
+
The standalone function version of this method:
|
|
3463
|
+
|
|
3464
|
+
```typescript
|
|
3465
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
3466
|
+
import { auditsListVendorsInAuditScope } from "vanta-auditor-api-sdk/funcs/auditsListVendorsInAuditScope.js";
|
|
3467
|
+
|
|
3468
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
3469
|
+
// You can create one instance of it to use across an application.
|
|
3470
|
+
const vanta = new VantaCore({
|
|
3471
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3472
|
+
});
|
|
3473
|
+
|
|
3474
|
+
async function run() {
|
|
3475
|
+
const res = await auditsListVendorsInAuditScope(vanta, {
|
|
3476
|
+
auditId: "<id>",
|
|
3477
|
+
});
|
|
3478
|
+
if (res.ok) {
|
|
3479
|
+
const { value: result } = res;
|
|
3480
|
+
console.log(result);
|
|
3481
|
+
} else {
|
|
3482
|
+
console.log("auditsListVendorsInAuditScope failed:", res.error);
|
|
3483
|
+
}
|
|
3484
|
+
}
|
|
3485
|
+
|
|
3486
|
+
run();
|
|
3487
|
+
```
|
|
3488
|
+
|
|
3489
|
+
### Parameters
|
|
3490
|
+
|
|
3491
|
+
| Parameter | Type | Required | Description |
|
|
3492
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3493
|
+
| `request` | [operations.ListVendorsInAuditScopeRequest](../../models/operations/listvendorsinauditscoperequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3494
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3495
|
+
| `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. |
|
|
3496
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3497
|
+
|
|
3498
|
+
### Response
|
|
3499
|
+
|
|
3500
|
+
**Promise\<[components.PaginatedResponseVendor](../../models/components/paginatedresponsevendor.md)\>**
|
|
3501
|
+
|
|
3502
|
+
### Errors
|
|
3503
|
+
|
|
3504
|
+
| Error Type | Status Code | Content Type |
|
|
3505
|
+
| --------------- | --------------- | --------------- |
|
|
3506
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
3507
|
+
|
|
3508
|
+
## ~~listVulnerabilities~~
|
|
3509
|
+
|
|
3510
|
+
List all vulnerabilities based on selected filters.
|
|
3511
|
+
|
|
3512
|
+
End of life — this endpoint works for legacy audits only and does not support controlled audit view.
|
|
3513
|
+
|
|
3514
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
3515
|
+
|
|
3516
|
+
### Example Usage
|
|
3517
|
+
|
|
3518
|
+
<!-- UsageSnippet language="typescript" operationID="ListVulnerabilities" method="get" path="/audits/{auditId}/vulnerabilities" example="Example 1" -->
|
|
3519
|
+
```typescript
|
|
3520
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
3521
|
+
|
|
3522
|
+
const vanta = new Vanta({
|
|
3523
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3524
|
+
});
|
|
3525
|
+
|
|
3526
|
+
async function run() {
|
|
3527
|
+
const result = await vanta.audits.listVulnerabilities({
|
|
3528
|
+
auditId: "<id>",
|
|
3529
|
+
});
|
|
3530
|
+
|
|
3531
|
+
console.log(result);
|
|
3532
|
+
}
|
|
3533
|
+
|
|
3534
|
+
run();
|
|
3535
|
+
```
|
|
3536
|
+
|
|
3537
|
+
### Standalone function
|
|
3538
|
+
|
|
3539
|
+
The standalone function version of this method:
|
|
3540
|
+
|
|
3541
|
+
```typescript
|
|
3542
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
3543
|
+
import { auditsListVulnerabilities } from "vanta-auditor-api-sdk/funcs/auditsListVulnerabilities.js";
|
|
3544
|
+
|
|
3545
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
3546
|
+
// You can create one instance of it to use across an application.
|
|
3547
|
+
const vanta = new VantaCore({
|
|
3548
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3549
|
+
});
|
|
3550
|
+
|
|
3551
|
+
async function run() {
|
|
3552
|
+
const res = await auditsListVulnerabilities(vanta, {
|
|
3553
|
+
auditId: "<id>",
|
|
3554
|
+
});
|
|
3555
|
+
if (res.ok) {
|
|
3556
|
+
const { value: result } = res;
|
|
3557
|
+
console.log(result);
|
|
3558
|
+
} else {
|
|
3559
|
+
console.log("auditsListVulnerabilities failed:", res.error);
|
|
3560
|
+
}
|
|
3561
|
+
}
|
|
3562
|
+
|
|
3563
|
+
run();
|
|
3564
|
+
```
|
|
3565
|
+
|
|
3566
|
+
### Parameters
|
|
3567
|
+
|
|
3568
|
+
| Parameter | Type | Required | Description |
|
|
3569
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3570
|
+
| `request` | [operations.ListVulnerabilitiesRequest](../../models/operations/listvulnerabilitiesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3571
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3572
|
+
| `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. |
|
|
3573
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3574
|
+
|
|
3575
|
+
### Response
|
|
3576
|
+
|
|
3577
|
+
**Promise\<[components.PaginatedResponseAuditorApiVulnerability](../../models/components/paginatedresponseauditorapivulnerability.md)\>**
|
|
3578
|
+
|
|
3579
|
+
### Errors
|
|
3580
|
+
|
|
3581
|
+
| Error Type | Status Code | Content Type |
|
|
3582
|
+
| --------------- | --------------- | --------------- |
|
|
3583
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
3584
|
+
|
|
3585
|
+
## ~~listVulnerabilityRemediationsInAuditScope~~
|
|
3586
|
+
|
|
3587
|
+
List all vulnerability remediations based on selected filters that are in scope for this audit.
|
|
3588
|
+
|
|
3589
|
+
End of life — this endpoint works for legacy audits only and does not support controlled audit view.
|
|
3590
|
+
|
|
3591
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
3592
|
+
|
|
3593
|
+
### Example Usage
|
|
3594
|
+
|
|
3595
|
+
<!-- UsageSnippet language="typescript" operationID="ListVulnerabilityRemediationsInAuditScope" method="get" path="/audits/{auditId}/vulnerability-remediations" example="Example 1" -->
|
|
3596
|
+
```typescript
|
|
3597
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
3598
|
+
|
|
3599
|
+
const vanta = new Vanta({
|
|
3600
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3601
|
+
});
|
|
3602
|
+
|
|
3603
|
+
async function run() {
|
|
3604
|
+
const result = await vanta.audits.listVulnerabilityRemediationsInAuditScope({
|
|
3605
|
+
auditId: "<id>",
|
|
3606
|
+
});
|
|
3607
|
+
|
|
3608
|
+
console.log(result);
|
|
3609
|
+
}
|
|
3610
|
+
|
|
3611
|
+
run();
|
|
3612
|
+
```
|
|
3613
|
+
|
|
3614
|
+
### Standalone function
|
|
3615
|
+
|
|
3616
|
+
The standalone function version of this method:
|
|
3617
|
+
|
|
3618
|
+
```typescript
|
|
3619
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
3620
|
+
import { auditsListVulnerabilityRemediationsInAuditScope } from "vanta-auditor-api-sdk/funcs/auditsListVulnerabilityRemediationsInAuditScope.js";
|
|
3621
|
+
|
|
3622
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
3623
|
+
// You can create one instance of it to use across an application.
|
|
3624
|
+
const vanta = new VantaCore({
|
|
3625
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3626
|
+
});
|
|
3627
|
+
|
|
3628
|
+
async function run() {
|
|
3629
|
+
const res = await auditsListVulnerabilityRemediationsInAuditScope(vanta, {
|
|
3630
|
+
auditId: "<id>",
|
|
3631
|
+
});
|
|
3632
|
+
if (res.ok) {
|
|
3633
|
+
const { value: result } = res;
|
|
3634
|
+
console.log(result);
|
|
3635
|
+
} else {
|
|
3636
|
+
console.log("auditsListVulnerabilityRemediationsInAuditScope failed:", res.error);
|
|
3637
|
+
}
|
|
3638
|
+
}
|
|
3639
|
+
|
|
3640
|
+
run();
|
|
3641
|
+
```
|
|
3642
|
+
|
|
3643
|
+
### Parameters
|
|
3644
|
+
|
|
3645
|
+
| Parameter | Type | Required | Description |
|
|
3646
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3647
|
+
| `request` | [operations.ListVulnerabilityRemediationsInAuditScopeRequest](../../models/operations/listvulnerabilityremediationsinauditscoperequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3648
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3649
|
+
| `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. |
|
|
3650
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3651
|
+
|
|
3652
|
+
### Response
|
|
3653
|
+
|
|
3654
|
+
**Promise\<[components.PaginatedResponseVulnerabilityRemediation](../../models/components/paginatedresponsevulnerabilityremediation.md)\>**
|
|
3655
|
+
|
|
3656
|
+
### Errors
|
|
3657
|
+
|
|
3658
|
+
| Error Type | Status Code | Content Type |
|
|
3659
|
+
| --------------- | --------------- | --------------- |
|
|
3660
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
3661
|
+
|
|
3662
|
+
## ~~getVulnerableAssets~~
|
|
3663
|
+
|
|
3664
|
+
List assets that Vanta monitors that are associated with vulnerabilities.
|
|
3665
|
+
|
|
3666
|
+
End of life — this endpoint works for legacy audits only and does not support controlled audit view.
|
|
3667
|
+
|
|
3668
|
+
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
3669
|
+
|
|
3670
|
+
### Example Usage
|
|
3671
|
+
|
|
3672
|
+
<!-- UsageSnippet language="typescript" operationID="GetVulnerableAssets" method="get" path="/audits/{auditId}/vulnerable-assets" example="Example 1" -->
|
|
3673
|
+
```typescript
|
|
3674
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
3675
|
+
|
|
3676
|
+
const vanta = new Vanta({
|
|
3677
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3678
|
+
});
|
|
3679
|
+
|
|
3680
|
+
async function run() {
|
|
3681
|
+
const result = await vanta.audits.getVulnerableAssets({
|
|
3682
|
+
auditId: "<id>",
|
|
3683
|
+
});
|
|
3684
|
+
|
|
3685
|
+
console.log(result);
|
|
3686
|
+
}
|
|
3687
|
+
|
|
3688
|
+
run();
|
|
3689
|
+
```
|
|
3690
|
+
|
|
3691
|
+
### Standalone function
|
|
3692
|
+
|
|
3693
|
+
The standalone function version of this method:
|
|
3694
|
+
|
|
3695
|
+
```typescript
|
|
3696
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
3697
|
+
import { auditsGetVulnerableAssets } from "vanta-auditor-api-sdk/funcs/auditsGetVulnerableAssets.js";
|
|
3698
|
+
|
|
3699
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
3700
|
+
// You can create one instance of it to use across an application.
|
|
3701
|
+
const vanta = new VantaCore({
|
|
3702
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
3703
|
+
});
|
|
3704
|
+
|
|
3705
|
+
async function run() {
|
|
3706
|
+
const res = await auditsGetVulnerableAssets(vanta, {
|
|
3707
|
+
auditId: "<id>",
|
|
3708
|
+
});
|
|
3709
|
+
if (res.ok) {
|
|
3710
|
+
const { value: result } = res;
|
|
3711
|
+
console.log(result);
|
|
3712
|
+
} else {
|
|
3713
|
+
console.log("auditsGetVulnerableAssets failed:", res.error);
|
|
3714
|
+
}
|
|
3715
|
+
}
|
|
3716
|
+
|
|
3717
|
+
run();
|
|
3718
|
+
```
|
|
3719
|
+
|
|
3720
|
+
### Parameters
|
|
3721
|
+
|
|
3722
|
+
| Parameter | Type | Required | Description |
|
|
3723
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3724
|
+
| `request` | [operations.GetVulnerableAssetsRequest](../../models/operations/getvulnerableassetsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3725
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3726
|
+
| `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. |
|
|
3727
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3728
|
+
|
|
3729
|
+
### Response
|
|
3730
|
+
|
|
3731
|
+
**Promise\<[components.PaginatedResponseVulnerableAsset](../../models/components/paginatedresponsevulnerableasset.md)\>**
|
|
3732
|
+
|
|
3733
|
+
### Errors
|
|
3734
|
+
|
|
3265
3735
|
| Error Type | Status Code | Content Type |
|
|
3266
3736
|
| --------------- | --------------- | --------------- |
|
|
3267
3737
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
@@ -0,0 +1,22 @@
|
|
|
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
|
+
* End of life — this endpoint works for legacy audits only and does not support controlled audit view.
|
|
18
|
+
*
|
|
19
|
+
* @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
20
|
+
*/
|
|
21
|
+
export declare function auditsGetVulnerableAssets(client: VantaCore, request: operations.GetVulnerableAssetsRequest, options?: RequestOptions): APIPromise<Result<components.PaginatedResponseVulnerableAsset, VantaError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
22
|
+
//# 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;;;;;;;;;GASG;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"}
|