.. mozilla_django_oidc_db documentation master file, created by startproject. You can adapt this file completely to your liking, but it should at least contain the root toctree directive.

mozilla-django-oidc-db

:Version: 0.19.0 :Source: https://github.com/maykinmedia/mozilla-django-oidc-db :Keywords: OIDC, django, database, authentication

|build-status| |coverage| |black|

|python-versions| |django-versions| |pypi-version|

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

.. contents::

.. section-numbering::

Features

• Thin layer on top of mozilla-django-oidc_
• Allows configuration of OpenID Connect variables via django-solo
• 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 a database singleton 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_.

Usage

Please see the hosted documentation_ for installation, configuration and usage instructions.

.. |build-status| image:: https://github.com/maykinmedia/mozilla-django-oidc-db/workflows/Run%20CI/badge.svg?branch=master :target: https://github.com/maykinmedia/mozilla-django-oidc-db/actions?query=workflow%3A%22Run+CI%22+branch%3Amaster

.. |coverage| image:: https://codecov.io/gh/maykinmedia/mozilla-django-oidc-db/branch/master/graph/badge.svg :target: https://codecov.io/gh/maykinmedia/mozilla-django-oidc-db :alt: Coverage status

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black

.. |python-versions| image:: https://img.shields.io/pypi/pyversions/mozilla_django_oidc_db.svg

.. |django-versions| image:: https://img.shields.io/pypi/djversions/mozilla_django_oidc_db.svg

.. |pypi-version| image:: https://img.shields.io/pypi/v/mozilla_django_oidc_db.svg :target: https://pypi.org/project/mozilla_django_oidc_db/

.. |docs| image:: https://readthedocs.org/projects/mozilla-django-oidc-db/badge/?version=latest :target: https://mozilla-django-oidc-db.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. _mozilla-django-oidc: https://github.com/mozilla/mozilla-django-oidc

.. _OpenID Connect specification: https://openid.net/specs/openid-connect-core-1_0.html#ClaimStability

.. _documentation: https://mozilla-django-oidc-db.readthedocs.io/en/latest/