Overview

Backend Authenticator

PAMBackend.authenticate Authentication method [1]

This method has two keyword arguments one for the username and the other for the password, both are manditory. There is a third argument used to pass in a dict of additional arguments that you may want stored in the database on the first login of the user.

In order to use the additional arguments both the django.contrib.auth.authenticate function and either the django.contrib.auth.forms.AuthenticationForm or the Django PAM django_pam.accounts.forms.AuthenticationForm would need to be overridden, depending on which one you use.

PAMBackend.get_user Returns the authenticated user [2]

There is one positional argument that can be the pk, username, or email. The email would be used only if the email is used instead of the username to identify the user.

Login and Logout Views

LoginView [3]

Usage:

re_path(r'^login/$', LoginView.as_view(
    form_class=MyAuthenticationForm,
    success_url='/my/success/url/',
    redirect_field_name='my-redirect-field-name',
    template_name='your_template.html'
    ), name='login'),

This view is written to work with either a template POST or a XMLHttpRequest POST request.

LogoutView [4]

Usage:

re_path(r'^logout/$', LogoutView.as_view(
    template_name='my_template.html',
    success_url='/my/success/url/),
    redirect_field_name='my-redirect-field-name'
    ), name='logout')

This view is written to work with either a template POST or a XMLHttpRequest POST request.

Footnotes