Keycloak Single Sign On (SSO) for Your Application miniOrange provides a ready to use Single Sign On (SSO)solution for your application. This solution ensures that you are ready to roll out secure access to your application using Keycloak within minutes.You just need to follow the few steps given below : Firstly you need to configure miniOrange as Service Provider(SP) on Keycloak, then configure Keycloak as OAuth 2.0 Provider in miniOrange & finally configure your application in miniOrange plugin. By Performing this steps you will configure Single Sign On (SSO) for your application using Keycloak.

Step 1: Configure Keycloak as OAuth 2.0 Provider in miniOrange.

• Go to miniOrange Admin Console.
• From the left navigation bar select Identity Provider. Select Oauth

• Enter the following values.

IdP Name	Custom Provider
IdP Display Name	Choose appropriate Name
OAuth Authorize Endpoint	https://<keycloak domain>/auth/realms/{realm-name}/protocol/openid-connect/auth
OAuth Access Token Endpoint	https://<keycloak domain>/auth/realms/{realm-name}/protocol/openid-connect/token
OAuth Get User Info Endpoint (optional)	https://<keycloak domain>/auth/realms/{realm-name}/protocol/openid-connect/userinfo
Client ID	From step 1
Client secret	From step 1
Scope	email profile openid

Step 2: Configure miniOrange as Service Provider (SP) in Keycloak

• First of all, Download Keycloak and install it.
• Start Server: Start the keycloak server by running the _standalone.sh_ file.
Root Directory of keycloak bin standalone.sh
• Add Realm : Now login to keycloak administration console and navigate to your desired realm. You can add new realm by selecting Add Realm option.

• Create realm: Enter Realm Name and click on CREATE Keycloak SSO(Create Realm).

• Create ROLE: The Role will be used by your applications to define which users will be authorized to access the application. Click on the Roles and choose Add Role.

• Add User: We need to add users to realm who will be able to access the resources of realm. Click on the Users and choose to Add a new User.

• User Configuration: After user is created following action needs to be performed on it.
1) Setting a password for it so click on Credentials and set a new Password for the user.



NOTE : Disabling Temporary will make user password permanent.

• Map User: We need to map user to a role. Click on Role Mappings and assign the user desired role from available roles and clicking on add selected.

• Create groups: Click on the Groups and choose New to create a new group.

• Assign user to group: Select the user whom you want to add in group. Choose Groups option from tab and then select the group-name and click on join.

• Create OpenID client: Click on the Clients and choose create to create a new client. Enter client id and select client protocol openeid-connect and select Save.

• Change Access type: After client is created change its access type to confidential.

• To get the Redirect URL:
• Go to miniOrange Admin Console.
• From the left navigation bar select Identity Provider.

• Copy the Callback URL as Redirect URL required for next step.

• Enter Valid Redirect URLs: Copy callback URL from plugin and then click on SAVE. Ex -- https:///oauth/callback

• Keycloak Group Mapper: Now to get group details we need to perform its client mapping with group membership else group details will not be fetched. So in client select Mappers and then click on create. Select mapper type Group Membership and enter name and token claim-name i.e the attribute name corresponding which groups will be fetched. Turn Off full group path and click on Save.


Note: -- If full path is on group path will be fetched else group name will be fetched.

• Realm name: You need a realm name when you set up Keycloak as an OAuth provider. Go to the Realm Settings tab and copy the realm name.
• Get Client Secret: Now we need to get client secret. So select Clients and select credentials and copy your secret from here.

Step 3: Configure your application in miniOrange

Step 4: Login using IDP selection page (Optional)

• You can configure multiple IDPs (Identity Providers) and give users the option to select the IDP of their choice to authenticate with.
  For Example - It could be multiple AD domains belonging to different departments or multiple okta organizations.

Few usecases where customers configure multiple IDPs -


• Suppose you have a product which many of your clients use and each client has their own unique IDP so you want them to SSO into your product as well using their existing IDP only. miniOrange provides a centralized way to connect with all IDPs in a very easy manner and integrate SSO into your application.
• Suppose you are providing a course to many universities, each having a unique SAML, OAuth protocol supported IDP's like Shibboleth, ADFS, CAS, etc. You can provide Single Sign-On (SSO) into your course application to all these universities by integrating with all of them using a single platform provided by miniOrange.
• This is the endpoint to call from your SAML application -

  For Cloud IDP -	https://login.xecurify.com/moas/discovery?customerId=<customer_id>
  For On-Premise IDP -	https://yourdomain.com/discovery?customerId=<customer_id>

• You should copy the Customer Key from admin console-> Settings -> and replace it with <customer_id> here. Once configured in SP, when you initiate the login from Service Provider, a user will be redirected to IDP Selection Page listing all IDPs configured for that account.

You can see the screenshot below of the IDP Selection Page with a list of IDPs .



Note: To view the IDP in drop-down list, go to Identity Providers tab > against your configured IDP > Select >Edit , here Enable the Show IdP to Users option.


• You can also change the look and feel of this page. Login to miniOrange Admin console. Navigate to Customization -> Branding Configuration. See the below screenshot for reference-
  

1. You can customize the title of this page.
2. Change the logo and favicon for this page.
3. Change the background and button color for this page from admin UI.

×

External References

• SSO using Keycloak as IDP