Community
Questions Library
Docs
Blog
Events
Swag
Github
Slack
JupiterOne
Discussions
Release Notes
Contact Us
Snyk - AskJ1 Community
<main> <article class="userContent"> <h2 data-id="snyk-jupiterone-integration-benefits">Snyk + JupiterOne Integration Benefits</h2> <ul><li>Visualize Snyk code repositories and findings in the JupiterOne graph.</li> <li>Monitor Snyk findings within the alerts app.</li> <li>Monitor changes to Snyk code repositories using JupiterOne alerts.</li> </ul><h2 data-id="how-it-works">How it Works</h2> <ul><li><p>JupiterOne periodically fetches Snyk repositories and findings to update the<br> graph.</p></li> <li><p>Write JupiterOne queries to review and monitor updates to the graph.</p></li> <li>Configure alerts to reduce the noise of findings.</li> <li>Configure alerts to take action when the JupiterOne graph changes.</li> </ul><h2 data-id="requirements">Requirements</h2> <ul><li><p>JupiterOne requires the organisation id where your Snyk projects reside as<br> well as the API Key configured to authenticate with Snyk.</p></li> <li><p>You must have permission in JupiterOne to install new integrations.</p></li> </ul><h2 data-id="support">Support</h2> <p>If you need help with this integration, please contact<br><a rel="nofollow" href="https://support.jupiterone.io">JupiterOne Support</a>.</p> <h2 data-id="integration-walkthrough">Integration Walkthrough</h2> <h2 data-id="in-snyk">In Snyk</h2> <p>The integration instance configurations requires the following two parameters:</p> <ul><li><p><strong>Snyk API Key</strong> (<code class="code codeInline" spellcheck="false" tabindex="0">snykApiKey</code>) In Snyk: In the upper right hand corner mouse<br> over your account name, where a drop down will appear. Click on<br><code class="code codeInline" spellcheck="false" tabindex="0">account settings</code> and your API token will appear in a hidden form in the<br> middle of the page. Click show and copy your key.</p></li> <li><p><strong>Snyk Organisation ID</strong> (<code class="code codeInline" spellcheck="false" tabindex="0">snykOrgId</code>) In Snyk: Go to the dashboard. Click on<br><code class="code codeInline" spellcheck="false" tabindex="0">manage organisation</code> on the far right of the screen across from <code class="code codeInline" spellcheck="false" tabindex="0">Dashboard</code>.<br> Here, your organisation ID is displayed.</p></li> </ul><h3 data-id="in-jupiterone">In JupiterOne</h3> <ol><li>From the top navigation of the J1 Search homepage, select <strong>Integrations</strong>.</li> <li>Scroll to the <strong>Snyk</strong> integration tile and click it.</li> <li>Click the <strong>Add Configuration</strong> button and configure the following settings:</li> </ol><ul><li><p>Enter the <strong>Account Name</strong> by which you'd like to identify this Snyk account<br> in JupiterOne. Ingested entities will have this value stored in<br><code class="code codeInline" spellcheck="false" tabindex="0">tag.AccountName</code> when <strong>Tag with Account Name</strong> is checked.</p></li> <li><p>Enter a <strong>Description</strong> that will further assist your team when identifying<br> the integration instance.</p></li> <li><p>Select a <strong>Polling Interval</strong> that you feel is sufficient for your monitoring<br> needs. You may leave this as <code class="code codeInline" spellcheck="false" tabindex="0">DISABLED</code> and manually execute the integration.</p></li> <li><p>Enter the <strong>API Key</strong> used to authenticate with Snyk.</p></li> <li>Enter the <strong>Organisation ID</strong> your Snyk projects reside in.</li> </ul><ol start="4"><li>Click <strong>Create Configuration</strong> once all values are provided.</li> </ol><h2 data-id="how-to-uninstall">How to Uninstall</h2> <ol><li>From the top navigation of the J1 Search homepage, select <strong>Integrations</strong>.</li> <li>Scroll to the <strong>Snyk</strong> integration tile and click it.</li> <li>Identify and click the <strong>integration to delete</strong>.</li> <li>Click the <strong>trash can</strong> icon.</li> <li>Click the <strong>Remove</strong> button to delete the integration.</li> </ol><p><br></p> <h2 data-id="data-model">Data Model</h2> <h3 data-id="entities">Entities</h3> <p>The following entities are created:</p> <table><thead><tr><th>Resources</th> <th>Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Entity <code class="code codeInline" spellcheck="false" tabindex="0">_class</code></th> </tr></thead><tbody><tr><td>Snyk Account</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_account</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Account</code></td> </tr><tr><td>Snyk Group</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_group</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Group</code></td> </tr><tr><td>Snyk Issue</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_finding</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Finding</code></td> </tr><tr><td>Snyk Organization</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_organization</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Organization</code></td> </tr><tr><td>Snyk Project</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_project</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Project</code></td> </tr><tr><td>Snyk Role</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_role</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">AccessRole</code></td> </tr><tr><td>Snyk Service</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_service</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Service</code></td> </tr><tr><td>Snyk User</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_user</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">User</code></td> </tr></tbody></table><h3 data-id="relationships">Relationships</h3> <p>The following relationships are created:</p> <table><thead><tr><th>Source Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Relationship <code class="code codeInline" spellcheck="false" tabindex="0">_class</code></th> <th>Target Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> </tr></thead><tbody><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_account</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_group</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_account</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_organization</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_account</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_service</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_group</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_organization</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_group</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_role</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_organization</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_project</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_organization</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_role</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_organization</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_user</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_project</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_finding</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_service</code></td> <td><strong>IDENTIFIED</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_finding</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_service</code></td> <td><strong>SCANS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_project</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_user</code></td> <td><strong>ASSIGNED</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_role</code></td> </tr></tbody></table><h3 data-id="mapped-relationships">Mapped Relationships</h3> <p>The following mapped relationships are created:</p> <table><thead><tr><th>Source Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Relationship <code class="code codeInline" spellcheck="false" tabindex="0">_class</code></th> <th>Target Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Direction</th> </tr></thead><tbody><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_finding</code></td> <td><strong>EXPLOITS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">*cwe*</code></td> <td>FORWARD</td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_finding</code></td> <td><strong>IS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">*cve*</code></td> <td>FORWARD</td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">snyk_project</code></td> <td><strong>SCANS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">*CodeRepo*</code></td> <td>FORWARD</td> </tr></tbody></table><p><br></p> </article> </main>
.png)