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.
Connecting to Link
This topic documents how to set up connection between Keycloack and Link.

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.

Connecting to Link

This topic documents how to set up connection between Keycloack and Link.

Procedure

Install the Link to connect to Keycloak.
In Keycloak, make sure that Keycloak Auth Enabled is set to true.

In text editor, open hip-server.env to confirm the connectivity information. You can see the below information and update as appropriate to your environment:

# Flag indicating if keycloak is used for identity & access management
HIP_KEYCLOAK_AUTH_ENABLED=true
# Keycloak server url
HIP_KEYCLOAK_SERVER_URL=http://localhost:XXXX/auth
# Keycloak realm id
HIP_KEYCLOAK_REALM_ID=link
# Keycloak client id for making rest calls
HIP_KEYCLOAK_CLIENT_ID=link-rest
# Associated client secret for above client id
HIP_KEYCLOAK_CLIENT_SECRET=94a30704-7694-476c-b9c2-5fb78d151892

Log in to Link using Keycloak or LDAP user credentials as configured. To unlock the maps if they are locked, go to Administration in Link and delete locks held by a user.