Keycloak Preparation

This section provides detailed information about how to prepare the Keycloak server to be able to accept connection from ProconTEL 4.

How to prepare Keycloak

1. Add required realm roles
   • Add two "realm roles", pct-admin and pct-user. These roles are needed for ProconTEL 4 UI access management.
   • Each user must be assigned to at least one of the two roles.
   • The pct-admin user, unlike the pct-user, has access to "external users" management.

How to create and assign roles

1. In the Keycloak Administration Console, open your realm.
2. Go to Realm roles.
3. Select Create role.
4. Create the pct-admin role.
5. Create the pct-user role.
6. Go to Users and open the user that should be able to sign in to ProconTEL 4.
7. Open the Role mapping tab.
8. Assign pct-user to regular users.
9. Assign pct-admin to administrator users.
10. A user may have both roles assigned if required by your access model.
11. Save the changes and make sure the user signs out and signs in again to receive an updated token.

Expected role mapping in ProconTEL 4

• pct-user is mapped to the ProconTEL role user.
• pct-admin is mapped to the ProconTEL role admin-external.

2. Realm roles configuration

   • Check if client scopes contain the right configuration as below.
   • In main menu go to: "Client scopes" -> "Roles" -> "Mappers" -> "realm roles".
   • Check if your configuration is the same as below.
     

3. Client configuration

   • In main menu go to: "Clients" and select "your client".
   • Check if "Valid redirect URIs" is assigned to PCT4 main Uri.
   • Check if "Capability config" is configured as below.

Importing the "Client" configuration

Optionally, it is possible to import the "Client" configuration from a file available at pct4client.json. To import the configuration:

• Download the config file.
• In main menu go to: "Clients" then select "Import Client".