Skip to main content

Django Rest Framework Library to use Auth0 authentication

Project description

=====
djangorestframework-auth0
=====

Warning
-------

**This library is in an early stage of development, use with caution, and -if you can- push some changes :)**


Library to simply use Auth0 token authentication in DRF within djangorestframework-jwt

This library let you to login an specific user based on the JWT Token returned by Auth0 Javascript libraries


Detailed documentation will be in the "docs" directory.

Installation
-----------

1. Using `pip` install the library cloning the repository with following command::

pip install rest_framework_auth0

Quick start
-----------

1. Add "django.contrib.auth to INSTALLED_APPS settings like this::

INSTALLED_APPS = [
...
'django.contrib.auth',
...
]

This will allow us to login as an specific user as well as auto-creating users when they don't exist

1. Add "rest_framework_auth0" to your INSTALLED_APPS **after** `rest_framework_jwt` setting like this::

INSTALLED_APPS = [
...,
'rest_framework_jwt',
'rest_framework_auth0',
]

2. Add `Auth0JSONWebTokenAuthentication` in your DEFAULT_AUTHENTICATION_CLASSES located at settings.py from your project::

REST_FRAMEWORK = {
...,
'DEFAULT_AUTHENTICATION_CLASSES': (
...,
'rest_framework_auth0.authentication.Auth0JSONWebTokenAuthentication',
),
}

3. Add your AUTH0_CLIENT_SECRET and AUTH0_CLIENT_ID in your settings.py file -must be the same secret and id than the frontend App-::

AUTH0 = {
'AUTH0_CLIENT_ID':'<YOUR_AUTH0_CLIENT_ID>', #make sure it's the same string that aud attribute in your payload provides
'AUTH0_CLIENT_SECRET':'<YOUR_AUTH0_CLIENT_SECRET>',
'AUTH0_ALGORITHM':'HS256', #default used in Auth0 apps
'JWT_AUTH_HEADER_PREFIX': 'JWT', #default prefix used by djangorestframework_jwt
}

4. Add the `Authorization` Header to all of your REST API request, prefixing JWT to your token::

Authorization: JWT <AUTH0_GIVEN_TOKEN>

5. Use the decorator `@token_required` in all views you want to protect (not_ready_yet)

6. That's it

Sample project
-----------

A sample project can be found on https://github.com/mcueto/djangorestframework-auth0_sample

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

rest_framework_auth0-0.1.6.tar.gz (7.1 kB view hashes)

Uploaded Source

Supported by

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