OAuth/OpenID Single Sign On (SSO) into Bitbucket using Gluu Server

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

Pre-requisites

To integrate your OAuth/OIDC providers 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 or 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 mO OAuth/OpenID Connect (OIDC) for Bitbucket 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 Bitbucket SSO.
  • Enter your information and click Generate license when redirected to MyAtlassian.
  • Click Apply licence.
OAuth Single Sign On (SSO) into Bitbucket

Step 1: Setup Gluu as OAuth Provider

  • Login to your Gluu Server.
  • Select OpenID Connect > Clients from the left-hand side menu and click on Add Client.
    • OAuth/OpenID/OIDC Single Sign On (SSO), Gluu Server SSO Login Add Client
  • Configure Standard Settings using below details.
    • Client Name: Enter the client application name e.g. JIRA
    Authentication method for the Token Endpoint: Select client_secret_post from the list.
    Redirect Login URI: Enter the Callback URL provided in the plugin.
    Scopes: Select openid, profile and email from the list.
    Response Type: Select code, token and id_token.
    Grant Type: Select authorization_code from the list.
    Post Logout Redirect URIs: Enter URL where you want to redirect after Logout. e.g. JIRA Base URL.
    OAuth/OpenID/OIDC Single Sign On (SSO), Gluu Server SSO Login App Settings
  • Once all the settings are done click on Update to save your changes.
  • Copy generated Client ID and Secret.
  • Switch to Advanced Settings for configuring Front Channel Logout URI. Enter logout URI as <Base_URL>/plugins/servlet/oauth/logout
    • OAuth/OpenID/OIDC Single Sign On (SSO), Gluu Server SSO Login Front Channel Logout
  • Click on Update to reflect your settings.
  • Now, we need to setup Front Channel Logout URI for oxTrust. Browse to OpenID Connect > Clients and select oxTrust Admin GUI from the clients list.
    • OAuth/OpenID/OIDC Single Sign On (SSO), Gluu Server SSO Login Set Logout For Oxtrust
  • Go to Advanced Setting section and configure Front Channel Logout URI as <Base_URL>/plugins/servlet/oauth/logout.

    OAuth/OpenID/OIDC Single Sign On (SSO), Gluu Server SSO Login oxTrust Front Channel Logout
      Note: The Front Channel Logout URI will be the same for your Atlassian app and oxTrust.

Step 2: Setup Bitbucket as OAuth Client

  • Enter Client Id, client secret , Gluu domain, and scope(required) as openid email profile.
  • Your Domain name will be https://<Gluu_Base_URL>
  • Click on Test Configuration for verifying the entered details.
    • OAuth / OpenID Single Sign On (SSO) into Bitbucket Service Provider, Select Okta Application

Step 3: User Profile Mapping

  • Click on User Profile from the left sidebar. We will be setting up user profile attributes for Bitbucket. If your users are stored in a directory that is Read Only, please disable the option User Profile Mapping in the User Profile tab and skip to the step, Matching a User.
    • Atlassian Data Center Single Sign-On (SSO) for OAuth User Profile

      a. Finding correct attributes

    • Go to the SSO Endpoints tab. Scroll down and click on Test Configuration.
    • You will see all the values returned by your OAuth/OpenID Provider to Bitbucket in a table. If you don't see a value for First Name, Last Name, Email or Username, make the required settings in your OAuth/OpenID Provider to return this information.
    • Once you see all the values in Test Configuration, keep the window open and go to the User Profile tab.

      • b. Setting profile attributes

    • In this User Profile 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. You can allow only existing users to log in, by unchecking the Allow User Creation attribute in the Advance SSO Options tab.

      • c. Matching a User

      When the user logs into Bitbucket, one of the user's data/ attributes coming in from the OAuth/OpenID Provider 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 the User Profile tab.
    • Select Username or Email for Login Bitbucket user account by.
    • Enter the attribute name from OAuth/OpenID Provider which corresponds to Username or Email using Finding Correct Attributes.

