Django integration

Install

pip install py-oidc-auth[django]

Wiring URL patterns

from django.urls import path
from py_oidc_auth import DjangoOIDCAuth

auth = DjangoOIDCAuth(
    client_id="my client",
    client_secret="secret",
    discovery_url="https://idp.example.org/realms/demo/.well-known/openid-configuration",
    scopes="openid profile email",
)

urlpatterns = [
    *auth.get_urlpatterns(prefix=""),
]

Protecting views

The wrapped view receives the validated token as an additional argument after the request object. Both sync and async views are supported.

from django.http import JsonResponse

@auth.required()
def me(request, token):
    return JsonResponse({"sub": token.sub})

@auth.optional()
async def maybe_me(request, token):
    if token is None:
        return JsonResponse({"anonymous": True})
    return JsonResponse({"sub": token.sub})