hongquan / drf-body-token

REST authentication class to get token from HTTP body

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DRF Body Token

Provide a Django REST Framework authentication class, to look for token in HTTP request's body, instead of HTTP header.

This use case is uncommon and may be less secure, but some REST client application doesn't let customize HTTP header, and hence, user cannot set Authorization header. One such client is Blynk Webhook Widget.

Install

pip3 install drf-body-token

DRF Body Token only supports Python 3.5+.

Usage

Add BodyTokenAuthentication to authentication_classes atrribute of your viewset. Example:

from drf_body_token.authentication import BodyTokenAuthentication

class MyAwesomeViewSet(GenericViewSet):
    authentication_classes = (TokenAuthentication, BodyTokenAuthentication)

You can also add it to REST_FRAMEWORK['DEFAULT_AUTHENTICATION_CLASSES'] settings, to make it available for every viewset.

By default, BodyTokenAuthentication looks for access_token field in request's body. That body can be, for example:

{
    "name": "Cuckoo",
    "type": "bird",
    "access_token": "Vừng ơi mở ra"
}

If you want it to look for another field, add this to your settings.py file:

DRF_BODY_TOKEN_FIELD = 'your_field'

About

REST authentication class to get token from HTTP body

License:MIT License


Languages

Language:Python 100.0%