Support basic authentication with custom user models that change username field

rest_framework/authentication.py

@@ -8,7 +8,7 @@
 from django.utils.translation import ugettext_lazy as _
 from rest_framework import exceptions, HTTP_HEADER_ENCODING
 from rest_framework.authtoken.models import Token
-
+from rest_framework.compat import get_user_model
 
 def get_authorization_header(request):
     """
@@ -85,7 +85,16 @@ def authenticate_credentials(self, userid, password):
         """
         Authenticate the userid and password against username and password.
         """
-        user = authenticate(username=userid, password=password)
+        user_model = get_user_model()
+        if hasattr(user_model, 'USERNAME_FIELD'):
+            username_field = user_model.USERNAME_FIELD
+        else:
+            username_field = 'username'
+        credentials = {
+            username_field: userid,
+            'password': password
+        }
+        user = authenticate(**credentials)
 
         if user is None:
             raise exceptions.AuthenticationFailed(_('Invalid username/password.'))

rest_framework/compat.py

@@ -119,6 +119,14 @@ def get_model_name(model_cls):
         return model_cls._meta.module_name
 
 
+# Support custom user models in Django 1.5+
+try:
+    from django.contrib.auth import get_user_model
+except ImportError:
+    from django.contrib.auth.models import User
+    get_user_model = lambda: User
+
+
 # View._allowed_methods only present from 1.5 onwards
 if django.VERSION >= (1, 5):
     from django.views.generic import View