Step 4: User Groups

We will be setting up user group attributes for Bitbucket. If you want to enable group mapping then you will need to select please check Enable Group Mapping in the User Groups tab else you can skip to Setting 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 Assign Default Group To. Select None if you don't want to assign any default group to SSO users.
      • Atlassian Data Center Single Sign-On (SSO) for OAuth User Groups

      b. Finding Group Attribute

    • Just like we found Attribute Name for User Profile attributes, we can find group attributes. Go to the Configure OAuth tab and click on Test Configuration.
    • You will see all the values returned by your OAuth/OpenID Provider to Bitbucket 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 the User Groups tab.
    • Enter the Attribute Name of the 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 Bitbucket are different from the corresponding groups in OAuth/OpenID Provider, then you should use Manual group mapping.
    • On-The-Fly group mapping: If the names of groups in Bitbucket and OAuth/OpenID Provider are the same, you should use On-The-Fly group mapping.

      • I. Manual Group Mapping

    • Check Allow 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/OpenID Provider 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 OAuth/OpenID Provider group to be mapped in the textbox Groups from Application.
    • For example, if you want all users in 'dev' group of OAuth/OpenID Provider to be added to Bitbucket-software-users, you will need to select Bitbucket-software-users from the dropdown and enter 'dev' against Bitbucket-software-users.
    • Use ' +' and ' +10' buttons to add extra mapping fields. Use the '-' button next to each mapping to delete that mapping.
      • Atlassian Data Center Single Sign-On (SSO) for OAuth Manual Group Mapping

      II. On-The Fly Group Mapping

    • Check Create New Groups option if you want new groups from OAuth/OpenID Provider to be created if not found in Bitbucket.
    • You can preserve existing user groups by selecting the Keep Existing User Groups option. Unticking this option will result in the user being removed from a group in Bitbucket if that group is not present in the OAuth/OpenID response returned by the OAuth/OpenID provider.
    • If you don't want On-The-Fly group mapping to affect Bitbucket groups which are managed locally, then deselect the option Keep Existing User Groups and add those groups in the Exclude Groups field.
      • Atlassian Data Center Single Sign-On (SSO) for OAuth On The Fly Group Mapping

Step 5: SSO Settings

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

    a. Sign In Settings

  • Enable Auto Redirect to Application feature to redirect users to an OAuth/OIDC provider when the Bitbucket login page is accessed. You can even set the delay before redirecting to the provider.
  • Enable Backdoor Login will allow you to use a backdoor URL in case of an emergency. You can even restrict access to backdoor URL for specific groups using Restrict Backdoor URL Access feature.
  • For example, if only 'miniorange.in' and 'gmail.com' domains are allowed then, the user test@miniorange.in and test@gmail.com will be able to log in and user test@yahoo.com will not be able to log in.
    • Atlassian Data Center Single Sign-On (SSO) for OAuth Sign In Settings
  • Use Domain Restriction to allow login to only a specific set of users. You can configure multiple domains (semicolon-separated).
    • Atlassian Data Center Single Sign-On (SSO) for OAuth Sign In Settings

    b. Redirection Rules

  • This section lets you set rules to redirect users to the login page/providers based on their email domains. This feature is more useful in case you have multiple providers configured. For example, You can set a rule of checking domain name while logging in and redirect users to different providers. You can add a rule by clicking on the Add Rule button.
    • Atlassian Data Center Single Sign-On (SSO) for OAuth Select Provider Add Rule
  • When a rule such as given above is configured example, a login form will be displayed to the users where they will have to input their Username/email address.
  • Here you can set domain-based rules for redirecting users to the specific provider. Also, you can set the default rule that will execute if the condition of any other rule does not satisfy.
    • Atlassian Data Center Single Sign-On (SSO) for OAuth Redirection Rules

    c. Session Management

  • Enable User Session Management option to set Remember Me-Cookie to keep users logged in until they are explicitly logged out.
    • Atlassian Data Center Single Sign-On (SSO) for OAuth Select Provider Add Rule

    d. Global SSO Settings

  • SSO can be enabled/disabled from the Global SSO Settings tab in the left sidebar. You can enable SSO for Bitbucket using option Enable SSO for Bitbucket Server .
  • You can change additional settings such as allow users to Change Password and Restrict access to plugin APIs.
    • Atlassian Data Center Single Sign-On (SSO) for OAuth Select Provider Global SSO Settings

    e. Look and Feel

    These settings will allow you to change the look and feel of the login page and error message. To access these settings click on the Look and Feel tab from the left sidebar.

  • You can customize the default login button text as well as you can completely design the login page using a customizable template.
  • The SSO Error Message section allows you to modify how error messages will be displayed to your users.
  • If you want to redirect users to an URL after they log out then you can use Custom Logout URL under Post Logout Configuration tab.
  • Similar to the customizable login template, you can also design the Logout page to improve the user experience.
    • Atlassian Data Center Single Sign-On (SSO) for OAuth Select Provider Look and Feel

