Community
Questions Library
Docs
Blog
Events
Swag
Github
Slack
JupiterOne
Discussions
Release Notes
Contact Us
Heroku - AskJ1 Community
<main> <article class="userContent"> <h2 data-id="heroku-jupiterone-integration-benefits">Heroku + JupiterOne Integration Benefits</h2> <ul><li><p>Visualize Heroku teams, users, applications, and services in the JupiterOne<br> graph.</p></li> <li><p>Map Heroku users to employees in your JupiterOne account.</p></li> <li>Monitor changes to your teams, users, applications, and services using<br> JupiterOne alerts.</li> </ul><h2 data-id="how-it-works">How it Works</h2> <ul><li><p>JupiterOne periodically fetches Heroku teams, users, applications, and<br> services to update the graph.</p></li> <li><p>Write JupiterOne queries to review and monitor updates to the graph.</p></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 an API key configured for read access in your Heroku<br> account.</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-heroku">In Heroku</h3> <p>Users configure the integration by providing an API key obtained from Heroku:<br><a rel="nofollow" href="https://devcenter.heroku.com/articles/platform-api-quickstart#authentication">https://devcenter.heroku.com/articles/platform-api-quickstart#authentication</a>.</p> <p><strong>Please Note</strong>: The integration currently requires a Heroku Enterprise account<br> and the following OAuth scopes:</p> <ul><li><code class="code codeInline" spellcheck="false" tabindex="0">read</code></li> </ul><p>Optional OAuth scopes:</p> <ul><li><code class="code codeInline" spellcheck="false" tabindex="0">global</code> <ul><li>Allows for fetching members of a Heroku team</li> </ul></li> </ul><p>The account used to generate the API key will dictate what permissions it has.<br> For full access to all available data, an account with the <code class="code codeInline" spellcheck="false" tabindex="0">admin</code> role should<br> be used. Using an account with the <code class="code codeInline" spellcheck="false" tabindex="0">member</code> role will be able to pull in most<br> data, but currently application add-on information is only available using the<br><code class="code codeInline" spellcheck="false" tabindex="0">admin</code> role.</p> <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>Herokue</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 Heroku 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> configured for read access.</p></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>Heroku</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><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>Addon</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_addon</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Service</code></td> </tr><tr><td>Application</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_application</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Application</code></td> </tr><tr><td>Enterprise Account</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_account</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Account</code></td> </tr><tr><td>Team</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_team</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Team</code></td> </tr><tr><td>User</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_account_member</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">heroku_account</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_account_member</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_account</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_team</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_application</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_addon</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_team</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_account_member</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_team</code></td> <td><strong>OWNS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">heroku_application</code></td> </tr></tbody></table> </article> </main>
.png)