JIRA OAuth/OpenID app gives the ability to enable OAuth/OpenID Single Sign On for JIRA Software and JIRA Service Desk. JIRA Software and JIRA Service Desk are compatible with all OAuth/OpenID Providers. Here we will go through a guide to configure SSO between JIRA and your OAuth/OpenID app. By the end of this guide, all the users should be able to login and register to JIRA Software and Service Desk.
To configure your OAuth/OpenID app with JIRA OAuth / OpenID Connect SSO, you need the following items:
- JIRA should be installed and configured (supported version JIRA Server 7.0.0 - 8.7.0, JIRA Data Center 7.0.0 -8.7.0 ).
- 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 OAuth / OpenID Connect 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 OAuth / OpenID Connect Single Sign On (SSO), JIRA SSO.
- Enter your information and click Generate license when redirected to MyAtlassian.
- Click Apply license.
Step 1: Setup OAuth 2.0 compliant Provider
- Register an application by providing Callback URL provided in the plugin.
- Collect below endpoints to configure it in the plugin.
|Client ID : Is used to identify the application.|
|Client Secret : Is used to Authenticate the Authorization Server|
|Scope : Is used to limit an application's access to a user's account. |
|Authorization Endpoint : |
|Access Token Endpoint :|
|User Info Endpoint :|
|Group Endpoint (optional) :|
Step 2: Setup JIRA as OAuth Client
- Select Custom OAuth app from the dropdown list.
- Enter the App Name, Client ID and Client Secret.
- Configure all the collected endpoints from Provider or if you have the Metadata URL of your Provider, then click on the Fetch Info by Metadata URL button for importing configurations.
- Enter the metadata URL and click on the Fetch option. All the Endpoints will be configured automatically except Client ID and Client Secret.
- Here are a few examples of Providers along with their Metadata URLs
- Click on Save button.
- Click on Test Configuration for verifying the entered details.
Step 3: User Profile
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 OAuth tab. Scroll down and click on Test Configuration.
- You will see all the values returned by your OAuth/OpenID Provider to Jira in a table. If you don't see a value for First Name, Last Name, Email or Username, make the required settings in your OAuth/OpenID Provider 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 OAuth/OpenID Provider 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 OAuth/OpenID Provider which corresponds to Username or Email using Finding Correct Attributes
Step 4: User Groups
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.
b. Finding Group Attribute
- Just like we found Attribute Name for User Profile attributes, we find group attribute.
- Go to Configure Oauth tab. Scroll down and click on Test Configuration.
- You will see all the values returned by your OAuth/OpenID Provider to Jira in a table. If you don't see value with groups, make the required settings in your OA uth Providerto 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 OAuth/OpenID Provider, then you should use Manual group mapping.
- On-The-Fly group mapping: If the names of groups in Jira and OAuth/OpenID Provider 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 OAuth/OpenID Provider 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 OAuth/OpenID Provider group to be mapped in the textbox beside
- For example, if you want all users in 'dev' group in OAuth/OpenID Provider 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.
II. On-The Fly Group Mapping
- Check Create New Groups option if you want new groups from OAuth/OpenID Provider 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 Oauth/OpenID response returned by OAuth/OpenID Provider, 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.
Step 5: Sign In 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 OAuth/OpenID Provider if you want to allow users to login only using OAuth/OpenID Provider. Enable backdoor for emergency, Restrict backdoor URL access based on user groups
- Select Secure Admin Login Options to control admin access.
- Domain Restriction : Go to Sign In Settings, enter domain name which should be allowed for login.
Eg. Allowed Domain is miniorange.com then the user with email@example.com can only able to do login.
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 the Error message template to build your own error page and redirect users to it in case SSO fails.