Community
Questions Library
Docs
Blog
Events
Swag
Github
Slack
JupiterOne
Discussions
Release Notes
Contact Us
Kandji - AskJ1 Community
<main> <article class="userContent"> <h2 data-id="kandji-jupiterone-integration-benefits">Kandji + JupiterOne Integration Benefits</h2> <ul><li>Visualize Kandji devices and apps in the JupiterOne graph.</li> <li>Monitor changes to Kandji devices and apps using JupiterOne alerts.</li> </ul><h2 data-id="how-it-works">How it Works</h2> <ul><li><p>JupiterOne periodically fetches devices and apps from Kandji to update the<br> graph.</p></li> <li><p>Write JupiterOne queries to review and monitor updates to the graph, or<br> leverage existing queries.</p></li> <li><p>Configure alerts to take action when JupiterOne graph changes, or leverage<br> existing alerts.</p></li> </ul><h2 data-id="requirements">Requirements</h2> <ul><li><p>JupiterOne requires an Access Token and Organization API URL. You need<br> permission to create a user in Kandji that will be used to obtain the Access<br> Token and API URL.</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> <h3 data-id="in-kandji">In Kandji</h3> <ol><li>Login to your Kandji subdomain.</li> </ol><ul><li>This is usually in the format of <code class="code codeInline" spellcheck="false" tabindex="0">https://{subdomain}.kandji.io/</code></li> </ul><ol start="2"><li>Got to Settings > Access > API Token. If you don't see this, contact the<br> server admin.</li> <li>Click "Add Token"</li> <li>Set a token name and description (optional). Once set, make sure to copy the<br> API token. You won't be able to see this again.</li> <li>Configure API permissions. The Kandji integration needs the following<br> permissions.</li> </ol><ul><li>Device list <code class="code codeInline" spellcheck="false" tabindex="0">GET /devices</code></li> <li>Device details <code class="code codeInline" spellcheck="false" tabindex="0">GET /devices/{device_id}/details</code></li> <li>Application list <code class="code codeInline" spellcheck="false" tabindex="0">GET /devices/{device_id}/apps</code></li> </ul><ol start="6"><li>Once you are finished with configuration, you should be able to see the<br> organization API URL under the API token section.</li> <li>Use the organization API URL for <code class="code codeInline" spellcheck="false" tabindex="0">API_URL</code> and API token for <code class="code codeInline" spellcheck="false" tabindex="0">ACCESS_TOKEN</code></li> </ol><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>Kandji</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 Kandji 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>Kandji Access Token</strong> and <strong>Kandji API URL</strong> generated for use by<br> JupiterOne.</p></li> </ul><ol start="4"><li>Click <strong>Create Configuration</strong> once all values are provided.</li> </ol><h1 data-id="how-to-uninstall">How to Uninstall</h1> <ol><li>From the top navigation of the J1 Search homepage, select <strong>Integrations</strong>.</li> <li>Scroll to the <strong>Kandji</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>Account</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">kandji_account</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Account</code></td> </tr><tr><td>App</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">kandji_app</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Application</code></td> </tr><tr><td>Device</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">kandji_device</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Device</code></td> </tr><tr><td>User</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">kandji_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">kandji_account</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">kandji_device</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">kandji_device</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">kandji_app</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">kandji_device</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">kandji_user</code></td> </tr></tbody></table><p><br></p> </article> </main>
.png)