SAML Single Sign On (SSO) into Jira

JIRA SAML Single Sign On app gives you the ability to enable Single Sign-On through SAML 2.0 for JIRA Software and JIRA ServiceDesk. This app is compatible with all SAML 2.0 Identity Providers.

Here is a list of providers we have already tested with: Identity Provider setup

If you don't find your IDP listed and your application supports SAML 2.0 as an Identity Provider, you can follow the guide given below to enable SSO into JIRA using your application.

Step 1: Setup Identity Provider to enable saml for your module.

Pre-requisite: You will need SAML information from your IDP to configure this app. Please get SAML metadata from your Identity Provider. If your IDP does not have a metadata URL or XML, please ask for the following information:

  1. Issuer/ Entity ID
  2. SAML Login URL
  3. SAML Logout URL (only if you want users to logout from IDP when they logout from JIRA)
  4. X.509 Certificate
  5. NameID format (optional)
  6. SAML Login binding type (optional)
  7. SAML Logout binding type (optional)

  • Provide setup information to your Identity Provider so that they can configure JIRA as a SAML Service Provider for your account. You can provide them the SAML metadata URL or SAML related information. We have given more information on how you can get each one of them below.
  • Go to Service Provider Info and give the link shown below to your Identity Provider. When you click on the link, you will be able to view the metadata for the SAML Single Sign On app.

  • If the Identity Provider does not accept metadata, you can give them SAML information manually. Go to Service Provider Info tab and get the following information.
  • SP Entity ID / Issuer This value contains unique identifier for your Atlassian application.
    ACS URL This is the URL the IdP will return SAML authentication requests to.
    Single Logout URL This will terminate all server sessions established via SAML SSO.
    Audience URI IdP will prepare SAML authentication requests for.
    Recipient URL IdP will return SAML authentication requests to.
    Destination URL IdP will return SAML authentication requests to.
    Certificate This Certificate is used validate SAML request and used to decrypt encrypted SAML assertions from the IDP.

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, you can select Refresh metadata periodically. Select 5 minutes for the best results.
  • Click Import

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

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
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 sso-20

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 sso-21
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 sso-22
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 sso-23

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 sso-23
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 sso-14

    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 the 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.
  • 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.

    jira sso-15
    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 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
  • At the bottom of the page, all groups in Jira are shown. You can map groups in IDP which correspond to Jira 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 Jira, check the option Update User Groups

  • b. Setting default group
  • Select the users' Default Group in the tab User Groups.Users are added to this group by default.
  • You can enable default groups for all users/new users and None using the option Enable Default Groups for.

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 sso-16
    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 sso-17
    c. Custom Login Template
  • Design your own login template that will be used to intitate SSO.

  • d. Sign Out Settings
  • Set Logout URL or Logout Template to redirect users after logout action.
  • jira sso-18
    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 sso-19
    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.

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