Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add documentation for post_authenticate signal #351

Merged
merged 2 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
ajw725 marked this conversation as resolved.
Show resolved Hide resolved
ajw725 marked this conversation as resolved.
Show resolved Hide resolved
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):
ajw725 marked this conversation as resolved.
Show resolved Hide resolved
user.do_post_auth_steps(claims, adfs_response)


Loading