django.contrib.auth
¶
This document provides API reference material for the components of Django’s authentication system. For more details on the usage of these components or how to customize authentication and authorization see the authentication topic guide.
User¶
Fields¶
-
class
models.
User
¶ User
objects have the following fields:-
username
¶ Required. 30 characters or fewer. Usernames may contain alphanumeric,
_
,@
,+
,.
and-
characters.
-
first_name
¶ Optional. 30 characters or fewer.
-
last_name
¶ Optional. 30 characters or fewer.
-
email
¶ Optional. Email address.
-
password
¶ Required. A hash of, and metadata about, the password. (Django doesn’t store the raw password.) Raw passwords can be arbitrarily long and can contain any character. See the password documentation.
-
user_permissions
¶ Many-to-many relationship to
Permission
-
is_staff
¶ Boolean. Designates whether this user can access the admin site.
-
is_active
¶ Boolean. Designates whether this user account should be considered active. We recommend that you set this flag to
False
instead of deleting accounts; that way, if your applications have any foreign keys to users, the foreign keys won’t break.This doesn’t necessarily control whether or not the user can log in. Authentication backends aren’t required to check for the
is_active
flag, and the default backends do not. If you want to reject a login based onis_active
beingFalse
, it’s up to you to check that in your own login view or a custom authentication backend. However, theAuthenticationForm
used by thelogin()
view (which is the default) does perform this check, as do the permission-checking methods such ashas_perm()
and the authentication in the Django admin. All of those functions/methods will returnFalse
for inactive users.
-
is_superuser
¶ Boolean. Designates that this user has all permissions without explicitly assigning them.
-
last_login
¶ A datetime of the user’s last login. Is set to the current date/time by default.
-
date_joined
¶ A datetime designating when the account was created. Is set to the current date/time by default when the account is created.
-
Methods¶
-
class
models.
User
-
get_username
()¶ Returns the username for the user. Since the User model can be swapped out, you should use this method instead of referencing the username attribute directly.
-
is_anonymous
()¶ Always returns
False
. This is a way of differentiatingUser
andAnonymousUser
objects. Generally, you should prefer usingis_authenticated()
to this method.
-
is_authenticated
()¶ Always returns
True
. This is a way to tell if the user has been authenticated. This does not imply any permissions, and doesn’t check if the user is active - it only indicates that the user has provided a valid username and password.
-
get_full_name
()¶ Returns the
first_name
plus thelast_name
, with a space in between.
-
set_password
(raw_password)¶ Sets the user’s password to the given raw string, taking care of the password hashing. Doesn’t save the
User
object.
-
check_password
(raw_password)¶ Returns
True
if the given raw string is the correct password for the user. (This takes care of the password hashing in making the comparison.)
-
set_unusable_password
()¶ Marks the user as having no password set. This isn’t the same as having a blank string for a password.
check_password()
for this user will never returnTrue
. Doesn’t save theUser
object.You may need this if authentication for your application takes place against an existing external source such as an LDAP directory.
-
has_usable_password
()¶ Returns
False
ifset_unusable_password()
has been called for this user.
-
get_group_permissions
(obj=None)¶ Returns a set of permission strings that the user has, through his/her groups.
If
obj
is passed in, only returns the group permissions for this specific object.
-
get_all_permissions
(obj=None)¶ Returns a set of permission strings that the user has, both through group and user permissions.
If
obj
is passed in, only returns the permissions for this specific object.
-
has_perm
(perm, obj=None)¶ Returns
True
if the user has the specified permission, where perm is in the format"<app label>.<permission codename>"
. (see documentation on permissions). If the user is inactive, this method will always returnFalse
.If
obj
is passed in, this method won’t check for a permission for the model, but for this specific object.
-
has_perms
(perm_list, obj=None)¶ Returns
True
if the user has each of the specified permissions, where each perm is in the format"<app label>.<permission codename>"
. If the user is inactive, this method will always returnFalse
.If
obj
is passed in, this method won’t check for permissions for the model, but for the specific object.
-
has_module_perms
(package_name)¶ Returns
True
if the user has any permissions in the given package (the Django app label). If the user is inactive, this method will always returnFalse
.
-
email_user
(subject, message, from_email=None)¶ Sends an email to the user. If
from_email
isNone
, Django uses theDEFAULT_FROM_EMAIL
.
-
get_profile
()¶ Deprecated since version 1.5: With the introduction of custom User models, the use of
AUTH_PROFILE_MODULE
to define a single profile model is no longer supported. See the Django 1.5 release notes for more information.Returns a site-specific profile for this user. Raises
django.contrib.auth.models.SiteProfileNotAvailable
if the current site doesn’t allow profiles, ordjango.core.exceptions.ObjectDoesNotExist
if the user does not have a profile.
-
Manager methods¶
-
class
models.
UserManager
¶ The
User
model has a custom manager that has the following helper methods (in addition to the methods provided byBaseUserManager
):-
create_user
(username, email=None, password=None, **extra_fields)¶ - The
email
parameter was made optional. The username parameter is now checked for emptiness and raises aValueError
in case of a negative result.Creates, saves and returns a
User
.The
username
andpassword
are set as given. The domain portion ofemail
is automatically converted to lowercase, and the returnedUser
object will haveis_active
set toTrue
.If no password is provided,
set_unusable_password()
will be called.The
extra_fields
keyword arguments are passed through to theUser
‘s__init__
method to allow setting arbitrary fields on a custom User model.See Creating users for example usage.
-
create_superuser
(self, username, email, password, **extra_fields)¶ Same as
create_user()
, but setsis_staff
andis_superuser
toTrue
.
-
Anonymous users¶
-
class
models.
AnonymousUser
¶ django.contrib.auth.models.AnonymousUser
is a class that implements thedjango.contrib.auth.models.User
interface, with these differences:- id is always
None
. is_staff
andis_superuser
are alwaysFalse
.is_active
is alwaysFalse
.groups
anduser_permissions
are always empty.is_anonymous()
returnsTrue
instead ofFalse
.is_authenticated()
returnsFalse
instead ofTrue
.set_password()
,check_password()
,save()
anddelete()
raiseNotImplementedError
.
- id is always
In practice, you probably won’t need to use
AnonymousUser
objects on your own, but
they’re used by Web requests, as explained in the next section.
Permission¶
-
class
models.
Permission
¶
Fields¶
Permission
objects have the following
fields:
-
name
¶ Required. 50 characters or fewer. Example:
'Can vote'
.
-
content_type
¶ Required. A reference to the
django_content_type
database table, which contains a record for each installed Django model.
-
codename
¶ Required. 100 characters or fewer. Example:
'can_vote'
.
Methods¶
Permission
objects have the standard
data-access methods like any other Django model.
Group¶
-
class
models.
Group
¶
Fields¶
Group
objects have the following fields:
-
name
Required. 80 characters or fewer. Any characters are permitted. Example:
'Awesome Users'
.
-
permissions
¶ Many-to-many field to
Permission
:group.permissions = [permission_list] group.permissions.add(permission, permission, ...) group.permissions.remove(permission, permission, ...) group.permissions.clear()
Login and logout signals¶
The auth framework uses two signals that can be used for notification when a user logs in or out.
-
user_logged_in
()¶ Sent when a user logs in successfully.
Arguments sent with this signal:
sender
- The class of the user that just logged in.
request
- The current
HttpRequest
instance. user
- The user instance that just logged in.
-
user_logged_out
()¶ Sent when the logout method is called.
sender
- As above: the class of the user that just logged out or
None
if the user was not authenticated. request
- The current
HttpRequest
instance. user
- The user instance that just logged out or
None
if the user was not authenticated.
-
user_login_failed
()¶ Sent when the user failed to login successfully
sender
- The name of the module used for authentication.
credentials
- A dictionary of keyword arguments containing the user credentials that were
passed to
authenticate()
or your own custom authentication backend. Credentials matching a set of ‘sensitive’ patterns, (including password) will not be sent in the clear as part of the signal.
Authentication backends¶
This section details the authentication backends that come with Django. For information on how to use them and how to write your own authentication backends, see the Other authentication sources section of the User authentication guide.
Available authentication backends¶
The following backends are available in django.contrib.auth.backends
:
-
class
ModelBackend
¶ This is the default authentication backend used by Django. It authenticates using credentials consisting of a user identifier and password. For Django’s default user model, the user identifier is the username, for custom user models it is the field specified by USERNAME_FIELD (see Customizing Users and authentication).
It also handles the default permissions model as defined for
User
andPermissionsMixin
.
-
class
RemoteUserBackend
¶ Use this backend to take advantage of external-to-Django-handled authentication. It authenticates using usernames passed in
request.META['REMOTE_USER']
. See the Authenticating against REMOTE_USER documentation.