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

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 and follow steps given in Matching a User.





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 set default group.



a. 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.
• 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 Enable Default Groups for.



b. 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.
• Check Disable Group Mapping option if you don't want to update groups of existing users.



c. Group Mapping


Group Mapping can be done in two ways:

• Manual group mapping: If the names of groups in Bamboo are different than the corresponding groups in IDP, then you should use Manual group mapping.
• On-The-Fly group mapping: If the names of groups in Bamboo and IDP 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 IDP 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 IDP group to be mapped in the textbox beside
  • For example, if you want all users in 'dev' group in IDP to be added to bamboo-users, you will need to select bamboo-users from the dropdown and enter 'dev' against bamboo-users.
  • 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 IDP 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 SAML response returned by IDP, 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: 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 Server to allow SSO for Bamboo 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.



b. Custom Login Template

Design your own login template that will be used to initiate SSO.




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.




e. Advance SSO Settings

• Allow Users to Change Password: Disable if you don't want user to change their local bamboo credential.
• Remember me cookies: If enabled, user stays logged in until user explicitly logs out.
• Validate IDP's SAML Response: Configure time difference(in minute) here In case Bamboo server time is not in sync with your IDP's time.