Versions Compared

Version Old Version 7 New Version 8
Changes made by

Huiyi Lin

Christian Eitel (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This document describes how to complete the initial setup for SAML Single Sign On plugin from 0.14.5 for JIRA with ADFS. 

Setup Guide with ADFS (JIRA) -
From plugin version
0.14.5 Install the plugin
Setup Guide with ADFS (JIRA) -
From plugin version
0.14.5 Setup the ADFS (A-E)
Setup Guide with ADFS (JIRA) -
From plugin version
0.14.5 Configure the Plugin (A-B)
Setup Guide with ADFS (JIRA) -
From plugin version
0.14.5 Test
Setup Guide with ADFS (JIRA) -
From plugin version
0.14.5 Enable login redirection

The video below is an installation guide for setting up SAML SSO for Confluence (URL: https://youtu.be/HB5blJt9VTE). As the steps are nearly identical with configuring the plugin for JIRA, it can be of great help for setting up the plugin. If you need any further support please feel free to contact us here.

Widget Connector
urlhttps://www.youtube.com/watch?v=HB5blJt9VTE&feature=youtu.be

Prerequisites

Image Modified

Step 1: Install the plugin 
Anchor
Step1
Step1

Click Add-ons under JIRA Administration on the top right corner of your JIRA interface. Then, you will be taken to Atlassian Marketplace. Search for SAML SSO and click on Free Trial to install. 

...

After installation succeeded, click on Manage, then choose Configure. Now, you are on the plugin configuration page. 

 


Back to Top

Step 2: Setup the ADFS   
Anchor
Step2
Step2

Substep A: Copy/Download the SAML Metadata URL

Expand
titleDo substep A1 if your ADFS has connection to your JIRA instance.

Substep A1:

      • Copy the SAML Metadata-URL from your SAML Single Sign On config page.

    

Expand
titleDo Substep A2 if your ADFS has no connection to your JIRA instance or if Step C1 below failed.

Substep A2:

      • Save the linked metadata.xml of the SAML Metadata URL from your SAML Single Sign On config page.
      • Move the saved metadata.xml to your ADFS on a location your choice.

Image ModifiedSubstep B: Start the Add Relying Party Trust Wizard

The rest of Step 2 will be completed in AD FS. 

...

  • Click the Start Button to start the wizard.

      

Image Modified

Substep C: Insert your SAML Metadata

Expand
titleDo Substep C1 if you completed Step A1.

Substep C1:

  • Select Import data about the relying party published online or on a local network and paste in the SAML Meta-URL from JIRA in the Federation metadata address (host name or URL) field.
  • Click Next.

      


Info
If an error is appeared after clicking on Next button, check the connection from ADFS to the JIRA instance. If you can't build up a connection, start a new wizard and begin with Step A2.
Expand
titleDo Substep C2 if you completed Step A2.

Substep C2:

  • Select Import data about the relying party from file and browse to your metadata.xml location with the Browse... button or fill in your location directly.
  • Click Next.

      

Back to Top


Image ModifiedSubstep D: Finish the Add Relying Party Trust Wizard

  • Fill the field Display name with a name of your choice.
  • Click Next.

...

  • Check the Open the Edit Claim Rules dialog for this relying party trust then the wizard closes checkbox to open the Edit Claim Rules dialog after closing the wizard.
  • Click Close to finish the Add Relying Party Trust Wizard.

         

Back to Top

Substep E: Add Name ID as Claim Rule

JIRA needs a Name ID (on the normal case) from the SAML Response to authenticate users. So we need to add a claim rule on ADFS, which add the Name ID in every SAML Response from ADFS.    

Expand
titleIf you didn't tick "Open the Edit Claim Rules dialog...", then it's necessary to open it manually for your Relying Party Trust, following steps here.
  • Navigate to ADFS → Trust Relationships → Relying Party Trusts on the left Navigation panel.
  • Select your Relying Party Trust.
  • Click on Edit Claim Rules... on the right Actions panel.

Otherwise, continue from below.

  • Click the Add Rule... Button to open the Add Transform Claim Rule Wizard. 

      


  • Select Send LDAP Attributes as Claims in the Claim rule template drop-down list.
  • Click Next.

      

...

  • Fill the field Claim rule name with a name your choice.
  • Select Active Directory in the Attribute store drop-down list.
  • Select your appropriate LDAP Attribute in the first drop-down field from LDAP Attribute (Select or type to add more). In this example we are using the Windows login name attribute SAM-Account-Name as Name ID.
  • Select Name ID in the first drop-down field from Outgoing Claim Type (Select or type to add more).
  • Click Finish to complete the Add Transform Claim Rule Wizard.

      

  • Check if your new rule has been added to the Edit Claim Rules dialog. Try again Step E if it has failed.
  • Click Apply to save your settings.
  • Click OK to finish.

      


Back to Top

Step 3: Configure the Plugin   
Anchor
Step3
Step3

Image Modified

To continue Step 3, please go back to the plugin configuration page opened in Step1.   

Substep A: Load ADFS Metadata

The recommended way to setup the ADFS is to import ADFS Metadata. The Metadata URL from ADFS is  https://<your-adfs>/federationmetadata/2007-06/federationmetadata.xml.  

  • Click the URL radio-button and paste the Metadata URL into the field below.
  • Check Accept all if your IdP's https-certificate is not in your JIRA instance's trust store.
  • Click on Load.

      


Substep B: Configure general JIRA groups in Advanced IdP Settings

If a user logs in using SAML, he will be added to the groups specified in the User Groups section. This applies to all users. The user is assigned to these groups in addition to the groups in the SAML-response's attribute. 
The standard group in JIRA 6 is called jira-users. 
The standard group in JIRA 7 is depending on which JIRA Version you are using:

...

  • Click Save settings to store the configuration

Back to Top

Step 4: Test 
Anchor
Step4
Step4

In a separate browser, open the URL https://<your-JIRA>/plugins/servlet/samlsso.

...