Skip to main content

JSON Web Token based authentication for Django REST framework

Project description

REST framework JWT Auth (FORK)

Added a possibility to use custom User model. So that it is possible have several User models at the same project and keep authentication flow separately from each other.


  1. Extend `rest_framework_jwt.authentication.JSONWebTokenAuthentication` and define which user model it should use.

    from rest_framework_jwt import authentication
    class MyJWTAuthentication(authentication.JSONWebTokenAuthentication):
        user_model = 'some_app.SomeUserModel'
  2. Define views that manipulate the token and tell them which user model to use. e.g.:

    from rest_framework_jwt.views import ObtainJSONWebToken, RefreshJSONWebToken
    obtain_jwt_token = ObtainJSONWebToken.as_view(user_model='some_app.SomeUserModel')
    urlpatterns = router.urls + [
        url(r'^api-token-auth/', obtain_jwt_token, name='auth-jwt-get'),
  3. Use your authentication class in your views.

    class TestView(ViewSet):
        authentication_classes = (MyJWTAuthentication, )

If you don’t want to use default `django.contrib.auth.authenticate` which is using backends defined at `settings.AUTHENTICATION_BACKENDS` for all users, you need to write your own authentication handler and tell `JSONWebTokenSerializer` to use it by overriding `JSONWebTokenSerializer.authenticate` method.

class MyJWTSerializer(serializers_jwt.JSONWebTokenSerializer):

    def authenticate(self, **credentials):
        return my_authenticate(**credentials)

# your obtain token view then will look like this
obtain_jwt_token = ObtainJSONWebToken.as_view(
urlpatterns = router.urls + [
   url(r'^api-token-auth/', obtain_jwt_token, name='auth-jwt-get'),

REST framework JWT Auth

build-status-image pypi-version

JSON Web Token Authentication support for Django REST Framework

Full documentation for the project is available at docs.


This package provides JSON Web Token Authentication support for Django REST framework.

If you want to know more about JWT, check out the following resources:


  • Python (2.7, 3.3, 3.4, 3.5)
  • Django (1.8, 1.9, 1.10, 1.11)
  • Django REST Framework (3.1, 3.2, 3.3, 3.4, 3.5, 3.6)


Install using pip

$ pip install djangorestframework-jwt

Documentation & Support

Full documentation for the project is available at docs.

You may also want to follow the author on Twitter.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for djangorestframework-jwt-custom-user, version 1.11.1
Filename, size File type Python version Upload date Hashes
Filename, size djangorestframework-jwt-custom-user-1.11.1.tar.gz (10.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page