doc: default role for first time OIDC user login, SH-1032

gatling · Nov 13, 2024 · a1728a4 · a1728a4
1 parent fc4488e
commit a1728a4
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 9 deletions.
diff --git a/self-hosted-legacy/install/server/configuration/includes/frontline.conf b/self-hosted-legacy/install/server/configuration/includes/frontline.conf
@@ -105,5 +105,7 @@ frontline {
         # lastname: "family_name"
         # email: "email"
       }
+      # default role when user connects for the first time: none, viewer, tester, testAdmin and systemAdmin
+      # defaultRole = viewer
     }
 }
diff --git a/self-hosted-legacy/install/server/manual/index.md b/self-hosted-legacy/install/server/manual/index.md
@@ -447,6 +447,8 @@ oidc {
     # lastname: "family_name" <9>
     # email: "email" <10>
   }
+  # default role when user connects for the first time: none, viewer, tester, testAdmin and systemAdmin
+  # defaultRole = viewer <11>
 }
 ```
 
@@ -465,6 +467,9 @@ Fill the following fields if you want to enable OpenID authentication on Gatling
 
 There's no default value for those attributes, they must all be defined in the configuration file.
 
+* <11> defaultRole for the role a user logging in for the first time will have (the default value is `viewer` for backward compatibility)
+
+
 ```hocon
 grafana {
   #url = "http://localhost:3008/dashboard/db/frontline-requests" <1>
@@ -505,6 +510,7 @@ Gatling Enterprise is able to use OpenID connect to manage its users. The OpenID
 Configuration is described above under _oidc_.
 
 By default, all registered users can connect as a global viewer and need an administrator to configure their permissions.
+You can change the default role by modifying the corresponding `defaultRole` attribute.
 
 ##### Sample OpenID configuration on Azure
 
@@ -525,11 +531,12 @@ oidc {
   scopes = ["email", "profile"]
   jwksRefreshFrequency = 1440
   mapping {
-    username: "email"
-    firstname: "given_name"
-    lastname: "family_name"
-    email: "email"
+    username = "email"
+    firstname = "given_name"
+    lastname = "family_name"
+    email = "email"
   }
+  defaultRole = viewer
 }
 ```
 
@@ -554,11 +561,12 @@ oidc {
   scopes = ["email", "profile"]
   jwksRefreshFrequency = 1440
   mapping {
-    username: "email"
-    firstname: "given_name"
-    lastname: "family_name"
-    email: "email"
+    username = "email"
+    firstname = "given_name"
+    lastname = "family_name"
+    email = "email"
   }
+  defaultRole = viewer
 }
 ```
 

diff --git a/self-hosted-legacy/release-notes/1.23.md b/self-hosted-legacy/release-notes/1.23.md
@@ -48,4 +48,3 @@ See release notes [3.13.1](https://github.com/gatling/gatling/milestone/129?clos
 #### Features
 
 * SH-1032: OIDC: Introduce `defaultRole` conf option to define the default role of new users. Defaulting to `viewer`. Can be set to `none` to remove all default permissions.
-*