OAuth/OpenID Single Sign On (SSO) into Jira using Google Apps


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 Provider. By the end of this guide, users from your OAuth/OpenID Provider should be able to login and register to Jira Software and Service Desk.

You can refer the steps to configure Google Apps as OAuth Provider with the Jira OAuth Client from the video or documentation given below


Pre-requisites

    Before proceeding with the integration of your OAuth/OpenID Provider and Jira, ensure that the following prerequisites are met:

    • Ensure that Jira has been installed and configured appropriately.
    • Enable HTTPS on the Jira Server (optional, but recommended).
    • Establish admin credentials for Jira.
    • Obtain a valid Jira Server and Data Center License.

Download And Installation



  • Log into your Jira instance as an admin.
  • Navigate to the Settings Menu and click on Manage Apps.
  • Next, click on Find new apps option on the left-hand menu of the page.
  • Here, locate miniOrange Jira OAuth/OpenID Connect Single Sign On (SSO) plugin on Atlassian marketplace via search.
  • Click on Try it free to begin a new trial of the plugin with a temporary license.
  • When redirected to MyAtlassian, enter your information and click Generate license.
  • Next, click Apply license.
    • OAuth / OpenID Single Sign On (SSO) using OAuth/OpenID Provider, Manage apps menu

Step 1: Setup Google Apps as OAuth Provider

  • Login to Google Console: Visit the Google's Developer Console and login to your account.
  • Click Select a project, then NEW PROJECT, and enter a name for the project, and optionally, edit the provided project ID. Then click on Create button.
    • OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Setup Google app OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login NEW PROJECT
  • Select your project, click on APIs & Services and select OAuth consent screen option.
    • OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login OAuth Consent Screen
  • On the Consent screen page, select the User Type and click on Create. In the next screen, provide Application name and save the changes.
  • Now go to Credentials, click on Create Credentials and select OAuth Client ID.
    • OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Create credentials
  • Select Web Application as application type.
    • OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Application type
  • Click on the Add URI button in Authorized redirect URIs section. Collect the callback URL provided in the plugin and enter it here. Click on Create.
    The callback URL would be {oauth_client_base_url}/plugins/servlet/oauth/callback
    • OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Redirect URI
  • Get Client ID and Client Secret: Copy the client ID and Client Secret to your clipboard, as you will need them when you configure miniOrange plugin.
    • OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Get Client ID
  • To send user's group to the client application, you need to enable Admin SDK and API access. For Admin SDK, navigate to the Dashboard and click on ENABLE APIS AND SERVICES.
    • OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Enable APIS and Services
  • Now search for Admin SDK, select it from the list and then click on ENABLE button.
    • OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Admin SDK
  • To enable API Access you need to login into Google Admin console. In Google Admin Console, go to Security ->Settings.
    • OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login Security ->Settings
  • Look for API Permissions -> Enable API access
    • OAuth/OpenID/OIDC Single Sign On (SSO), Google Apps SSO Login API reference

Step 2: Setup JIRA as OAuth Client

  • Go to Jira Manage Apps -> click Configure under OAuth/OpenID Connect (OIDC) for Jira SSO. Then click on Add New Provider button. Select your preferred IDP. If an IDP is not present, select custom IDP.
    • jira oauth select provider
  • Enter Client Id, Client Secret and scope as email. And if you also want to fetch group info of the users then enter email https://www.googleapis.com/auth/admin.directory.group.readonly in the scope field.
    • Jira OAuth / OpenID SSO using Google Apps Configure OAuth
  • Verify the Google Administrator Account :For fetching the user groups from Google, you need to verify your Google Administrator's account . After saving all the details in Configure Oauth tab, you will be redirected to page listing all configured Oauth providers.
  • Click on Edit button in front of app configured for Google Apps.
  • You will be again redirected to Configure Oauth tab .
  • Click on Verify Admin Credentials.

    • NOTE: You need to login with your Google Administrator's account in this step. If you login with an user account, groups will not be fetched from Google.


  • If you are unable to fetch Groups then Go to Permissions and click on REMOVE ACCESS
    • OAuth / OpenID Single Sign On (SSO) using Google Apps, remove access

