Skip to main content

Sign-in users to your Django Web app with Azure Active Directory.

Project description

Django Azure Active Directory Sign-In 🔑

Django 4.1 Python 3.11 License EUPL 1.2 Code style: black CodeQL codecov PyPI Become a sponsor to JV-conseil Follow JV conseil on StackOverflow Follow JVconseil on Twitter Follow JVconseil on Mastodon Follow JV conseil on GitHub

Sign-in users to your Django Web app with Azure Active Directory.


django-azure-active-directory-signin is a Django app which wraps MSAL package to sign in users with Microsoft's Azure Active Directory (OAuth 2.0 and OpenID Connect) in Django projects.

Sign-in users to your Django Web app with Azure Active Directory

The app includes login, logout and callback authentication views, a customizable backend to validate, create user and extend user with extra attributes, a decorator to protect individual views to protect individual views, and middleware which allows the entire site to require user authentication by default, with the ability to exempt specified views.

The GitHub repository provides a demo Django app to run local tests on https protocol thanks to django-sslserver.

This project is in no way affiliated with Microsoft Corporation.


From PyPi:

pip install django-azure-active-directory-signin


Azure App Registration

Register an application. You must have permission to manage applications in Azure Active Directory (Azure AD) on your Azure account.

Add a client secret in Certificates & secrets > Client secrets > New client secret and note it down.

Add a client secret

Copy your client_id, tenant_id and client_secret and store them in environment variables (see .env folder for sample) or better still in an Azure Key Vault.

Obfuscate your credentials by using environment variables

Add redirect URI like so:

  • https://<your-domain>/azure-signin/callback
  • https://localhost:8000/azure-signin/callback


Add the following to your, replacing the variables in braces with the values from your Azure app:


    "CLIENT_ID": os.environ.get("CLIENT_ID"),  # Mandatory
    "CLIENT_SECRET": os.environ.get("CLIENT_SECRET"),  # Mandatory
    "TENANT_ID": os.environ.get("TENANT_ID"),  # Mandatory
    "SAVE_ID_TOKEN_CLAIMS": True,  # Optional, default is False.
        ("employeeNumber", "employee_id"),
        ("affiliationNumber", "omk2"),
    ],  # Optional
    "REDIRECT_URI": "https://<domain>/azure-signin/callback",  # Optional
    "SCOPES": ["User.Read.All"],  # Optional
    "AUTHORITY": "" + os.environ.get("TENANT_ID"),  # Optional Or if multi-tenant
    "LOGOUT_REDIRECT_URI": "https://<domain>/logout",  # Optional
    "PUBLIC_URLS": ["<public:view_name>",]  # Optional, public views accessible by non-authenticated users


LOGIN_URL = "azure_signin:login"
LOGIN_REDIRECT_URL = "/" # Or any other endpoint

Installed apps

Add the following to your INSTALLED_APPS:


Authentication backend

Configure the authentication backend:



Include the app's URLs in your urlpatterns:

from django.urls import path, include

urlpatterns += [
    path("azure-signin/", include("azure_signin.urls", namespace="azure_signin")),



Add extra attributes to users with AZURE_SIGNIN["RENAME_ATTRIBUTES"] and Django django.contrib.auth.models.AbstractUser.

from django.contrib.auth.models import AbstractUser
from django.db import models

class ExtendedUser(AbstractUser):
    Extend user with extra attributes set in `AZURE_SIGNIN["RENAME_ATTRIBUTES"]`

    email = models.EmailField(unique=True, db_index=True)
    employee_id = models.IntegerField(
        null=True, default=None, unique=True, blank=True, db_index=True
    omk2 = models.CharField(max_length=5, null=True, default=None, db_index=True)
    hcm = models.CharField(max_length=7, null=True, default=None, db_index=True)


Backend can be subclassed to customize validation rules for user.

import logging

from azure_signin.backends import AzureSigninBackend

logger = logging.getLogger(__name__)

class CustomAzureSigninBackend(AzureSigninBackend):
    "Subclass AzureSigninBackend to customize validation rules for user."

    def is_valid_user(self, user: dict, *args, **kwargs) -> bool:
        output = super().is_valid_user(user, *args, **kwargs)
            "run extra checks here..."
        except Exception as e:
        logger.debug("is_valid_user: %s", output)
        return output


To make user authentication a requirement for accessing an individual view, decorate the view like so:

from azure_signin.decorators import azure_signin_required
from django.shortcuts import HttpResponse

def protected_view(request):
    return HttpResponse("A view protected by the decorator")


If you want to protect your entire site by default, you can use the middleware by adding the following to your


Make sure you add the middleware after Django's session and authentication middlewares so that the request includes the session and user objects. Public URLs which need to be accessed by non-authenticated users should be specified in the settings.AZURE_SIGNIN["PUBLIC_URLS"], as shown above.

VS Code Tasks

The GitHub repository provides commands Install, Launch and Tests accessible through Command Palette (press Cmd+Shift+P) then >Tasks: Run Tasks.

VS Code Tasks The app includes Install, Launch and Tests commands accessible through Command Palette > Tasks: Run Tasks (press Cmd+Shift+P)

All bash scripts are stored in .bash folder.

The virtual environment is propelled by poetry which can be installed with Homebrew brew install poetry.


This app is inspired by and builds on functionality in, with both feature improvements, code coverage and extended documentation.

Readings 📚


If this project helps you, you can offer me a cup of coffee ☕️ :-)

Become a sponsor to JV-conseil

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

Built Distribution

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