Keycloak Start-Up Guide

This guide details the minimal requirements on a new Keycloak installation.

As part of this guide, we will create two Keycloak clients, one for Universal Controller and one for Universal Portal. We will use the master realm for simplicity.

info

Keycloak terminology differs from other identity providers. Keycloak refers to OAuth applications as Clients and refers to namespaces as Realms. Within the context of realms, there are clients (applications), users, groups, and so on.

Prerequisites

Before beginning, make sure you meet the following requirements:

• You have administrator access to Keycloak.
• You have administrator access to Universal Controller.
• Universal Portal is installed, and you have the signin URL.
• Keycloak host is accessible to Universal Controller.
• Keycloak host is accessible to Universal Portal users.

Steps

This guide has four main steps that must be completed in order:

1. Create a Keycloak Client for Universal Controller.
2. Create a Keycloak Client for Universal Portal.
3. Note the Issuer URL for the master realm.
4. Configure OAuth settings in Universal Controller.

Example values for many fields are provided throughout these steps, but your production settings may vary. This guide assumes that:

• Keycloak is deployed on localhost:8080.
• Universal Controller is deployed on localhost:7900.
• Universal Portal is deployed on localhost:5173.

Where your configurations differ, change these values accordingly.

tip

Universal Portal can be deployed to the same port as Universal Controller, depending on the deployment method used for installation.