diff --git a/docs/index.rst b/docs/index.rst index ae55c12..d3dcc5c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -38,6 +38,7 @@ Contents settings_ref config_guides middleware + signals rest_framework demo troubleshooting diff --git a/docs/settings_ref.rst b/docs/settings_ref.rst index 8d1c011..1a33122 100644 --- a/docs/settings_ref.rst +++ b/docs/settings_ref.rst @@ -173,6 +173,8 @@ ADFS server. Based on this information, certain configuration for this module is This setting determines the interval after which the configuration is reloaded. This allows to automatically follow the token signing certificate rollover on ADFS. +.. _create_new_users_setting: + CREATE_NEW_USERS ---------------- * **Default**: ``True`` diff --git a/docs/signals.rst b/docs/signals.rst new file mode 100644 index 0000000..cdb630a --- /dev/null +++ b/docs/signals.rst @@ -0,0 +1,31 @@ +Django Signals +================ + +**django-auth-adfs** uses Django `Signals ` to allow the +application to listen for and execute custom logic at certain points in the authentication process. Currently, the +following signals are supported: + +* ``post_authenticate``: sent after a user has been authenticated through any subclass of ``AdfsBaseBackend``. The + signal is sent after all other processing is done, e.g. mapping claims and groups and creating the user in Django (if + :ref:`the CREATE_NEW_USERS setting ` is enabled). In addition to the sender, the signal + includes the user object, the claims dictionary, and the ADFS response as arguments for the signal handler: + + * ``sender`` (``AdfsBaseBackend``): the backend instance from which the signal was triggered. + * ``user`` (Django user class): the user object that was authenticated. + * ``claims`` (``dict``): the decoded access token JWT, which contains all claims sent from the identity provider. + * ``adfs_response`` (``dict|None``): used in the ``AdfsAuthCodeBackend`` to provide the full response received from + the server when exchanging an authorization code for an access token. + +To use a signal in your application: + +.. code-block:: python + + from django.dispatch import receiver + from django_auth_adfs.signals import post_authenticate + + + @receiver(post_authenticate) + def handle_post_authenticate(sender, user, claims, adfs_response=None, **kwargs): + user.do_post_auth_steps(claims, adfs_response) + +