Skip to main content

Authenticated users using Auth0.

Project description

Django Auth0 Auth allows you to authenticate through Auth0.

Installation

Run pip install django-auth0-auth

Add the Auth0Backend to your AUTHENTICATION_BACKENDS setting:

AUTHENTICATION_BACKENDS = (
    ...
    'auth0_auth.backends.Auth0Backend',
)

Edit your urls.py to include:

urlpatterns = [
    url(r'^auth0/', include('auth0_auth.urls')),
    ...
]

Settings

###AUTH0_DOMAIN

Auth0 domain.

###AUTH0_CLIENT_ID

Auth0 client id.

###AUTH0_CLIENT_SECRET

Auth0 client secret.

###AUTH0_SECRET_BASE64_ENCODED

default: False Flag if Auth0 client secret is base64 encoded.

###AUTH0_SCOPE

default: 'openid email' OAuth scope parameter.

###AUTH0_RESPONSE_TYPE

default: 'token' OAuth response type parameter.

###AUTH0_USER_CREATION

default: True Allow creation of new users after successful authentication.

Lock Signin

To log in using the JavaScript based Lock dialog, add the following to your project.

Add the auth0 context processor to the TEMPLATES options.

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')],
        'OPTIONS': {
            'context_processors': [
                ...
                'auth0_auth.context_processors.auth0',
            ],
        },
    },
]

Add the following JavaScript snippet to your base.html below your sites other JavaScript.

<script src="https://cdn.auth0.com/js/lock-9.min.js"></script>
<script type="text/javascript">
    var lock = new Auth0Lock('{{ AUTH0_CLIENT_ID }}', '{{ AUTH0_DOMAIN }}');
    function signin() {
        lock.show({
            callbackURL: '{{ AUTH0_CALLBACK_URL }}',
            responseType: 'token',
            authParams: {
                'scope': '{{ AUTH0_SCOPE }}',
                'response_mode': 'form_post',
                'state': '{{ AUTH0_STATE }}'
            }
        });
    }
</script>

Add a login button to your base.html.

<button onclick="window.signin();">Login</button>

Logging

To enable logging add auth0_auth to LOGGING['loggers'] options.

LOGGING = {
    ...,
    'loggers': {
        ...,
        'auth0_auth': {
            'handlers': ['console'],
            'level': 'DEBUG',
        }
    }
}

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-auth-3.3.tar.gz (7.0 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