Step 3: User Profiles

    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.

    OAuth / OpenID Single Sign On (SSO) into Jira, oauth 2.0, oauth authentication, oauth 2.0 authentication, Configure User Profile

    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

    • d. Custom Attribute Mapping

  • The custom attributes recieved in the OAuth/OpenID response can be configured using Configure User Properties(Custom Attributes) option.
  • Click Add Attributes .
  • Enter the attribute name( E.g. department) as User Property Key.
  • This option will be added in the profiles of Jira Users.
  • Corresponding to this key, fill the attribute value you recieved in Test Configuration window. For instance, if the Attribute Name in the Test Configuration window is Department, enter Department as Attribute.
  • Another attribute e.g. location can be added by reclicking on Add Attributes option.
    • OAuth / OpenID Single Sign On (SSO) into Jira, oauth token, oauth api, oauth oidc, Configure User Profile

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 Assign Default Group To.
    • oauth sso, oauth client, open id oauth, OAuth / OpenID Single Sign On (SSO) into Jira, Default group

    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 OAuth 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.
    open authentication oauth, saml oauth and openid connect, OAuth / OpenID Single Sign On (SSO) into Jira, Manual group 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.
    sso oauth 2.0, oauth in rest api, oauth authentication, OAuth / OpenID Single Sign On (SSO) into Jira , On the fly group mapping

Step 5: Sign In Settings

    The settings in the 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.
  • Change the text on the SSO button on the login page using the Login Button Text option.
  • Set the Relay State to the URL to which the users would be redirected after login. Keep this empty to redirect users to the same page they started with.
  • 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 the access of backdoor URL to limited users by using the Restrict backdoor URL access based on user groups feature.
  • Use Domain Restriction to allow login to only a specific set of users. You can configure multiple domains (semicolon-separated).
  • For example, if only 'miniorange.in' and 'gmail.com' domains are allowed then, the user test@miniorange.in and test@gmail.com will be able to log in and user test@yahoo.com will not be able to login.
  • Select Secure Admin Login Options to control admin access. User needs to authenticate again to access admin settings or to perform any admin operation. This helps you to add an extra level of security for admin access.
    • oauth authentication, single sign on loginOAuth / OpenID Single Sign On (SSO) into Jira , Sign In Settings

    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.
  • Enable Auto-redirect to Provider if you want to allow users to login to ServiceDesk only using provider and use Disable Auto Redirect to Provider to allow basic login for selective customer portals.
    • single sign on login, microsoft single sign on, OAuth / OpenID Single Sign On (SSO) into Jira, Service Desk Settings

    c. Sign Out Settings

  • Set Logout URL or Logout Template to redirect users after logout action.
    • single sign on solutions, sso single sign on, OAuth / OpenID Single Sign On (SSO) into Jira, Sign Out Settings

    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 Provider enabled.
    • oauth 2.0 authentication, OAuth / OpenID Single Sign On (SSO) into Jira, Error Settings

    e. Advanced SSO Settings

  • Set the restriction to access of Plugin API outside the Jira environment by Restrict access to plugin API's.
    • single sign on authentication, OAuth / OpenID Single Sign On (SSO) into Jira, Error Settings

miniorange img  Hi! Do you need help with this guide?




 Thank you for your response. We will get back to you soon.

Something went wrong. Please submit your query again

Sync product to woocommerce store from Amrod

