SAML Single Sign On (SSO) into Bitbucket using Azure AD

Download

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

Pre-requisites

To integrate your Identity Provider(IDP) with Bitbucket, you need the following items:

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

Download And Installation

Log into your Bitbucket 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 Bitbucket SAML Single Sign On, SSO SAML via search.
Click Try free to begin a new trial or Buy now to purchase a license for Bitbucket SAML Single Sign On, SSO SAML.
Enter your information and click Generate license when redirected to MyAtlassian.
Click Apply license.

SAML Single Sign On (SSO) into Bitbucket

Step 1: Setup Azure AD as Identity Provider

Single Sign On using AzureAD, AzureAD SSO Login Prerequisites Prerequisites:

Copy these values from the Service Provider Info tab of the SAML plugin.

SP Entity ID
ACS URL

Single Sign On into AzureAD, AzureAD SSO Login Instructions Instructions:

Note: Enterprise app configuration is the recommended option for SAML . If you do not have Azure subscription or using free account please setup App Registration Configuration.

To perform Single Logout using Azure AD, the Atlassian instance (E.g. Jira,Confluence) must be https enabled.

Azure AD setup through Enterprise Applications
Azure AD setup through App Registrations

Azure AD setup through Enterprise Applications

Select ⇒ and Azure Active Directory ⇒ Enterprise Applications.

Single Sign On(SSO)using Azure AD, SAML SSO enterprise application

Click on Create your own application. Then enter the name for your app, select the Integrate any other application you don't find in the gallery checkbox and click on Create button

Single Sign On(SSO)using Azure AD, Azure AD SAML SSO new application

Click on Set up Single sign-on.

Single Sign On(SSO)using Azure AD,Azure AD SAML SSO - set up single sign on

The next screen presents the options for configuring single sign-on. Click on SAML.

Single Sign On(SSO)using Azure AD, Azure AD SAML SSO select saml

Edit the option 1 :Basic SAML Configuration to configure plugin endpoints.
Enter the SP Entity ID for Identifier and the ACS URL for Reply URL from Service Provider Info tab of the plugin.

Single Sign On(SSO)using Azure AD, Azure AD SAML configuration

Click on Save icon.

Single Sign On(SSO)using Azure AD, SSO save window

By default, the following Attributes will be sent in the SAML token. You can view or edit the claims sent in the SAML token to the application under the User Attributes & Claims tab.
You can add attribute using Add new claim

Single Sign On(SSO)using Azure AD, user attributes claims

You can add group attribute claim using Add a group claim

Single Sign On(SSO)using Azure AD, add a group claim

Copy App Federation Metadata Url from setup tab.

Single Sign On(SSO)using Azure AD,federation metadata URL

Click on User and groups from the applications left-hand navigation menu. The next screen presents the options for assigning the users/groups to the application.

Single Sign On(SSO)using Azure AD, user and groups

Azure AD setup through App Registrations

Select ⇒ Azure Active Directory ⇒ App Registrations. Click on New Application Registration.

Single Sign On(SSO)using Azure AD, New app

Assign a Name and choose the account type. In the Redirect URI field, provide the ACS URL provided in Service Provider Info tab of the plugin and click on Register button.

Single Sign On(SSO)using Azure AD, app registration

Now, navigate to Expose an API menu option and click the Set button and replace the APPLICATION ID URI with the plugin's SP Entity ID

Single Sign On(SSO)using Azure AD, expose an API

By default, some Attributes will be sent in the SAML token. If you're not getting group information. Then, add Token configuration for Group information.

Single Sign On(SSO)using Azure AD, token configuration

Click on Add groups claim

Single Sign On(SSO)using Azure AD, Add groups claim

Copy the Federation Metadata URL given below. Replace the '{tenant_ID}' part with your Directory/Tenant ID. This will be required while configuring the SAML plugin.

Federation Metadata URL https://login.microsoftonline.com/{tenant_ID}/federationmetadata/2007-06/federationmetadata.xml

Step 2: Setup Bitbucket as Service Provider

Now we will go through the steps to setup Bitbucket as a Service Provider using miniOrange SAML add-on:

configure single Identity Provider Setup
Configure Multiple Identity Provider(IDP) Setup

configure single Identity Provider Setup

Configuring Single IDP

With the information you have been given by your IDP team, you can configure IDP settings in 3 ways:

By Metadata URL
By uploading Metadata XML file
Manual Configuration

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(Eg. Azure AD), you can select Refresh metadata periodically. Select 5 minutes for the best results.
Click Import.

SAML Single Sign On (SSO) into Bitbucket Service Provider, Import IDP metadata from URL

B. By Uploading Metadata XML File

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

