Home
Administration
Here you will find the tasks that are required for administration of your HCL Link product.
Keycloak
This documentation describes about the Keycloak functionality.
User Administration
After you install Keycloak, you must consider how the software manages users and authentication.
LDAP User Authentication
You are using a Lightweight Directory Access Protocol and Active Directory HTTP server to manage users and authentication. You want to know the best practices to use that LDAP/AD server to manage user access to Link.
User synchronization
You must import all users from your LDAP/AD user database by using the option to Synchronize all users. Users are imported based on your saved settings when you set up your LDAP/AD provider.

Administration
Here you will find the tasks that are required for administration of your HCL Link product.
- User Management
  HCL Link provides inbuilt support for managing users who may create, deploy and run integrations.
- Keycloak
  This documentation describes about the Keycloak functionality.
  - Introduction
    Keycloak is an open-source identity and Access Management solution. It is a single sign-on security application for web applications and RESTful web services. Link and Runtime REST API supports Keycloak solution of user administration and authorization.
  - Installation
    To install Keycloak refer to the latest “Getting Started” documentation available on the Keycloak product website.
  - User Administration
    After you install Keycloak, you must consider how the software manages users and authentication.
    - Default User Administration
      Keycloak uses the concept of a realm to manage and authenticate users. When you install the Keycloak server, a realm called testserver is created for you in Keycloak. All server users belong to this realm and when they log in to the server, they log into that realm.
    - LDAP User Authentication
      You are using a Lightweight Directory Access Protocol and Active Directory HTTP server to manage users and authentication. You want to know the best practices to use that LDAP/AD server to manage user access to Link.
      - Selecting LDAP provider in Keycloak
        You can use the Keycloak Admin Console to add an LDAP/AD provider.
      - Required settings for a successful connection to your LDAP/AD provider
        The form includes many fields and several fields include default values.
      - User synchronization
        You must import all users from your LDAP/AD user database by using the option to Synchronize all users. Users are imported based on your saved settings when you set up your LDAP/AD provider.
      - Mappers
        Keycloak uses mappers to map the user attributes defined in the Keycloak user model such as username and email to the corresponding user attributes in the LDAP/AD user database. By default, when you saved your settings and created your LDAP/AD provider, the following mappers were created.
    - Runtime REST API
      Runtime REST API supports Keycloak authentication of user credentials for running maps and flows. Like Link, Runtime REST API can be configured to authenticate users with Keycloak.

User synchronization

You must import all users from your LDAP/AD user database by using the option to Synchronize all users. Users are imported based on your saved settings when you set up your LDAP/AD provider.

A successful import is followed by a success message with the number of users imported. A failed import typically results when there is a mismatch between user attributes in the Keycloak user database and the LDAP/AD user database.

You can view all the LDAP/AD database users that were imported and authenticated from the Users page in the Keycloak Admin Console.

Users are listed with ID, Username, Email, Last Name, and First Name. The ID is generated by Keycloak. The value of the other attributes is fetched from the LDAP/AD user database by using mappers.