Skip to main content

A Django app to authenticate by api_key and api_secret

Project description

Django REST Framework API Auth

Django REST Framework API Auth is a secure API Key and Secret authentication plugin for REST API built with Django Rest Framework.

Quickstart

1 - Install with pip:

pip install drf-api-ath

2 - Register the app in the INSTALLED_APPS in the settings.py file:

# settings.py

INSTALLED_APPS = [
  # ...
  "rest_framework",
  "drf_api_auth",
]

4 - Run migrations:

python manage.py migrate

In your view then, you can add the authentication class.

⚠️ Important Note: By default, authentication is performed using the AUTH_USER_MODEL specified in the settings.py file.

from rest_framework import viewsets

from drf_api_auth.authentications import ApikeyAuthentication
from rest_framework.response import Response


class TestViewSets(viewsets.ViewSet):
  authentication_classes = (ApikeyAuthentication,)

  def list(self, request):
    return Response([{"message": "Ok"}], 200)

TODO

  • Prevent save api_key as clear text
  • Toggling (show/hide) for api_key admin field

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_api_auth-0.1.5.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

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

drf_api_auth-0.1.5-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file drf_api_auth-0.1.5.tar.gz.

File metadata

  • Download URL: drf_api_auth-0.1.5.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for drf_api_auth-0.1.5.tar.gz
Algorithm Hash digest
SHA256 a2e7ede53ef56f909ab9bcc3fa53e8faf980bf3ed5f43b1414090b784dc90b28
MD5 0037098c2f537d5b4258ea39c8278a94
BLAKE2b-256 07b47808503e615af6d9528abe6bebd7bab3264ec537b9232b7f80d3b910adaa

See more details on using hashes here.

File details

Details for the file drf_api_auth-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: drf_api_auth-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for drf_api_auth-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 378d3412fbcda29d9061f3fea0f662707a6b080ad1f0b93b824267a324346a2c
MD5 5bcab67eb7347dfa6d8f06d2131243b5
BLAKE2b-256 3ba773db9e2065601fdafc47fa6db39acc8cc5e405a15f048fe8709e85f242f8

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