refactor(authentication-service): update urls and add scope for keycloak idp (#2176)

* refactor(authentication-service): update urls and add scope for keycloak idp

update urls and add scope for keycloak idp

BREAKING CHANGE:
yes

47

* refactor(authentication-service): add realm to kecloak host env

add realm to kecloak host env

BREAKING CHANGE:
yes

0

* docs(authentication-service): update readme for keycloak url changes

update readme for keycloak url changes

gh-0

---------

Co-authored-by: yeshamavani <[email protected]>

Author: Tyagi-Sunny

services/authentication-service/README.md

@@ -464,7 +464,7 @@ Authenttication service can be used as a identity server. Following endpoints ha
       <tr>
         <td>KEYCLOAK_HOST</td>
         <td>N</td>
-        <td>Hostname of the Keycloak instance</td>
+        <td>Hostname of the Keycloak instance. For all keycloak version below 17, user can still use this by only updating the KEYCLOCK_HOST and appending '/auth/realms' to its existing value</td>
         <td></td>
       </tr>
       <tr>

services/authentication-service/src/modules/auth/controllers/keycloak-login.controller.ts

@@ -64,9 +64,10 @@ export class KeycloakLoginController {
       //'e607fd75-adc8-4af7-9f03-c9e79a4b8b72',
       callbackURL: process.env.KEYCLOAK_CALLBACK_URL,
       //'http://localhost:3001/auth/keycloak-auth-redirect',
-      authorizationURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/auth`,
-      tokenURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/token`,
-      userInfoURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/userinfo`,
+      authorizationURL: `${process.env.KEYCLOAK_HOST}/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/auth`,
+      tokenURL: `${process.env.KEYCLOAK_HOST}/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/token`,
+      userInfoURL: `${process.env.KEYCLOAK_HOST}/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/userinfo`,
+      scope: process.env.KEYCLOAK_SCOPE ?? 'openid',
     },
     queryGen('body'),
   )
@@ -108,9 +109,10 @@ export class KeycloakLoginController {
       //'e607fd75-adc8-4af7-9f03-c9e79a4b8b72',
       callbackURL: process.env.KEYCLOAK_CALLBACK_URL,
       //'http://localhost:3001/auth/keycloak-auth-redirect',
-      authorizationURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/auth`,
-      tokenURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/token`,
-      userInfoURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/userinfo`,
+      authorizationURL: `${process.env.KEYCLOAK_HOST}/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/auth`,
+      tokenURL: `${process.env.KEYCLOAK_HOST}/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/token`,
+      userInfoURL: `${process.env.KEYCLOAK_HOST}/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/userinfo`,
+      scope: process.env.KEYCLOAK_SCOPE ?? 'openid',
     },
     queryGen('query'),
   )
@@ -149,9 +151,10 @@ export class KeycloakLoginController {
       //'e607fd75-adc8-4af7-9f03-c9e79a4b8b72',
       callbackURL: process.env.KEYCLOAK_CALLBACK_URL,
       //'http://localhost:3001/auth/keycloak-auth-redirect',
-      authorizationURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/auth`,
-      tokenURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/token`,
-      userInfoURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/userinfo`,
+      authorizationURL: `${process.env.KEYCLOAK_HOST}/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/auth`,
+      tokenURL: `${process.env.KEYCLOAK_HOST}/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/token`,
+      userInfoURL: `${process.env.KEYCLOAK_HOST}/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/userinfo`,
+      scope: process.env.KEYCLOAK_SCOPE ?? 'openid',
     },
     queryGen('query'),
   )