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 Azure AD. By the end of this guide, Azure AD users should be able to login and register to Bitbucket Software.

Step 1: Setup Azure AD as Identity Provider

    miniorange img Prerequisites:

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

    • SP Entity ID
    • ACS URL

    miniorange img Instructions:

Azure AD setup through App Registrations

  • Log in to Azure AD Portal

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

    • azure ad sso-1
  • 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.
    •       azure ad sso-2
  • 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

    • azure ad sso-3
  • Go back to Azure Active Directory ⇒ App Registrations window and click on Endpoints link.

    • azure ad sso-4
  • This will open up a window with multiple URLs listed there. Copy the Federation Metadata Document URL. This will be required while configuring the SAML plugin.

    • azure ad sso-5

Azure AD setup through Enterprise Applications

  • Log in to Azure AD Portal

  • Select Azure Active Directory ⇒ Enterprise Applications.

    • azure ad sso-6
  • Click on New Application.

    • azure ad sso-7
  • Click on Non-gallery application section and enter the name for your app and click on Add button.

    • azure ad sso-8
  • Click on Single sign-on from the application's left-hand navigation menu. The next screen presents the options for configuring single sign-on. Click on SAML.

    • azure ad sso-9
  • Enter the SP Entity ID for Identifier and the ACS URL for Reply URL from Service Provider Info tab of the plugin.

    • azure ad sso-10
  • 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 Attributes tab.

    • azure ad sso-11
  • Copy App Federation Metadata Url. This will be used while configuring the SAML plugin.

    • azure ad sso-12
  • 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.

    • azure ad sso-13

Step 2: Setup Bitbucket as Service Provider

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

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:

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

bitbucket sso-8

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

bitbucket sso-9

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
bitbucket sso-10

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.


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.


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.


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.



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.


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

Step 3: Setting up Bitbucket user profile attributes

    We will be setting up user profile attributes for Bitbucket. If your users are stored in a directory that is Read Only, please check Disable user Profile Mapping in User Profile tab and follow steps given in Matching a User.

    bitbucket sso-11

    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
    When the user logs into Bitbucket, one of the user's data/attribute coming in from the IDP is used to search the user in Bitbucket. This is used to detect the user in Bitbucket and log in the user to the same account.
  • 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

    We will be setting up user group attributes for Bitbucket. 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.

    bitbucket sso-12
    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 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
  • At the bottom of the page, all groups in Bitbucket are shown. You can map groups in IDP which correspond to Bitbucket 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 Bitbucket, check the option Update User Groups

    • b. Setting default group
  • Select the users Default Group to assign SSO users. Recommended to set up the groups needed to access the application.
  • You can enable default groups for all users or new users using the option.Select Noneif you don't want to assign any default group to SSO users.Using the option Enable Default Groups for.

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 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
    • bitbucket sso-13
    b. Custom Login Template
  • Design your own login template that will be used to intitate SSO.

    • c. Sign Out Settings
  • Set Logout URL or Logout Template to redirect users after logout action.
    • bitbucket sso-14
    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.
    • bitbucket sso-15
    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.

Step 6: Git Authentication Configuration

    miniorange img Configure Azure AD:

    • Sign in to the Azure Portal
    • Click on All Service in the left hand nav and choose Azure Active Directory.
    • In the Azure Active Directory panel, click on the App Registration and choose New Application Registration.
    • Enter friendly name for your application, for example Bitbucket-Git-App and Select Native as the Application Type.
    • For the redirect URL enter https:///Bitbucket-Git-App. Replace “your_tenant_name” with the name or id of your Azure AD Tenant.
    • Click Create to create the Application.
    • In the succeeding page, Find the Application ID and copy it to clipboard. You will need it to configure the plugin.
    • Click on the settings and then choose the Required permission.
    • Click on the Add, then Select and API, select Microsoft Graph and Windows Azure Active Directory, provide permission.
    • Navigate back to the Required Permission section and click on the Grant Permission.

    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