Confluence SAML app gives the ability to enable SAML Single Sign On for Confluence Software. Confluence Software is compatible with all SAML Identity Providers. Here we will go through a guide to configure SSO between Confluence and Jboss Keyclock. By the end of this guide, Jboss Keyclock users should be able to login and register to Confluence Software.
To configure Keycloak integration with Confluence SAML SSO, you need the following items:
- Confluence should be installed and configured.
- Admin credentials are set up in Confluence.
- Valid Confluence Server and Data center Licence.
Download And Installation
- Log into your Confluence 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 Confluence SAML Single Sign On (SSO),Confluence SSO via search.
- Click Try free to begin a new trial or Buy now to purchase a license for Confluence SAML Single Sign On (SSO), Confluence SSO.
- Enter your information and click Generate license when redirected to MyAtlassian.
- Click Apply license.
Step 1: Setup Jboss Keycloak as Identity Provider
Follow the steps below to configure Jboss Keycloak as an Identity Provider.You can use 2 ways to configure the JBoss Keycloak as IDP.
Method 2: Manual Configuration
- In your Keycloak admin console, select the realm that you want to use.
- Click on the Clients from the left nav bar.
- Create a new client/application.
- Configure the following:
||The SP-EntityID / Issuer from the step 1 of the plugin under Configure IDP tab.
||Provide a name for this client
||Provide a description
|Optimize Redirect signing key lookup
|Client Signature Required
|Force Name ID Format
|Name ID Format
||Leave empty or Base URL of Service Provider
|Valid Redirect URIs
||The ACS (Assertion Consumer Service) URL from the step 1 of the plugin under configure IDP tab.
- Under Fine Grain SAML Endpoint Configuration, configure the following:
|Assertion Consumer Service POST Binding URL
||The ACS (Assertion Consumer Service) URL from the step 1 of the plugin under Configure IDP tab.
|Logout Service Redirect Binding URL
||The Single Logout URL from the step 1 of the plugin under Configure IDP tab.
- Click on Save.
- Add the following attributes in the Mappers tab.
- Click on Add Builtin and add the following option.
Download IDP Metadata
- Go to Realm Settings, click on SAML 2.0 Identity Provider Metadata endpoint link provided under Genaral tab.
- Download it and keep it handy. It will be used to configure the plugin.
Step 2: Setup Confluence as Service Provider
Now we will go through the steps to setup Confluence as a Service Provider using miniOrange add-on:
Configure Identity Provider
Step 1. Adding IDP settings in add-on
- With the information you have been given by your IDP, you can configure IdP settings in 3 ways.
Step 3: 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 User Profile 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
Step 4: 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. 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. Using the option Enable Default Groups for.
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 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.
- 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 Confluence 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 Confluence 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 Confluence group from the dropdown which lists all groups present in Confluence 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 confluence-users, you will need to select confluence-users from the dropdown and enter 'dev' against confluence-users.
- 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 Confluence.
- If the user is part of some group in Confluence and that group is not present in the SAML response returned by IDP, then the user will be removed from that group in Confluence.
- If you don't want On-The-Fly group mapping to affect Confluence groups which are managed locally then add those groups in Exclude Groups field.
Step 5: 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. Custom Login Template
- Set custom login template to redirect users to a custom login page instead of Confluence default login page. This won't work if you have Auto-redirect to IDP enabled.
- Don't forget to copy default login page URL in case of emergency.
c. 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
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.
e. Advanced Settings
- Remember Me: If enabled, user stays logged in until user explicitly logs out.
- You can extend Confluence default session timeout using these steps. By default it is set to 60 mins.
- Validate IDP's SAML Response: Configure time difference(in minute) here In case Confluence server time is not in sync with your IDP's time.