Skip to main content

Additions for Django Rest Framework Simple JWT

Project description

DRF SimpleJWT additions

Additional features for django-rest-framework-simplejwt.


Features

  • Full user info in TokenObtainPairSerializer
  • Full user info in TokenObtainPairView
  • Auto creation of user from token

Installation

pip install drf-simplejwt-additions

Usage

Note: for all these features you need to set same SECRET_KEY and SIMPLE_JWT['ALGORITHM'] in all services.

Full user info in TokenObtainPairSerializer

In settings.py:

INSTALLED_APPS = [
    ...
    'drf_simplejwt_additions',
    ...
]
  
...
  
SIMPLE_JWT = {
    ...
    "TOKEN_OBTAIN_SERIALIZER": "drf_simplejwt_additions.serializers.TokenObtainPairWithFullUserSerializer",
    ...
}

From now on, the response of the TokenObtainPairView will contain the full user info.
Serializer get all fields from the user model.
Then theses fields are added to the response in the user field.

User's password is also added to the response. But it's encrypted twice:

  • First time by Django itself
  • Second: JWT encryption

Auto creation of user from token

This feature is useful in microservices architecture. Token, obtained from one service, can be used in another service to get user info. So, if the user doesn't exist in the second service, it will be created automatically.

In settings.py:

INSTALLED_APPS = [
    ...
    'drf_simplejwt_additions',
    ...
]

...

MIDDLEWARE = [
    ...
    'drf_simplejwt_additions.middleware.AutoCreateUserFromTokenMiddleware',
    ...
]

...

REST_FRAMEWORK = {
    ...
    'DEFAULT_AUTHENTICATION_CLASSES': (
        ...
        'rest_framework_simplejwt.authentication.JWTAuthentication',
        ...
    ),
    ...
}

django-rest-framework-simplejwt has great feature: TokenUserAuthentication. But it doesn't create user automatically.


Full user info in TokenObtainPairView

In urls.py:

from drf_simplejwt_additions.views import TokenObtainPairWithFullUserView

urlpatterns = [
    ...
    path('api/token/', TokenObtainPairWithFullUserView.as_view(), name='token_obtain_pair'),
    ...
]

The TokenObtainPairWithFullUserView is a subclass of TokenObtainPairView with the TokenObtainPairWithFullUserSerializer serializer.


License

MIT

Project details


Download files

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

Source Distribution

drf-simplejwt-additions-1.1.3.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

drf_simplejwt_additions-1.1.3-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file drf-simplejwt-additions-1.1.3.tar.gz.

File metadata

  • Download URL: drf-simplejwt-additions-1.1.3.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for drf-simplejwt-additions-1.1.3.tar.gz
Algorithm Hash digest
SHA256 70e09c325639af3d47fb201a210e7e60b2de15dfd1768abbd23d7e73139c3af5
MD5 6232a933d7d21053734d57a4f513b10a
BLAKE2b-256 6f47b0d4597e341ac048add9ad13ef614fc7421da069156201945d55fd9071bc

See more details on using hashes here.

File details

Details for the file drf_simplejwt_additions-1.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for drf_simplejwt_additions-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 591d06a2007ed704ce9e50c32dc7ff9d54641d8bf9ae131d6144ef7f0f9d1a13
MD5 f1253e350564ec95d58e15f3c628c70e
BLAKE2b-256 6b877080bad80c0e0b732459225f3cd68f012bdd80e1b21b8ffd98771500ef7f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page