Welcome to mozilla-django-oidc-db’s documentation!

Database-backed settings for mozilla-django-oidc, with modified unique identifiers for users

Features

• Thin layer on top of mozilla-django-oidc

• Allows configuring OpenID connect providers and clients.

• Overrides mozilla-django-oidc default behaviour, using the sub claim instead of the email claim as unique identifier for users

mozilla-django-oidc-db provides database configuration for several configuration variables required for mozilla-django-oidc, moving them from deploy-time to run-time. This enables modification of the configuration, without having to restart the application.

Additionally, mozilla-django-oidc-db by default uses the sub (subject) claim instead of the email claim as the unique identifier for users in the RP (Relying Party) application. Using email as the unique identifier is not recommended, as mentioned in the OpenID Connect specification.

Contents:

• Quickstart
  • Installation
  • Usage
• Customizing behaviour
  • Models
  • Plugin
  • OIDC flow initialization
  • Authentication backend(s)
  • Callback flow
  • Templatetags
• Django Setup Configuration
  • Setup Configuration Settings
• Reference
  • Views
  • Authentication backends
  • Models
  • Utils
  • Signals
  • Plugins
  • Tests
• Architecture
  • Flow
• Running tests
  • Tox
  • VCR
• Running dev server
• Changelog
  • 2.0.1 (2026-03-17)
  • 2.0.0 (2026-03-10)
  • 1.1.1 (2025-11-19)
  • 1.1.0 (2025-11-18)
  • 1.0.2 (2025-10-24)
  • 1.0.1 (2025-10-24)
  • 1.0.0 (2025-10-23)
  • 0.25.1 (2025-08-25)
  • 0.25.0 (2025-08-08)
  • 0.24.0 (2025-08-01)
  • 0.23.0 (2025-04-08)
  • 0.22.0 (2025-01-27)
  • 0.21.1 (2024-12-10)
  • 0.21.0 (2024-12-09)
  • 0.20.0 (2024-12-03)
  • 0.19.0 (2024-07-02)
  • 0.18.1 (2024-06-18)
  • 0.18.0 (2024-06-12)
  • 0.17.0 (2024-05-28)
  • 0.16.0 (2024-05-02)
  • 0.15.0 (2024-02-07)
  • 0.14.1 (2024-01-12)
  • 0.14.0 (2024-01-05)
  • 0.13.0 (2023-12-21)
  • 0.12.0 (2022-12-14)
  • 0.11.0 (2022-08-09)
  • 0.10.1 (2022-07-27)
  • 0.10.0 (2022-04-25)
  • 0.9.0 (2022-04-21)
  • 0.8.0 (2022-02-15)
  • 0.7.2 (2022-01-11)
  • 0.7.1 (2021-11-29)
  • 0.7.0 (2021-11-29) YANKED
  • 0.6.0 (2021-11-26)
  • 0.5.0 (2021-09-13)
  • 0.4.0 (2021-08-16)
  • 0.3.0 (2021-07-19)
  • 0.2.1 (2021-07-06)
  • 0.2.0 (2021-07-06)

Indices and tables

• Index

• Module Index

• Search Page