OAuth/OpenID Single Sign On (SSO) into Bamboo using Azure AD

Download

Bamboo OAuth/OpenID app gives the ability to enable OAuth/OpenID Single Sign-On for Bamboo. Bamboo is compatible with all OAuth/OpenID Providers. Here we will go through a guide to configure SSO between Bamboo and Azure AD. By the end of this guide, Azure AD users should be able to log in and register to Bamboo.

Step 1: Setup Azure Active Directory as OAuth Provider

  • Sign in to Azure portal.
  • In the left-hand navigation pane, click the Azure Active Directory service, click App registrations, and click New application registration.
    • centrify_3
  • When the Create page appears, enter your application's registration information:
    • Name : Name of your application.
    Application type :
    1. Select "Native" for client applications that are installed locally on a device. This setting is used for OAuth public native clients
    2. Select "Web app / API" for client applications and resource/API applications that are installed on a secure server. This setting is used for OAuth confidential web clients and public user-agent-based clients. The same application can also expose both a client and resource/API.
    Sign-on URL :
    1. For "Web app / API" applications, provide the base URL of your app. eg, https://<domain-name>/oauth/callback might be the URL for a web app running on your local machine. Users would use this URL to sign in to a web client application.
    2. For "Native" applications, provide the URI used by Azure AD to return token responses. Enter a value specific to your application.
      eg, https://localhost:8090
    centrify_11
  • When finished, click Create. Azure AD assigns a unique Application ID to your application. Copy Application ID, this will be your Client ID.
    • azure-ad-1
  • Click on Settings > Keys.
    • azure-ad-2
  • Enter description and expiration time. Click on Save option.
    • centrify_12
  • Copy value. This will be your Secret key.
    • azure-ad-3
  • Get Tenant ID : Click on Azure Active Directory > Properties. Copy Directory ID. This Directory ID will be your Tenant ID.
    • aruze-ad-4
  • Enter application Home page URL Logout Settings->Properties->Logout URL.

Step 2: Setup Bamboo as OAuth Client

  • Go to Configure OAuth tab and configure Client ID, Client Secret, Tenant ID
  • scope as User.Read and for fetching group info use scope is Directory.read.all.
  • Click on Test Configuration.
    • Bamboo_configure_oauth_azure_ad

Step 3: User Profile

    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.

    bamboo-oauth-openid-sso-user-profile

    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 Bamboo 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 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 Provider 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 Provider which corresponds to Username or Email using Finding Correct Attributes.

Step 4: User Groups

    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.

    bamboo-oauth-openid-sso-user-groups
    a. 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 Provider to Bamboo in a table. If you don't see value with groups, make the required settings in your Provider 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 Provider which correspond to Bamboo groups. For example, if you want all users in dev-ops and dev groups in Provider to be added to bamboo-admin, you will need to enter dev-ops;dev against bamboo-admin.

    • 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: Sign In Settings

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

  • 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 Provider if you want to allow users to login only using Provider. Enable backdoor for emergency
  • Backdoor/Emergency URL: Backdoor/Emergency URL gives access to the Application’s default login page. This allows users to log in directly into the application using their local credentials. This will be useful in case the Provider is under maintenance or inaccessible.
  • Domain Restriction : Set domain name which should be allowed for login in Allow Domain. Eg. Allow Domain is miniorange.com then the user with abc@miniorange.com can only able to do login.


    • bamboo-oauth-openid-sso-sign-in-settings

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