django.contrib.authLink to this heading#This document provides API reference material for the components of Django’s\nauthentication system. For more details on the usage of these components or\nhow to customize authentication and authorization see the authentication\ntopic guide.
\nUser modelLink to this heading#User objects have the following\nfields:
Required. 150 characters or fewer. Usernames may contain alphanumeric,\n_, @, +, . and - characters.
The max_length should be sufficient for many use cases. If you need\na longer length, please use a custom user model.
Optional (blank=True). 150\ncharacters or fewer.
Optional (blank=True). 150\ncharacters or fewer.
Optional (blank=True). Email\naddress.
Required. A hash of, and metadata about, the password. (Django doesn’t\nstore the raw password.) Raw passwords can be arbitrarily long and can\ncontain any character. The metadata in this field may mark the password\nas unusable. See the password documentation.
\nMany-to-many relationship to Group
Many-to-many relationship to Permission
Boolean. Allows this user to access the admin site.
\nBoolean. Marks this user account as active. We recommend that you set\nthis flag to False instead of deleting accounts. That way, if your\napplications have any foreign keys to users, the foreign keys won’t\nbreak.
This doesn’t necessarily control whether or not the user can log in.\nAuthentication backends aren’t required to check for the is_active\nflag but the default backend\n(ModelBackend) and the\nRemoteUserBackend do. You can\nuse AllowAllUsersModelBackend\nor AllowAllUsersRemoteUserBackend\nif you want to allow inactive users to login. In this case, you’ll also\nwant to customize the\nAuthenticationForm used by the\nLoginView as it rejects inactive\nusers. Be aware that the permission-checking methods such as\nhas_perm() and the\nauthentication in the Django admin all return False for inactive\nusers.
Boolean. Treats this user as having all permissions without assigning\nany permission to it in particular.
\nA datetime of the user’s last login.
\nThe date/time when the account was created.
\nRead-only attribute which is always True (as opposed to\nAnonymousUser.is_authenticated which is always False). This is\na way to tell if the user has been authenticated. This does not imply\nany permissions and doesn’t check if the user is active or has a valid\nsession. Even though normally you will check this attribute on\nrequest.user to find out whether it has been populated by the\nAuthenticationMiddleware\n(representing the currently logged-in user), you should know this\nattribute is True for any User instance.
Read-only attribute which is always False. This is a way of\ndifferentiating User and AnonymousUser\nobjects. Generally, you should prefer using\nis_authenticated to this\nattribute.
Returns the username for the user. Since the User model can be\nswapped out, you should use this method instead of referencing the\nusername attribute directly.
Returns the first_name plus\nthe last_name, with a space in\nbetween.
Returns the first_name.
Sets the user’s password to the given raw string, taking care of the\npassword hashing. Doesn’t save the\nUser object.
When the raw_password is None, the password will be set to an\nunusable password, as if\nset_unusable_password()\nwere used.
Asynchronous version: acheck_password()
Returns True if the given raw string is the correct password for\nthe user. (This takes care of the password hashing in making the\ncomparison.)
Marks the user as having no password set by updating the metadata in\nthe password field. This isn’t\nthe same as having a blank string for a password.\ncheck_password() for this user\nwill never return True. Doesn’t save the\nUser object.
You may need this if authentication for your application takes place\nagainst an existing external source such as an LDAP directory.
\n\nReturns False if\nset_unusable_password() has\nbeen called for this user.
Asynchronous version: aget_user_permissions()
Returns a set of permission strings that the user has directly.
\nIf obj is passed in, only returns the user permissions for this\nspecific object.
Asynchronous version: aget_group_permissions()
Returns a set of permission strings that the user has, through their\ngroups.
\nIf obj is passed in, only returns the group permissions for\nthis specific object.
Asynchronous version: aget_all_permissions()
Returns a set of permission strings that the user has, both through\ngroup and user permissions.
\nIf obj is passed in, only returns the permissions for this\nspecific object.
Asynchronous version: ahas_perm()
Returns True if the user has the specified permission, where perm\nis in the format "<app label>.<permission codename>". (see\ndocumentation on permissions). If the user is\ninactive, this method will always return False. For an active\nsuperuser, this method will always return True.
If obj is passed in, this method won’t check for a permission for\nthe model, but for this specific object.
Asynchronous version: ahas_perms()
Returns True if the user has each of the specified permissions,\nwhere each perm is in the format\n"<app label>.<permission codename>". If the user is inactive,\nthis method will always return False. For an active superuser, this\nmethod will always return True.
If obj is passed in, this method won’t check for permissions for\nthe model, but for the specific object.
Asynchronous version: ahas_module_perms()
Returns True if the user has any permissions in the given package\n(the Django app label). If the user is inactive, this method will\nalways return False. For an active superuser, this method will\nalways return True.
Sends an email to the user. If from_email is None, Django uses\nthe DEFAULT_FROM_EMAIL. Any **kwargs are passed to the\nunderlying send_mail() call.
The User model has a custom manager\nthat has the following helper methods (in addition to the methods provided\nby BaseUserManager):
Asynchronous version: acreate_user()
Creates, saves and returns a User.
The username and\npassword are set as given. The\ndomain portion of email is\nautomatically converted to lowercase, and the returned\nUser object will have\nis_active set to True.
If no password is provided,\nset_unusable_password() will\nbe called.
If no email is provided, email\nwill be set to an empty string.
The extra_fields keyword arguments are passed through to the\nUser’s __init__ method to\nallow setting arbitrary fields on a custom user model.
See Creating users for example usage.
\n\nAsynchronous version: acreate_superuser()
Same as create_user(), but sets is_staff and\nis_superuser to True.
Returns users that have the given permission perm either in the\n"<app label>.<permission codename>" format or as a\nPermission instance. Returns an\nempty queryset if no users who have the perm found.
If is_active is True (default), returns only active users, or\nif False, returns only inactive users. Use None to return all\nusers irrespective of active state.
If include_superusers is True (default), the result will\ninclude superusers.
If backend is passed in and it’s defined in\nAUTHENTICATION_BACKENDS, then this method will use it.\nOtherwise, it will use the backend in\nAUTHENTICATION_BACKENDS, if there is only one, or raise an\nexception.
AnonymousUser objectLink to this heading#django.contrib.auth.models.AnonymousUser is a class that\nimplements the django.contrib.auth.models.User interface, with\nthese differences:
id is always None.
username is always the empty\nstring.
get_username() always returns\nthe empty string.
is_anonymous is True\ninstead of False.
is_authenticated is\nFalse instead of True.
is_staff and\nis_superuser are always\nFalse.
is_active is always False.
groups and\nuser_permissions are always\nempty.
set_password(),\ncheck_password(),\nsave() and\ndelete() raise NotImplementedError.
In practice, you probably won’t need to use\nAnonymousUser objects on your own, but\nthey’re used by web requests, as explained in the next section.
Permission modelLink to this heading#Permission objects have the following\nfields:
Required. 255 characters or fewer. Example: 'Can vote'.
Required. A foreign key to the\nContentType model.
Required. 100 characters or fewer. Example: 'can_vote'.
Permission objects have the standard\ndata-access methods like any other Django model.
Group modelLink to this heading#Group objects have the following fields:
Required. 150 characters or fewer. Any characters are permitted.\nExample: 'Awesome Users'.
Many-to-many field to Permission:
group.permissions.set([permission_list])\ngroup.permissions.add(permission, permission, ...)\ngroup.permissions.remove(permission, permission, ...)\ngroup.permissions.clear()\nA field validator allowing only ASCII letters and numbers, in addition to\n@, ., +, -, and _.
A field validator allowing Unicode characters, in addition to @, .,\n+, -, and _. The default validator for User.username.
The auth framework uses the following signals that\ncan be used for notification when a user logs in or out.
\nSent when a user logs in successfully.
\nArguments sent with this signal:
\nsenderThe class of the user that just logged in.
\nrequestThe current HttpRequest instance.
userThe user instance that just logged in.
\nSent when the logout method is called.
\nsenderAs above: the class of the user that just logged out or None\nif the user was not authenticated.
requestThe current HttpRequest instance.
userThe user instance that just logged out or None if the\nuser was not authenticated.
Sent when the user failed to login successfully
\nsenderThe name of the module used for authentication.
\ncredentialsA dictionary of keyword arguments containing the user credentials that were\npassed to authenticate() or your own custom\nauthentication backend. Credentials matching a set of “sensitive” patterns,\n(including password) will not be sent in the clear as part of the signal.
requestThe HttpRequest object, if one was provided to\nauthenticate().
This section details the authentication backends that come with Django. For\ninformation on how to use them and how to write your own authentication\nbackends, see the Other authentication sources section of the User authentication guide.
\nThe following backends are available in django.contrib.auth.backends:
A base class that provides default implementations for all required\nmethods. By default, it will reject any user and provide no permissions.
\nAsynchronous version: aget_user_permissions()
Returns an empty set.
\n\nAsynchronous version: aget_group_permissions()
Returns an empty set.
\n\nAsynchronous version: aget_all_permissions()
Uses get_user_permissions() and get_group_permissions() to\nget the set of permission strings the user_obj has.
Asynchronous version: ahas_perm()
Uses get_all_permissions() to check if user_obj has the\npermission string perm.
This is the default authentication backend used by Django. It\nauthenticates using credentials consisting of a user identifier and\npassword. For Django’s default user model, the user identifier is the\nusername, for custom user models it is the field specified by\nUSERNAME_FIELD (see Customizing Users and authentication).
\nIt also handles the default permissions model as defined for\nUser and\nPermissionsMixin.
has_perm(), get_all_permissions(), get_user_permissions(),\nand get_group_permissions() allow an object to be passed as a\nparameter for object-specific permissions, but this backend does not\nimplement them other than returning an empty set of permissions if\nobj is not None.
with_perm() also allows an object to be passed as a parameter, but\nunlike others methods it returns an empty queryset if obj is not None.
Asynchronous version: aauthenticate()
Tries to authenticate username with password by calling\nUser.check_password. If no username\nis provided, it tries to fetch a username from kwargs using the\nkey CustomUser.USERNAME_FIELD. Returns an\nauthenticated user or None.
request is an HttpRequest and may be None\nif it wasn’t provided to authenticate()\n(which passes it on to the backend).
Asynchronous version: aget_user_permissions()
Returns the set of permission strings the user_obj has from their\nown user permissions. Returns an empty set if\nis_anonymous or\nis_active is False.
Asynchronous version: aget_group_permissions()
Returns the set of permission strings the user_obj has from the\npermissions of the groups they belong. Returns an empty set if\nis_anonymous or\nis_active is False.
Asynchronous version: aget_all_permissions()
Returns the set of permission strings the user_obj has, including both\nuser permissions and group permissions. Returns an empty set if\nis_anonymous or\nis_active is False.
Asynchronous version: ahas_perm()
Uses get_all_permissions() to check if user_obj has the\npermission string perm. Returns False if the user is not\nis_active.
Asynchronous version: ahas_module_perms()
Returns whether the user_obj has any permissions on the app\napp_label.
Returns whether the user is allowed to authenticate. To match the\nbehavior of AuthenticationForm\nwhich prohibits inactive users from logging in,\nthis method returns False for users with is_active=False. Custom user models that\ndon’t have an is_active\nfield are allowed.
Returns all active users who have the permission perm either in\nthe form of "<app label>.<permission codename>" or a\nPermission instance. Returns an\nempty queryset if no users who have the perm found.
If is_active is True (default), returns only active users, or\nif False, returns only inactive users. Use None to return all\nusers irrespective of active state.
If include_superusers is True (default), the result will\ninclude superusers.
Same as ModelBackend except that it doesn’t reject inactive users\nbecause user_can_authenticate() always returns True.
When using this backend, you’ll likely want to customize the\nAuthenticationForm used by the\nLoginView by overriding the\nconfirm_login_allowed()\nmethod as it rejects inactive users.
Use this backend to take advantage of external-to-Django-handled\nauthentication. It authenticates using usernames passed in\nrequest.META['REMOTE_USER']. See\nthe Authenticating against REMOTE_USER\ndocumentation.
If you need more control, you can create your own authentication backend\nthat inherits from this class and override these attributes or methods:
\nTrue or False. Determines whether or not a user object is\ncreated if not already in the database Defaults to True.
Asynchronous version: aauthenticate()
The username passed as remote_user is considered trusted. This\nmethod returns the user object with the given username, creating a new\nuser object if create_unknown_user is\nTrue.
Returns None if create_unknown_user is\nFalse and a User object with the given username is not found in\nthe database.
request is an HttpRequest and may be None\nif it wasn’t provided to authenticate()\n(which passes it on to the backend).
Performs any cleaning on the username (e.g. stripping LDAP DN\ninformation) prior to using it to get or create a user object. Returns\nthe cleaned username.
Asynchronous version: aconfigure_user()
Configures the user on each authentication attempt. This method is\ncalled immediately after fetching or creating the user being\nauthenticated, and can be used to perform custom setup actions, such as\nsetting the user’s groups based on attributes in an LDAP directory.\nReturns the user object. When fetching or creating an user is called\nfrom a synchronous context, configure_user is called,\naconfigure_user is called from async contexts.
The setup can be performed either once when the user is created\n(created is True) or on existing users (created is\nFalse) as a way of synchronizing attributes between the remote and\nthe local systems.
request is an HttpRequest and may be None\nif it wasn’t provided to authenticate()\n(which passes it on to the backend).
Returns whether the user is allowed to authenticate. This method\nreturns False for users with is_active=False. Custom user models that\ndon’t have an is_active\nfield are allowed.
Same as RemoteUserBackend except that it doesn’t reject inactive\nusers because user_can_authenticate always\nreturns True.
Asynchronous version: aget_user()
Returns the user model instance associated with the given request’s\nsession.
It checks if the authentication backend stored in the session is present in\nAUTHENTICATION_BACKENDS. If so, it uses the backend’s\nget_user() method to retrieve the user model instance and then verifies\nthe session by calling the user model’s\nget_session_auth_hash()\nmethod. If the verification fails and SECRET_KEY_FALLBACKS are\nprovided, it verifies the session against each fallback key using\nget_session_auth_fallback_hash().
Returns an instance of AnonymousUser\nif the authentication backend stored in the session is no longer in\nAUTHENTICATION_BACKENDS, if a user isn’t returned by the\nbackend’s get_user() method, or if the session auth hash doesn’t\nvalidate.