This document explains the usage of Django’s authentication system in its\ndefault configuration. This configuration has evolved to serve the most common\nproject needs, handling a reasonably wide range of tasks, and has a careful\nimplementation of passwords and permissions. For projects where authentication\nneeds differ from the default, Django supports extensive extension and\ncustomization of authentication.
\nDjango authentication provides both authentication and authorization together\nand is generally referred to as the authentication system, as these features\nare somewhat coupled.
\nUser objectsLink to this heading#User objects are the core of the\nauthentication system. They typically represent the people interacting with\nyour site and are used to enable things like restricting access, registering\nuser profiles, associating content with creators etc. Only one class of user\nexists in Django’s authentication framework, i.e., 'superusers' or admin 'staff' users are just user objects with\nspecial attributes set, not different classes of user objects.
The primary attributes of the default user are:
\nSee the User API documentation for a\ncomplete reference. The documentation that follows is more task-oriented.
The most direct way to create users is to use the included\ncreate_user() helper function:
>>> from django.contrib.auth.models import User\n>>> user = User.objects.create_user("john", "lennon@thebeatles.com", "johnpassword")\n\n# At this point, user is a User object that has already been saved\n# to the database. You can continue to change its attributes\n# if you want to change other fields.\n>>> user.last_name = "Lennon"\n>>> user.save()\nIf you have the Django admin installed, you can also create users\ninteractively.
\nCreate superusers using the createsuperuser command:
Linux / macOS
$ python manage.py createsuperuser --username=joe --email=joe@example.com\nWindows
...\\> py manage.py createsuperuser --username=joe --email=joe@example.com\nYou will be prompted for a password. After you enter one, the user will be\ncreated immediately. If you leave off the --username or --email options, it will\nprompt you for those values.
Django does not store raw (clear text) passwords on the user model, but only\na hash (see documentation of how passwords are managed for full details). Because of this, do not attempt to\nmanipulate the password attribute of the user directly. This is why a helper\nfunction is used when creating a user.
\nTo change a user’s password, you have several options:
\nmanage.py changepassword *username* offers a method\nof changing a user’s password from the command line. It prompts you to\nchange the password of a given user which you must enter twice. If\nthey both match, the new password will be changed immediately. If you\ndo not supply a user, the command will attempt to change the password\nwhose username matches the current system user.
You can also change a password programmatically, using\nset_password():
>>> from django.contrib.auth.models import User\n>>> u = User.objects.get(username="john")\n>>> u.set_password("new password")\n>>> u.save()\nIf you have the Django admin installed, you can also change user’s passwords\non the authentication system’s admin pages.
\nDjango also provides views and forms that may be used to allow users to change their own\npasswords.
\nChanging a user’s password will log out all their sessions. See\nSession invalidation on password change for details.
\nAsynchronous version: aauthenticate()
Use authenticate() to verify a set of\ncredentials. It takes credentials as keyword arguments, username and\npassword for the default case, checks them against each\nauthentication backend, and returns a\nUser object if the credentials are\nvalid for a backend. If the credentials aren’t valid for any backend or if\na backend raises PermissionDenied, it\nreturns None. For example:
from django.contrib.auth import authenticate\n\nuser = authenticate(username="john", password="secret")\nif user is not None:\n # A backend authenticated the credentials\n ...\nelse:\n # No backend authenticated the credentials\n ...\nrequest is an optional HttpRequest which is\npassed on the authenticate() method of the authentication backends.
Django uses sessions and middleware to hook the\nauthentication system into HttpRequest objects.
These provide a request.user attribute\nand a request.auser async method\non every request which represents the current user. If the current user has not\nlogged in, this attribute will be set to an instance\nof AnonymousUser, otherwise it will be an\ninstance of User.
You can tell them apart with\nis_authenticated, like so:
if request.user.is_authenticated:\n # Do something for authenticated users.\n ...\nelse:\n # Do something for anonymous users.\n ...\nOr in an asynchronous view:
\nuser = await request.auser()\nif user.is_authenticated:\n # Do something for authenticated users.\n ...\nelse:\n # Do something for anonymous users.\n ...\nIf you have an authenticated user you want to attach to the current session\n- this is done with a login() function.
Asynchronous version: alogin()
To log a user in, from a view, use login(). It\ntakes an HttpRequest object and a\nUser object.\nlogin() saves the user’s ID in the session,\nusing Django’s session framework.
Note that any data set during the anonymous session is retained in the\nsession after a user logs in.
\nThis example shows how you might use both\nauthenticate() and\nlogin():
from django.contrib.auth import authenticate, login\n\n\ndef my_view(request):\n username = request.POST["username"]\n password = request.POST["password"]\n user = authenticate(request, username=username, password=password)\n if user is not None:\n login(request, user)\n # Redirect to a success page.\n ...\n else:\n # Return an 'invalid login' error message.\n ...\nWhen a user logs in, the user’s ID and the backend that was used for\nauthentication are saved in the user’s session. This allows the same\nauthentication backend to fetch the user’s\ndetails on a future request. The authentication backend to save in the session\nis selected as follows:
\nUse the value of the optional backend argument, if provided.
Use the value of the user.backend attribute, if present. This allows\npairing authenticate() and\nlogin():\nauthenticate()\nsets the user.backend attribute on the user object it returns.
Use the backend in AUTHENTICATION_BACKENDS, if there is only\none.
Otherwise, raise an exception.
In cases 1 and 2, the value of the backend argument or the user.backend\nattribute should be a dotted import path string (like that found in\nAUTHENTICATION_BACKENDS), not the actual backend class.
Asynchronous version: alogout()
To log out a user who has been logged in via\ndjango.contrib.auth.login(), use\ndjango.contrib.auth.logout() within your view. It takes an\nHttpRequest object and has no return value.\nExample:
from django.contrib.auth import logout\n\n\ndef logout_view(request):\n logout(request)\n # Redirect to a success page.\nNote that logout() doesn’t throw any errors if\nthe user wasn’t logged in.
When you call logout(), the session data for\nthe current request is completely cleaned out. All existing data is\nremoved. This is to prevent another person from using the same web browser\nto log in and have access to the previous user’s session data. If you want\nto put anything into the session that will be available to the user\nimmediately after logging out, do that after calling\ndjango.contrib.auth.logout().
The raw way to limit access to pages is to check\nrequest.user.is_authenticated and either redirect to a\nlogin page:
from django.conf import settings\nfrom django.shortcuts import redirect\n\n\ndef my_view(request):\n if not request.user.is_authenticated:\n return redirect(f"{settings.LOGIN_URL}?next={request.path}")\n # ...\n…or display an error message:
\nfrom django.shortcuts import render\n\n\ndef my_view(request):\n if not request.user.is_authenticated:\n return render(request, "myapp/login_error.html")\n # ...\nlogin_required decoratorLink to this heading#As a shortcut, you can use the convenient\nlogin_required() decorator:
from django.contrib.auth.decorators import login_required\n\n\n@login_required\ndef my_view(request): ...\nlogin_required() does the following:
If the user isn’t logged in, redirect to\nsettings.LOGIN_URL, passing the current absolute\npath in the query string. Example: /accounts/login/?next=/polls/3/.
If the user is logged in, execute the view normally. The view code is\nfree to assume the user is logged in.
By default, the path that the user should be redirected to upon\nsuccessful authentication is stored in a query string parameter called\n"next". If you would prefer to use a different name for this parameter,\nlogin_required() takes an\noptional redirect_field_name parameter:
from django.contrib.auth.decorators import login_required\n\n\n@login_required(redirect_field_name="my_redirect_field")\ndef my_view(request): ...\nNote that if you provide a value to redirect_field_name, you will most\nlikely need to customize your login template as well, since the template\ncontext variable which stores the redirect path will use the value of\nredirect_field_name as its key rather than "next" (the default).
login_required() also takes an\noptional login_url parameter. Example:
from django.contrib.auth.decorators import login_required\n\n\n@login_required(login_url="/accounts/login/")\ndef my_view(request): ...\nNote that if you don’t specify the login_url parameter, you’ll need to\nensure that the settings.LOGIN_URL and your login\nview are properly associated. For example, using the defaults, add the\nfollowing lines to your URLconf:
from django.contrib.auth import views as auth_views\n\npath("accounts/login/", auth_views.LoginView.as_view()),\nThe settings.LOGIN_URL also accepts view function\nnames and named URL patterns. This allows you\nto freely remap your login view within your URLconf without having to\nupdate the setting.
LoginRequiredMixin mixinLink to this heading#When using class-based views, you can\nachieve the same behavior as with login_required by using the\nLoginRequiredMixin. This mixin should be at the leftmost position in the\ninheritance list.
If a view is using this mixin, all requests by non-authenticated users will\nbe redirected to the login page or shown an HTTP 403 Forbidden error,\ndepending on the\nraise_exception parameter.
You can set any of the parameters of\nAccessMixin to customize the handling\nof unauthorized users:
from django.contrib.auth.mixins import LoginRequiredMixin\n\n\nclass MyView(LoginRequiredMixin, View):\n login_url = "/login/"\n redirect_field_name = "redirect_to"\nlogin_not_required decoratorLink to this heading#When LoginRequiredMiddleware is\ninstalled, all views require authentication by default. Some views, such as the\nlogin view, may need to disable this behavior.
Allows unauthenticated requests to this view when\nLoginRequiredMiddleware is\ninstalled.
To limit access based on certain permissions or some other test, you’d do\nessentially the same thing as described in the previous section.
\nYou can run your test on request.user in\nthe view directly. For example, this view checks to make sure the user has an\nemail in the desired domain and if not, redirects to the login page:
from django.shortcuts import redirect\n\n\ndef my_view(request):\n if not request.user.email.endswith("@example.com"):\n return redirect("/login/?next=%s" % request.path)\n # ...\nAs a shortcut, you can use the convenient user_passes_test decorator\nwhich performs a redirect when the callable returns False:
from django.contrib.auth.decorators import user_passes_test\n\n\ndef email_check(user):\n return user.email.endswith("@example.com")\n\n\n@user_passes_test(email_check)\ndef my_view(request): ...\nuser_passes_test() takes a required\nargument: a callable that takes a\nUser object and returns True if\nthe user is allowed to view the page. Note that\nuser_passes_test() does not\nautomatically check that the User is\nnot anonymous.
user_passes_test() takes two\noptional arguments:
login_urlLets you specify the URL that users who don’t pass the test will be\nredirected to. It may be a login page and defaults to\nsettings.LOGIN_URL if you don’t specify one.
redirect_field_nameSame as for login_required().\nSetting it to None removes it from the URL, which you may want to do\nif you are redirecting users that don’t pass the test to a non-login\npage where there’s no «next page».
For example:
\n@user_passes_test(email_check, login_url="/login/")\ndef my_view(request): ...\nWhen using class-based views, you\ncan use the UserPassesTestMixin to do this.
You have to override the test_func() method of the class to\nprovide the test that is performed. Furthermore, you can set any of the\nparameters of AccessMixin to\ncustomize the handling of unauthorized users:
from django.contrib.auth.mixins import UserPassesTestMixin\n\n\nclass MyView(UserPassesTestMixin, View):\n def test_func(self):\n return self.request.user.email.endswith("@example.com")\nYou can also override the get_test_func() method to have the mixin\nuse a differently named function for its checks (instead of\ntest_func()).
permission_required decoratorLink to this heading#It’s a relatively common task to check whether a user has a particular\npermission. For that reason, Django provides a shortcut for that case: the\npermission_required() decorator:
from django.contrib.auth.decorators import permission_required\n\n\n@permission_required("polls.add_choice")\ndef my_view(request): ...\nJust like the has_perm() method,\npermission names take the form "<app label>.<permission codename>"\n(i.e. polls.add_choice for a permission on a model in the polls\napplication).
The decorator may also take an iterable of permissions, in which case the\nuser must have all of the permissions in order to access the view.
\nNote that permission_required()\nalso takes an optional login_url parameter:
from django.contrib.auth.decorators import permission_required\n\n\n@permission_required("polls.add_choice", login_url="/loginpage/")\ndef my_view(request): ...\nAs in the login_required() decorator,\nlogin_url defaults to settings.LOGIN_URL.
If the raise_exception parameter is given, the decorator will raise\nPermissionDenied, prompting the 403\n(HTTP Forbidden) view instead of redirecting to the\nlogin page.
If you want to use raise_exception but also give your users a chance to\nlogin first, you can add the\nlogin_required() decorator:
from django.contrib.auth.decorators import login_required, permission_required\n\n\n@login_required\n@permission_required("polls.add_choice", raise_exception=True)\ndef my_view(request): ...\nThis also avoids a redirect loop when LoginView’s\nredirect_authenticated_user=True and the logged-in user doesn’t have\nall of the required permissions.
PermissionRequiredMixin mixinLink to this heading#To apply permission checks to class-based views, you can use the PermissionRequiredMixin:
This mixin, just like the permission_required\ndecorator, checks whether the user accessing a view has all given\npermissions. You should specify the permission (or an iterable of\npermissions) using the permission_required parameter:
from django.contrib.auth.mixins import PermissionRequiredMixin\n\n\nclass MyView(PermissionRequiredMixin, View):\n permission_required = "polls.add_choice"\n # Or multiple of permissions:\n permission_required = ["polls.view_choice", "polls.change_choice"]\nYou can set any of the parameters of\nAccessMixin to customize the handling\nof unauthorized users.
You may also override these methods:
\nReturns an iterable of permission names used by the mixin. Defaults to\nthe permission_required attribute, converted to a tuple if\nnecessary.
Returns a boolean denoting whether the current user has permission to\nexecute the decorated view. By default, this returns the result of\ncalling has_perms() with the\nlist of permissions returned by get_permission_required().
Django provides several views that you can use for handling login, logout, and\npassword management. These make use of the stock auth forms but you can pass in your own forms as well.
\nDjango provides no default template for the authentication views. You should\ncreate your own templates for the views you want to use. The template context\nis documented in each view, see All authentication views.
\nThere are different methods to implement these views in your project. The\neasiest way is to include the provided URLconf in django.contrib.auth.urls\nin your own URLconf, for example:
urlpatterns = [\n path("accounts/", include("django.contrib.auth.urls")),\n]\nThis will include the following URL patterns:
\naccounts/login/ [name='login']\naccounts/logout/ [name='logout']\naccounts/password_change/ [name='password_change']\naccounts/password_change/done/ [name='password_change_done']\naccounts/password_reset/ [name='password_reset']\naccounts/password_reset/done/ [name='password_reset_done']\naccounts/reset/<uidb64>/<token>/ [name='password_reset_confirm']\naccounts/reset/done/ [name='password_reset_complete']\nThe views provide a URL name for easier reference. See the URL\ndocumentation for details on using named URL patterns.
\nIf you want more control over your URLs, you can reference a specific view in\nyour URLconf:
\nfrom django.contrib.auth import views as auth_views\n\nurlpatterns = [\n path("change-password/", auth_views.PasswordChangeView.as_view()),\n]\nThe views have optional arguments you can use to alter the behavior of the\nview. For example, if you want to change the template name a view uses, you can\nprovide the template_name argument. A way to do this is to provide keyword\narguments in the URLconf, these will be passed on to the view. For example:
urlpatterns = [\n path(\n "change-password/",\n auth_views.PasswordChangeView.as_view(template_name="change-password.html"),\n ),\n]\nAll views are class-based, which\nallows you to easily customize them by subclassing.
\nThis is a list with all the views django.contrib.auth provides. For\nimplementation details see Using the views.
URL name: login
See the URL documentation for details on using\nnamed URL patterns.
\nMethods and Attributes
\nThe name of a template to display for the view used to log the user in.\nDefaults to registration/login.html.
The URL to redirect to after login. Defaults to\nLOGIN_REDIRECT_URL.
The name of a GET field containing the URL to redirect to after\nlogin. Defaults to next. Overrides the\nget_default_redirect_url() URL if the given GET parameter is\npassed.
A callable (typically a form class) to use for authentication. Defaults\nto AuthenticationForm.
A dictionary of context data that will be added to the default context\ndata passed to the template.
\nA boolean that controls whether or not authenticated users accessing\nthe login page will be redirected as if they had just successfully\nlogged in. Defaults to False.
A set of hosts, in addition to request.get_host(), that are safe for redirecting\nafter login. Defaults to an empty set.
Returns the URL to redirect to after login. The default implementation\nresolves and returns next_page if set, or\nLOGIN_REDIRECT_URL otherwise.
Here’s what LoginView does:
If called via GET, it displays a login form that POSTs to the\nsame URL. More on this in a bit.
If called via POST with user submitted credentials, it tries to log\nthe user in. If login is successful, the view redirects to the URL\nspecified in next. If next isn’t provided, it redirects to\nsettings.LOGIN_REDIRECT_URL (which\ndefaults to /accounts/profile/). If login isn’t successful, it\nredisplays the login form.
It’s your responsibility to provide the html for the login template\n, called registration/login.html by default. This template gets passed\nfour template context variables:
form: A Form object representing the\nAuthenticationForm.
next: The URL to redirect to after successful login. This may\ncontain a query string, too.
site: The current Site,\naccording to the SITE_ID setting. If you don’t have the\nsite framework installed, this will be set to an instance of\nRequestSite, which derives the\nsite name and domain from the current\nHttpRequest.
site_name: An alias for site.name. If you don’t have the site\nframework installed, this will be set to the value of\nrequest.META['SERVER_NAME'].\nFor more on sites, see The «sites» framework.
If you’d prefer not to call the template registration/login.html,\nyou can pass the template_name parameter via the extra arguments to the\nas_view method in your URLconf. For example, this URLconf line would\nuse myapp/login.html instead:
path("accounts/login/", auth_views.LoginView.as_view(template_name="myapp/login.html")),\nYou can also specify the name of the GET field which contains the URL\nto redirect to after login using redirect_field_name. By default, the\nfield is called next.
Here’s a sample registration/login.html template you can use as a\nstarting point. It assumes you have a base.html template that\ndefines a content block:
{% extends "base.html" %}\n\n{% block content %}\n\n{% if form.errors %}\n<p>Your username and password didn't match. Please try again.</p>\n{% endif %}\n\n{% if next %}\n {% if user.is_authenticated %}\n <p>Your account doesn't have access to this page. To proceed,\n please login with an account that has access.</p>\n {% else %}\n <p>Please login to see this page.</p>\n {% endif %}\n{% endif %}\n\n<form method="post" action="{% url 'login' %}">\n{% csrf_token %}\n<table>\n<tr>\n <td>{{ form.username.label_tag }}</td>\n <td>{{ form.username }}</td>\n</tr>\n<tr>\n <td>{{ form.password.label_tag }}</td>\n <td>{{ form.password }}</td>\n</tr>\n</table>\n\n<input type="submit" value="login">\n<input type="hidden" name="next" value="{{ next }}">\n</form>\n\n{# Assumes you set up the password_reset view in your URLconf #}\n<p><a href="{% url 'password_reset' %}">Lost password?</a></p>\n\n{% endblock %}\nIf you have customized authentication (see Customizing Authentication) you can use a custom authentication form by\nsetting the authentication_form attribute. This form must accept a\nrequest keyword argument in its __init__() method and provide a\nget_user() method which returns the authenticated user object (this\nmethod is only ever called after successful form validation).
Logs a user out on POST requests.
URL name: logout
Attributes:
\nThe URL to redirect to after logout. Defaults to\nLOGOUT_REDIRECT_URL.
The full name of a template to display after logging the user out.\nDefaults to registration/logged_out.html.
The name of a GET field containing the URL to redirect to after log\nout. Defaults to 'next'. Overrides the\nnext_page URL if the given GET parameter is\npassed.
A dictionary of context data that will be added to the default context\ndata passed to the template.
\nA set of hosts, in addition to request.get_host(), that are safe for redirecting\nafter logout. Defaults to an empty set.
Template context:
\ntitle: The string «Logged out», localized.
site: The current Site,\naccording to the SITE_ID setting. If you don’t have the\nsite framework installed, this will be set to an instance of\nRequestSite, which derives the\nsite name and domain from the current\nHttpRequest.
site_name: An alias for site.name. If you don’t have the site\nframework installed, this will be set to the value of\nrequest.META['SERVER_NAME'].\nFor more on sites, see The «sites» framework.
Logs a user out on POST requests, then redirects to the login page.
URL name: No default URL provided
\nOptional arguments:
\nlogin_url: The URL of the login page to redirect to.\nDefaults to settings.LOGIN_URL if not supplied.
URL name: password_change
Allows a user to change their password.
\nAttributes:
\nThe full name of a template to use for displaying the password change\nform. Defaults to registration/password_change_form.html if not\nsupplied.
The URL to redirect to after a successful password change. Defaults to\n'password_change_done'.
A custom «change password» form which must accept a user keyword\nargument. The form is responsible for actually changing the user’s\npassword. Defaults to\nPasswordChangeForm.
A dictionary of context data that will be added to the default context\ndata passed to the template.
\nTemplate context:
\nform: The password change form (see form_class above).
URL name: password_change_done
The page shown after a user has changed their password.
\nAttributes:
\nThe full name of a template to use. Defaults to\nregistration/password_change_done.html if not supplied.
A dictionary of context data that will be added to the default context\ndata passed to the template.
\nURL name: password_reset
Allows a user to reset their password by generating a one-time use link\nthat can be used to reset the password, and sending that link to the\nuser’s registered email address.
\nThis view will send an email if the following conditions are met:
\nThe email address provided exists in the system.
The requested user is active (User.is_active is True).
The requested user has a usable password. Users flagged with an unusable\npassword (see\nset_unusable_password()) aren’t\nallowed to request a password reset to prevent misuse when using an\nexternal authentication source like LDAP.
If any of these conditions are not met, no email will be sent, but the\nuser won’t receive any error message either. This prevents information\nleaking to potential attackers. If you want to provide an error message in\nthis case, you can subclass\nPasswordResetForm and use the\nform_class attribute.
Attributes:
\nThe full name of a template to use for displaying the password reset\nform. Defaults to registration/password_reset_form.html if not\nsupplied.
Form that will be used to get the email of the user to reset the\npassword for. Defaults to\nPasswordResetForm.
The full name of a template to use for generating the email with the\nreset password link. Defaults to\nregistration/password_reset_email.html if not supplied.
The full name of a template to use for the subject of the email with\nthe reset password link. Defaults to\nregistration/password_reset_subject.txt if not supplied.
Instance of the class to check the one time link. This will default to\ndefault_token_generator, it’s an instance of\ndjango.contrib.auth.tokens.PasswordResetTokenGenerator.
The URL to redirect to after a successful password reset request.\nDefaults to 'password_reset_done'.
A valid email address. By default Django uses the\nDEFAULT_FROM_EMAIL.
A dictionary of context data that will be added to the default context\ndata passed to the template.
\nThe full name of a template to use for generating a\ntext/html multipart email with the password reset link. By\ndefault, HTML email is not sent.
\nA dictionary of context data that will be available in the email\ntemplate. It can be used to override default template context values\nlisted below e.g. domain.
Template context:
\nform: The form (see form_class above) for resetting the user’s\npassword.
Email template context:
\nemail: An alias for user.email
user: The current User,\naccording to the email form field. Only active users are able to\nreset their passwords (User.is_active is True).
site_name: An alias for site.name. If you don’t have the site\nframework installed, this will be set to the value of\nrequest.META['SERVER_NAME'].\nFor more on sites, see The «sites» framework.
domain: An alias for site.domain. If you don’t have the site\nframework installed, this will be set to the value of\nrequest.get_host().
protocol: http or https
uid: The user’s primary key encoded in base 64.
token: Token to check that the reset link is valid.
Sample registration/password_reset_email.html (email body template):
Someone asked for password reset for email {{ email }}. Follow the link below:\n{{ protocol}}://{{ domain }}{% url 'password_reset_confirm' uidb64=uid token=token %}\nThe same template context is used for subject template. Subject must be\nsingle line plain text string.
\nURL name: password_reset_done
The page shown after a user has been emailed a link to reset their\npassword. This view is called by default if the PasswordResetView\ndoesn’t have an explicit success_url URL set.
Attributes:
\nThe full name of a template to use. Defaults to\nregistration/password_reset_done.html if not supplied.
A dictionary of context data that will be added to the default context\ndata passed to the template.
\nURL name: password_reset_confirm
Presents a form for entering a new password.
\nKeyword arguments from the URL:
\nuidb64: The user’s id encoded in base 64.
token: Token to check that the password is valid.
Attributes:
\nThe full name of a template to display the confirm password view.\nDefault value is registration/password_reset_confirm.html.
Instance of the class to check the password. This will default to\ndefault_token_generator, it’s an instance of\ndjango.contrib.auth.tokens.PasswordResetTokenGenerator.
A boolean indicating if the user should be automatically authenticated\nafter a successful password reset. Defaults to False.
A dotted path to the authentication backend to use when authenticating\na user if post_reset_login is True. Required only if you have\nmultiple AUTHENTICATION_BACKENDS configured. Defaults to\nNone.
Form that will be used to set the password. Defaults to\nSetPasswordForm.
URL to redirect after the password reset done. Defaults to\n'password_reset_complete'.
A dictionary of context data that will be added to the default context\ndata passed to the template.
\nToken parameter displayed as a component of password reset URLs.\nDefaults to 'set-password'.
Template context:
\nform: The form (see form_class above) for setting the new user’s\npassword.
validlink: Boolean, True if the link (combination of uidb64 and\ntoken) is valid or unused yet.
URL name: password_reset_complete
Presents a view which informs the user that the password has been\nsuccessfully changed.
\nAttributes:
\nThe full name of a template to display the view. Defaults to\nregistration/password_reset_complete.html.
A dictionary of context data that will be added to the default context\ndata passed to the template.
\nRedirects to the login page, and then back to another URL after a\nsuccessful login.
\nRequired arguments:
\nnext: The URL to redirect to after a successful login.
Optional arguments:
\nlogin_url: The URL of the login page to redirect to.\nDefaults to settings.LOGIN_URL if not supplied.
redirect_field_name: The name of a GET field containing the\nURL to redirect to after login. Overrides next if the given\nGET parameter is passed.
If you don’t want to use the built-in views, but want the convenience of not\nhaving to write forms for this functionality, the authentication system\nprovides several built-in forms located in django.contrib.auth.forms:
A form used in the admin interface to change a user’s password, including\nthe ability to set an unusable password (via\nset_unusable_password()), which\nblocks the user from logging in with password-based authentication.
Takes the user as the first positional argument.
A form used in the admin interface to create a new user. Inherits from\nUserCreationForm.
It includes an additional usable_password field, enabled by default. If\nusable_password is enabled, it verifies that password1 and\npassword2 are non empty and match, validates the password using\nvalidate_password(), and\nsets the user’s password using\nset_password().\nIf usable_password is disabled, no password validation is done, and\npassword-based authentication is disabled for the user by calling\nset_unusable_password().
A form for logging a user in.
\nTakes request as its first positional argument, which is stored on the\nform instance for use by sub-classes.
By default, AuthenticationForm rejects users whose is_active\nflag is set to False. You may override this behavior with a custom\npolicy to determine which users can log in. Do this with a custom form\nthat subclasses AuthenticationForm and overrides the\nconfirm_login_allowed() method. This method should raise a\nValidationError if the given user may\nnot log in.
For example, to allow all users to log in regardless of «active»\nstatus:
\nfrom django.contrib.auth.forms import AuthenticationForm\n\n\nclass AuthenticationFormWithInactiveUsersOkay(AuthenticationForm):\n def confirm_login_allowed(self, user):\n pass\n(In this case, you’ll also need to use an authentication backend that\nallows inactive users, such as\nAllowAllUsersModelBackend.)
Or to allow only some active users to log in:
\nclass PickyAuthenticationForm(AuthenticationForm):\n def confirm_login_allowed(self, user):\n if not user.is_active:\n raise ValidationError(\n _("This account is inactive."),\n code="inactive",\n )\n if user.username.startswith("b"):\n raise ValidationError(\n _("Sorry, accounts starting with 'b' aren't welcome here."),\n code="no_b_users",\n )\nA ModelForm for creating a new user. This is the\nrecommended base class if you need to customize the user creation form.
It has three fields: username (from the user model), password1,\nand password2. It verifies that password1 and password2 match,\nvalidates the password using\nvalidate_password(), and\nsets the user’s password using\nset_password().
A form for allowing a user to change their password.
\nA form for generating and emailing a one-time use link to reset a\nuser’s password.
\nUses the arguments to send an EmailMultiAlternatives.\nCan be overridden to customize how the email is sent to the user. If\nyou choose to override this method, be mindful of handling potential\nexceptions raised due to email sending failures.
subject_template_name – the template for the subject.
email_template_name – the template for the email body.
context – context passed to the subject_template,\nemail_template, and html_email_template (if it is not\nNone).
from_email – the sender’s email.
to_email – the email of the requester.
html_email_template_name – the template for the HTML body;\ndefaults to None, in which case a plain text email is sent.
By default, save() populates the context with the\nsame variables that\nPasswordResetView passes to its\nemail context.
A form that lets a user change their password without entering the old\npassword.
\nA form used in the admin interface to change a user’s information and\npermissions.
\nInherits from BaseUserCreationForm. To help prevent confusion with\nsimilar usernames, the form doesn’t allow usernames that differ only in\ncase.
The currently logged-in user and their permissions are made available in the\ntemplate context when you use\nRequestContext.
When rendering a template RequestContext, the\ncurrently logged-in user, either a User\ninstance or an AnonymousUser instance, is\nstored in the template variable {{ user }}:
{% if user.is_authenticated %}\n <p>Welcome, {{ user.username }}. Thanks for logging in.</p>\n{% else %}\n <p>Welcome, new user. Please log in.</p>\n{% endif %}\nThis template context variable is not available if a RequestContext is not\nbeing used.
The currently logged-in user’s permissions are stored in the template variable\n{{ perms }}. This is an instance of\ndjango.contrib.auth.context_processors.PermWrapper, which is a\ntemplate-friendly proxy of permissions.
Evaluating a single-attribute lookup of {{ perms }} as a boolean is a proxy\nto User.has_module_perms(). For example, to check if\nthe logged-in user has any permissions in the foo app:
{% if perms.foo %}\nEvaluating a two-level-attribute lookup as a boolean is a proxy to\nUser.has_perm(). For\nexample, to check if the logged-in user has the permission foo.add_vote:
{% if perms.foo.add_vote %}\nHere’s a more complete example of checking permissions in a template:
\n{% if perms.foo %}\n <p>You have permission to do something in the foo app.</p>\n {% if perms.foo.add_vote %}\n <p>You can vote!</p>\n {% endif %}\n {% if perms.foo.add_driving %}\n <p>You can drive!</p>\n {% endif %}\n{% else %}\n <p>You don't have permission to do anything in the foo app.</p>\n{% endif %}\nIt is possible to also look permissions up by {% if in %} statements.\nFor example:
{% if 'foo' in perms %}\n {% if 'foo.add_vote' in perms %}\n <p>In lookup works, too.</p>\n {% endif %}\n{% endif %}\nWhen you have both django.contrib.admin and django.contrib.auth\ninstalled, the admin provides a convenient way to view and manage users,\ngroups, and permissions. Users can be created and deleted like any Django\nmodel. Groups can be created, and permissions can be assigned to users or\ngroups. A log of user edits to models made within the admin is also stored and\ndisplayed.
You should see a link to «Users» in the «Auth»\nsection of the main admin index page. The «Add user» admin page is different\nthan standard admin pages in that it requires you to choose a username and\npassword before allowing you to edit the rest of the user’s fields.\nAlternatively, on this page, you can choose a username and disable\npassword-based authentication for the user.
\nAlso note: if you want a user account to be able to create users using the\nDjango admin site, you’ll need to give them permission to add users and\nchange users (i.e., the «Add user» and «Change user» permissions). If an\naccount has permission to add users but not to change them, that account won’t\nbe able to add users. Why? Because if you have permission to add users, you\nhave the power to create superusers, which can then, in turn, change other\nusers. So Django requires add and change permissions as a slight security\nmeasure.
\nBe thoughtful about how you allow users to manage permissions. If you give a\nnon-superuser the ability to edit users, this is ultimately the same as giving\nthem superuser status because they will be able to elevate permissions of\nusers including themselves!
\nUser passwords are not displayed in the admin (nor stored in the database), but\nthe password storage details are displayed.\nIncluded in the display of this information is a link to\na password change form that allows admins to change or unset user passwords.
\n