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.
Required settings for a successful connection to your LDAP/AD provider
The form includes many fields and several fields include default values.

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.

Required settings for a successful connection to your LDAP/AD provider

The form includes many fields and several fields include default values.

Procedure

Click on the ldap provider to open the settings to configure.
In the Settings tab, select Active Directory from the drop-down list of Vendor. Many fields complete with default values based on this selection.
Enter your LDAP/AD URL to connect to your LDAP/AD user database, for example: ldap://<hostname>.<domain>
Click on Test connection button to test the connection and confirm that the connection is successful.
Provide the directory where the LDAP users are listed, for example: cn=Users,dc=MYCOMPANY,dc=COM.
From the Bind Type drop-down list, select Simple option.
Provide the LDAP/AD user database administrator user ID for BIND DN and password for the BIND Credential. These credentials are used by Keycloak to access the LDAP/AD user database.
Click on Test Authentication button to test the authentication and confirm that the authentication is successful.
Click on Save button to save the configuration.