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

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

Step 1: Setup Google app as OAuth Provider

  • Login to Google Console :Visit the Google website for Developer Console.
  • Click Select a project, then NEW PROJECT, and enter a name for the project, and optionally, edit the provided project ID. Click Create. (If project is note created)
    • google-1 google2
  • Create Google application : Select your project. On the Credentials page, select Create credentials, then OAuth client ID.
    • google3 google4
  • You may be prompted to set a product name on the Consent screen; if so, click Configure consent screen, supply the requested information, and click Save to return to the Credentials screen.
  • Select Web Application. Enter Authorized redirect URLs as callback URL given in the plugin. Click Create.
  • Get Client ID and Client Secret: Copy the client ID and client secret to your clipboard, as you will need them when you configure miniOrange plugin.
    • google5
  • To send user's group to the client application, you need to enable Admin SDK and API access. Navigate to Dashboard and click on ENABLE APIS AND SERVICES.
    • google6
  • Search for Admin SDK and ENABLE it.
    • google7
  • Login to Google Admin console. Go to Security ->Settings.
    • google8
  • Look for API reference -> Enable API access and SAVE settings.
    • google9


Step 2: Setup Confluence as OAuth Client

  • Enter Client Id, Client Secret and scope as email and email https://www.googleapis.com/auth/admin.directory.group.readonly for fetching groups.
    • goggle-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 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 atlassiansupport@xecurify.com