Google Workspace SSO

Updated 2 years ago by admin

This article applies to:

  • Gmail
  • Google Drive and Docs
  • Google Calendar
  • Google Sites
  • Google Groups for Business

For this guide you will need:

  • Your Google Workspace primary domain
  • Usernames in your identity provider will need to match usernames in Google Workspace e.g. if your IdP has a user then Google Workspace will also need the same user to exist. This may mean you have to add a secondary domain to Google Workspace (please note, setting that up is outside of the scope of this document and requires access to the DNS records for your domain)
  • Ensure that you have an Identity Provider configured
  • Your IdP URL - this can be found by clicking the relevant Identity Provider tile in Products -> IDaaS -> Identity Providers and will save some time later in the guide
  • Ensure that you have a Google Workspace account that supports Single Sign on using a Third Party IdP
  1. Navigate to App Launcher -> Add Apps
  2. Select the Google App tile for the app you are adding. This guide will use Gmail as an example. If you do not see a tile that matches the desired Google App, select the Google App (Generic) tile and change the Application Name to the name of the app you are setting up
  1. Select an existing category or create a new category by using the Manage option. The app tile will appear in this category for IDaaS users.
  2. Leave the Add Application window open and open a new tab and log in to Google Admin. Navigate to Account Settings -> Custom URLs and make a note of the URL for the app you are adding i.e. Gmail. Note that you may have a custom domain set up rather than the default Google URL, which usually takes the format <app><custom domain>
  3. Switch back to the Add Application window and paste the link for the app into the Application URL field
  4. Select the preferred Identity Provider for this app
  5. Click Next
  6. Click the Download Certificate button and save the file on your computer
  7. Leave this window open and switch back to Google Admin as an administrator. Now search for Single sign-on and select the Set up single sign-on (SSO) with a third party IdP menu option
  8. If this is the first time you have configured third party SSO, you will need to click Add SSO Profile otherwise click the pencil icon to the right of SSO profile for your organization to edit the settings
  9. Tick Set up SSO with third-party identity provider
  10. The next step is to set the Sign-in Page URL for Google to use
Remember, in this case, the IDaaS product is acting as a broker between the app and your configured Identity Provider. Therefore, the IDaaS service is the IdP.

This URL will take the format https://<your-vanity-subdomain> and can be found by clicking the relevant Identity Provider tile in Products -> IDaaS -> Identity Providers

Please note that at the time of writing the IDaaS product does not support Single Sign Out, however this is a mandatory field. You can use the format https://<your-vanity-domain> for the purposes of configuration.
  1. You will either see “No certificate file has been uploaded. UPLOAD CERTIFICATE” or “A certificate file has been uploaded. REPLACE CERTIFICATE”. Click on whichever option is available, and upload the certificate from Step 10.
  2. Ensure the Use a domain specific issuer checkbox is ticked
  3. Click the Save button in the bottom right-hand corner of the page
  4. At this point, the Google side is configured. Unfortunately, at this moment in time, Google does not provide the option to download metadata for use with the IdP. Copy the following template into your clipboard, taking note that the <CUSTOM_DOMAIN> tag will be updated in both sections before use in the following steps
Important: if you are using a secondary domain, you must populate the metadata with the primary domain, otherwise your users will get a configuration error when they try to sign in.
Important: if you plan to add multiple Google app tiles, the first app that uses the entityID<CUSTOM_DOMAIN> will determine the Identity Provider that all subsequent Google app tiles will use, if more are added at the end of this guide. Put simply, it is not possible to split Google Apps access across multiple Identity Providers.
<EntityDescriptor entityID="<CUSTOM_DOMAIN>" xmlns="urn:oasis:names:tc:SAML:2.0:metadata">
<SPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">
<AssertionConsumerService index="1" Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
Location="<CUSTOM_DOMAIN>/acs" />
  1. Switch back to the Add Application window and click Next.
  2. Click Paste Metadata XML and then paste in the XML from the previous step
  3. Before clicking OK, change <CUSTOM_DOMAIN> tags to the name of your Google Workspace primary domain e.g., in both parts of the XML
  4. Click OK and then Next to finalise the configuration
  5. The new tile should be visible in the application list. Test the authentication by clicking the newly created Gmail tile and when prompted sign in with your identity provider credentials

Additional Google App tiles

Once a user has authenticated with the primary Google app that has been configured, they can switch between Google Apps using the selector menu.

However, it is also possible to add additional Google app tiles to the Applications list if required.

To add another app, such as Google Drive, repeat the same steps 1-5 and steps 17-19 taking care to use a unique EntityID in step 17 that matches the Application URL e.g. entityID="<APP><CUSTOM_DOMAIN>" . In the example of Google Drive the entityID would become entityID="<CUSTOM_DOMAIN>". Failing to do this will generate an error that an application already exists with the given metadata.

Further Reading

How did we do?