Browse Guides

BACK TO TOP
Single Sign on Options
Reading mode
Copy Link
Link Copied!
Print
Feedback
This guide is part of a collection:
<style> .chartjs-size-monitor { display: none !important; height: 0 !important; overflow: hidden !important; }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><style> .chartjs-size-monitor { display: none !important; height: 0 !important; overflow: hidden !important; } 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><style> .chartjs-size-monitor { display: none !important; height: 0 !important; overflow: hidden !important; } 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><style> .chartjs-size-monitor { display: none !important; height: 0 !important; overflow: hidden !important; } 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><style> .chartjs-size-monitor { display: none !important; height: 0 !important; overflow: hidden !important; } 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>- How to choose which Single Sign on Method to use</strong></p><p><br></p><p><br></p><p>Halo support various methods for setting up single sign on for accessing both the Halo agent app and portal. The best method to use will depend on your identity provider, your user base and your desired authentication protocol. Use this flow chart to determine which setup method you should use.&nbsp;</p><p><br></p><p><br></p><div style="overflow-x:auto;width:100%;"><div style="width:100%;max-width:1200px;min-width:960px;margin:0 auto;box-sizing:border-box;padding:12px 4px;font-family:'Poppins', Arial, Helvetica, sans-serif;background:#ffffff;"><div style="max-width:520px;margin:0 auto;padding:8px 10px;border:1.5px solid #222222;border-radius:10px;background:#ffffff;color:#222222;text-align:center;line-height:1.4;"><span style="font-size: 11pt;">Do you need sign-in to be authenticated using the SAML protocol? For example, if your identity provider only uses the SAML authentication protocol, or if SAML is your preferred method over OIDC.</span></div><div style="width:0;height:18px;border-left:2px solid #555555;margin:0 auto;"><br></div><table style="width:100%;table-layout:fixed;border-collapse:collapse;border:none;"><tbody><tr><td style="width:41.5%;height:18px;padding:0;"><br></td><td style="width:41.5%;height:18px;padding:0;border-top:2px solid #555555;border-left:2px solid #555555;"><br></td><td style="width:8.5%;height:18px;padding:0;border-top:2px solid #555555;"><br></td><td style="width:8.5%;height:18px;padding:0;border-left:2px solid #555555;"><br></td></tr><tr><td colspan="2" style="vertical-align:top;padding:0 3px;"><div style="text-align:center;color:#222222;font-weight:600;padding:2px 0;"><span style="font-size: 11pt;">No</span></div><div style="width:0;height:14px;border-left:2px solid #555555;margin:0 auto;"><br></div><div style="text-align:center;color:#555555;font-size:10px;line-height:10px;margin-top:-2px;">▼</div><div style="max-width:340px;margin:0 auto;padding:8px 10px;border:1.5px solid #222222;border-radius:10px;background:#ffffff;color:#222222;text-align:center;line-height:1.4;"><span style="font-size: 11pt;">Which identity provider are the users (who will be using single sign-on) held in?</span></div><div style="width:0;height:18px;border-left:2px solid #555555;margin:0 auto;"><br></div><table style="width:100%;table-layout:fixed;border-collapse:collapse;border:none;"><tbody><tr><td style="width:7.5%;height:18px;padding:0;"><br></td><td style="width:7.5%;height:18px;padding:0;border-top:2px solid #555555;border-left:2px solid #555555;"><br></td><td style="width:27.5%;height:18px;padding:0;border-top:2px solid #555555;"><br></td><td style="width:27.5%;height:18px;padding:0;border-top:2px solid #555555;border-left:2px solid #555555;"><br></td><td style="width:7.5%;height:18px;padding:0;border-top:2px solid #555555;"><br></td><td style="width:7.5%;height:18px;padding:0;border-top:2px solid #555555;border-left:2px solid #555555;"><br></td><td style="width:7.5%;height:18px;padding:0;border-top:2px solid #555555;"><br></td><td style="width:7.5%;height:18px;padding:0;border-left:2px solid #555555;"><br></td></tr><tr><td colspan="2" style="vertical-align:top;padding:0 3px;"><div style="text-align:center;color:#222222;font-weight:600;padding:2px 0;"><span style="font-size: 11pt;">Google</span></div><div style="width:0;height:14px;border-left:2px solid #555555;margin:0 auto;"><br></div><div style="text-align:center;color:#555555;font-size:10px;line-height:10px;margin-top:-2px;">▼</div><div style="max-width:280px;margin:0 auto;padding:8px 8px;border:1.5px solid #6d9eeb;border-radius:10px;background:#ffffff;color:#222222;text-align:center;line-height:1.4;"><span style="font-size: 11pt;">Use the Single Sign-On module, creating a connection with the type &quot;Google&quot;.<br><a href="https://www.usehalo.com/guides/2667" style="font-size: 11pt;" target="_blank" rel="noopener noreferrer">Guide here</a></span></div></td><td colspan="2" style="vertical-align:top;padding:0 3px;"><div style="text-align:center;color:#222222;font-weight:600;padding:2px 0;"><span style="font-size: 11pt;">Entra ID</span></div><div style="width:0;height:14px;border-left:2px solid #555555;margin:0 auto;"><br></div><div style="text-align:center;color:#555555;font-size:10px;line-height:10px;margin-top:-2px;">▼</div><div style="max-width:300px;margin:0 auto;padding:8px 10px;border:1.5px solid #222222;border-radius:10px;background:#ffffff;color:#222222;text-align:center;line-height:1.4;"><span style="font-size: 11pt;">Who are you setting up single sign-on for?</span></div><div style="width:0;height:18px;border-left:2px solid #555555;margin:0 auto;"><br></div><table style="width:100%;table-layout:fixed;border-collapse:collapse;border:none;"><tbody><tr><td style="width:21.0%;height:18px;padding:0;"><br></td><td style="width:21.0%;height:18px;padding:0;border-top:2px solid #555555;border-left:2px solid #555555;"><br></td><td style="width:29.0%;height:18px;padding:0;border-top:2px solid #555555;"><br></td><td style="width:29.0%;height:18px;padding:0;border-left:2px solid #555555;"><br></td></tr><tr><td colspan="2" style="vertical-align:top;padding:0 3px;"><div style="max-width:240px;margin:0 auto;padding:2px 2px;text-align:center;color:#444444;line-height:1.35;"><span style="font-size: 10pt;">People in my Entra tenant, or Entra tenants I manage. In other words, people in my own organisation or organisations I manage. (Business to business)</span></div><div style="width:0;height:14px;border-left:2px solid #555555;margin:0 auto;"><br></div><div style="text-align:center;color:#555555;font-size:10px;line-height:10px;margin-top:-2px;">▼</div><div style="max-width:280px;margin:0 auto;padding:8px 8px;border:1.5px solid #6d9eeb;border-radius:10px;background:#ffffff;color:#222222;text-align:center;line-height:1.4;"><span style="font-size: 11pt;">Use the Single Sign-On module, creating a connection with the type &quot;Microsoft Entra ID&quot;.<br><a href="https://www.usehalo.com/guides/2667" style="font-size: 11pt;" target="_blank" rel="noopener noreferrer">Guide here</a></span></div></td><td colspan="2" style="vertical-align:top;padding:0 3px;"><div style="max-width:240px;margin:0 auto;padding:2px 2px;text-align:center;color:#444444;line-height:1.35;"><span style="font-size: 10pt;">External users that are not in my organisation or organisations I manage. These users should be able to sign up and sign in to my Halo portal. (Business to customer)</span></div><div style="width:0;height:14px;border-left:2px solid #555555;margin:0 auto;"><br></div><div style="text-align:center;color:#555555;font-size:10px;line-height:10px;margin-top:-2px;">▼</div><div style="max-width:290px;margin:0 auto;padding:8px 10px;border:1.5px solid #222222;border-radius:10px;background:#ffffff;color:#222222;text-align:center;line-height:1.4;"><span style="font-size: 11pt;">Would you like to set up sign-on using an Entra B2C tenant? (Keep in mind Microsoft is deprecating B2C licensing.)</span></div><div style="width:0;height:18px;border-left:2px solid #555555;margin:0 auto;"><br></div><table style="width:100%;table-layout:fixed;border-collapse:collapse;border:none;"><tbody><tr><td style="width:25.0%;height:18px;padding:0;"><br></td><td style="width:25.0%;height:18px;padding:0;border-top:2px solid #555555;border-left:2px solid #555555;"><br></td><td style="width:25.0%;height:18px;padding:0;border-top:2px solid #555555;"><br></td><td style="width:25.0%;height:18px;padding:0;border-left:2px solid #555555;"><br></td></tr><tr><td colspan="2" style="vertical-align:top;padding:0 3px;"><div style="text-align:center;color:#222222;font-weight:600;padding:2px 0;"><span style="font-size: 11pt;">Yes</span></div><div style="width:0;height:14px;border-left:2px solid #555555;margin:0 auto;"><br></div><div style="text-align:center;color:#555555;font-size:10px;line-height:10px;margin-top:-2px;">▼</div><div style="max-width:280px;margin:0 auto;padding:8px 8px;border:1.5px solid #6d9eeb;border-radius:10px;background:#ffffff;color:#222222;text-align:center;line-height:1.4;"><span style="font-size: 11pt;">Use the B2C single sign-on method under the Entra ID integration module.<br><a href="https://www.usehalo.com/guides/2443" style="font-size: 11pt;" target="_blank" rel="noopener noreferrer">Guide here</a></span></div></td><td colspan="2" style="vertical-align:top;padding:0 3px;"><div style="text-align:center;color:#222222;font-weight:600;padding:2px 0;"><span style="font-size: 11pt;">No</span></div><div style="width:0;height:14px;border-left:2px solid #555555;margin:0 auto;"><br></div><div style="text-align:center;color:#555555;font-size:10px;line-height:10px;margin-top:-2px;">▼</div><div style="max-width:280px;margin:0 auto;padding:8px 8px;border:1.5px solid #6d9eeb;border-radius:10px;background:#ffffff;color:#222222;text-align:center;line-height:1.4;"><span style="font-size: 11pt;">Use the Single Sign-On module, creating a connection with the type &quot;Microsoft Entra External ID&quot;.<br><a href="https://www.usehalo.com/guides/2667" style="font-size: 11pt;" target="_blank" rel="noopener noreferrer">Guide here</a></span></div></td></tr></tbody></table></td></tr></tbody></table></td><td colspan="2" style="vertical-align:top;padding:0 3px;"><div style="text-align:center;color:#222222;font-weight:600;padding:2px 0;"><span style="font-size: 11pt;">Okta</span></div><div style="width:0;height:14px;border-left:2px solid #555555;margin:0 auto;"><br></div><div style="text-align:center;color:#555555;font-size:10px;line-height:10px;margin-top:-2px;">▼</div><div style="max-width:280px;margin:0 auto;padding:8px 8px;border:1.5px solid #6d9eeb;border-radius:10px;background:#ffffff;color:#222222;text-align:center;line-height:1.4;"><span style="font-size: 11pt;">Use the Single Sign-On module, creating a connection with the type &quot;Okta&quot;.<br><a href="https://www.usehalo.com/guides/2667" style="font-size: 11pt;" target="_blank" rel="noopener noreferrer">Guide here</a></span></div></td><td colspan="2" style="vertical-align:top;padding:0 3px;"><div style="text-align:center;color:#222222;font-weight:600;padding:2px 0;"><span style="font-size: 11pt;">Other</span></div><div style="width:0;height:14px;border-left:2px solid #555555;margin:0 auto;"><br></div><div style="text-align:center;color:#555555;font-size:10px;line-height:10px;margin-top:-2px;">▼</div><div style="max-width:280px;margin:0 auto;padding:8px 8px;border:1.5px solid #6d9eeb;border-radius:10px;background:#ffffff;color:#222222;text-align:center;line-height:1.4;"><span style="font-size: 11pt;">Use the Single Sign-On module, creating a connection with the type &quot;OIDC&quot;.<br><a href="https://www.usehalo.com/guides/2667" style="font-size: 11pt;" target="_blank" rel="noopener noreferrer">Guide here</a></span></div></td></tr></tbody></table></td><td colspan="2" style="vertical-align:top;padding:0 3px;"><div style="text-align:center;color:#222222;font-weight:600;padding:2px 0;"><span style="font-size: 11pt;">Yes</span></div><div style="width:0;height:14px;border-left:2px solid #555555;margin:0 auto;"><br></div><div style="text-align:center;color:#555555;font-size:10px;line-height:10px;margin-top:-2px;">▼</div><div style="max-width:280px;margin:0 auto;padding:8px 8px;border:1.5px solid #6d9eeb;border-radius:10px;background:#ffffff;color:#222222;text-align:center;line-height:1.4;"><span style="font-size: 11pt;">Set up single sign-on using the SAML 2.0 module.<br><a href="https://www.usehalo.com/guides/2285" style="font-size: 11pt;" target="_blank" rel="noopener noreferrer">Guide here</a></span></div></td></tr></tbody></table></div><p><br></p><p><span style="font-size: 11pt;"><strong><em>Note: Additional single sign on setup methods are available that are not linked in this diagram, this is because these methods have been replaced by our single sign on module, which offers additional features. Therefore it is recommended to use this where supported.&nbsp;</em></strong></span></p></div>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.