OpenID Single Sign On (SSO) Into Confluence

Download

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.

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: Setup OpenID Provider

Register an OpenID application on your Provider by configuring the Callback URL provided in the plugin.
The callback URL would be {openid_client_base_url}/plugins/servlet/oauth/callback
Collect the endpoints given below from your Provider to configure them in the plugin..

Endpoints	Use
Client ID	Identify the application.
Client Secret	Authenticate the Authorization Server.
Scope	Limit an application's access to a user's account.
Authorization Endpoint	Identify a user or obtain an authorization code.
Access Token Endpoint	Allows an application to access an API.

Step 2: Setup Confluence as OpenID Client

Select OpenID App from the dropdown list.
Enter the App Name, Client ID, Client Secret and Scope.

OAuth / OpenID Single Sign On (SSO) into Confluence, Configure Custom OpenId app

Configure all the endpoints collected from the Provider (as mentioned in the Step 1) or if you have the Metadata URL of your Provider, then click on the Fetch Info by Metadata URL button for importing configurations.

OAuth / OpenID Single Sign On (SSO) into Confluence, Fetch Metadata using Metadata URL

Enter the metadata URL and click on the Fetch option. All the Endpoints [like Authorize Endpoint, Access Token Endpoint, Scope and JWKS Enpoint] will be configured automatically except Client ID and Client Secret.

The format of metadata URL is {domain_name}/.well-known/openid-configuration
Here are a few examples of Providers along with their Metadata URLs.

miniOrange	https://login.xecurify.com/moas/.well-known/openid-configuration
Azure AD	https://login.microsoftonline.com/{tenant_id}/.well-known/openid-configuration
Okta	{domain_name}/.well-known/openid-configuration
Keycloak	{hostname}/auth/realms/{realm-name}/.well-known/openid-configuration

Configure the Logout Endpoint if you want users to log out from Confluence along with Provider. This setting is optional. Logout URL will destroy user’s session in Confluence and Provider. You can also set redirect URL here, which specifies where to redirect after Confluence logout.
Click on ACR Value Check checkbox if you want to add ACR Value parameter to the authorised server request. This setting is optional. The ACR value specifies the authentication method used by the Authorization Server and is used to enable the multi-factor authentication.
Click on Nonce checkbox if you want to add the nonce parameter to authorised server request. The nonce parameter is used to validate the tokens received from the provider. Its purpose is to mitigate the replay attack.
Select the Check State Parameter and Issuer Check parameters if required by your OpenID Provider. Using state parameter, a client application can validate that the response received from the provider is not altered in between. On the other hand, the issuer check parameter verifies that the received token has been originated from the expected provider.
If your provider sends the tokens in a signed format then, configure the Public key of the provider in the text box provided. Or else you can configure the JWKS Endpoint of your OpenID Provider and the plugin will fetch the current public key of provider from that endpoint itself. This setting is optional.
Click on Save button.
Click on Test Configuration for verifying the entered details.

Step 3: User Profile

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 Confluence in a table. If you don't see 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 Confluence.

c. Matching a User

Go to User Profile tab
Select Username or Email for Login/Search Confluence 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 Confluence 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

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 / OPenID Single Sign On (SSO) into Confluence, 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 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 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

Manual group mapping: If the names of groups in Confluence 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 Confluence 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 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 beside
- For example, if you want all users in 'dev' group in OAuth/OpenID Provider to be added to confluence-users, you will need to select confluence-users from the dropdown and enter 'dev' against confluence-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 Confluence.
- If the user is part of some group in Confluence 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 Confluence.
- If you don't want On-The-Fly group mapping to affect Confluence groups which are managed locally then add those groups in Exclude Groups field.

Step 5: Sign In Settings

a. Sign In Settings

Set Enable SSO for Confluence Server to allow SSO for Confluence 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.

OAuth / OpenID Single Sign On (SSO) into Confluence, Sign In Settings

b. Sign Out Settings

Set Logout URL or Logout Template to redirect users after logout action.

OAuth / OpenID Single Sign On (SSO) into Confluence, Sign Out Settings

c. 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 / OpenID Single Sign On (SSO) into Confluence, Error Templete Settings

Additional Resources

Pre-requisites
Download And Installation
Step 1: Setup your OpenID Provider
Step 2: Setup Confluence as OpenID Client
Step 3: User Profile
Step 4: User Groups
Step 5: Sign In Settings
Additional Resources

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