Merge pull request #707 from minrk/doc-group-claim

clarify what claim_groups_key is used for
jupyterhub · Nov 28, 2023 · 280b988 · 280b988
2 parents f3cc739 + c2fb51e
commit 280b988
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/oauthenticator/generic.py b/oauthenticator/generic.py
@@ -25,6 +25,10 @@ def _login_service_default(self):
 
         Can be a string key name (use periods for nested keys), or a callable
         that accepts the returned json (as a dict) and returns the groups list.
+
+        This configures how group membership in the upstream provider is determined
+        for use by `allowed_groups`, `admin_groups`, etc.
+        It has no effect on its own, and is not related to users' _JupyterHub_ group membership.
         """,
     )