SAML Single Sign On (SSO into Bitbucket Service Provider, Import IDP Metadata From File

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

SAML Single Sign On (SSO) into Bitbucket Service Provider, Configure IDP Metadata Manually

Configure Multiple Identity Provider(IDP) Setup

Configure New IDP

If you already have one IDP & you are looking to add second IDP then you can do it by performing the following steps.

Navigate to Configure IDP tab.
Click on Add new IDP.
It will present a blank form & you can configure new IDP using steps from Single IdP Setup.

SAML Single Sign On (SSO) into Bitbucket Service Provider, Add Second IDP

Configure multiple IDPs

If you have configured more than two IDPs then it will show you the list of IDP that you have configured with Bitbucket.

Click on Add new IdP button for adding new IDP on Bitbucket. The steps for adding new IDP will remain the same.

SAML Single Sign On (SSO) into Bitbucket Service Provider, Add New IDP

SAML Single Sign On (SSO) into Bitbucket Service Provider, Add New IDP

An operation that you can perform with List of IdPs page.

Add / delete Identity Provider.
Test Connection between Bitbucket & IdP by click on Test button for respective IDP.
Edit the IdP configuration by clicking on the Edit button.
You can allow an only specific set of users to access Bitbucket by using Domain Mapping.

Single Sign-On with Multiple Identity Provider(IDP)

Select your IdP from the list. It will redirect you to selected IdP login page.

SAML Single Sign On (SSO) into Bitbucket Service Provider, IDP List While Login

SAML Single Sign On (SSO) into Bitbucket Service Provider, IDP List While Login

Configure Domain Mapping

You can enable domain mapping using Use Domain Mapping option.
Once enable it, you need add domain name against each IDP.
After enabling Domain Mapping it allows SSO only for those users whose domain matches with the specified one.

SAML Single Sign On (SSO) into Bitbucket Service Provider, Domain Mapping Configuration

Single Sign-On using Domain mapping

Enter the user email address. It will check your domain name with the configured domain if it matches then it will redirect you to the respective Identity Provider login page.

SAML Single Sign On (SSO) into Bitbucket Service Provider, Domain Mapping Form for Login

This is how the login screen would appear after enabling domain mapping.

Step 3: Setting up Bitbucket user profile attributes

Read Only

Disable user Profile Mapping

User Profile

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 Bitbucket 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 Bitbucket.

c. Matching a User

Go to User Profile tab.
Select Username or Email for Login/Search Bitbucket 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

Read Only

Disable Group Mapping

User Groups

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 for the option Enable Default Groups for.

SAML Single Sign On (SSO) into Bitbucket Service Provider, Default groups

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 Bitbucket 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

Manual group mapping: If the names of groups in Bitbucket 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 Bitbucket 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 bitbucket group from the dropdown which lists all groups present in bitbucket 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 stash-user, you will need to select stash-user from the dropdown and enter 'dev' against stash-user.
- 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 Bitbucket.
- If the user is part of some group in Bitbucket and that group is not present in the SAML response returned by IDP, then the user will be removed from that group in Bitbucket.
- If you don't want On-The-Fly group mapping to affect Bitbucket groups which are managed locally then add those groups in Exclude Groups field.

Step 5: SSO Settings

SSO Settings tab

Single Sign On

a. Sign In Settings

Set Enable SSO for Bitbucket Server to allow SSO for Bitbucket 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.

SAML Single Sign On (SSO) into Bitbucket Service Provider, Sign In Settings

b. Custom Login Template

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

SAML Single Sign On (SSO) into Bitbucket Service Provider, Custom Login Settings

c. Sign Out Settings

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

SAML Single Sign On (SSO) into Bitbucket Service Provider, Sign Out Settings

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.

SAML Single Sign On (SSO) into Bitbucket Service Provider, SAML Error Message Settings

e.Advanced Settings

Allow Users to Change Password: Disable if you don't want user to chnage their local Bitbucket credential.
Remember Me-cookie: If enabled, user stays logged in until user explicitly logs out.
You can extend Bitbucket default session timeout using these steps. By default it is set to 30 mins.
Validate IDP's SAML Response: Configure time difference(in minute) here In case Bitbucket server time is not in sync with your IDP's time.

SAML Single Sign On (SSO) into Bitbucket Service Provider,Advance SAML settings Tab

Step 6: Git Authentication Configuration

miniorange img Configure Azure AD:

Log in to Azure AD Portal (Make sure to use Azure Active Directory user account with "onmicrosoft.com" domain, e.g., user@demo.onmicrosoft.com)
Select ⇒ Azure Active Directory ⇒ App Registrations. Click on New registration.
Enter friendly name for your application, for example Bitbucket-Git-App.
For the Redirect URI, select Public client/native (mobile & desktop) as the Application Type and enter https://your_tenant_name/Bitbucket-Git-App. Replace “your_tenant_name” with the name or id of your Azure AD Tenant.
Click on Register to create the Application and copy Application (client) ID.
Now, click on API permissions to update directory permission

Git Authentication using Azure AD as Identity Provider, Azure AD

Click on the Add a permission, then select Microsoft Grap, and add user related permissions like User.Read.All, User.ReadWrite.All etc.

Click on the Grant admin consent.

Kindly verify granted permissions.

Navigate to Authentication and set Default client type to yes and Save settings.

Git Authentication using Azure AD as Identity Provider, Azure AD,SSO

miniorange img Configure Bitbucket:

Navigate to the Git Authentication Configuration tab, select Azure AD as IdP and configure the Application ID that you have copied from in the step 7.

If you are looking for anything which you cannot find, please drop us an email on info@xecurify.com