OAuth/OpenID Single Sign On (SSO) into Crowd using Keycloak

Crowd OAuth/OIDC app gives the ability to enable OAuth/OIDC Single Sign-On for JIRA, Confluence, Bitbucket, Bamboo, Fisheye, and other connected applications from any OAuth/OpenID Identity Providers. Here we will go through a guide to configure SSO between Crowd and Identity Provider. By the end of this guide, your IdP users should be able to log in and register to Crowd Software.


    To configure your Identity Provider integration with Crowd OAuth/OIDC SSO, you need the following items:

    • Crowd should be installed and configured.
    • Admin credentials are set up in Crowd.
    • Crowd Server is HTTPS enabled (optional).
    • Valid Crowd Server or Datacenter Licence.

Download And Installation

  • Log into your Crowd instance as an admin.
  • Navigate to the Administration menu and Click Manage Apps.
  • Click Find new apps or Find new add-ons from the left-hand side of the page.
  • Locate OAuth/OIDC SSO via search and click on install.
  • SAML Single Sign On (SSO) into Crowd, Install Crowd Add-On through manage apps menu
A. License and Plugin Download

  • Create an account with miniOrange.
  • Login to miniOrange Admin console.
  • Navigate to License > Manage License > Release and Download .
  • Download the jar file from the Download link.
  • Now, click on the View License button to get the license key.
B. Installation

  • Log in to the Crowd Admin console.
  • Navigate to Administration > Manage Apps.
  • Click on the Upload App and upload the jar file.
  • Now, click on the Configure button. You will be asked to verify the miniOrange credential and license key.
C. Plugin Activation

  • Navigate to Crowd Admin Console → Manage Apps.
  • Click on the Configure button of the miniOrange Crowd OAuth/OIDC SSO plugin.
  • Log in with your miniOrange account. Once authenticated, you will be prompted to enter the license key.
  • Enter the license key and click on the verify button.

Step 1: Setup Keycloak as OAuth Provider

  • Create openid client : Login to your Keycloak server. Go to the Clients and click on Create button. Enter client id and select openid-connect as client protocol and select Save.
  • OAuth/OpenID/OIDC Single Sign On (SSO) using Keycloak Identity Provider, Setup Client App
  • Change Access type: After client is created change its access type to confidential.
  • OAuth/OpenID/OIDC Single Sign On (SSO) using Keycloak Identity Provider, Change Access type
  • Enter Valid Redirect URIs :
    • Copy the Callback URL from plugin and insert into Valid Redirect URIs field.
    • Click on SAVE.
    OAuth/OpenID/OIDC Single Sign On (SSO) using Keycloak Identity Provider, Redirect URIs
  • Keycloak Group Mapper:
    • Now, if you want to fetch the user groups you will have to map the client and group membership.
    • For that, navigate to the Clients and select the client Id you created, then go to the Mappers tab and click on Create.
    • Provide Name, select Mapper Type as Group Membership and enter the Token Claim Name i.e attribute name corresponding to which the groups will be sent.
    • Turn off Full group path else group mapping will fail. And then click on Save.
    OAuth/OpenID/OIDC Single Sign On (SSO) using Keycloak Identity Provider, Group Mapper
  • Realm name: You need a realm name when you set up Keycloak as an OAuth provider, kindly copy it. For example in this case it is Master
  • OAuth/OpenID/OIDC Single Sign On (SSO) using Keycloak Identity Provider, Realm name
  • Get Client Secret: To get Client Secret Navigate to Clients, select Client Id and navigate to the Credentials tab.
  • OAuth/OpenID/OIDC Single Sign On (SSO)using Keycloak Identity Provider, Client App Credentials

Step 2: Setup Crowd as OAuth Client

  • Click on Add new Provider and select Keycloak from the list.
  • Enter copied Client ID, Secret, Issuer URL(Host Name), Realm Name in the plugin.
  • Enter JWKS EndPoint URL or Public Key for signature validation.
  • Click on Test Configuration.
  • OAuth / OpenID Single Sign On (SSO) into Crowd Service Provider using Keycloak, Configure OAuth for Keycloak App

Step 3.1: Configuring Multiple IDPs

  • If your use case requires multiple IDPs to be configured on your SP, the plugin supports that as well. You can add another IDP by going to the Configured Providers section andusing the Add New Provider button.
  •  OAuth / OpenID Single Sign On (SSO) into Crowd, Multiple IDP

Step 3.2: Managing SSO with multiple IDPs

  • If you have multiple IDPs configured, you will have to modify the custom login template by adding a new SSO button.
  • Go to the Look and Feel tab and paste the code given to add an SSO button.
  •  OAuth / OpenID Single Sign On (SSO) into Crowd, Multiple IDP

Step 4: User Profile

    We will be setting up user profile attributes for Crowd. If your users are stored in a Read-Only directory, please check Disable Attribute Mapping in theUser Profile tab and follow the steps given in Matching a User.

     OAuth / OpenID Single Sign On (SSO) into Crowd, Multiple IDP

    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 Crowd 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.

    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 Crowd.

    c. Matching a User

    When the user logs into Crowd, one of the user's data/attributes coming in from the OAuth/OpenID Provider is used to search the user in Crowd. This is used to detect the user in Crowd and log in the user to the same account.

    • Go to the User Profile tab
    • Select Username or Email for Login/Search Crowd user account by
    • Enter the attribute name from OAuth/OpenID Provider which corresponds to Username or Email using Finding Correct Attributes

Step 5: User Groups

    We will be setting up user group attributes for Crowd. If your users are stored in a Read-Only directory, please select assign default groups to "None".

     Setting default group 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 Enable Default Groups for.
    •  OAuth / OpenID Single Sign On (SSO) into Crowd, Multiple IDP

Step 6: Sign In Settings

  • The settings in the SSO Settings tab define the user experience for Single Sign-On.
  • Enable Auto-redirect to OAuth/OpenId Provider if you want to allow users to log in only using OAuth/OpenId Provider. Enable backdoor for an emergency.
  •  OAuth / OpenID Single Sign On (SSO) into Crowd, Multiple IDP

Step 7: Advance SSO options

  • 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.
  • 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 if required by your OAuth Provider. Using state parameter, a client application can validate that the response received from the provider is not altered in between.
  •  OAuth / OpenID Single Sign On (SSO) into Crowd, Multiple IDP