Skip to content

Commit 2e29098

Browse files
devGregAclaude
andcommitted
docs: JFrog Xray connector — Artifact-Level Records mode + hierarchy behavior
Documents the opt-in artifact-level record granularity (one record per first-level entry under a repository), automatic parent/child asset-hierarchy relationships, the mode-switch runbook in both directions, and corrects the sync description: every sync generates a complete per-repository report (the previous text described incremental delta reports, which the connector does not do). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 7857ff8 commit 2e29098

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

docs/content/import_data/pro/connectors/connectors_tool_reference.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,20 @@ Required token scopes for JFrog Xray:
192192
- **All Services**, as DefectDojo needs access to both access to both XRay and Artifactory services
193193
- **Manage Reports + Manage Resources** at a minimum.
194194

195-
DefectDojo maps each Artifactory **repository** as a separate Record. On first Sync, DefectDojo generates a full historical vulnerability report; subsequent Syncs generate incremental (delta) reports covering new findings since the last Sync.
195+
By default, DefectDojo maps each Artifactory **repository** as a separate Record. Each Sync generates a complete vulnerability report per repository via Xray, so finding statuses in DefectDojo always reflect the current state of the repository.
196+
197+
#### Artifact-Level Records
198+
199+
Enabling the **Artifact-Level Records** toggle on the connection changes discovery to one level below the repository: every first-level entry under a repository root (for Docker repositories, each image; for generic repositories, each top-level file or folder) becomes its own Record. Each Sync still generates a single Xray report per repository — DefectDojo attributes each vulnerability to the artifacts it impacts, so the load on your JFrog instance does not increase.
200+
201+
With Artifact-Level Records enabled:
202+
203+
* Repositories remain as Records and become **parent assets**: they carry no findings themselves, but when the Asset Hierarchy feature is enabled, DefectDojo automatically relates each artifact asset to its repository asset with a `parent` relationship. Assets can then be filtered by parent/child, and findings roll up the hierarchy.
204+
* A vulnerability that impacts several artifacts is imported into each affected artifact's asset, so every asset shows the complete set of findings that affect it.
205+
* Hierarchy relationships created by the connector never overwrite relationships you created by hand. If an asset already has a parent you assigned, the connector leaves it alone.
206+
* The token additionally needs read access to the Artifactory storage API (included in the scopes above).
207+
208+
**Switching an existing connection to Artifact-Level Records:** the toggle can be changed at any time. On the first Sync afterward, new artifact Records appear for mapping — enable **Auto Map** on the connection when flipping the toggle so findings move without a gap. The repository-level assets stop receiving findings and their previously imported findings are closed on their next Sync (the same findings are re-imported under the new artifact assets, with fresh status); notes and history on the old repository-level findings stay on the repository asset. Switching back reverses this: repository Records resume carrying findings (previously closed findings re-open as they re-match), and artifact Records are marked MISSING — their assets and findings are kept but stop updating, so you can archive them at your convenience.
196209

197210
See the [JFrog Xray REST API documentation](https://jfrog.com/help/r/jfrog-rest-apis/xray-rest-apis) for more information.
198211

0 commit comments

Comments
 (0)