Skip to main content

Overview

This integration guide describes how to use Microsoft Active Directory Federation Services (AD FS) as an Identity Provider (IdP) for the ILM platform and enable SSO. AD FS is integrated using Security Assertion Markup Language 2.0. The platform is internally using OIDC and Keycloak is used as a bridge and mapping of user attributes between AD FS and platform.

This integration guide was tested using:

  • Keycloak version 24
  • AD FS 3.0
SAML 2.0

Security Assertion Markup Language 2.0 (SAML 2.0) is a version of the SAML standard for exchanging authentication and authorization identities between security domains. SAML 2.0 is an XML-based protocol that uses security tokens containing assertions to pass information about a principal (usually an end-user) between a SAML authority, named an Identity Provider, and a SAML consumer. The assertions are digitally signed and can be verified with the public key and certificate of the SAML authority.

Active Directory Federation Services presence​

Before you start with the integration, make sure that you have AD FS installed and configured. If you don't have AD FS installed, you can follow the official Microsoft documentation on how to Install Active Directory Federation Services.

Prerequisites​

We assume that the integration is done using existing Keycloak. Although any OpenID Connect (OIDC) enabled provider can be used with the platform, there is an existing Keycloak integration using Helm chart.

Be sure that you provider is properly configured and integrated with the platform. For more information, see integration guide on Keycloak Authentication Server.

Integration​

Integration consists of the following steps:

#StepDescription
1Configure KeycloakConfigure AD FS as SAML 2.0 IdP for Keycloak, define attribute mappings and export SAML XML metadata for AD FS.
2Configure AD FSImport SAML metadata from Keycloak, establish trust and define attribute mappings for the platform.
3Configure ILMOptionaly configure automatic creation of users and roles.

Login using AD FS​

The identity-provider Display name configured in Keycloak determines the sign-in option shown to users. For the example in this guide, the option is AD FS.

  1. Open the ILM administrator interface and choose the configured OIDC sign-in method.
  2. On the Keycloak sign-in page, choose the AD FS identity provider by its configured display name.
  3. Authenticate with AD FS. Keycloak maps the returned SAML claims and completes the platform's OIDC sign-in.
  4. Verify that the expected user attributes and roles are available in ILM.
AD FS sign-in through the Keycloak identity broker

AD FS sign-in through the Keycloak identity broker

100%Scroll to explore · Esc to close
AD FS sign-in through the Keycloak identity broker
AD FS sign-in through the Keycloak identity broker
Open full diagram ↗

The sign-in method and provider labels depend on your deployment configuration. The protocol relationships and field values in this guide remain the reference when a user-interface layout changes.

Troubleshooting​

For common issues and troubleshooting, refer to Troubleshooting.

References​