JSON Web Token based authentication for Django REST framework
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.
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'
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'), ]
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( user_model='some_app.SomeUserModel', serializer_class=MyJWTSerializer ) urlpatterns = router.urls + [ url(r'^api-token-auth/', obtain_jwt_token, name='auth-jwt-get'), ]
REST framework JWT Auth
JSON Web Token Authentication support for Django REST Framework
Full documentation for the project is available at docs.
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