username as default self-hosted field for current_user() (#1200)

Author: adehad

jira/client.py

@@ -3846,15 +3846,15 @@ def backup_download(self, filename: str = None):
         return None
 
     def current_user(self, field: Optional[str] = None) -> str:
-        """Returns the username or emailAddress of the current user. For anonymous
-        users it will return a value that evaluates as False.
+        """Return the `accountId` (Cloud) else `username` of the current user.
+        For anonymous users it will return a value that evaluates as False.
 
         Args:
             field (Optional[str]): the name of the identifier field.
-              Defaults to "accountId" for Jira Cloud, else "key"
+              Defaults to "accountId" for Jira Cloud, else "username"
 
         Returns:
-            str
+            str: User's `accountId` (Cloud) else `username`.
         """
         if not hasattr(self, "_myself"):
 
@@ -3865,7 +3865,9 @@ def current_user(self, field: Optional[str] = None) -> str:
             self._myself = r_json
 
         if field is None:
-            field = "accountId" if self._is_cloud else "key"
+            # Note: For Self-Hosted 'displayName' can be changed,
+            # but 'name' and 'key' cannot, so should be identifying properties.
+            field = "accountId" if self._is_cloud else "name"
 
         return self._myself[field]