Step 3: User Profile Mapping

    Navigate to the User Profile section in the left sidebar to set up user profile attributes for Jira. If your user directory is read-only, disable the User Profile Mapping option in this tab and proceed directly to the Matching a User step.



    OAuth / OpenID Single Sign On (SSO) into Jira, auth0 single sign on, saml and oauth, atlassian single sign on, Configure User Profile

    3.1 Identifying Correct Attributes

  • Access the SSO Endpoints tab and click on Test Configuration.
  • In the pop-up that appears, review the table displaying all values returned by your OAuth/OpenID Provider to Jira. If essential attributes like First Name, Last Name, Email, or Username are missing, adjust the settings in your OAuth/OpenID Provider accordingly.
  • Once you've confirmed all values in the Test Configurationpopup window, proceed to the User Profile tab.

    • 3.2 Configuring Profile Attributes

  • In the User Profile tab, populate the fields by matching attribute names. For instance, if the Attribute Name in the Test Configuration window is NameID, enter NameID as Username.
  • It's essential to set up both Username and Email if you allow user registration. Alternatively, you can restrict login to existing users by deselecting the Allow User Creation option in the Advanced SSO Options tab.

    • 3.3 User Attribute Matching

    When a user logs into Jira, data or attributes from the OAuth/OpenID provider are used to search for that user in Jira and facilitate login. To match the attributes:

  • Navigate to the User Profile tab.
  • Choose either Username or Email as the login for the Jira user account.
  • Enter the attribute name from the OAuth/OpenID Provider that corresponds to the Username or Email as identified in the Identifying Correct Attributes step.

    • oauth 2.0, oauth authentication, OAuth / OpenID Single Sign On (SSO) into Jira, User Profile Mapping tab of the plugin

    3.4 Custom Attribute Mapping

    You can configure custom attributes received in the OAuth/OpenID response using the Configure User Properties(Extended Attributes) section.

  • Click on Add Attribute Mapping.
  • Enter the attribute name( E.g. department) as User Property Key in the Select Jira Attribute to Map field.
  • For each attribute, input the corresponding value retrieved from the Attributes from IDP tab in the Test Configuration window. For example, if the attribute name in the Test Configuration window is Department, enter Department as the Attribute Value.
  • Additional attributes, such as location, can be added by selecting the Add Attribute Mapping option.
    • oauth 2.0 authentication, oauth token, OAuth / OpenID Single Sign On (SSO) into Jira, provision for configuring additional attributes

Step 4: User Group Mapping

    As we proceed to configure user group attributes for Jira, you have the option to enable group mapping.

    If you wish to do so, please ensure to select Enable Group Mapping in the User Groups tab. Alternatively, you can proceed directly to setting the default group.


    4.1 Setting the Default Group

  • In the User Groups tab, select the default group for users. If no group is mapped, users are automatically added to this group.
  • Using the Assign Default Group To option, you can assign default groups to all users or new users. Choose None if you prefer not to assign any default group to SSO users.
    • oauth api, oauth oidc, oauth sso, OAuth / OpenID Single Sign On (SSO) into Jira, Default group

    4.2 Finding Group Attribute

  • To identify group attributes, go to the Configure OAuth tab and click on Test Configuration. Review the values returned by your OAuth/OpenID provider to Jira in the table. If group values are missing, adjust the settings in your OAuth provider to include group names.
  • After reviewing all values in Test Configuration, proceed to the User Groups tab. Enter the Attribute Name of the group under Group Attribute.
  • Check Disable Group Mapping option if you don't want to update groups of existing users.

    • 4.3 Group Mapping

    Group mapping can be done manually or on the fly:

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

  • 4.3.1 Manual Group Mapping

    • Check the Allow 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.
    • Select a Jira group from the dropdown list and enter the name of the OAuth/OpenID Provider group to be mapped in the Groups from Applications textbox.
    • For instance, if you want all users in the 'dev' group of OAuth/OpenID providers 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.
    • You can use the '+' and '+10' buttons to add extra mapping fields, and the '-' button to delete mappings.
    oauth client, open id oauth, open authentication oauth, OAuth / OpenID Single Sign On (SSO) into Jira, Manual group mapping

  • 4.3.2 On-The Fly Group Mapping

    • If the group names in both Jira and the OAuth/OpenID provider match, opt for On-The-Fly group mapping.
    • Check the Create New Groups option to create new groups from the OAuth/OpenID Provider if not found in Jira.
    • Preserve existing user groups by selecting the Keep Existing User Groups option. Unticking this option will remove the user from a Jira group if it's not present in the OAuth/OpenID response.
    • Deselect the Keep Existing User Groups option to prevent On-The-Fly group mapping from affecting locally managed Jira groups. Add those groups to the Exclude Groups field.
    saml oauth and openid connect, sso oauth 2.0, OAuth / OpenID Single Sign On (SSO) into Jira , provision for on-the-fly group mapping

