Skip to content

Commit

Permalink
docs: add documentation for post_authenticate signal
Browse files Browse the repository at this point in the history
  • Loading branch information
ajw725 committed Oct 17, 2024
1 parent 5ea3c87 commit 05c2832
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Contents
settings_ref
config_guides
middleware
signals
rest_framework
demo
troubleshooting
Expand Down
25 changes: 25 additions & 0 deletions docs/signals.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Django Signals
================

**django-auth-adfs** uses Django `Signals <https://docs.djangoproject.com/en/stable/topics/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 either the ``AdfsAuthCodeBackend``
or the ``AdfsAccessTokenBackend`` (and created in Django, if ``CREATE_NEW_USERS`` is enabled) and
after all claims and groups have been mapped. The signal is sent with the user object, the claims
dictionary, and the ADFS response as arguments for the signal handler.

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, **kwargs):
user.do_post_auth_steps(claims, adfs_response)

0 comments on commit 05c2832

Please sign in to comment.