Connecting Runtime REST API server

This topic documents how to set up connection between Keycloak and Runtime REST API server.

  1. Install Design Studio or Runtime & Monitoring.
  2. In Keycloak, make sure that Keycloak Auth Enabledis set to true.
  3. In text editor, open tx-rest.properties to confirm the connectivity information. You can see the below information and update as appropriate to your environment:
    #Flag indicating whether Keycloak is enabled for identity & access management
    authentication.keycloak.enabled=true
    #Keycloak specific properties
    authentication.keycloak.serverUrl=http://localhost:8080/auth
    authentication.keycloak.realmId=itx
    authentication.keycloak.clientId=itx-runtime-rest
    authentication.keycloak.clientSecret=9465403f-0ae6-4cfd-98fb-ecdf8c4485ed
    
  4. Run Runtime REST API server to service REST client calls.
  5. REST clients invoking the Runtime REST API should include the user credentials that can be authenticated with Keycloak to run the maps or flows, or to fetch any runtime information.