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.
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.
Creating a Realm
This topic documents how to create a realm.

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.
      - Creating a Realm
        This topic documents how to create a realm.
      - Configuring Clients
        This topic documents how to configure clients.
      - Connecting to Link
        This topic documents how to set up connection between Keycloack and Link.
    - 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.
    - 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.
- Account recovery
  These instructions describe how to use the Administrators' account recover utility to recover account information for both Windows and Linux accounts.

Creating a Realm

This topic documents how to create a realm.

Procedure

Log in to the Keycloak Admin Console.
Click on the Select realm drop-down and click on Add realm button. The Add realm page opens.
Import the realm-export.json file from the installation directory. When you import the realm-export.json, it will automatically configure all the settings of realm. You can edit the configuration settings as required.
Specify the name of realm in the Name field. Default value is link.
Click on Create button to create a realm.

The realm is created with link name.
Note: To facilitate easy setup, Link includes the realm-export.json file for Keycloak server. You can modify before import as required for your environment or create your own configuration not using the realm-export.json file that best suits your requirements.