Browse Guides

API Applications with Organisation access
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><br></p><p><br></p><p>Enable Multi-tenancy so that you can create multiple organizations</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImFjYWE3YzIyLTE0MTItNDk4MC1hMjY4LWI5ZGYyODBkNDgzMyJ9.unR6aF8ad0cklI5ePK7stQ0XRWz5sbpvt7kbnHSb-8Q" class="fr-fic fr-fil fr-dib" width="834" style="width: 836px; height: 257.412px;" height="257"></p><p><br></p><p><br></p><p>Create departments within the organizations. These departments will be assigned to your API Agents.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImJkYWQxNDkzLTk2ZTQtNDE4Ni1iMWExLTQ1ZTVjMjZjMzUzOSJ9.1i6h9Ddki5EbJIvueh53jcsSVE9Mgxg8TyFytL3IU3s" class="fr-fic fr-fil fr-dib" width="791" style="width: 793px; height: 467.275px;" height="467"></p><p><br></p><p>Create an Agent and enable the setting for &quot;Is API Agent&quot;, then assign them access to a department from the correct organization</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg3MmIwZWEzLTBkZjQtNGMzZi04NTM0LWFiY2VjYzE2ZTg2NSJ9.vUaSczqGXWXidQUri4M3bL97Bp_fGlXF7KaU9jbuXi0" class="fr-fic fr-fil fr-dib" width="946" style="width: 948px; height: 342.181px;" height="342"></p><p><br></p><p>Go to the customer records that should be part of the organization and ensure they are configured correctly</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjM3YjJiY2VjLTZmNDItNGMzYS1iMzg0LTRmNjczODJjMGQ0ZCJ9._uqi6OoHr3noW0QDGpGxomYOoqYfxVB8NJYxAS_T1Zs" class="fr-fic fr-fil fr-dib" width="1024" height="369"></p><p><br></p><p>Create an API application using the agent that has access only to the organizations intended and ensure they do not have the &quot;All: Teams&quot; permission as part of the API application setup</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjQ1MmJhMDg1LTk1YzYtNDhkMS05N2RlLTY2YzEzNzhjYjcyMSJ9.lGykccUHE_1MH9GWH9PaKSn2vp0nAoiYdTJvgUlisW4" class="fr-fic fr-fil fr-dib" width="1162" style="width: 1164px; height: 642.76px;" height="643"></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.