Goal

After completing this setup guide, you will have setup Google Cloud Identity with Just-In-Time Provisioning and your Atlassian product for the SAML SSO app. Additionally, you will test SSO and enable the SSO redirection.



Prerequisites

To use the SAML SSO app with GSuite, you need the following:

  • A Google Cloud Identity subscription
  • A (trial) subscription for the SAML SSO app
  • Admin access to your Atlassian product

Video Guide



Step-by-Step Setup Guide

Configure Google Cloud Identity for the SAML SSO App

Go to http://admin.google.com and click on "Apps", then "Web and mobile apps".


Afterwards, click on "Add app", then "Add custom SAML app".



In the next window, give the application a name, and click on "CONTINUE".


Next, click "DOWNLOAD METADATA" and save the file to your computer, and click "CONTINUE".


Next, for "ACS URL" and "Entity ID" enter "https://<base-url>/plugins/servlet/samlsso" (without quotes) and substitute "<baseURL>" with the URL to your Atlassian product.

For "Name ID", make sure that "Name ID Format" is set to "UNSPECIFIED" and that "Name ID"  is set to "Basic Information > Primary email".

Click "CONTINUE" to proceed.




Click on "ADD MAPPING".


Under "Basic Information", select "First name", and enter "firstName" (without quotes) as the App attribute.


Similarly, add "lastName" and "mail" attributes. 

Optionally, if you would like to also send the Groups attribute in the SAML response, set it in the next section, by selecting all the groups that you want to send (at the moment, you need to select them one by one from the list), then enter "Groups" (without quotes) as the App attribute.

This is sort of a white list for the groups to be returned in the SAML response, i.e., if you don't add a group in that list, it wouldn't be returned in the Groups attribute in the SAML response, even if the user was a member of another group that you've already added to that list.


Click on "FINISH".


After setting up the app, it is turned OFF. To activate it, click on "OFF for everyone".


Check "ON for everyone" and click "SAVE".






Configure Jira for the SAML SSO App

Install the SAML SSO App


In your Atlassian product, open the in-product marketplace as described in the Atlassian documentation.
Search for "resolution saml" and click "Install" for SAML Single Sign On (SSO) by resolution Reichert Network Solutions GmbH



After the installation is complete, click on Manage, then choose Configure

Now, you are on the Add-on / app configuration page and the first step of the setup wizard will appear.

install_saml_sso






Configure the SAML SSO App


After you clicked "Configure", the Wizard will be triggered. If not, or if you want to add another Identity Provider (IdP) to your existing configuration, click on "Add new IdP +". This guide assumes, that you there is no IdP configured.


The Wizard greets you with information, click on "Add New IdP" to proceed.







Choose Google Cloud identity (G Suite) for the Identity Provider. Keep the Authentication Protocol set to SAML2. You must also provide a (unique) name.


Click "Next".


Click on "Select Metadata XML File".


Select the file you have downloaded before and click "Choose".


Click on "Import".


Click "Next" to continue.





If you configured your Atlassian product and your Identity Provider in a common way, you do not need to change anything here. In that case, just click "Next".


userid






For the User Update Method, choose "Update from SAML-Attributes".


The window now expands. There are various options you can set. For this tutorial, new users should be created automatically when first accessing your Atlassian product instace, thus tick "Create New Users". 

You can also choose the directory for new users or to update non-SAML provisioned users, i.e. which are already present in your Atlassian product. By activating the option, they can also be updated via SAML attributes when they log in.

Further, the "Full Name Attribute" and "Email Attribute" must be set. Set the first to "{firstName} {lastName}" and the second to "mail" (both without quotation marks) as configured before.



For the Group Setting, set the Group attribute to "Groups" (without quotation marks).

Then click on "Save & Next".




Testing SSO


The wizard also allows to test the Single Sign On. Just follow the steps to test if the login works as expected. 


Click on "Start test" to proceed.

start_test

Copy the orange marked link and open a new incognito/private tab or a different web browser. Then, paste the link and navigate to it. 

test_your_settings


You will be now redirected to GSuite's login page. Please log-in with you username and password. 



If everything worked fine, you will log in into your Atlassian product. In the other tab/browser in which you were configuring the SAML SSO plugin, you can see also the "SUCCESS" status, if everything worked as expected. Click Next to proceed.

test_sso




SSO Redirection


As a last step, you can set the Enable SSO Redirect option. If set, all users will be redirected to Single Sign On, thus they will be logged in via the IdP. Click on Save & Close to finish the configuration.


enable_redirection