Skip to main content

Auth0 Authentication Backend for Django

Project description

django-auth0-auth

Authentication backend for Django with Auth0. As of June 2025, all of the libraries that I saw for Django Auth0 target old versions of Django, we'll start this by supporting version 5+ and python 3.11+ (3.10 only has 1 year of life). Also, some of these don't actually subclass Django's AuthBackend{.verbatim} and implement a login system that is more "beside" Django than integrated with it. Because this is fully integrated, we can use Django's built-in @login_required{.verbatim} decorator and it's auth Mixins.

This project is not affiliated with Auth0.

Usage

Take a look at the sample app provided in sample/{.verbatim} to see how it's used in a MWE. There are only a few steps. First, include the app in your apps in your Django settings:

INSTALLED_APPS = [
    ...,
    "django_auth0_auth",
]

Next, include the auth settings and auth backend (also in your Django settings):

AUTH0_CLIENT_ID = os.environ.get("AUTH0_CLIENT_ID")
AUTH0_CLIENT_SECRET = os.environ.get("AUTH0_CLIENT_SECRET")
AUTH0_DOMAIN = os.environ.get("AUTH0_DOMAIN")
AUTH0_AUDIENCE = os.environ.get("AUTH0_AUDIENCE")

AUTHENTICATION_BACKENDS = [
    "django_auth0_auth.backend.Auth0Backend",
]

Finally, include the urls in your project urls.py{.verbatim}:

from django.urls import path, include

urlpatterns = [
    ...,
    path("auth0/", include("django_auth0_auth.urls")),
]

Running the sample app

First, create an auth0 application.

Set up python however you prefer, I'll use a virtual env:

~/.pyenv/versions/3.11.10/bin/python -m venv .venv
source .venv/bin/activate
pip install .

Running the sample app, we can do:

export AUTH0_CLIENT_ID=...
export AUTH0_CLIENT_SECRET=...
export AUTH0_DOMAIN=...
export AUTH0_AUDIENCE=...
python manage.py migrate
python manage.py runserver

Go to http://localhost:8000/auth0 and log in!

Next steps

  • Test that it works with the sample app (create an auth0 account to test)
  • Run through genAI to look for general improvements: is all the logic we have in the views/index the right place for this?
  • Add pre-commit code checks
  • Add automated release via github action
  • Flesh out user documentation here in README
  • Add automated tests
  • Profit

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

django_auth0_authbackend-0.0.6.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

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

django_auth0_authbackend-0.0.6-py3-none-any.whl (2.2 kB view details)

Uploaded Python 3

File details

Details for the file django_auth0_authbackend-0.0.6.tar.gz.

File metadata

File hashes

Hashes for django_auth0_authbackend-0.0.6.tar.gz
Algorithm Hash digest
SHA256 635a8d35f09b0bb1a906c612b1e894bc9bc16437f626655768723ea10d8a79e4
MD5 2c2f5ad4a76676c7b54b22d18fcf5498
BLAKE2b-256 42628653578758c7fde0395f883d95f3565a73b09c4533ce2cff3946fb8fcb5e

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_auth0_authbackend-0.0.6.tar.gz:

Publisher: python-test-publish.yml on andyreagan/django-auth0-auth

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_auth0_authbackend-0.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for django_auth0_authbackend-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e18d3495b86f3555f13557c9e14c081c1a57a5534f56a1c813f2f9a05f9549ec
MD5 87ec23b837e318ae51fa075334eb2aa5
BLAKE2b-256 b0614db34797ae04537343b71eb9330a94f3613bb8ab9f36fb357530376c90c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_auth0_authbackend-0.0.6-py3-none-any.whl:

Publisher: python-test-publish.yml on andyreagan/django-auth0-auth

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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