Step 5: SSO Setting

    The configurations within the SSO Settings tab are pivotal in shaping the user experience for Single Sign-On.


    5.1 Sign In Settings

  • Enable Auto Redirect to Application to redirect users to the OAuth/OIDC provider when accessing the Jira login page. You can set a delay before redirection.
  • Next, toggle the Enable Backdoor Login option for emergency access using a backdoor URL. Restrict access to this URL for specific groups if needed.
  • You can use Domain Restriction to allow login for specific user domains and configure multiple allowed domains (semicolon-separated).
  • The Secure Admin Login option ensures the re-authentication of admin users before accessing pages with administrative permissions.
    • oauth authentication, single sign on login, OAuth / OpenID Single Sign On (SSO) into Jira , provision for configuring sign-in settings in the plugin

    5.2 Redirection Rules

  • Redirection rules allow you to redirect users to login pages/providers based on their email domains. This functionality is especially useful with multiple configured providers.
  • To create a new rule, go to the Redirection Rules tab and click Add Rule.
    • oauth 2.0 authentication, single sign on authentication, OAuth / OpenID Single Sign On (SSO) into Jira, Redirection Rules tab with provision for creating new rule
  • Next, give the rule a name and set the conditions for redirection. Click Save once you’re done.
    • saml and oauth, atlassian single sign on, OAuth / OpenID Single Sign On (SSO) into Jira, Add Rule window in the Redirection Rules tab
  • You can also set a default rule if no other rule conditions are met.
    • oauth authentication, oauth 2.0 authentication, OAuth / OpenID Single Sign On (SSO) into Jira, provision for setting a default redirection rule
  • Once you set a redirection rule, users who fulfill its conditions will be shown a login form, prompting them to input their username/email address. You can set domain-based rules for directing users to specific providers as well.

    • 5.3 Global SSO Settings

  • You can enable/disable SSO for Jira Software and Service Desk from the Global SSO Settings tab.
  • If enforcing SSO for Service Desk Agents only, select Enable SSO Only For Service Desk Agents.
  • You have the option to activate SSO for both Jira software and service desk by selecting Enable SSO for Jira Software and Enable SSO for Jira Service Desk respectively.
  • The app also gives you options to adjust additional settings like Allow Users to Change Password, Restrict Access to Plugin APIs, and Auto Activate Users on SSO.
  • To keep users logged in until explicitly logged out, you can enable Remember Me-Cookie in the Session Management tab.
    • oauth token, oauth api, oauth oidc, OAuth / OpenID Single Sign On (SSO) into Jira, Global SSO Settings tab in the plugin

    5.4 Look and Feel

  • You can customize the appearance of your login page and error messages from the Look and Feel tab.
  • The plugin has provisions for modifying the default login button text and designing the login page using customisable templates.
    • open authentication oauth, saml oauth and openid connect, provision for customizing the login page under the Look and Feel tab
  • You can also set a Custom Logout URL from the Post Logout Configuration tab to redirect users to a specific screen after they logout.
  • The SSO Error Message section allows you to customize the error message displayed to users.
    • Look and Feel tab with provision for customizing the error messages

Configure SCIM with OAuth

    Set up SCIM with OAuth for your chosen IDP by following the step-by-step guide provided in this guide.

miniorange img  Hi! Do you need help with this guide?




 Thank you for your response. We will get back to you soon.

Something went wrong. Please submit your query again

Sync product to woocommerce store from Amrod



Free Trial

If you don't find what you are looking for, please contact us at support-atlassian@miniorange.atlassian.net or raise a support ticket here.