Contents

OAuth/OpenID Single Sign On (SSO) into Bamboo using Google Apps

Bamboo OAuth app gives the ability to enable OAuth Single Sign On for Bamboo Software. Bamboo OAuth app is compatible with all OAuth OAuth/OIDC providers. Here we will go through a guide to configure SSO between Bamboo and your OAuth/OIDC providers. By the end of this guide, users from your OAuth/OIDC providers users should be able to login and register to Bamboo Software.

Pre-requisites

To integrate your OAuth/OIDC providers with Bamboo, you need the following items:

Bamboo should be installed and configured.
Bamboo Server is https enabled (optional).
Admin credentials are set up in Bamboo .
Valid Bamboo Server or data center Licence.

Download And Installation

Log into your Bamboo instance as an admin.
Navigate to the settings menu and Click Manage Apps.
Click Find new apps or Find new add-ons from the left-hand side of the page.
Locate mO OAuth/OpenID Connect (OIDC) for Bamboo SSO via search.
Click Try free to begin a new trial or Buy now to purchase a license for mO OAuth/OpenID Connect (OIDC) for Bamboo SSO.
Enter your information and click Generate license when redirected to MyAtlassian.
Click Apply licence.

SAML Single Sign On(SSO) into Bamboo using Identity Provider

Step 1: Setup Google app as OAuth Provider

Login to Google Console: Visit the Google's Developer Console and login to your account.
Click Select a project, then NEW PROJECT, and enter a name for the project, and optionally, edit the provided project ID. Then click on Create button.

OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Setup Google app

OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login NEW PROJECT

Select your project, click on APIs & Services and select OAuth consent screen option.

OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login OAuth Consent Screen

On the Consent screen page, select the User Type and click on Create. In the next screen, provide Application name and save the changes.
Now go to Credentials, click on Create Credentials and select OAuth Client ID.

OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Create credentials

Select Web Application as application type.

OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Application type

Click on the Add URI button in Authorized redirect URIs section. Collect the callback URL provided in the plugin and enter it here. Click on Create.
The callback URL would be {oauth_client_base_url}/plugins/servlet/oauth/callback

OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Redirect URI

Get Client ID and Client Secret: Copy the client ID and Client Secret to your clipboard, as you will need them when you configure miniOrange plugin.

OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Get Client ID

To send user's group to the client application, you need to enable Admin SDK and API access. For Admin SDK, navigate to the Dashboard and click on ENABLE APIS AND SERVICES.

OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Enable APIS and Services

Now search for Admin SDK, select it from the list and then click on ENABLE button.

OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Admin SDK

To enable API Access you need to login into Google Admin console. In Google Admin Console, go to Security ->Settings.

OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Security ->Settings

Look for API Permissions -> Enable API access

OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login API reference

Step 2: Setup Bamboo as OAuth Client

Enter Client Id, Client Secret and scope as email. And if you also want to fetch group info of the users then enter email https://www.googleapis.com/auth/admin.directory.group.readonly in the scope field.

OAuth / OpenID Single Sign On (SSO) into Bamboo Service Provider, Select Google Application

Verify the Google Administrator Account : Click on Verify Admin Credentials. For fetching the user groups from Google, you need to verify your Google Administrator's Account by clicking on 'Verify Credentials'.

NOTE: You need to login with your Google Administrator's account in this step. If you login with an user account, groups will not be fetched from Google.

If you are unable to fetch Groups then Go to Permissions and click on REMOVE ACCESS

OAuth / OpenID Single Sign On (SSO) using Google Apps Identity Provider, Remove access

Step 3: User Profile

Read Only

Disable Attribute Mapping

User Profile

Matching a User

a. Finding correct attributes

Go to Configure OAuth tab. Scroll down and click on Test Configuration.
You will see all the values returned by your Provider to Bamboo in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your Provider to return this information.
Once you see all the values in Test Configuration, keep the window open and go to User Profile tab.

