SAML Single Sign On (SSO) into JIRA using PingFederate

Setup PingFederate as Identity Provider

All the information required to configure the Ping Federate as SAML IDP i.e. plugin’s metadata is given in the Service Provider Info tab of the miniOrange plugin.

Step 1: Login to your Ping Federate User Admin dashboard.

Step 2: Click on the Identity Provider in the left navigation menu.

Step 3: Under SP CONNECTION, click on Create New button.

Identity Provider - Ping Federate SSO

Step 4: Select the Browser SSO Profiles connection template on the Connection Type tab and click Next.

Connection Type - Ping Federate SSO

Step 5: Select Browser SSO on the Connection Options tab and click Next.

Connection Options - Ping Federate SSO

Step 6: Select File as the method for importing metadata and click Choose file to choose the miniOrange SSO plugin’s metadata on the Import Metadata tab. Click Next.

Import Metadata - Ping Federate SSO

Step 7: Review the information on the Metadata Summary tab and click Next.

Step 8: In the General Info tab ensure that the Service Provider’s Entity ID, Connection Name, and Base URL fields pre-populate based on the metadata. Click Next.

Step 9: Navigate to the Browser SSO tab and click on the Configure Browser SSO. You will be redirected to Browser SSO Setup wizard.

1. Select the IdP-Initiated SSO and SP-Initiated SSO options on the SAML Profiles tab and click Next.

SAML Profiles - Ping Federate SSO

2. Enter your desired assertion validity time from on the Assertion Lifetime tab and click Next. By default, it is configured 5 minutes for both.

3. Navigate to the Assertion Creation and click on the Configure Assertion Creation. You will be redirected to the assertion creation setup wizard.

3.1 In the Identity Mapping tab select STANDARD and click Next.

3.2 Select a Subject Name Format for the SAML_SUBJECT on the Attribute Contract tab and click Next.

3.3 Click Map New Adapter Instance on the Authentication Source Mapping.

Authentication Source Mapping - Ping Federate SSO

3.4 Select an Adapter Instance and click Next. The adapter must include the user’s email address.

Adapter Instance - Ping Federate SSO

3.5 Select the Use only the adapter contract values in the SAML assertion option on the Mapping Method tab and click Next.

3.6 Select your adapter instance as the Source and the email as the Value on the Attribute Contract Fulfilment tab and click Next.

Attribute Contract - Ping Federate SSO

3.7 (Optional) Select any authorization conditions you would like on the Issuance Criteria tab and click Next.

3.8 Click Done on the Summary.

3.9 Click Next on the Authentication Source Mapping tab.

3.10 Click Done on the Summary tab.

3.11 Click Next on the Assertion Creation

4. Navigate to the Protocol Settings tab of the Browser SSO wizard and click on the Configure Protocol settings.

4.1 Select POST for Binding and specify the single sign-on endpoint URL in the Endpoint URL field on the Assertion Consumer Service URL Click Next.

Protocol Settings - Ping Federate SSO

4.2 Select POST on the Allowable SAML Bindings tab and click Next.

4.3 Select your desired signature policies for assertions on the Signature Policy tab and click Next.

Signature Policy - Ping Federate SSO

4.4 Select your desired encryption policy for assertions on the Encryption Policy tab and click Next.

4.5 Click Done on the Protocol Settings Summary tab.

4.6 Click Done on the Browser SSO Summary.

Step 10: Navigate to the Credentials and click on the Configure Credentials. You will be redirected to the Credentials setup wizard.

1. Select the Signing Certificate to use with the Single Sign-On service and select Include the certificate in the signature element in the Digital Signature Settings tab. Click Done.

Signing Certificate - Ping Federate SSO

2. Click Done on the Summary.

3. Click Next on the Credentials.

Step 11: Select Active for the Connection Status on the Activation & Summary tab and click Save.

Step 12: Now, navigate to the Ping Federate User Admin dashboardè Identity Provide.

Step 13: Click Manage All under SP Connections.

Step 14: Click Export Metadata for the desired service provider connection.

Step 15: Choose a Signing Certificate on the Metadata Signing tab and click Next.

Step 16: Click Export on the Export & Summary tab and click Done.

Step 17: Provide the downloaded Ping Federate metadata to the Service Provide applications.


Setup Jira as Service Provider

Now we will go through the steps to setup Jira as a Service Provider using miniOrange add-on:

Configuring IDP First Time

You can skip the Flow Driven setup by closing it by clicking on cross(X) and continue with setting up using Single IDP Setup.

1. Click on the Configure button from the plugin's list. It will show you the following page to download the setup guide. Click Next

2. Note down the following information. This information is required for creating an application on IdP. Click Next.
  • SP Entity ID / Issuer
  • ACS URL
  • Certificate

3. We can configure IDP Settings in JIRA in four ways:

3.1. Using Metadata URL
Enter IDP Name, select IDP Metadata as URL & enter your IDP metadata URL in the given textbox. Click on Import to fetch IDP settings.


3.2. Using Metadata File
Enter IDP Name, select IDP Metadata as File & browse your IDP metadata file. Click on Import to fetch IDP settings.


3.3. Using Metadata Text
Enter IDP Name, select IDP Metadata as Text & add your IDP metadata XML content in the given text area. Click on Import to fetch IDP settings.


3.4. Manual Configuration
You can also configure IDP settings on Jira manually. For that, you need to click here.


Enter the following details
  1. IDP Name
  2. IDP Entity ID /Issuer
  3. Single Sign-on URL
  4. Single Logout URL
  5. IDP Signing Certificate

4. Enter username attribute name & email address attribute name from IDP. Click on the Save button after adding valid information. If you are not sure about this information, you can configure this later.


5. Click on Finish.

Configuring Single IDP

We can configure IDP settings in 3 ways:

A. By Metadata URL

  1. Click on Import from Metadata in Configure IDP tab
  2. Select IDP: Import From Metadata URL
  3. Enter IDP metadata URL: Enter your metadata URL
  4. If your IDP changes certificates at intervals, you can select Refresh metadata periodically. Select 5 minutes for the best results.
  5. Click Import



B. By uploading Metadata XML file

  1. Click on Import from Metadata in Configure IDP tab
  2. Select IDP: Import from Metadata File
  3. Upload metadata file
  4. 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.


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.


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.


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.



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.


This is how the login screen would appear after enabling domain mapping.

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.



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

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

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.

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

c. Sign Out Settings
Set Logout URL or Logout Template to redirect users after logout action.

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.