ECAuth0Backend 0.1.2

Django app to authenticate with code or JWT for DjangoRestFramework

Source

Experimental application to manage code and jwt auth from Auth0 with Django.

If you’re using the JWT mechanism, you’ll need to include the openid email scopes to get the email_verified claim.

This app provides a custom user model which is required for use with the app (see step 2 of setup).

Setup

1. Add to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = [
       ...
       'Auth0Backend',
   ]

2. Set django to use the Auth0Backend user model:

   AUTH_USER_MODEL = 'Auth0Backend.A0User'

3. Include the URLconf in your project urls.py like this:

   urlpatterns = [
       # your urls
   ] + Auth0Backend.urls.urlpatterns

4. Run python manage.py migrate to create the user model.

5. Add the required configuration to your settings.py:

   AUTH0_DOMAIN = '' # Your auth0 domain
   
   AUTH0_CLIENT_ID = '' # Your auth0 client ID for code auth
   AUTH0_CLIENT_SECRET = '' # Your auth0 client secret for code auth
   AUTH0_CALLBACK_URL = '' # Callback url you want auth0 to send the client back to (url pattern defined below)
   
   AUTH0_BACKEND_SUCCESS_REDIRECT = '' # where to redirect on successful code auth. Default '/success/'
   AUTH0_BACKEND_FAILURE_REDIRECT = '' # where to redirect on failed code auth. Default '/failed/'
   AUTH0_BACKEND_CALLBACK_URL = '' # url pattern to use for auth callback. Default r'^auth_callback/$'
   
   AUTH0_JWT_SECRET = '' # auth0 client secret for jwt client
   AUTH0_JWT_CLIENT_ID = '' # auth0 client id for jwt client
   AUTH0_JWT_HEADER_SEPARATOR = '' # jwt header separator, defaults to 'JWT'