- Home
- OAuth SSO
- OAuth SSO Documentation
- OAuth SSO into Confluence using Keycloak as OAuth Provider
OAuth/OpenID Single Sign On (SSO) into Confluence using Keycloak
Confluence OAuth/OpenID app gives the ability to enable OAuth/OpenID Single Sign-On for Confluence. Confluence is compatible with all OAuth/OpenID Providers. Here we will go through a guide to configure SSO between Confluence and your OAuth/OpenID Provider. By the end of this guide, users from your OAuth/OpenID Provider should be able to log in and register to Confluence.
Try it for freeVideo Setup Guide
Pre-requisites
To integrate your OAuth/OpenID provider with Confluence, you need the following items:
- Confluence should be installed and configured.
- Confluence Server is https enabled (optional).
- Admin credentials are set up in Confluence.
- Valid Confluence Server and Data center Licence.
Download and Installation
- Log into your Confluence 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 Confluence OAuth/OpenID Connect Single Sign On (SSO), Confluence SSO via search.
- Click Try free to begin a new trial or Buy now to purchase a license for OAuth/OpenID Connect for Confluence SSO.
- Enter your information and click Generate license when redirected to MyAtlassian.
- Click Apply license.
Step 1: Set Up Keycloak as OAuth Provider
Follow the following steps to configure Keycloak as IdP to achieve Keycloak SSO
Select Keycloak version:
Pre-requisites : Download And Installation
- First of all, Download Keycloak and install it.
- Start the keycloak server based on your keycloak version. (See table below)
| For the Keycloak Version 16 and below |
Go to the Root Directory of keycloak bin standalone.sh |
| For the Keycloak Version 17 and above |
Go to the Root Directory of keycloak bin kc.bat and run the below commands.
|
Configure Keycloak as IdP
- Navigate to the plugin configuration page, click the "Add New Provider" button (located either in the middle or top-right corner), select Keycloak as the application, and copy the callback URL from the plugin and keep it handy, as you'll need it to configure Keycloak as the OAuth provider.
- Add Realm : Now login to keycloak administration console and navigate to your desired realm. You can add new realm by selecting Add Realm option.
- Create realm: Enter Realm Name and keep the realm name handy as it will required later to configure the Realm under the plugin. Click on CREATE to add realm.
- Create OpenID client: Click on the Clients and choose create to create a new client. Enter client id and select client protocol openeid-connect and select Save.
- Change Access type: After client is created change its access type to confidential.
- Enter Valid Redirect URIs: Copy callback URL from plugin and then click on
SAVE. Ex -- https://
/oauth/callback - Get Client Secret: Now we need to get client secret. So select Clients and select credentials and copy your secret from here.
- Plugin Configuration: Enter copied Client Secret under Client secret field in the OAuth Client plugin, and enter the Client Name under the Client ID field.
- Add User: We need to add users to realm who will be able to access the resources of realm. Click on the Users and choose to Add a new User.
- User Configuration: After user is created following action needs to be performed on it.
- Map User: We need to map user to a role. Click on Role Mappings and assign the user desired role from available roles and clicking on add selected.
- Create ROLE: The Role will be used by your applications to define which users will be authorized to access the application. Click on the Roles and choose Add Role.
- Create groups: Click on the Groups and choose New to create a new group.
- Assign user to group: Select the user whom you want to add in group. Choose Groups option from tab and then select the group-name and click on join.
- Keycloak Group Mapper: Now to get group details we need to perform its client mapping with group membership else group details will not be fetched. So in Client section, select your client and then click on mapper->create.
- Now, select mapper type as Group Membership and enter the name and token claim name i.e the attribute name corresponding to which groups will be fetched. Turn Off the full group path, Add to ID token and Add to access token options, and click on Save.
- Keycloak Role Mapper: Now to get role details we need to perform its client mapping with role membership else role details will not be fetched. So in Client section, select your client and then click on mapper->create.
- Now, select mapper type as user realm Role Membership and enter the name. and token claim name i.e the attribute name corresponding to which groups will be fetched. Add to ID token and Add to access token options, and click on Save.
- Navigate to the plugin configuration page, click the "Add New Provider" button (located either in the middle or top-right corner), select Keycloak as the application, and copy the callback URL from the plugin and keep it handy, as you'll need it to configure Keycloak as the OAuth provider.
- Add Realm : Now login to keycloak administration console and navigate to your desired realm. You can add new realm by selecting Create Realm option.
- Create realm: Enter Realm Name and keep the realm name handy as it will required later to configure the Realm under the OAuth Client plugin. Click on CREATE to add realm.
- Create OpenID client: Click on the Clients and choose Create Client to create a new client. Enter Client id and select client protocol openeid-connect and Click Next.
- Enable the Client Authentication and Authorization toggle.
- Scroll down to the Access settings and enter your Callback/Redirect URL which you will get from your plugin present on your Client side under the CallBack URLs text-field.
- Go to the Credentials tab, copy the Client Secret and keep it handy as we will require it later while configuring plugin.
- Plugin Configuration: Enter copied Client Secret under Client secret field in the OAuth Client plugin, and enter the Client ID under the Client ID field.
- Add User: We need to add users to realm who will be able to access the resources of realm. Click on the Users and Click on Create new user to Add a new User.
- User Configuration: After user is created following action needs to be performed on it.
- Map User: We need to map user to a role. Click on Role Mappings and assign the user desired role from available roles.
- Create ROLE: The Role will be used by your applications to define which users will be authorized to access the application. Click on the Roles and choose Create Role.
- Navigate to the plugin configuration page, click the "Add New Provider" button (located either in the middle or top-right corner), select Keycloak as the application, and copy the callback URL from the plugin and keep it handy, as you'll need it to configure Keycloak as the OAuth provider.
- Add Realm : Now login to keycloak administration console and navigate to your desired realm. You can add new realm by selecting Create Realm option.
- Create realm: Enter Realm Name and keep the realm name handy as it will required later to configure the Realm under the OAuth Client plugin. Click on CREATE to add realm.
- Create OpenID client: Click on the Clients and choose Create Client to create a new client. Enter Client id and select client protocol openeid-connect and Click Next.
- Enable the Client Authentication and Authorization toggle.
- Scroll down to the Access settings and enter your Callback/Redirect URL which you will get from your plugin present on your Client side under the CallBack URLs text-field.
- Go to the plugin and copy the Client Secret and keep it handy as we will require it later while configuring plugin.
- Plugin Configuration: Enter copied Client Secret under Client secret field in the plugin, and enter the Client ID under the Client ID field.
- Add User: We need to add users to r+ealm who will be able to access the resources of realm. Click on the Users and Click on Create new user to Add a new User.
- User Configuration: After user is created following action needs to be performed on it.
- Map User: We need to map user to a role. Click on Role Mappings and assign the user desired role from available roles.
- 1) Setting a password for it so click on Credentials and set a new Password
for the user.
NOTE : Disabling Temporary will make user password permanent.
Step 1.1: Steps to fetch Keycloak Groups [Premium]
Note: -- If full path is on group path will be fetched else group name will be fetched.
Step 1.2: Steps to fetch Keycloak Roles [Premium]
- 1) Setting a password for it so click on Credentials and set a new Password
for the user.
NOTE : Disabling Temporary will make user password permanent.
- 1) Setting a password for it so click on Credentials and set a new Password
for the user.
NOTE : Disabling Temporary will make user password permanent.
Step 2: Set Up Confluence as OAuth Client
- Go to Configure OAuth tab, enter copied Client ID, Secret in the plugin.
- Enter the Host Name (Base URL of the Keycloak server For eg. http://example.com) and Realm Name you copied from the keycloak server.
- 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 Mapping
- Click on User Profile from the left sidebar. We will be setting up user profile attributes for Confluence. 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.
3.1 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 Confluence 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.
3.2 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.
3.3 Matching a User
When the user logs into Confluence, one of the user's data/ attributes coming in from the OAuth/OpenID Provider is used to search the user in Confluence. This is used to detect the user in Confluence and log in the user to the same account.
- Go to the User Profile tab.
- Select Username or Email for Login Confluence user account by.
- Enter the attribute name from OAuth/OpenID Provider which corresponds to Username or Email using Finding Correct Attributes.
3.4 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 Confluence 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 Group Mapping
We will be setting up user group attributes for Confluence. 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.
4.1 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.
4.2 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 Confluence 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.
4.3 Group Mapping
Group mapping can be done manually or on the fly:
- Manual group mapping: If the names of groups in Confluence 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 Confluence 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 Confluence group from the dropdown which lists all groups present in Confluence 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 Confluence-software-users, you will need to select Confluence-software-users from the dropdown and enter 'dev' against Confluence-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 Confluence.
- 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 Confluence 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 Confluence groups which are managed locally, then deselect the option Keep Existing User Groups and add those groups in the Exclude Groups field.
Step 5: Advanced SSO Configurations
- Enable PKCE to enhance security by adding an extra layer of protection to the OAuth flow, preventing authorization code interception attacks.
- Allow User Creation: Enabling this will allow you to create new users through SSO.
- Directory for New User: After a successful SSO, if the user is not found in Confluence, a new user account will be created in the selected user directory.
- Remote Directory Sync: The user details will be synced from the remote directory on successful SSO only if the user exists in the remote directory.
- ACR Value: Requests additional information from the OpenID provider to determine the Level of Assurance for user authentication.
- State Parameter: Protects against CSRF attacks by sending a unique, non-guessable value with the authorization request, mandatory for certain providers.
- Add Custom Parameters: Allows the inclusion of extra parameters in the authentication request.
- Public Key: Used in asymmetric cryptography to decrypt signed tokens, verifying the identity of the OpenID provider and ensuring the tokens remain unchanged.
- JWKS Endpoint URL: Provides public keys used to validate JSON Web Tokens (JWT) issued by the authorization server for user authentication.
Step 6: SSO Setting
The settings in the SSO Settings tab define the user experience for Single Sign On.
6.1 Sign In Settings
- Return URL: Enter the absolute URL where you want to redirect the user after SSO. Keep empty to redirect users to the same URL they started with.
- You can use Domain Restriction to allow login for specific user domains and configure multiple allowed 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.
- No / Skip SSO: SSO will be bypassed for the specified URL patterns. For example, to disable SSO for http://localhost:8080/servlet/applinks, simply enter /applinks in the URL pattern field.
- Enable Auto Redirect to Application feature to redirect users to an OAuth/OIDC provider when the Confluence 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.
- You can customize the Backdoor URL by clicking on the edit button beside it and entering new parameter values.
- Secure Admin Login Option will ensure reauthentication of admin user before accessing the pages with administrative permissions.
- Secure Admin Login Option can be enabled to ensure the admins will also log in via SSO.
6.2 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.
6.3 Session Management
- Enable User Session Management option to set Remember Me-Cookie to keep users logged in until they are explicitly logged out.
6.4 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.
6.5 Post Logout Configurations
To access these settings click on the Post Logout Configurations tab from the left sidebar.
- 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.
6.6 Global SSO Settings
- SSO can be enabled/disabled from the Global SSO Settings tab in the left sidebar. You can enable SSO for Confluence software and service desk using options Enable SSO for Confluence Software and Enable SSO for Confluence 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.
Configure SCIM with OAuth
Configure SCIM with OAuth for your choosen IDP by following the step by step
guide linked
here.
×
![]()
Additional Resources
Did this page help you?
