SAML Single Sign On (SSO) Into Bamboo Using Jboss Keyclock

Step 1: Setup Jboss Keyclock as Identity Provider

Follow the steps below to configure Jboss Keyclock as an Identity Provider

 Add Mappers

• Add the following attributes in the Mappers tab.
• Click on Add Built-in and add the following option.

 Download setup file

• In the Installation Tab, choose SAML Metadata IDPSSODescriptor as Format option.
• Download it and keep it handy. It will be used to configure the plugin.

Step 2: Setup Bamboo as Service Provider

We can configure IDP settings in 3 ways:

A. By Metadata URL

• Click on Import from Metadata in Configure IDP tab
• Select IDP: Import From Metadata URL
• Enter IDP metadata URL: Enter your metadata URL
• If your IDP changes certificates at intervals, you can select Refresh metadata periodically. Select 5 minutes for the best results.
• Click Import

B. By uploading Metadata XML file

• Click on Import from Metadata in Configure IDP tab
• Select IDP: Import from Metadata File
• Upload IDP metadata file
• Click Upload

C. Manual Configuration

Go to Configure IDP tab and enter the following details

• IDP Entity ID
• Single Sign On URL
• Single Logout URL
• X.509 Certificate

Step 3: Setting up Bamboo user profile attributes

We will be setting up user profile attributes for Bamboo. If your users are stored in a directory that is Read Only, please check Disable Attribute Mapping in User Profile tab.





a. Finding correct attributes

• Go to Configure IDP tab. Scroll down and click on Test Configuration.
• You will see all the values returned by your IDP 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 IDP 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 NameID, enter NameID against Username
• Setting up both Username and Email is required if you want to let users register. If you want existing users to the only login, configure the attribute using which you will match the user in Bamboo.

c. Matching a User

When the user logs into Bamboo, one of the user's data/attribute coming in from the IDP is used to search the user in Bamboo. This is used to detect the user in Bamboo and log in the user to the same account.
• Go to User Profile tab
• Select Username or Email for Login/Search Bamboo user account by
• Enter the attribute name from IDP which corresponds to Username or Email using Finding Correct Attributes

Step 4: Assigning groups to users

We will be setting up user group attributes for Bamboo. If your users are stored in a directory that is Read Only, please check Disable Group Mapping in User Groups tab and skip to Setting default group.




a. Finding Group Attribute

• Just like we found Attribute Name for User Profile attributes, we find group attribute.
• Go to Configure IDP tab. Scroll down and click on Test Configuration.
• You will see all the values returned by your IDP to Bamboo in a table. If you don't see value with groups, make the required settings in your IDP 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
• At the bottom of the page, all groups in Bamboo are shown. You can map groups in IDP which correspond to Bamboo groups. For example, if you want all users in dev-ops and dev groups in IDP to be added to crucible-users, you will need to enter dev-ops;dev against crucible-users
• If you want user mapping to work for only limited groups in Bamboo, check the option Update User Groups



b. Setting default group

• Select the users' Default Group in the tab User Groups. If no group is mapped, users are added by default to this group.

Step 5: SSO Settings

The settings in SSO Settings tab define the user experience for Single Sign On.


a. Sign In Settings

• Set Enable SSO for Bamboo Software to allow SSO for Bamboo Software users.
• Set button text for button on login page using Login Button Text
• Set redirect URL after login using Relay State. Keep this empty for coming back to the same page user started from
• Enable Auto-redirect to IDP if you want to allow users to login only using IDP. Enable backdoor for emergency



c. Sign Out Settings

Set Logout URL or Logout Template to redirect users after logout action.




d. SSO Error Settings

Set error template to redirect users to a custom error page instead of login page. Use this if you have Auto-redirect to IDP enabled.