SAML Single Sign On (SSO) into Confluence using CA Identity as IDP

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 CA Identity. By the end of this guide, CA Identity users should be able to login and register to Confluence Software.

Step 1: Setup CA Identity Manager as Identity Provider

    Follow the steps below to configure CA Identity Manager as an Identity Provider.

    miniorange img Pre-requisite:

      To configure CA Identity Manager, you need the metadata of the service provider. Go to the Add-on tab for SP Info and click on the link for metadata in Step In the new tab, SP metadata is generated. Right-click it and choose Save As to save it as an XML on your system.

    miniorange img  Login as Administrator

    • Log in to your CA Identity service portal with the administrator account. You're going to be sent to the launchpad.
    • CA Identity sso-1
    • Go to Apps and click on add an app.
    • CA Identity sso-2
    • Scroll down in the Add App popup window and click Create a SAML SSO app
    • Fill out the information in each of the steps as given below.

      Enable SSO for Your App Using SAML

    • In Display Name, enter the name of your app and click Continue.
    • CA Identity sso-3

      Identity Provider Information

    • Download IDP Metadata. This is necessary to configure the add-on later. Click on Continue.
    • CA Identity sso-4

    miniorange img  Service Provider Information

      CA Identity sso-5
    • Upload SP metadata to Upload SP metadata and click Continue.
    • You can also manually enter data. The data can be found in the add- on's SP Info tab.
    • Information to be entered in CA Information to copy from the add-on
      Assertion Consumer Service URL ACS URL
      Relay State -
      Entity ID SP Entity ID
      NameID Format Email Address
      Binding POST
      Requests Signed Yes
      Certificate Download the certificate provided in SP Info tab and upload it here

      Attribute Mapping

    • Fill Attribute Mapping as per your requirement. Set Type against NameID to User Attribute and set Value as User Name or Primary Email. These attributes are used to create user in the SP.
    • Click on Continue and click Finish.
    • CA Identity sso-6

    miniorange img  Create a Rule

    • You’ll be redirected to app Dashboard. Go to Rules. A Rule defines who has the access to app. Click on add rule.
    • Enter the rule name. Click on Add Filter and select on which basis you want to assign app. You can select a department, type or title. You can add more filters according to your need. Click Continue.
    • Select the SP app you setup in Then they should have. Click Continue.
    • You can test the app by selecting a person from that department. Click Finish
    • CA Identity sso-7

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.
    • miniorange img By Metadata URL:

      • 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.
      • confluence sso-9

      miniorange img By uploading Metadata XML file:

      • Click on Import from Metadata in Configure IDP tab.
      • Select IDP: Import from Metadata File.
      • Upload metadata file.
      • Click Import.
      • confluence sso-8

      miniorange img 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

        confluence sso-10

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.
  • confluence sso-11

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.
  • confluence sso-12

Step 3: Single Sign On

  • Select your IdP from the list. It will redirect you to selected IdP login page.
  • confluence sso-13

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.

    confluence sso-14

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.
  • confluence sso-15

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.

    confluence sso-15
    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.

    confluence sso-16
    confluence sso on the fly 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 to assign SSO users. Recommended to set up the groups needed to access the application.
    • You can enable default groups for all users or new users using the option.Select Noneif you don't want to assign any default group to SSO users.Using the option Enable Default Groups for.

Step 5: SSO Settings

    The settings in Sign In Settings tab define the user experience for Single Sign On
    a. Sign In Settings
      confluence sso-17
    • 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
    • confluence sso-18
    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.
    • confluence sso login template
    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
    • confluence sso-19
    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.
    • confluence sso-20
    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.
    • confluence sso-21

If you are looking for anything which you cannot find, please drop us an email on