SAML Single Sign On (SSO) into Confluence using Azure AD as IDP

Setup Azure AD as Identity Provider

Prerequisites:

  • Copy these values from the Service Provider Info tab of the SAML plugin.
    • SP Entity ID
    • ACS URL

Instructions:

  1. Log in to Azure AD Portal
  2. Select Azure Active Directory ⇒ App Registrations. Click on New Application Registration.New Application - Azure AD SSO
  3. In Create Application dialogue, enter the name of the application, keep Application type as Web app/API and enter ACS URL copied from the plugin as Sign-On URL and create the application.                                                                                                       Create Application - Azure AD SSO
  4. The newly created application’s information will show up. Click on Settings  Properties. Enter SP entity ID copied from the plugin as APP ID and save it.APP ID - Azure AD SSO
  5. Go back to Azure Active Directory ⇒ App Registrations window and click on Endpoints link.Endpoints - Azure AD SSO
  6. 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.Copy Federation Metadata Document URL - Azure AD SSO
  1. Log in to Azure AD Portal
  2. Select Azure Active Directory ⇒ Enterprise Applications.Enterprise Application - Azure AD SSO
  3. Click on New Application.New Application - Azure AD SSO
  4. Click on Non-gallery application section and enter the name for your app and click on Add button.Non Gallary Application - Azure AD SSO
  5. 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.SAML Application - Azure AD SSO
  6. Enter the SP Entity ID for Identifier and the ACS URL for Reply URL from Service Provider Info tab of the plugin.SP URLs - Azure AD SSO
  7. 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.Attributes - Azure AD SSO
  8. Copy App Federation Metadata Url. This will be used while configuring the SAML plugin.Metadata URL - Azure AD SSO
  9. 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.Assign Users - Azure AD SSO

Setup Confluence as Service Provider

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

Flow Driven Setup

Step 1: Quick Setup

Select your IdP from the list and click on download. You will get redirect to Step by Step setup guide for SSO configuration. You can skip this setup too.

If you are unable to find your IdP in the list then please contact us.



Step 2: SP Info

This section contains Service Provider endpoints. Note down the following information. This is required for creating an application in IdP.



Step 3: Configure IdP

IdP can be configured using one of these methods.

  1. By using Metadata URL : Enter IdP Name, select URL option, enter metadata URL and click on import


  2. By using Metadata File : Enter IdP Name, select File option, upload your IdP metadata file and click on import


  3. Using XML/Text : Enter IdP Name, select XML/Text option, insert IdP metadata in the given text field and click on import.


  4. Manual Configuration : Enter following endpoints manually.

a. IDP Name

b. IDP Entity ID

c. Single Sign On URL

d. Single Logout URL

e. X.509 Certificate



Step 4: User Profile

Enter username attribute name & email address attribute name from IDP. If you are not sure about it then keep it as it is.

\



Step 5: Finish

It has few instructions for further plugin configurations like configuring user attributes. eg. name, groups etc

Configure Identity Provider



Step 1. Adding IDP settings in add-on

If you skip Quick setup, then you can configure your IdP using one of these 3 methods.

A. By Metadata URL

  1. Click on Import from Metadata in Configure IDP tab.
  2. Select IDP: Import From Metadata URL .
  3. Enter your metadata URL.
  4. If your IDP changes certificates at intervals, you can select Refresh metadata periodically. Select 5 minutes for the best results.
  5. Click Import.


B. By uploading Metadata XML file

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


C. Manual Configuration

Go to Configure IDP tab and enter the following details.
  • IDP Name
  • IDP Entity ID
  • Single Sign On URL
  • Single Logout URL
  • X.509 Certificate


Configure Multiple Identity Providers



Step 1 : Add New IdP.

Click on Add New IdP button given in the right topmost corner. You can configure IdP using one of these 3 methods.



Step 2: List of IdPs

Once the IdP endpoints are configured successfully, you will get to see list of all the IdPs.

You can edit Metadata endpoints using Edit option.

Click on Test to check your IdP response. It shows Test successful with set of attributes you configured in your IdP. You can perform Single Sign-On once the test is successful.

You can remove IdP from the list using Delete option.



Step 3: Single Sign On.

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



Step 4 : Domain Mapping

Enable Domain mapping using Use Domain Mapping option.

Enter IdP domain name.

Note: For this feature you have to configure domain name for each and every IDP from the list.



Step 5: Single Sign On using Domain mapping

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



Setting up Confluence user profile attributes

We will be setting up user profile attributes for Confluence. 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 Confluence 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 only login, configure the attribute using which you will match user in Confluence.
c. Matching a User
When user logs into Confluence, one of the user’s data/attribute coming in from the IDP is used to search the user in Confluence. This is used to detect the user in Confluence and login the user to the same account.
  • Go to User Profile tab
  • Select Username or Email for Login/Search Confluence user account by
  • Enter the attribute name from IDP which corresponds to Username or Email using Finding Correct Attributes
Assigning groups to users

We will be setting up user group attributes for Confluence. 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. 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 Confluence 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 Confluence are shown. You can map groups in IDP which correspond to Confluence 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 Confluence, check the option Update User Groups
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.
  • You can enable default groups for all users or only new users using the option Enable Default Groups for.
SSO Settings

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

  • 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. Sign Out Settings
  • Enter a custom logout URL to redirect your users to a pre-defined logout page
  • Set a custom logout template to show custom logout page to users on logout


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 IDP enabled.



d. Advanced Settings
You can extend Confluence default session timeout using these steps. By default it is set to 60 mins.