diff --git a/oauthenticator/cilogon.py b/oauthenticator/cilogon.py index ea77d91d..39d942d8 100644 --- a/oauthenticator/cilogon.py +++ b/oauthenticator/cilogon.py @@ -314,7 +314,8 @@ def user_info_to_username(self, user_info): def _user_info_to_unprocessed_username(self, user_info): """ - Returns a username from + Returns a username from user_info without also applying the "action" + specified under "username_derivation" for the associated idp. """ user_idp = user_info["idp"] username_derivation = self.allowed_idps[user_idp]["username_derivation"] @@ -330,8 +331,8 @@ def _user_info_to_unprocessed_username(self, user_info): def _get_processed_username(self, username, user_info): """ - This method optionally adjusts a username from user_info based on the - "action" specified under "username_derivation" for the associated idp. + Optionally adjusts a username from user_info based on the "action" + specified under "username_derivation" for the associated idp. """ user_idp = user_info["idp"] username_derivation = self.allowed_idps[user_idp]["username_derivation"] diff --git a/oauthenticator/generic.py b/oauthenticator/generic.py index 26be3ab8..445e5ea6 100644 --- a/oauthenticator/generic.py +++ b/oauthenticator/generic.py @@ -84,6 +84,11 @@ def _default_http_client(self): ) def user_info_to_username(self, user_info): + """ + Overrides OAuthenticator.user_info_to_username to support the + GenericOAuthenticator unique feature of allowing username_claim to be a + callable function. + """ if callable(self.username_claim): username = self.username_claim(user_info) else: