Keycloak as IdP – SAML

Step 1: Set Up Keycloak as Identity Provider

Select Keycloak version:

Keycloak Single Sign-On | miniorange img Configure Keycloak as IdP

    • In your Keycloak Admin console, select the realm that you want to use.
    • Click on Clients from the left menu and then click on Create button to create a new client/application.
      • Keycloak Single Sign-On | Creating an APP
    • Enter SP-EntityID / Issuer as the Client ID from the "Service Provider Metadata" Tab and select SAML as the Client Protocol.

      • Keycloak SSO | Add Client
    • Now click on Save.
    • Configure Keycloak by providing the required details:

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

      Keycloak Single Sign-On | Settings Keycloak Login | Settings
    • Under Fine Grain SAML Endpoint Configuration, Enter the following details:

      • Assertion Consumer Service POST Binding URL The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab
      Logout Service Redirect Binding URL (Optional) The Single Logout URL from the plugin's Service Provider Metadata tab

      Keycloak Single Sign-On | SAML Endpoint Configuration
    • Click on Save.
    • In your Keycloak Admin console, select the realm that you want to use.
    • Click on Clients from the left menu and then click on Create Client button to create a new client/application.

      • Keycloak SSO | Creating an APP
    • Select SAML as Client type, Enter SP-EntityID / Issuer as the Client ID from the "Service Provider Metadata" Tab,Enter Name of your application and enter Description.

      • Keycloak SSO | Add Client
    • Now click on Save.
    • Configure Keycloak by providing the required details:

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

      Keycloak Single Sign-On | Keycloak Login - Settings Keycloak Single Sign-On | Keycloak Login - Settings Keycloak Single Sign-On | Keycloak Login - Settings
    • Now click on Save.
    • In Advanced tab, under Fine Grain SAML Endpoint Configuration, Enter the following details:

      • Assertion Consumer Service POST Binding URL The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab
      Logout Service Redirect Binding URL (Optional) The Single Logout URL from the plugin's Service Provider Metadata tab

      Keycloak Login | Login SAML Endpoint Configuration
    • Click on Save.
    • In your Keycloak Admin console, select the realm that you want to use.
    • Click on Clients from the left menu and then click on Create Client button to create a new client/application.

      • Keycloak SSO | Creating an APP / Client
    • Select SAML as Client type, Enter SP-EntityID / Issuer as the Client ID from the Service Provider Metadata tab, enter Name of your application and enter Description.

      • Keycloak SSO | Add Client in Keycloak IDP
    • Click on the Next button.
    • Provide the details as mentioned below:

      • 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

    • Click on Save button.

      • Keycloak Single Sign-On | Provide details in Keycloak IDP
    • In the Settings tab under SAML capabilities section, configure Keycloak by providing the required details:

      • Force POST Binding OFF
      Force Name ID Format OFF
      Name ID Format Email

      Keycloak SSO | Keycloak Login - Settings tab configuration
    • In the Keys tab, disable the Client signature required toggle.

      • Keycloak SSO | Disable Client signature required
    • Click on the Save button.
    • In Advanced tab, under Fine Grain SAML Endpoint Configuration, enter the following details:

      • Assertion Consumer Service POST Binding URL The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab
      Logout Service Redirect Binding URL (Optional) The Single Logout URL from the plugin's Service Provider Metadata tab

      Keycloak SSO | Advanced tab configuration
    • Click on Save button.

Keycloak Single Sign-On | miniorange img Add Mappers

    • Navigate to Mappers tab and click on Add Builtin button.

      • Keycloak SSO | Mappers Tab
    • Select the checkboxes of X500 givenName, X500 surname and X500 email attributes.

      • Keycloak Login | Add built-in protocol mapper
    • Click on Add Selected button. You will see the mappings that are added below.

      • Keycloak Single Sign-On | Add Selected
    • In Client scopes tab,click on your application.

      • Keycloak SSO | click on application
    • Click on Add predefined mapper.

      • Keycloak Single Sign-On | Add predefined mapper
    • Select the checkboxes of X500 givenName, X500 surname and X500 email attributes.

      • Keycloak SSO | select checkboxes
    • Click on Add button.
    • You will see the mappings that are added below.

      • Keycloak Single Sign-On | mappings
    • In the Client scopes tab, click on your application.

      • Keycloak SSO | Client scopes
    • Click on Add predefined mapper.

      • Keycloak SSO | Add predefined mapper
    • Select the checkboxes of X500 givenName, X500 surname and X500 email attributes.

      • Keycloak SSO | Select the checkboxes
    • Click on the Add button.
    • You will see the mappings that are added below.

      • Keycloak SSO | See the mappings

Keycloak Single Sign-On | miniorange img Download setup file

    • Navigate to Realm Settings, click on SAML 2.0 Identity Provider Metadata mentioned as Endpoints in the General Tab.

      • Keycloak SSO | configure Settings
    • Note the URL and keep it handy. That will provide you with the Endpoints required to configure the plugin.
    • Navigate to Realm Settings, click on SAML 2.0 Identity Provider Metadata mentioned as Endpoints in the General Tab.
      • Keycloak Login | configure settings
    • Note the URL and keep it handy. That will provide you with the Endpoints required to configure the plugin.
    • Navigate to Realm Settings, click on SAML 2.0 Identity Provider Metadata mentioned as Endpoints in the General tab.
      • Keycloak Login | Realm settings endpoints
    • Note the URL and keep it handy. That will provide you with the Endpoints required to configure the plugin.