miniorange img  Hi! Do you need help with this guide?




 Thank you for your response. We will get back to you soon.

Something went wrong. Please submit your query again

Sync product to woocommerce store from Amrod

Step 3: 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 Attribute Mapping in User Profile tab and follow steps given in Matching a User.


OAuth / OpenID Single Sign On (SSO) into Bitbucket Service Provider, Configure user profile attribute

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

c. Matching a User

When the user logs into Bitbucket, one of the user's data/attribute coming in from the Provider 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 Provider which corresponds to Username or Email using Finding Correct Attributes .

Step 4: User Groups

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.

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 Bitbucket 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/OpenID Provider to Bitbucket in a table. If you don't see value with groups, make the required settings in your OAuth/OpenID Providerto 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 Bitbucket are different than the corresponding groups in OAuth/OpenID Provider, then you should use Manual group mapping.
  • On-The-Fly group mapping: If the names of groups in Bitbucket and OAuth/OpenID 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/OpenID Provider 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 OAuth/OpenID Provider group to be mapped in the textbox beside
    • For example, if you want all users in 'dev' group in OAuth/OpenID Provider to be added to stash-users, you will need to select stash-users from the dropdown and enter 'dev' against stash-users.
    • Use '+1' and '+10' buttons to add extra mapping fields.
    • Use '-' button next to each mapping to delete that mapping.

    OAuth / OpenID Single Sign On (SSO) into Bitbucket Service Provider, Manual group mapping

  • II. On-The Fly Group Mapping

    • Check Create New Groups option if you want new groups from OAuth/OpenID Provider 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 OAuth/OpenID response returned by OAuth/OpenID Provider, 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.

    OAuth / OpenID Single Sign On (SSO) into Bitbucket Service Provider, On the fly group mapping

Step 5: Sign In Settings

The settings in Sign In 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.
  • 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.
  • Restrict the access of backdoor URL to limited users by using the Restrict backdoor URL access based on user groups feature.
  • 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.in' and 'gmail.com' domains are allowed then, the user test@miniorange.in 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 Bitbucket Service Provider, Sign in settings

    b. Sign Out Settings

  • Set Logout URL or Logout Template to redirect users after logout action.
    • OAuth / OpenID Single Sign On (SSO) into BitbucketS, Sign out settings and custom logout template

    c. 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 Provider enabled.
    • OAuth / OpenID Single Sign On (SSO) into Bitbucket Service Provider, Custom error template settings

miniorange img  Hi! Do you need help with this guide?




 Thank you for your response. We will get back to you soon.

Something went wrong. Please submit your query again

Sync product to woocommerce store from Amrod



Free Trial

If you don't find what you are looking for, please contact us at support-atlassian@miniorange.atlassian.net or raise a support ticket here.