Enabling SSO with a Generic Identity Provider
In this article
What is SSO?
Single sign-on (or SSO) is a way to authenticate and log-in to an application with just one set of credentials, rather than having to set up multiple usernames and passwords across different platforms. It's a more secure process and prevents potentially losing or forgetting log-in credentials since it's stored through another service.
SAML is an open standard for allowing single sign-on between 2 systems: A Service Provider (that's Help Scout) and an Identity Provider (that's the system storing your organization's user database e.g. Okta, Onelogin etc.).
Setting up SSO with a Generic Identity Provider
This section explains step by step how to configure SAML Single Sign-On between Help Scout and a generic Identity Provider. Please see the separate articles listed below for setup instructions if your Identity Provider is Okta or Onelogin:
You'll need to be either the Account Owner or an Administrator to get this setup for your account.
- Login to Help Scout, then navigate to Manage → Company → Login
Before making any changes on this page, take note of the
Post-back URL and the
Audience URI at the bottom of the page.
- Log in to your preferred Identity Provider as an administrator.
- Following the IdP documentation, create an "app" that uses the Post-back URL and the Audience URI from step 2. You can also upload a Help Scout logo (if that option is available) to make it easier for users to see which application they are signing into.
- Configure the IdP application to allow access to all the relevant users within the organization. This can typically be done either manually or by using groups/roles defined within the IdP users list.
- Now that you have the app created, locate the Single Sign-On URL and the X.509 Signing Certificate. The certificate should be a file for download, if it is simply displayed on the page then copy it and save it as a file.
- Head back to Help Scout, then head to Manage → Company → Login. You can now click Enable SAML .
On the form that you are presented with, use the details from step 6. Paste the URL and upload the certificate.
Note: If the certificate upload fails with an error saying the certificate has to be in PEM or CER format then you will have to convert the certificate before uploading it to Help Scout. Your IdP will indicate what sort of certificate it is providing, so use that to find out the easiest way of converting the certificate. An example command for converting a CRT certificate to a PEM certificate is as follows:
openssl x509 -in idpcertificate.crt -out convertedcertificate.pem -outform PEM
- Provide the email domain(s) that will trigger Single Sign-On. The login screen will be aware of these domains and users trying to login with an email from either of these domains will be taken through single sign-on.
Force SAML Sign-in if you want users to only log in to Help Scout via SSO with the Identity Provider. Even if this is selected, an Account Owner will
always be able to log in to Help Scout with their account password (this is to prevent the Account Owner from getting locked out). Don't forget to click the
Single Sign-On will now be enabled. Users who try to login with an email address for any of the domain(s) provided in step 9, will be taken to the Identity Provider to authenticate, and then redirected to Help Scout upon a successful log in.