Advertising sustains the DA. Ads are hidden for members. Join today

Keycloak SSO Login

Last updated on
11 March 2024

This document will help you configure Keycloak as a Service Provider (SP) making Drupal as your Identity Provider (IDP). Following these steps will allow you to configure SAML SSO between Keycloak and your Drupal site such that your users will be able to log in to Blackboard using their Drupal credentials.

The Drupal SAML IDP 2.0 Single Sign-On (SSO) module is compatible with Drupal 7, Drupal 8, Drupal 9, and Drupal 10.

Prerequisite:

Drupal SAML IDP Metadata:

  • After installing the module on your Drupal site, in the Administration menu, navigate to Configuration -> People -> miniOrange SAML IDP Configuration. (/admin/config/people/miniorange_saml_idp/idp_setup)

    Configuration-Drupal-Select-miniOrange-SAML-IDP-Configuration

  • Under the IDP Metadata tab, copy the Metadata URL. Keep it handy(This is needed to configure Keycloak as SAML SP).

    Drupal-Copy-Meta-Data-URL

Configure SAML SSO Application in Keycloak:

  • Navigate to the Keycloak admin console and log in using your Keycloak credentials.
  • Next, go to the Identity providers from the left panel and select SAML v2.0.

Drupal SAML IDP select identity providers from keycloak

  • Download the SAML 2.0 Service Provider Metadata and keep it handy for configuring Drupal.

Drupal SAML IDP copy metadata from keycloak

Configure Drupal as SAML Identity Provider (IdP):

  • Navigate to the Drupal site and switch to the Service Provider Setup tab of the miniOrange SAML IDP module and click on the Upload SP metadata to expand it.

Drupal SAML IDP upload metadata expand

  • Now upload the metadata file in Upload Metadata text field which was downloaded from Keycloak SSO Application. Click the Upload button.

Drupal-saml-idp-upload-metadata

Configure IDP Metadata:

  • Go back to the Keycloak, enter the Display name, and paste the copied IDP Entity ID and SAML Login URL in the respective fields.
  • Once done click on the Save button.

Drupal SAML IDP paste IDP metadata

Test Connection between Keycloak and Drupal:

  • Go to the Clients from the left panel and copy the Home URL.

Drupal SAML IDP copy home url

  • Now, open a private browser or incognito window and paste the copied URL.
  • Click on the Sign in button.

Drupal SAML IDP click on sign in

  • Login with your application link.

Drupal SAML IDP test configuration

  • You will be redirected to the Drupal user login page. Login with your Drupal credentials.
  • You will have successfully signed in to Keycloak.

Drupal SAML IDP keycloak login successful

You have successfully set up Blackboard as Service Provider and Drupal as Identity Provider.

Need assistance? Contact our 24*7 support team

If you face any issues or if you have any questions, please feel free to reach out to us at 24*7 support by clicking on Support Icon from the bottom right corner. In case you want some additional features to be included in the module, please get in touch with us, and we can get that custom-made for you.

Also, if you are looking for some other Service Provider, click here to check out the step-by-step guides for the other Service providers.

You can also join us on Drupal Slack in the #miniorange channel.

Get In Touch With Us Join Our Slack Channel

back to top Back to top

Help improve this page

Page status: No known problems

You can: