OAuth/OpenID Single Sign On (SSO) into Jira using GitHub Enterprise

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 GitHub Enterprise. By the end of this guide, GitHub Enterprise users should be able to login and register to JIRA Software and Service Desk.

Step 1: Setup GitHub Enterprise as OAuth Provider

  • Login to GitHub Enterprise : Go to Github Enterprise and login with your account. Click on settings.
  • github-1-1
  • Create Organization: Select Organizations from Personal Settings.
  • github-enter-2.png
    • Click on New organization and create organization by entering.
    •       1) organization name
            2) Billing email
            3) choose your plan
            4) terms and conditions - enter a business name

    • click on create organization.
    github-enter-3.png github-enter-5.png
  • Create OAuth app: Click on Settings. Select your Organization.
  • github-enter-4 github-enter-6
    • Click on Settings.
    • github-enter-7
    • Select OAuth Apps from Developer settings.
    • github-enter-8
    • Click on New OAuth App.
    • github-enter-9
  • Enter app credentials : Enter app name, plugin homepage URL. Copy callback URL from the plugin and paste it under Authorized callback URLfield.
  • github-enter-10
  • Copy Client ID and Client Secret.
  • github-enter-11


Step 2: Setup JIRA as OAuth Client

  • Go toConfigure OAuth tab and configure Client ID, Client Secret.
  • Scope is optional. If you want to enter scope then you can add “user” as scope.
  • Click on Test Configuration.
  • github-enter-gif
  • Check email attribute in Test Configuration Window. If email is returning null then go to profile and set public email.
  • image12
  • If Public Email field is disabled, go to Emails and uncheck the option Keep my email addresses private.
  • github_emails_tab

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.

    jira sso-14

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

    jira sso-15
    a. 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 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 jira-users, you will need to enter dev-ops;dev against jira-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.

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 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.
  • 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 abc@miniorange.com can only able to do login.
  • 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. Sign Out Settings
    Set Logout URL or Logout Template to redirect users after logout action.

    jira sso-18

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