Browse Guides

AuthRocket Integration
Reading mode
Copy Link
Link Copied!
Print
Feedback
This guide has multiple versions available:
<style>p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><p><strong>In this guide we will cover:</strong></p><p><strong>- What is the AuthRocket Integration?<br>- Enabling the AuthRocket Module</strong></p><p><strong>- Connecting to AuthRocket</strong></p><p><strong>- Using the Runbook</strong></p><p><br></p><p><br></p><p><strong><span style="font-size: 14pt;">What is the AuthRocket Integration?</span></strong></p><p>The AuthRocket integration can be used to import users from AuthRocket into Halo using a scheduled runbook.</p><p><br></p><p><strong><span style="font-size: 14pt;">Enabling the AuthRocket Module</span></strong></p><p>In Configuration &gt; Integrations &gt; Asset Management and Alerting, you will find the AuthRocket module. Hover over it, and click the plus (+) icon to enable it.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjU2MjdmNjE3LTdlOTQtNGE3Mi1hZGM1LTljMjFhMjE0OWJiNyJ9.iDkxGjWW1VAy0mtNlYZlUN3RCm-UWmnDbYiP0B4fXIw" class="fr-fic fr-fil fr-dib" width="523" height="232"></p><p><strong><span style="font-size: 10pt;">Fig 1. Enabling the AuthRocket module.</span></strong></p><p><br></p><p>Upon enabling the module, the &quot;AuthRocket&quot; runbook will automatically download into your list in Configuration &gt; Integrations &gt; Custom Integrations &gt; Integration Runbooks.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVmMjJlYzFkLTE1ZjgtNDRhNy1hNTM5LTE3ZmNkYmI2ZDU5NyJ9.XWPyD7xLGNRVaiEme80ErICg_QuV63n2f82ioKYVNpI" class="fr-fic fr-fil fr-dib" width="1215" style="width: 1217px; height: 689.43px;" height="689"></p><p><strong><span style="font-size: 10pt;">Fig 2. AuthRocket runbook.</span></strong></p><p><br></p><p>The runbook can also be accessed by clicking the &quot;AuthRocket Runbook&quot; button within the module.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijk1N2ViNGE0LTc4MTEtNDIxMS1iMWM4LThjMTlmMjg5MTE5NSJ9.C3WXemdFAQ37_uNt0VtR1xsLOdAA0t77zx8jUAotZlM" class="fr-fic fr-fil fr-dib" width="1216" style="width: 1218px; height: 161.638px;" height="162"></p><p><strong><span style="font-size: 10pt;">Fig 3. AuthRocket Runbook shortcut.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Connecting to AuthRocket</span></strong></p><p>In AuthRocket, navigate to the realm of choice, and go to the &quot;Integration&quot; tab. Here you can then go to the &quot;API keys&quot; section, and click &quot;Add API key&quot;. Give the key an appropriate name, and &quot;Read/write/admin&quot; permissions. Click &quot;Save&quot;.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImRlZjFjYjQ4LTQ4MjctNGZjYi1hNmViLThiZDM3NTMwNzQyYyJ9.HB0qFBZf1uUmNaApVz8YesU-Fiy6nAYKS6kE0yOf8eA" class="fr-fic fr-fil fr-dib" width="853" height="570"></p><p><strong><span style="font-size: 10pt;">Fig 4. Creating an AuthRocket API key.</span></strong></p><p><br></p><p>Upon saving, the API key and endpoint URL will be available to copy. Store these somewhere safe, and save.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImMwMjFjZDU2LTEyODItNDZhOS1hZTIwLTlmZjA0N2QyZTQwYyJ9.BjljTz8cX_48NvxESiqh_9oEaRT-uZQ4cvH2kDDSWUA" class="fr-fic fr-fil fr-dib" width="832" height="856"></p><p><strong><span style="font-size: 10pt;">Fig 5. Copying the key and endpoint.</span></strong></p><p><br></p><p>Back in Halo, click into the module. You will see these three fields at the top of the page. Enter the URL and API key your stored into the first two respective fields.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImY1YWNhNWYwLTM2NTYtNGY0Ny04MmMxLTYyOTFjN2M3M2JjMSJ9.myWVYo5Zm9suaoeG9UPil4DgmtkBQp5s9D65Q60pQNo" class="fr-fic fr-fil fr-dib" width="1218" style="width: 1220px; height: 168.053px;" height="168"></p><p><strong><span style="font-size: 10pt;">Fig 6. Setup in the AuthRocket module.</span></strong></p><p><br></p><p>The third field, &quot;Realm&quot;, is set from the URL of your AuthRocket realm. When viewing your realm in the &quot;Dashboard&quot; tab, it will be the last string of text after the final slash &quot;/&quot;, where the red box is below, or if viewing another tab like &quot;Users&quot;, it will be the string before the ending &quot;/users&quot; - i.e. /realms/[realm here]/users</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNkYjlhYWI0LWNhYmMtNDg0Yy1hNjhiLTM1ZGZkNWEwODQ2MiJ9.3oZgIYID2hG3lRMMVDvZLTl4sZEnQFgppaIaL5-eaXg" class="fr-fic fr-fil fr-dib" width="657" height="40"></p><p><strong><span style="font-size: 10pt;">Fig 7. Realm URL.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Using the Runbook</span></strong></p><p>Upon connection, the runbook that downloaded automatically can now be used to import users from AuthRocket into Halo.</p><p><br></p><p>A schedule is set against the runbook, but this can be altered depending on how frequently/when you wish this to run. Clicking &quot;Run now&quot; can also manually run this in addition to the schedule set.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjM5Y2U3OWZhLTg5NmQtNGM2Mi1hODg4LWRhYjlhZTVkYmNmMCJ9.hsj1pfrvWZEl8VLFsZHsmpcZh_-pHgvB1VFDqSzjr28" class="fr-fic fr-fil fr-dib" width="641" height="418"></p><p><strong><span style="font-size: 10pt;">Fig 8. Schedule on the runbook.</span></strong></p><p><br></p><p>For instance, upon running the runbook the user &quot;Jim Shorts&quot; has been created with his relevant information such as his email and default site.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZiMjkxM2VjLTY4NWQtNDNiYi1hZGE2LTg5NzI2NGU1MjRhNiJ9.PCs0CLIlt6u-UK3s42P8ZHWDF8nqzMCTHTtNC192oQY" class="fr-fic fr-fil fr-dib" width="487" height="475"></p><p><strong><span style="font-size: 10pt;">Fig 9. User example in AuthRocket.</span></strong></p><p><br></p><p>As below.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjE3MDIyMDJkLWE3NDItNGJmYi1hYzljLWIxMGE1MGJjNmZmZSJ9.Mk5g2ums9df7MXiT2gxelp0H-SOK6ujFX0-njWODXnU" class="fr-fic fr-fil fr-dib" width="1213" style="width: 1215px; height: 462.494px;" height="462"></p><p><strong><span style="font-size: 10pt;">Fig 10. User imported into Halo.</span></strong></p><p><br></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.