[pgadmin4] Add Microsoft OAuth example with OIDC support (#234)

OIDC allows to use server side claim filtering via information provided in the token. See https://learn.microsoft.com/en-us/security/zero-trust/develop/configure-tokens-group-claims-app-roles and pgAdmin documentation for more information. This funcionality requires at least pgAdmin4 version 8.0. Signed-off-by: Vilius Šumskas <[email protected]>
rowanruseler · Jan 5, 2024 · bc87077 · bc87077
1 parent d619d95
commit bc87077
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/charts/pgadmin4/Chart.yaml b/charts/pgadmin4/Chart.yaml
@@ -1,8 +1,8 @@
 apiVersion: v1
 description: pgAdmin4 is a web based administration tool for PostgreSQL database
 name: pgadmin4
-version: 1.19.0
-appVersion: "7.8"
+version: 1.20.0
+appVersion: "8.1"
 keywords:
   - pgadmin
   - postgres

diff --git a/charts/pgadmin4/examples/add-oauth2-config.yaml b/charts/pgadmin4/examples/add-oauth2-config.yaml
@@ -92,5 +92,22 @@ data:
         'OAUTH2_SCOPE': 'User.Read',
         'OAUTH2_ICON': 'fa-microsoft',
         'OAUTH2_BUTTON_COLOR': '#0000ff',
+      },
+      {
+        'OAUTH2_NAME': 'microsoft-oidc',
+        'OAUTH2_DISPLAY_NAME': 'Microsoft OIDC',
+        'OAUTH2_CLIENT_ID': os.environ['OAUTH2_CLIENT_ID'],
+        'OAUTH2_CLIENT_SECRET': os.environ['OAUTH2_CLIENT_SECRET'],
+        'OAUTH2_TOKEN_URL': 'https://login.microsoftonline.com/{YOUR_TENANT_ID}/oauth2/v2.0/token',
+        'OAUTH2_AUTHORIZATION_URL': 'https://login.microsoftonline.com/{YOUR_TENANT_ID}/oauth2/v2.0/authorize',
+        'OAUTH2_SERVER_METADATA_URL': 'https://login.microsoftonline.com/{YOUR_TENANT_ID}/v2.0/.well-known/openid-configuration',
+        'OAUTH2_API_BASE_URL': 'https://graph.microsoft.com/v1.0/',
+        'OAUTH2_USERINFO_ENDPOINT': 'https://graph.microsoft.com/oidc/userinfo',
+        'OAUTH2_SCOPE': 'openid profile email',
+        'OAUTH2_ICON': 'fa-microsoft',
+        'OAUTH2_BUTTON_COLOR': '#0000ff',
+        'OAUTH2_ADDITIONAL_CLAIMS': {
+          'groups': ["{LIST_OF_YOUR_GROUP_GUIDS}"],
+        }
       }
     ]