Skip to content

Commit 5340bfc

Browse files
author
Paul Osinski
committed
update CLI docs
update cli docs
1 parent 794d861 commit 5340bfc

1 file changed

Lines changed: 32 additions & 8 deletions

File tree

docs/content/en/connecting_your_tools/external_tools.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ defectdojo-cli import \
201201
#### Options
202202

203203
`--active, -a`
204-
* Dictates whether findings should be active on import. (default: true) `[$DD_CLI_ACTIVE]`
204+
* Dictates whether Findings should be forced to Active or Inactive on import. A value of True forces Findings to Active, while a value of False forces all Findings to Inactive. If no value is set, Active status will instead rely on the incoming report file. (default: unset) `[$DD_CLI_ACTIVE]`
205205

206206
`--api-scan-configuration value, --asc value`
207207
* The ID of the API Scan Configuration object to use when importing or reimporting. (default: 0) `[$DD_CLI_API_SCAN_CONFIGURATION]`
@@ -216,6 +216,12 @@ defectdojo-cli import \
216216
`--auto-create-context, --acc`
217217
* If set to true, the importer automatically creates Engagements, Products, and Product_Types (default: false) `[$DD_CLI_AUTO_CREATE_CONTEXT]`
218218

219+
`--close-old-findings, --cof`
220+
* If True, old findings no longer present in the report will be Closed as Mitigated when importing. If Service has been set, only the findings for this Service will be closed. [$DD_CLI_CLOSE_OLD_FINDINGS]
221+
222+
`--close-old-findings-product-scope, --cofps`
223+
* Select if --close-old-findings applies to **all** Findings of the same type in the Product. By default, this is set to false, meaning that only old Findings of the same type in the Engagement are in scope (and will be closed by Close Old Findings). [$DD_CLI_CLOSE_OLD_FINDINGS_PRODUCT_SCOPE]
224+
219225
`--deduplication-on-engagement, --doe`
220226
* If set to true, the importer restricts deduplication for imported findings to the newly created Engagement. (default: false) `[$DD_CLI_DEDUPLICATION_ON_ENGAGEMENT]`
221227

@@ -250,7 +256,7 @@ defectdojo-cli import \
250256
* The version of the test. `[$DD_CLI_TEST_VERSION]`
251257

252258
`--verified, -v`
253-
* Dictates whether findings should be verified on import. (default: false) `[$DD_CLI_VERIFIED]`
259+
* Dictates whether findings should be set to Verified on import. A value of True forces Findings to Verified. If no value is set, Verified status will instead rely on the incoming report file. `[$DD_CLI_VERIFIED]`
254260

255261
**Settings:**
256262

@@ -320,7 +326,7 @@ example, x Shows an example of required and optional flags for reimport operati
320326
#### Options
321327

322328
`--active, -a`
323-
* Dictates whether findings should be active on import. (default: true) `[$DD_CLI_ACTIVE]`
329+
* Dictates whether Findings should be forced to Active or Inactive on import. A value of True forces Findings to Active, while a value of False forces all Findings to Inactive. If no value is set, Active status will instead rely on the incoming report file. `[$DD_CLI_ACTIVE]`
324330

325331
`--api-scan-configuration value, --asc value`
326332

@@ -335,6 +341,12 @@ example, x Shows an example of required and optional flags for reimport operati
335341
`--auto-create-context, --acc`
336342
* If set to true, the importer automatically creates Engagements, Products, and Product_Types (default: false) `[$DD_CLI_AUTO_CREATE_CONTEXT]`
337343

344+
`--close-old-findings, --cof`
345+
* If True, old findings no longer present in the report will be Closed as Mitigated when importing. If Service has been set, only the findings for this Service will be closed.[$DD_CLI_CLOSE_OLD_FINDINGS]
346+
347+
`--close-old-findings-product-scope, --cofps`
348+
* Select if --close-old-findings applies to **all** Findings of the same type in the Product. By default, this is set to false, meaning that only old Findings of the same type in the Engagement are in scope (and will be closed by Close Old Findings). [$DD_CLI_CLOSE_OLD_FINDINGS_PRODUCT_SCOPE]
349+
338350
`--deduplication-on-engagement, --doe`
339351
* If set to true, the importer restricts deduplication for imported findings to the newly created Engagement. (default: false) `[$DD_CLI_DEDUPLICATION_ON_ENGAGEMENT]`
340352

@@ -369,7 +381,7 @@ example, x Shows an example of required and optional flags for reimport operati
369381
* The version of the test. `[$DD_CLI_TEST_VERSION]`
370382

371383
`--verified, -v`
372-
* Dictates whether findings should be set to Verified on import. (default: false) `[$DD_CLI_VERIFIED]`
384+
* Dictates whether findings should be set to Verified on import. A value of True forces Findings to Verified. If no value is set, Verified status will instead rely on the incoming report file. `[$DD_CLI_VERIFIED]`
373385

374386
**Settings:**
375387