b. Setting profile attributes

In this tab, fill the values by matching the name of the attribute. For instance, if the Attribute Name in the Test Configuration window is Email, enter Email against Username.

You can configure Email and Username here, otherwise it will create a new user with email address returned in Test Configuration window. If you want only existing users to login, configure the attribute using which you will match the user in Bamboo.

c. Matching a User

Go to User Profile tab.
Select Username or Email for Login/Search Bamboo user account by.
Enter the attribute name from Provider which corresponds to Username or Email using Finding Correct Attributes .

Step 4: User Groups

Read Only

Disable Group Mapping

User Groups

a. Setting default group

Select the users' Default Group in the tab User Groups. Users are added by default to this group.
You can enable default groups for All Users or New Users using the option. Select None if you don't want to assign any default group to SSO users. Using the option Assign Default Group.

OAuth / OpenID Single Sign On (SSO) into Bamboo Service Provider, Default group configuration

b. Finding Group Attribute

Just like we found Attribute Name for User Profile attributes, we find group attribute.
Go to Configure OAuth tab. Scroll down and click on Test Configuration.
You will see all the values returned by your OAuth Provider to Bamboo in a table. If you don't see value with groups, make the required settings in your OAuth Provider to return group names.
Once you see all the values in Test Configuration, keep the window open and go to User Groups tab.
Enter the Attribute Name of group against Group Attribute.
Check Disable Group Mapping option if you don't want to update groups of existing users.

c. Group Mapping

Manual group mapping: If the names of groups in Bamboo are different than the corresponding groups in OAuth Provider, then you should use Manual group mapping.
On-The-Fly group mapping: If the names of groups in Bamboo and OAuth Provider are same, you should use On-The-Fly group mapping.

I. Manual Group Mapping
- Check Restrict User Creation Based on Group Mapping option if you want new users to be created only if at least one of the user's OAuth Provider groups is mapped to a group in the application.
- For mapping, first select a Bamboo group from the dropdown which lists all groups present in Bamboo and then enter the name of the OAuth Provider group to be mapped in the textbox beside
- For example, if you want all users in 'dev' group in OAuth Provider to be added to bamboo-admin, you will need to select bamboo-admin from the dropdown and enter 'dev' against bamboo-admin.
- Use '+1' and '+10' buttons to add extra mapping fields.
- Use '-' button next to each mapping to delete that mapping.
II. On-The Fly Group Mapping
- Check Create New Groups option if you want new groups from OAuth Provider to be created if not found in Bamboo.
- If the user is part of some group in Bamboo and that group is not present in the OAuth/OpenID response returned by OAuth Provider, then the user will be removed from that group in Bamboo.
- If you don't want On-The-Fly group mapping to affect Bamboo groups which are managed locally then add those groups in Exclude Groups field.

Step 5: Sign In Settings

Change the text on the SSO button on the login page using the Login Button Text option.
Set the Relay State to the URL to which the users would be redirected after login. Keep this empty to redirect users to the same page they started with.
Enable Auto-redirect to OAuth/OpenID Provider if you want to allow users to login only using OAuth/OpenID Provider. Enable backdoor for emergency.
Backdoor/Emergency URL: Backdoor/Emergency URL gives access to the Application’s default login page. This allows users to log in directly into the application using their local credentials. This will be useful in case the Provider is under maintenance or inaccessible.
Use Domain Restriction to allow login to only a specific set of users. You can configure multiple domains (semicolon-separated).
For example, if only 'miniorange.com' and 'gmail.com' domains are allowed then, the user test@miniorange.com and test@gmail.com will be able to log in and user test@yahoo.com will not be able to login.

OAuth / OpenID Single Sign On (SSO) into Bamboo Service Provider, Sign in settings

When enabled, the plugin's APIs will not be accessible form outside this Bamboo instance.
On enabled, It allows end-users to reset their local application password as they can access change password, and forget password link . if disabled, only the system admin can reset their password.