OAuth/OpenID Single Sign On (SSO) into Confluence using Okta

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 OKTA. By the end of this guide, OKTA users should be able to log in and register to Confluence.

Pre-requisites

To configure Okta integration with Confluence OAuth/OpenID Connect SSO, you need the following items:

  • Confluence should be installed and configured (supported version Confluence Server 5.8.15 - 7.3.1, Confluence Data Center 5.8.15 - 7.3.1 ).
  • Confluence Server is https enabled.
  • 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 Confluence OAuth/OpenID Connect Single Sign On (SSO), Confluence SSO.
  • Enter your information and click Generate license when redirected to MyAtlassian.
  • Click Apply license.
ā€¯confluence

Step 1: Setup Okta as OAuth Provider

  • First of all, go to https://www.okta.com/login and log into your Okta account.
  • will be presented with following screen. Click on Applications on the navigation bar on top.
  • OAuth/OpenID/OIDC Single Sign On (SSO), Okta SSO Login Setup Okta
  • Click on Add Application button and select Create New App.
  • OAuth/OpenID/OIDC Single Sign On (SSO), Okta SSO Login Add Application
  • Choose Web as platform, OpenID Connect as Sign on method, and click on Create.
  • OAuth/OpenID/OIDC Single Sign On (SSO), Okta SSO Login Web
  • You will be redirected to the app details page. Enter Application name and Login Redirect URIs. Copy Callback URL from the plugin to configure Login Redirect URL. Click on Save
  • OAuth/OpenID/OIDC Single Sign On (SSO), Okta SSO Login OpenID connect integration
  • You will be brought to App details page. Scroll down to Client Credentials section.
  • OAuth/OpenID/OIDC Single Sign On (SSO), Okta SSO Login Client Credentials


Step 2: Setup Confluence as OAuth Client

  • Enter Client Id, client secret & OKTA domain, and scope(required) as openid email profile.
  • Click on Test Configuration for verifying the entered details.
  • okta oauth/openid login into jira

Step 3: User Profile

    We will be setting up user profile attributes for Confluence. 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.

    confluence-oauth-openid-sso-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 IDP 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 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 Confluence.
  • c. Matching a User
    When the user logs into Confluence, one of the user's data/attribute coming in from the IDP 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 User Profile tab
  • Select Username or Email for Login/Search Confluence 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 Confluence. 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.

    confluence-oauth-openid-sso-user-groups
    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 Confluence 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 Confluence are shown. You can map groups in IDP which correspond to Confluence groups. For example, if you want all users in dev-ops and dev groups in IDP to be added to confluence-users, you will need to enter dev-ops;dev against confluence-users
  • If you want user mapping to work for only limited groups in Confluence, 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.
  • Set Enable SSO for Confluence Software to allow SSO for Confluence 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.
  • Set Logout URL or Logout Template to redirect users after logout action.


  • confluence-oauth-openid-sso-sign-in-settings



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