• Home
• Login with External IDP
• Keycloak Single Sign-On

Single Sign-On (SSO) for Apps Using Keycloak as IDP

---

miniOrange helps you to log into your applications using Keycloak Identity Provider without having to worry about configuration changes and protocol support. In this case miniOrange will act as a broker between your app and Keycloak while providing additional features like MFA, Adaptive Authentication, Provisioning, Role Based access, Attribute Filtering, Cross Protocol Support etc. We will go through the step-by-step guide below to set up Keycloak as an Identity Provider in miniOrange. Once configured successfully you will be ready to securely access your website/application using Keycloak IDP.

1. Configure miniOrange as SP in Keycloak

Mentioned below are steps to configure Keycloak as IDP via SAML and OAuth configuration. Follow the steps accordingly based on your requirement (SAML or OAuth).

• SAML
• OAuth

• Go to miniOrange Admin console and navigate to Idenity Providers in the left navigation menu. Then, click on Add Identity Provider button.



• Now click on the Click here link to get miniOrange metadata as shown in Screen below.



• For SP -INITIATED SSO section Select Show Metadata Details.



• Click on Download Metadata



• Log in to the Keycloak Admin Panel and go to Clients.



• Click on Create on the right corner of the table.



• If you have XML file from service provider, you can click on import file and upload metadata.



• For manual configuration, Select saml from client protocol dropdown and enter values provided by service provider as follows:

Client Id	EntityID / Issuer
Endpoints	ACS Url




• Click on Save for further configuration.
• Now provide SP configuration values as instructed in table value: .

Client ID	The SP-EntityID / Issuer from the miniOrange's Metadata
Name	Provide a name for this client
Description	Provide a description
Client Signature Required	OFF
Force POST Binding	OFF
Force Name ID Format	OFF
Name ID Format	Email
Root URL	Leave empty or Provide Base URL from Service Provider Metadata tab
Valid Redirect URIs	The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab






• Now in Fine Grain SAML Endpoint Configuration enter values as follows.

Assertion Consumer Service POST Binding URL	ACS Url
Logout Service Redirect Binding URL	Single Logout Url


• Click on the Save button.
• For IDP metadata, Go to Realms in left panel and click on SAML 2.0 Identity Provider Metadata.

• 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. Select Oauth





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

2. Configure Keycloak as IDP in miniOrange

• SAML
• OAuth

• Go to miniOrange Admin Console .
• From the left navigation bar select Identity Provider.
• Click on Add Identity Provider button.



• Select SAML. Click on Import IDP metadata.



• Choose an appropriate IDP name. Enter the URL which you have saved in the previous step from AzureAD.
• Click on Import.



• As shown in the below screen the IDP Entity ID, SAML SSO Login URL and x.509 Certificate will be filled from the Metadata file we just imported.



• Click Save

Test Connection

• Go to Identity Providers tab.
• Click on Select>>Test Connection option against the Identity Provider you configured.



• On entering valid Keycloak credentials you will see a pop-up window which is shown in the below screen.



• Hence your configuration of Keycloak as an Identity Provider in miniOrange is successfully completed.

Follow the steps to configure Keycloak as IdP by OAuth configuration.

• 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://{your-base-url}/as/authorization.oauth2
OAuth Access Token Endpoint	https://{your-base-url}/as/token.oauth2
OAuth Get User Info Endpoint (optional)	https://{your-base-url}/idp/userinfo.oauth2
Client ID	From step 1
Client secret	From step 1
Scope	auto

3. Configure your app in miniOrange

• Login to miniOrange Admin Console.
• Go to Apps >> Add Application.

• SAML Application
• OAuth Application
• JWT Application

• Click on Create App under SAML.



• Search for your Application. In case you do not find your app, search for Custom SAML App.





• Get the ACS URL and SP Entity ID from your application.
• Enter the following values OR click on Import SP Metadata:

Service Provider Name	Choose appropriate name according to your choice
SP Entity ID or Issuer	Your Application Entity ID
ACS URL X.509 Certificate (optional)	Your Application Assertion Consumer Service URL
NameID Format	Select urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
Response Signed	Unchecked
Assertion Signed	Checked
Encrypted Assertion	Unchecked
Group policy	Default
Login Method	Password

• Click on Save to configure your application.
• Now to get the IDP metadata of the app configured, Go to apps >> your_app >> select >> metadata tab.



• Click on the Show Metadata details in the Information required to Authenticate via External IDPs section. Download the metadata XML file by clicking on Download Metadata button or copy the Metadata URL link.



• You need to Upload this metadata in your application.

• Click on Create App under OAuth/OIDC. Click on Open ID Connect App .



• You can add any OAuth Client app here to enable miniOrange as OAuth Server. Few popular OAuth client apps for single sign-on are Salesforce, WordPress, Joomla, Atlassian, etc.





• Enter following Values:

Client Name	Add appropriate Name
Redirect URL	Get the Redirect-URL from your OAuth Client
Description	Add if required
Group Name	Default
Policy Name	As per your Choice
Login Method	Password

• Click on Save
• Now to provide the required data to OAuth client go to the app configured i.e apps >> your_app >> select >> edit.






Note: Choose the Authorization Endpoint according to the identity source you configure.

• When you want to use you want to use miniOrange as OAuth identity server use this endpoint: https://{mycompany.domainname.com}/moas/idp/openidsso
• If you are configuring any Identity Provider in Identity Providers Menu and not using miniOrange as IDP use this endpoint: https://{mycompany.domainname.com}/broker/login/oauth{customerid}

• Click on Create App under JWT.



• Select JWT App.



• Configure the name for your application and configure Redirect-URL which tells where to send JWT response. Redirect-URL should be an endpoint on your application where you want to achieve SSO.




In case you are setting up SSO with Mobile Applications where you can't create an endpoint for Redirect or Callback URL, use below URL.

https://login.xecurify.com/moas/jwt/mobile


• Click Save
• To get the SSO link for your application, Go to Apps >> your_app >> select >> Edit.



• Then, copy the Single Sign On Url and verify SSO setup by browsing that url.



• On successful authentication, you will be redirected to configured Redirect or Callback URL with JWT token
• You will need to download a certificate from App > Manage Apps, and click Certificate link against your configured application. This certificate will be used for signature validation of JWT response.

4. Setup Multiple IDPs (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-




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

External References

• What is Identity Brokering?
• Learn more about SSO