OAuth/OpenID Single Sign On (SSO) into Jira using Keycloak
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 Keycloak as OpenID Provider swith the Jira OAuth Client from the video or documentation given below
Pre-requisites
To integrate your OAuth/OpenID Provider with Jira, you need the following items:
Jira should be installed and configured.
Jira Server is https enabled (optional).
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 OAuth/OpenID Connect (OIDC) for Jira SSO.
Enter your information and click Generate license. when redirected to MyAtlassian.
Click Apply license.
Step 1: Setup Keycloak as OAuth Provider
Create openid client : Login to your Keycloak server. Go to the Clients and click on Create button. Enter client id and select openid-connect as client protocol and select Save.
Change Access type: After client is created change its access type to confidential.
Enter Valid Redirect URIs :
Copy the Callback URL from plugin and insert into Valid Redirect URIs field.
Click on SAVE.
Keycloak Group Mapper:
Now, if you want to fetch the user groups you will have to map the client and group membership.
For that, navigate to the Clients and select the client Id you created, then go to the Mappers tab and click on Create.
Provide Name, select Mapper Type as Group Membership and enter the Token Claim Name i.e attribute name corresponding to which the groups will be sent.
Turn off Full group path else group mapping will fail. And then click on Save.
Realm name: You need a realm name when you set up Keycloak as an OAuth provider, kindly copy it. For example in this case it is Master
Get Client Secret: To get Client Secret Navigate to Clients, select Client Id and navigate to the Credentials tab.
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.
Go to Configure OAuth tab, enter copied Client ID, Secret, Host Name, Realm Name in the plugin.
Enter JWKS EndPoint URL or Public Key for signature validation. eg.http://${yourKeycloakDomain}/auth/realms/${realmName}/protocol/openid-connect/certs
Click on Test Configuration.
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
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.
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.
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.
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 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.com' and 'gmail.com' domains are allowed then, the user test@miniorange.com
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.
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.
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 Provider enabled.
e. Advanced SSO Settings
Set the restriction to access of Plugin API outside the Jira environment by Restrict access to
plugin API's.
Click on User Profile from the left sidebar. We will be setting up user profile attributes
for Jira. If your
users are stored in a directory that is Read Only, please disable the option User
Profile Mapping in the User Profile tab and skip to the step, Matching a User.
a. Finding correct attributes
Go to the SSO Endpoints 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 the User
Profile tab.
b. Setting profile attributes
In this User Profile 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. You can allow only
existing users to log in, by unchecking the Allow User Creation attribute in the
Advance SSO Options tab.
c. Matching a User
When the user logs into Jira, one of the user's data/ attributes 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 the User Profile tab.
Select Username or Email for Login 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 received in the OAuth/OpenID response can be configured using the
Configure User Properties(Extended Attributes) section.
Click Add Attribute Mapping.
Enter the attribute name (E.g. department) as User Property Key in the Select Jira Attribute to
Map field.
Corresponding to this key, fill the attribute value you receive from the Test Configuration window into
Attributes from IDP tab. For instance, if the Attribute Name in the Test Configuration
window is Department, enter Department as the Attribute Value.
Another attribute e.g. location can be added by clicking on Add Attribute Mapping
option.
Step 4: User Groups
We will be setting up user group attributes for Jira. If you want to enable group mapping then you will need to
select please check Eisable Group Mapping in the User Groups tab else you can 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 Assign Default Group To. Select None if you don't want to
assign any default group to SSO users.
b. Finding Group Attribute
Just like we found Attribute Name for User Profile attributes, we can find group attributes. Go to the
Configure OAuth tab 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 Provider to return group names.
Once you see all the values in Test Configuration, keep the window open and go to the User
Groups tab.
Enter the Attribute Name of the 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 from 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
the same, you should use On-The-Fly group mapping.
I. Manual Group Mapping
Check 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.
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 Groups from
Application.
For example, if you want all users in 'dev' group of 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 '+' and '+10' buttons to add extra mapping fields. Use the '-'
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.
You can preserve existing user groups by selecting the Keep Existing User Groups
option. Unticking this option will result in the user being removed from a group in Jira if that group
is not present in the OAuth/OpenID response returned by the OAuth/OpenID provider.
If you don't want On-The-Fly group mapping to affect Jira groups which are managed locally, then
deselect the option Keep Existing User Groups and add those groups in the
Exclude Groups field.
Step 5: SSO Settings
The settings in the SSO Settings tab define the user experience for Single Sign On.
a.Sign In Settings
Enable Auto Redirect to Application feature to redirect users to an OAuth/OIDC provider
when the Jira login page is accessed. You can even set the delay before redirecting to the provider.
Enable Backdoor Login will allow you to use a backdoor URL in case of an emergency. You can
even restrict access to backdoor URL for specific groups using Restrict Backdoor URL
Access 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.com' and 'gmail.com' domains are allowed then, the user test@miniorange.com
and test@gmail.com will be able to log in and user test@yahoo.com will not be able to log in.
Secure Admin Login Option will ensure reauthentication of admin user before accessing the
pages with administrative permissions.
b. Redirection Rules
This section lets you set rules to redirect users to the login page/providers based on their email domains.
This feature is more useful in case you have multiple providers configured. For example, You can set a rule
of checking domain name while logging in and redirect users to different providers. You can add a rule by
clicking on the Add Rule button.
When a rule such as given above is configured example, a login form will be displayed to the users where
they will have to input their Username/email address.
Here you can set domain-based rules for redirecting users to the specific provider. Also, you can set the
default rule that will execute if the condition of any other rule does not satisfy.
c. Global SSO Settings
SSO can be enabled/disabled from the Global SSO Settings tab in the left sidebar. You can
enable SSO for
Jira software and service desk using options Enable SSO for Jira Software and
Enable SSO for Jira Service
Desk.
If you want to enforce SSO to the Service Desk Agents only then you can select the Enable SSO Only
For ServiceDesk Agents option.
You can change additional settings as Allow Users to Change Password, Restrict access to plugin APIs and
Auto Activate Users on SSO.
You can enable Set Remember Me-Cookie in the Session Management tab to keep users logged in
until they are explicitly logged out.
d. Look and Feel
These settings will allow you to change the look and feel of the login page and error message. To access
these settings click on the Look and Feel tab from the left sidebar.
You can customize the default login button text as well as you can completely design the login page using a
customizable template.
You can also have a custom login page and template for customer portal.
The SSO Error Message section allows you to modify how error messages will be displayed to
your users.
If you want to redirect users to an URL after they log out then you can use Custom Logout
URL under Post Logout Configuration tab.
Similar to the customizable login template, you can also design the Logout page to improve the user
experience.