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

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

Pre-requisites

To configure AWS Cogito 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 AWS Cognito as OAuth Provider

  • Sign in to AWS Amazon.
  • Now enter “Cognito” in search textbox & select Cognito from dropdown.
  • OAuth/OpenID/OIDC Single Sign On (SSO), AWS cognito SSO Login Cognito
  • Go to “Manage your user pools”
  • OAuth/OpenID/OIDC Single Sign On (SSO), AWS cognito SSO Login Manage user pools
  • Click on “Create a user pool”
  • OAuth/OpenID/OIDC Single Sign On (SSO), AWS cognito SSO Login Create a user pool
  • Add pool name and select “Review Defaults”.
  • OAuth/OpenID/OIDC Single Sign On (SSO), AWS cognito SSO Login Review Defaults
  • Click on “Add app client” & then click on Add an app client
  • OAuth/OpenID/OIDC Single Sign On (SSO), AWS cognito SSO Login Add app client
  • Enter App client name & then Click on “Create app client”.
  • OAuth/OpenID/OIDC Single Sign On (SSO), AWS cognito SSO Login Create app client
  • Click on Return to pool details. After this click on “Create Pool”.
  • Navigate to App client settings.
    • Select “Cognito User Pool”, add callback URL. You will get this callback URL from the plugin.
    • Add application home page URL has to Sign out URL.
    • Also, select Authorization code grant as “Allowed OAuth Flows” & select OpenID as “Allowed OAuth Scopes”.
    • After selecting all details click on Save changes button.
    • OAuth/OpenID/OIDC Single Sign On (SSO), AWS cognito SSO Login Save changes
  • Go to “App client” and click on “Show details” to get a client ID and client secret.
  • OAuth/OpenID/OIDC Single Sign On (SSO), AWS cognito SSO Login App client
  • Go to domain name and enter a domain name for your app. After adding domain name you can check its availability by clicking on “Check availability” button. After entering valid domain name click ”Save changes” button.
  • OAuth/OpenID/OIDC Single Sign On (SSO), AWS cognito SSO Login domain name
  • Complete domain name: The complete domain name that you need to enter in plugin is {your domain name}.auth.{region name}.amazoncognito.com
  • Add Users / Groups to Cognito App : Go to Users and groups and then click on Users. After this click on Create user.
  • OAuth/OpenID/OIDC Single Sign On (SSO), AWS cognito SSO Login Add Users / Groups
  • Fill all required informations and click on Create user.
  • OAuth/OpenID/OIDC Single Sign On (SSO), AWS cognito SSO Login Create user
  • Click on Groups and then click on Create group.
  • OAuth/OpenID/OIDC Single Sign On (SSO), AWS cognito SSO Login Groups
  • Fill all required informations and click on Create group.
  • OAuth/OpenID/OIDC Single Sign On (SSO), AWS cognito SSO Login Create group

Step 2: Setup Confluence as OAuth Client

  • Enter Client Id, client secret & AWS Cognito domain name.
  • Add https://{domainName}/logout?client_id={ClientID}&logout_uri={Sign out URL} in logout endpoint. This endpoint will logout you from cognito when you logout from Confluence. logout_uri will redirect you to Confluence login Page.
  • Scope is required. Configure Scope as openid.
  • Enter JWKS EndPoint URL or Public Key for signature validation.
  • Click on Test Configuration for verifying the entered details.
  • aws-cognito-gif

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 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
    When the user logs into Confluence, one of the user's data/attribute 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 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

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 Oauth/OpenID Provider to Confluence in a table. If you don't see value with groups, make the required settings in your Oauth/OpenID 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
  • At the bottom of the page, all groups in Confluence are shown. You can map groups in Oauth/OpenID Provider which correspond to Confluence groups. For example, if you want all users in dev-ops and dev groups in Oauth/OpenID Provider 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.
    a. Sign In Settings
  • 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 OAuth/OpenId Provider if you want to allow users to login only using OAuth/OpenId Provider. 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.
  • confluence sso-16
    b. Sign Out Settings
  • Set Logout URL or Logout Template to redirect users after logout action.

  • confluence sso-18

    c. SSO Error Settings
  • Set the Error message template to build your own error page and redirect users to it in case SSO fails.

  • confluence sso-19

Additional Resources




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