@@ -687,7 +699,7 @@ universal-importer import \
687699
#### Options
688700

689701
`--active, -a`
690-
* Dictates whether findings should be active on import. (default: true) `[$DD_IMPORTER_ACTIVE]`
702+
* Dictates whether Findings should be forced to Active or Inactive on import. A value of True forces Findings to Active, while a value of False forces all Findings to Inactive. If no value is set, Active status will instead rely on the incoming report file. `[$DD_IMPORTER_ACTIVE]`
691703

692704
`--api-scan-configuration value, --asc value`
693705
* The ID of the API Scan Configuration object to use when importing or reimporting. (default: 0) `[$DD_IMPORTER_API_SCAN_CONFIGURATION]`
@@ -702,6 +714,12 @@ universal-importer import \
702714
`--auto-create-context, --acc`
703715
* If set to true, the importer automatically creates Engagements, Products, and Product_Types (default: false) `[$DD_IMPORTER_AUTO_CREATE_CONTEXT]`
704716

717+
`--close-old-findings, --cof`
718+
* If True, old findings no longer present in the report will be Closed as Mitigated when importing. If Service has been set, only the findings for this Service will be closed. [$DD_IMPORTER_CLOSE_OLD_FINDINGS]
719+
720+
`--close-old-findings-product-scope, --cofps`
721+
* Select if --close-old-findings applies to **all** Findings of the same type in the Product. By default, this is set to false, meaning that only old Findings of the same type in the Engagement are in scope (and will be closed by Close Old Findings). [$DD_IMPORTER_CLOSE_OLD_FINDINGS_PRODUCT_SCOPE]
722+
705723
`--deduplication-on-engagement, --doe`
706724
* If set to true, the importer restricts deduplication for imported findings to the newly created Engagement. (default: false) `[$DD_IMPORTER_DEDUPLICATION_ON_ENGAGEMENT]`
707725

@@ -736,7 +754,7 @@ universal-importer import \
736754
* The version of the test. `[$DD_IMPORTER_TEST_VERSION]`
737755

738756
`--verified, -v`
739-
* Dictates whether findings should be verified on import. (default: false) `[$DD_IMPORTER_VERIFIED]`
757+
* Dictates whether findings should be set to Verified on import. A value of True forces Findings to Verified. If no value is set, Verified status will instead rely on the incoming report file. `[$DD_IMPORTER_VERIFIED]`
740758

741759
**Settings:**
742760

@@ -806,7 +824,7 @@ example, x Shows an example of required and optional flags for reimport operati
806824
#### Options
807825

808826
`--active, -a`
809-
* Dictates whether findings should be active on import. (default: true) `[$DD_IMPORTER_ACTIVE]`
827+
* Dictates whether Findings should be forced to Active or Inactive on import. A value of True forces Findings to Active, while a value of False forces all Findings to Inactive. If no value is set, Active status will instead rely on the incoming report file. `[$DD_IMPORTER_ACTIVE]`
810828

811829
`--api-scan-configuration value, --asc value`
812830
* The ID of the API Scan Configuration object to use when importing or reimporting. (default: 0) `[$DD_IMPORTER_API_SCAN_CONFIGURATION]`
@@ -820,6 +838,12 @@ example, x Shows an example of required and optional flags for reimport operati
820838
`--auto-create-context, --acc`
821839
* If set to true, the importer automatically creates Engagements, Products, and Product_Types (default: false) `[$DD_IMPORTER_AUTO_CREATE_CONTEXT]`
822840

841+
`--close-old-findings, --cof`
842+
* If True, old findings no longer present in the report will be Closed as Mitigated when importing. If Service has been set, only the findings for this Service will be closed. [$DD_IMPORTER_CLOSE_OLD_FINDINGS]
843+
844+
`--close-old-findings-product-scope, --cofps`
845+
* Select if --close-old-findings applies to **all** Findings of the same type in the Product. By default, this is set to false, meaning that only old Findings of the same type in the Engagement are in scope (and will be closed by Close Old Findings). [$DD_IMPORTER_CLOSE_OLD_FINDINGS_PRODUCT_SCOPE]
846+
823847
`--deduplication-on-engagement, --doe`
824848
* If set to true, the importer restricts deduplication for imported findings to the newly created Engagement. (default: false) `[$DD_IMPORTER_DEDUPLICATION_ON_ENGAGEMENT]`
825849

@@ -854,7 +878,7 @@ example, x Shows an example of required and optional flags for reimport operati
854878
* The version of the test. `[$DD_IMPORTER_TEST_VERSION]`
855879

856880
`--verified, -v`
857-
* Dictates whether findings should be set to Verified on import. (default: false) `[$DD_IMPORTER_VERIFIED]`
881+
* Dictates whether findings should be set to Verified on import. A value of True forces Findings to Verified. If no value is set, Verified status will instead rely on the incoming report file. (default: unset) `[$DD_IMPORTER_VERIFIED]`
858882

859883
**Settings:**
860884

0 commit comments

Comments
 (0)