Contents

OAuth 2.0 Single Sign On (SSO) Into Bamboo

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.

You can refer the steps to configure ADFS for Confluence Bamboo SSO from the video or documentation given below

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 OAuth 2.0 compliant Provider

Register an OAuth application on your Provider by configuring the Callback URL provided in the plugin. The callback URL would be {oauth_client_base_url}/plugins/servlet/oauth/callback
Collect the endpoints given below from your Provider to configure them in the plugin.

Endpoints	Use
Client ID	Identify the application.
Client Secret	Authenticate the Authorization Server.
Scope	Limit an application's access to a user's account.
Authorization Endpoint	Identify a user or obtain an authorization code.
Access Token Endpoint	Allows an application to access an API.
User Info Endpoint	Access the user profile information.
Group Endpoint (optional)	Fetch groups of a user.
Logout Endpoint (optional)	Enter the Logout endpoint of your OAuth/OpenID Provider. Leave it blank if Logout endpoint is not supported by provider.

Step 2: Setup Bamboo as OAuth Client

Select Custom OAuth App from the dropdown list.
Enter the App Name, Client ID, Client Secret and Scope.

OAuth / OpenID Single Sign On (SSO), Configure Custom OAuth app

Configure Authorize Endpoint, Access Token Endpoint, User info Endpoint and Fetch groups Endpoint(optional) collected from the Provider (as mentioned in the Step 1).
Configure the Logout Endpoint if you want users to log out from Bamboo along with Provider. This setting is optional. Logout URL will destroy user’s session in Bamboo and Provider. You can also set redirect URL here, which specifies where to redirect after Bamboo logout.
Click on Nonce checkbox if you want to add the nonce parameter to authorised server request. The nonce parameter is used to validate the tokens received from the provider. Its purpose is to mitigate the replay attack.
Select the Check State Parameter if required by your OAuth Provider. Using state parameter, a client application can validate that the response received from the provider is not altered in between.
Click on Save button.
Click on Test Configuration for verifying the entered details.

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.