Set up custom SSO for GorgiasUpdated 7 days ago
Configure Gorgias as an OpenID Connect (OIDC) app in the Identity Provider (IdP) of your choice to allow users to sign into Gorgias using Single Sign-On (SSO).
Requirements
- Available on Advance and Enterprise Helpdesk plans
- To set up SSO, you need to be an Admin in Gorgias and your IdP
Configure SSO
To configure SSO for Gorgias, you’ll need the following parameters:
| Parameter | Description | Where to find it |
|---|---|---|
| Redirect URI/Callback URL | This is where users are redirected after they’ve successfully logged in | The Callback URL is provided in your Gorgias Access Management settings, and you’ll add it to your OIDC web application |
| Client ID | This identifies Gorgias as the app being logged into during an authentication request | The Client ID is provided by your IdP when creating an OIDC web application, and you’ll add it to your Gorgias Access Management settings when configuring SSO. |
| Client Secret | This proves the app’s identity to the IdP during an authentication request | The Client Secret is provided by your IdP when creating an OIDC web application, and you’ll add it to your Gorgias Access Management settings when configuring SSO. |
| Provider URL | This identifies the IdP your users log into. Typically, it includes your company’s unique subdomain, plus the IdP’s domain. For example: if you use Okta as your IdP, your provider URL might look something like https://companyname.okta.com | This URL comes from your IdP, and you'll add it to your Gorgias Access Management settings. You can often find it in your browser’s address bar when you’re signed into your IdP’s admin console, but where it appears can differ by provider. |
| Provider name | On the Gorgias sign-in page, users will click a Continue with [SSO Provider Name] button to sign in with SSO. The name you enter in this field will update the name on this button. | You can use the name of your IdP, or customize it, if you'd like. |
Step 1: Create an OIDC web application
The steps for creating an OIDC web application will vary depending on your IdP. Below, we’ve listed some documentation from common IdPs, but if you’re having trouble with the setup, we recommend reaching out to your IdP for support.
When prompted to add a Callback URL or Redirect URI to your OIDC app configuration, follow the steps below to access the URL in your Gorgias Access management settings:
- From your helpdesk, click the Settings icon in the bottom-left corner.
- In the menu, locate Account, then select Access management.
- Under Single Sign-On, click +Add Provider.
- Copy the Callback URL from Gorgias, then add it to the app settings in your IdP.
profile and email scope properties. Some IdPs (like JumpCloud) will require you to add these scopes manually while configuring the OIDC app. If you’re given the option to add scopes or attributes, be sure to select both the profile and email scopes.Step 2: Connect Gorgias to your IdP
Once you’ve created the OIDC web application in your IdP, add the required parameters to Gorgias to complete the set up.
- From your Access management settings in Gorgias, click +Add Provider.
- Enter a Provider Name. For example, if Okta is your IdP, your provider name is Okta.
- Enter the Client ID from the OIDC web application you configured earlier.
- Enter the Client Secret.
- Enter your Provider URL. For example, if Okta is your IdP, your provider URL might look something like
companyname.okta.com - Click Add SSO Provider.
- Click Save changes.
What to expect after SSO is enabled
When SSO is enabled, your users will see the a Continue with [SSO Provider] button on the Gorgias sign-in page, alongside the option to sign in with their email address and password, and any other SSO configurations you’ve enabled.
