SAML Single Sign On (SSO) into Jira using Jboss Keycloak as IDP

JIRA SAML app gives the ability to enable SAML Single Sign On for JIRA Software and JIRA ServiceDesk. JIRA Software and JIRA ServiceDesk are compatible with all SAML Identity Providers. Here we will go through a guide to configure SSO between JIRA and Jboss Keyclock. By the end of this guide, Jboss Keyclock users should be able to login and register using SSO to JIRA Software.

Pre-requisites

To configure Keycloak integration with JIRA SAML SSO, you need the following items:

  • Jira should be installed and configured.
  • Jira Server is https enabled.
  • Admin credentials are set up in Jira.
  • Valid Jira Server and Data center Licence.

Download And Installation

  • Log into your Jira 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 Jira SAML Single Sign On (SSO), Jira SSO via search.
  • Click Try free to begin a new trial or Buy now to purchase a license for Jira SAML Single Sign On (SSO), Jira SSO.
  • Enter your information and click Generate license when redirected to MyAtlassian.
  • Click Apply license.
jira saml sso using adfs

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.

Single Sign On into JIRA using Keycloak, Keycloak SSO Login-1 Method 1: Upload SP Metadata

  • 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.
  • Click Import File button.
  • Single Sign On into JIRA using Keycloak, Keycloak SSO Login-2
  • Upload plugin metadata. You can obtain it from Service Provider tab of plugin.
  • Click on Save.
  • Procced to set Mappers .

Single Sign On into JIRA using Keycloak, Keycloak SSO Login-3 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:
    Client ID The SP-EntityID / Issuer from the step 1 of the plugin under Configure IDP tab.
    Name Provide a name for this client
    Description Provide a description
    Enabled ON
    Consent Required OFF
    Client Protocol SAML
    Include AuthnStatement ON
    Sign Documents ON
    Optimize Redirect signing key lookup OFF
    Sign Assertions ON
    Signature Algorithm RSA_SHA256
    Encrypt Assertion OFF
    Client Signature Required OFF
    Canonicalization Method EXCLUSIVE
    Force Name ID Format ON
    Name ID Format Email
    Root URL 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.
  • Single Sign On into JIRA using Keycloak, Keycloak SSO Login-5

 Add Mappers

  • Add the following attributes in the Mappers tab.
  • Click on Add Builtin and add the following option.
  • Single Sign On into JIRA using Keycloak, Keycloak SSO Login-6

Single Sign On into JIRA using Keycloak, Keycloak SSO Login-7 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 Jira as Service Provider

Configuring Single IDP

With the information you have been given by Your IDP team, you can configure IDP settings in 3 ways:

A. By Metadata URL

  • Click on Import from Metadata in Configure IDP tab
  • Select IDP: Import From Metadata URL
  • Enter IDP metadata URL: Enter your metadata URL
  • If your IDP changes certificates at intervals (Eg. Azure AD), you can select Refresh metadata periodically. Select 5 minutes for the best results.
  • Click Import

JIRA SAML Single Sign On, SSO

B. 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

JIRA SAML Single Sign On, SSO

C. Manual Configuration

Go to Configure IDP tab and enter the following details

  • IDP Entity ID
  • Single Sign On URL
  • Single Logout URL
  • X.509 Certificate
JIRA SAML Single Sign On, SSO
Configure New IDP

If you already have one IDP & you are looking to add Second IDP then you can do it by performing the following steps.

  • Navigate to Configure IDP tab.
  • Click on Add new IDP.
  • It will present a blank form & you can configure new IDP using steps from Single IdP Setup.
JIRA SAML Single Sign On, SSO

Configure multiple IDPs

If you have configured more than two IDPs then it will show you the list of IDP that you have configured with Jira.

Click on Add new IdP button for adding new IDP on Jira. The steps for adding new IDP will remain the same.

JIRA SAML Single Sign On, SSO
An operation that you can perform with List of IdPs page.

  • Add / delete Identity Provider.
  • Test Connection between Jira & IdP by click on Test button for respective IDP.
  • Edit the IdP configuration by clicking on the Edit button.
  • You can allow an only specific set of users to access Jira by using Domain Mapping.

Single Sign-On with Multiple Identity Provider(IDP)

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

JIRA SAML Single Sign On, SSO
Configure Domain Mapping

You can enable domain mapping using Use Domain Mapping option.
Once enable it, you need add domain name against each IDP.
After enabling Domain Mapping it allows SSO only for those users whose domain matches with the specified one.

JIRA SAML Single Sign On, SSO

Single Sign-On using Domain mapping

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

JIRA SAML Single Sign On, SSO
This is how the login screen would appear after enabling domain mapping.

Step 3: Setting up Jira user profile attributes

    We will be setting up user profile attributes for Jira. 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.

    JIRA SAML Single Sign On, SSO

    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 Jira 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 the user in Jira.
  • c. Matching a User
    When the user logs into Jira, one of the user's data/attribute coming in from the IDP is used to search the user in Jira. This is used to detect the user in Jira and log in the user to the same account.
    You can configure it using steps given below:
  • Go to User Profile tab
  • Select Username or Email for Login/Search Jira 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 Jira. 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.
  • Jira SAML Single Sign On - SSO - Default group
    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 Jira 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 Jira 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 Jira 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 Jira group from the dropdown which lists all groups present in Jira 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 jira-software-users, you will need to select jira-software-users from the dropdown and enter 'dev' against jira-software-users.
    • Use '+1' and '+10' buttons to add extra mapping fields.
    • Use '-' button next to each mapping to delete that mapping.
    Jira SAML Single Sign On - SSO - Manual group 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 Jira.
    • If the user is part of some group in Jira and that group is not present in the SAML response returned by IDP, then the user will be removed from that group in Jira.
    • If you don't want On-The-Fly group mapping to affect Jira groups which are managed locally then add those groups in Exclude Groups field.
    Jira SAML Single Sign On - SSO - On the fly group mapping

Step 5: SSO Settings

    The settings in SSO Settings tab define the user experience for Single Sign On.
    a. Sign In Settings
  • Set Enable SSO for Jira Software to allow SSO for Jira Software users.
  • 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
  • Select Secure Admin Login Options to control admin access.
  • JIRA SAML Single Sign On, SSO
    b. Service Desk SSO Settings
  • Set Enable SSO For ServiceDesk Customer Portal to allow SSO for Service Desk user.
  • Set Enable SSO Only For Agents to allow SSO only for specific set of users
  • JIRA SAML Single Sign On, SSO
    c. Custom Login Template
  • Design your own login template that will be used to intitate SSO.
  • JIRA SAML Single Sign On, SSO
    d. Sign Out Settings
  • Set Logout URL or Logout Template to redirect users after logout action.
  • JIRA SAML Single Sign On, SSO
    e. 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.
  • JIRA SAML Single Sign On, SSO
    f. Advanced settings
  • Remember Me-cookie: If enabled, user stays logged in until user explicitly logs out.
  • You can extend Jira default session timeout. By default it is set to 300 mins.
  • Validate IDP's SAML Response: Configure time difference(in minute) here In case Jira server time is not in sync with your IDP's time.
  • JIRA SAML Single Sign On, SSO



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