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

Configure Keycloak as IDP to Single Sign-On (SSO) into multiple applications using Keycloak as SAML IDP (Identity Provider). In this case miniOrange will act as a identity broker between your app (SP) and Keycloak (IDP) while providing additional features like MFA, Adaptive Authentication, Provisioning, Role Based access, Attribute Filtering, Cross Protocol Support etc. Follow the step-by-step guide below to set up Keycloak as SAML Identity Provider in miniOrange. Once configured successfully you will be ready to securely access your website/application using Keycloak IDP with only one set of credentials.

Get Free Installation Help

miniOrange offers free help through a consultation call with our System Engineers to configure SSO for different apps using Keycloak as IDP in your environment with 30-day free trial.

For this, you need to just send us an email at idpsupport@xecurify.com to book a slot and we'll help you in no time.

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

Keycloak as IDP : get miniorange metadata

For SP -INITIATED SSO section Select Show Metadata Details.

Click on Download Metadata

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 plugin's Service Provider Metadata tab
Name	Provide a name for this client
Description	Provide a description
Client Signature Required	OFF
Force POST Binding	OFF
Force NameID format	OFF
NameID 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

Keycloak as SAML IDP: Keycloak SSO Client Configuration

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.

2. Configure Keycloak as IDP in miniOrange

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 Keycloak.
Click on Import.

Configuring Keycloak as IdP: Keycloak 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.

Configuring Keycloak as IdP : SAML SSO Login URL and x.509 Certificate

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.

Keycloak as SAML IDP: SucessTestConn-Keycloak-IDP

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

First of all, Download Keycloak and install it.
Start Server: Start the keycloak server by running the _standalone.sh_ file.

Add Realm : Now login to keycloak administration console and navigate to your desired realm. You can add new realm by selecting Add Realm option.

Keycloak as SAML IDP: Keycloak SSO(Add Realm)

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

Keycloak as SAML IDP: Keycloak IDP - add 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.

Credentials

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.

Keycloak as SAML IDP: Single Sign-On using Keycloak SSO

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.

Keycloak as SAML IDP: Single Sign-On using (Identity Provider with OAuth 2.0 Provider)

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

Keycloak Single Sign-On (SSO) - change access type

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

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

Note:

If you have already configured your application in miniOrange you can skip the following steps.

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.

Download certificate to proceed with SSO

4. Setup Multiple IDPs (Optional)

Warning: include(../../common-template-docs/common-template-setup-multiple-idps-for-subsite-docs.php): failed to open stream: No such file or directory in /var/www/html/iam/login-with-external-idp/configure-keycloak-sso.php on line 295

Warning: include(): Failed opening '../../common-template-docs/common-template-setup-multiple-idps-for-subsite-docs.php' for inclusion (include_path='.:/usr/share/pear:/usr/share/php') in /var/www/html/iam/login-with-external-idp/configure-keycloak-sso.php on line 295

Contents

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

Get Free Installation Help

1. Configure miniOrange as SP in Keycloak

2. Configure Keycloak as IDP in miniOrange

Test Connection

2. Configure Keycloak as IDP in miniOrange

3. Configure your app in miniOrange

Note:

4. Setup Multiple IDPs (Optional)

External References

Want To Schedule A Demo?

STAY CONNECTED

Contents

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

Get Free Installation Help

1. Configure miniOrange as SP in Keycloak

2. Configure Keycloak as IDP in miniOrange

Test Connection

2. Configure Keycloak as IDP in miniOrange

3. Configure your app in miniOrange

Note:

4. Setup Multiple IDPs (Optional)

External References

Want To Schedule A Demo?

Strictly Necessary Cookies

Always Active

Performance Cookies

Always Active