Keycloak Configuration

This document covers the setup for importing the pre-configured realm in Keycloak.

1. For release HC 4.1 or backward download the realm-export.json file and place it in any directory of your choice.
2. For release CX-4.1 and onwards download the realm-export-4.1-onwards.json file and place it in any directory of your choice.
3. For release CX-4.3 and onwards download the realm-export-4.3.json file and place it in any directory of your choice.
4. If you've not imported the realm and its users using the above realm file & upgrade script, then you can create a realm, client, roles, and an admin user following these steps:
   Login to the KeyCloak Administration console by browsing the https://server-fqdn/auth. 
   
   

   

   Go to link
5. Login to the administration console using the password set in environment variables (KEYCLOAK_USERNAME and KEYCLOAK_PASSWORD). Default username is admin and password is admin.
   
6. Bring cursor to master realm and click on Add realm button.
   
   

   

7. Click on the Select file button and select the realm-export.json file downloaded in step 1 and press Create.
   
   

   

   
   
   
   
8.  This will create the expertflow realm with all required configuration.
   
   

   

   
   
   
9. Once realm is imported, we need to create create the users in our example agent/supervisor and admin. To create user click on Users from left nav bar.
   
   

   

   
   
   
10. Once user is created, we can see additional fields at top (Details, Attributes, Credentials). Now select Credentials tab and click on Set Password button.  Type password of your choice, also turn Temporary to off
    
    

    

    
    
      
11. To assign the roles to user, click on Role Mappings tab on top and click on Assign Role Button. In pop up window we can see admin, agent and supervisor roles, for agent user assign agent role and for supervisor user assign supervisor role.
    
    

    

    
    
    
12. For admin-user first select the admin from Roles and click on Assign button. This will create the admin user in Keycloak.
    
    

    

    
    
    
13. Select the admin user from users list and click on Assign Role Button.
    
    

    

    
    
    
14. Select the Filter by clients filter and search all realm-management roles. Select all realm-management roles and click on Assign button.
    
    

    

    
    
    
15. To assign Groups to user, click on Groups from left nav bar. You can see list of all the Groups available
    
    

    

    
    
    
16. Click on Group you want to add user in. Once in Group Settings, click on members tab
    
    

    

    
    
    
17. Click on Add member, select the user you want to add and click Add
    
    

    

    
    
    
    

18. we can see newly added user in Members of Group. Similarly add user in agents_permission Group.
    
    

    

    
    
    

19.  Follow Keycloak User's Teams Configuration guide to create and assign users in team.
    

Additional Documents

     Following are the files for Setup of AgentDesk Permissions and Teams in Keycloak.

1. AgentDesk Permissions Document link: AgentDesk Permissions Setup in Keycloak:
   
2. Keycloak Version 20 or greater setup link: Configure Keycloak for Client Application (Version 20 and above):
   
3. Keycloak API Developer Guide (Setup of older version and Keycloak NodeJS Adapter Setting) link: Keycloak API Developer Guide
4. Keycloak VRS Setup Document link: Setup Keycloak for VRS
5. New permissions Upgrade path / User import script: Script to Upgrade the realm with users being intact
6. Keycloak-Superset Configuration Setup Document Link: Using Keycloak for Superset Authentication