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 Ping One. By the end of this guide, Ping One users should be able to login and register to Confluence Software.
Step 1: Setup Ping One as Identity Provider
- Login to your Ping One environment as the administrator. Click on your ProfileAdmin.
- Go to ApplicationsAdd ApplicationNew SAML Application.
- Enter the application details and click Continue to Next Step. Application Name, Application Description, and Category are required fields. For logos and icons, PNG is the only supported graphics format.
All the information required to configure the Ping One i.e. plugin’s metadata is given in the Service Provider Info tab of the miniOrange plugin.
Provide the SAML configuration details for the application.
- Click Continue to Next Step. The SSO Attribute Mapping page is displayed.
- The summary information for the application configuration is then displayed on a new page and the new SAML application is added to your My Applications list.
1.Signing. In the dropdown list, select the signing certificate you want to use.
2.SAML Metadata. Click Download to retrieve the SAML metadata for Ping One. This supplies the Ping One connection information to the application.
3.Protocol Version. Select the SAML protocol version appropriate for your application.
4.Upload Metadata. Click Choose File to upload the application’s metadata file. The entries for ACS URL and Entity ID will then be supplied for you. If you do not upload the application metadata, you will need to enter this information manually. When you are manually assigning an Entity ID value, the Entity ID must be unique, unless you are assigning the Entity ID value for a private, managed application (an application that is supplied and configured by a PingOne for Enterprise administrator, rather than by an SP).
5.Single Logout Endpoint. The URL to which our service will send the SAML Single Logout (SLO) request using the Single Logout Binding Type that you select).
6.Single Logout Response Endpoint. The URL to which your service will send the SLO Response.
7.Single Logout Binding Type. Select the binding type (Redirect or POST) to use for SLO.
8.Primary Verification Certificate. Click Choose File to upload the primary public verification certificate to use for verifying the SP signatures on SLO requests and responses.
9.Signing Algorithm. Use the default value or select the algorithm to use from the dropdown list.
Optional:
I.Encrypt Assertion. If selected, the assertions PingOne sends to the SP for the application will be encrypted.
II.Encryption Certificate: Upload the certificate from miniOrange plugin to use to encrypt the assertions.
III.Encryption Algorithm: Choose the algorithm to use for encrypting the assertions. We recommend AES_256 (the default), but you can select AES_128 instead.
IV.Transport Algorithm: The algorithm used for securely transporting the encryption key. Currently, RSA-OAEP is the only transport algorithm supported.
V.Force Re-authentication. If selected, users having a current, active SSO session will be re- authenticated by the identity bridge to establish a connection to this application.
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:
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.
- Enter IdP Name, select URL option, enter metadata URL and click on import.
- Enter IdP Name, select File option, upload your IdP metadata file and click on import.
- Enter IdP Name, select XML/Text option, insert IdP metadata in the given text field and click on import.
- Enter following endpoints manually.
By using Metadata URL:
By using Metadata File :
Using XML/Text :
Manual Configuration :
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.
- Click on Import from Metadata in Configure IDP tab.
- Select IDP: Import From 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.
- Click on Import from Metadata in Configure IDP tab.
- Select IDP: Import from Metadata File.
- Upload metadata file.
- Click Import.
- Go to Configure IDP tab and enter the following details.
By Metadata URL:
By uploading Metadata XML file:
Manual Configuration:
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.
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 Attribute Mapping in User Profile tab and follow steps given in Matching a User.
- 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.
- 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.
- 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
a. Finding correct attributes
b. Setting profile attributes
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.
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.
- 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
- 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.
a. Finding Group Attribute
b. Setting default group
Step 5: SSO 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 IDP if you want to allow users to login only using IDP. Enable backdoor for emergency
- 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
- 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.
- You can extend Confluence default session timeout using these steps. By default it is set to 60 mins.
a. Sign In Settings
b. Sign Out Settings
c. SSO Error Settings
d. Advanced Settings
If you are looking for anything which you cannot find, please drop us an email on info@miniorange.com