User objects have the following fields:
Required. 30 characters or fewer. Usernames may contain alphanumeric, _, @, +, . and - characters.
Optional. 30 characters or fewer.
Optional. 30 characters or fewer.
Optional. Email address.
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.
Boolean. Designates whether this user can access the admin site.
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 on is_active being False, it’s up to you to check that in your own login view or a custom authentication backend. However, the AuthenticationForm used by the login() view (which is the default) does perform this check, as do the permission-checking methods such as has_perm() and the authentication in the Django admin. All of those functions/methods will return False for inactive users.
Boolean. Designates that this user has all permissions without explicitly assigning them.
A datetime of the user’s last login. Is set to the current date/time by default.
A datetime designating when the account was created. Is set to the current date/time by default when the account is created.
User objects have two many-to-many fields: groups and user_permissions. User objects can access their related objects in the same way as any other Django model:
myuser.groups = [group_list]
myuser.groups.add(group, group, ...)
myuser.groups.remove(group, group, ...)
myuser.groups.clear()
myuser.user_permissions = [permission_list]
myuser.user_permissions.add(permission, permission, ...)
myuser.user_permissions.remove(permission, permission, ...)
myuser.user_permissions.clear()
In addition to those automatic API methods, User objects have the following custom methods:
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.
Always returns False. This is a way of differentiating User and AnonymousUser objects. Generally, you should prefer using is_authenticated() to this method.
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.
Returns the first_name plus the last_name, with a space in between.
Sets the user’s password to the given raw string, taking care of the password hashing. Doesn’t save the User object.
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.)
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 return True. Doesn’t save the User object.
You may need this if authentication for your application takes place against an existing external source such as an LDAP directory.
Returns False if set_unusable_password() has been called for this user.
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.
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.
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 return False.
If obj is passed in, this method won’t check for a permission for the model, but for this specific object.
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 return False.
If obj is passed in, this method won’t check for permissions for the model, but for the specific object.
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 return False.
Sends an email to the user. If from_email is None, Django uses the DEFAULT_FROM_EMAIL.
Returns a site-specific profile for this user. Raises django.contrib.auth.models.SiteProfileNotAvailable if the current site doesn’t allow profiles, or django.core.exceptions.ObjectDoesNotExist if the user does not have a profile.
The User model has a custom manager that has the following helper functions:
Creates, saves and returns a User.
The username and password are set as given. The domain portion of email is automatically converted to lowercase, and the returned User object will have is_active set to True.
If no password is provided, set_unusable_password() will be called.
See Creating users for example usage.
Returns a random password with the given length and given string of allowed characters. (Note that the default value of allowed_chars doesn’t contain letters that can cause user confusion, including:
django.contrib.auth.models.AnonymousUser is a class that implements the django.contrib.auth.models.User interface, with these differences:
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 objects have the following fields:
Required. 50 characters or fewer. Example: 'Can vote'.
Required. A reference to the django_content_type database table, which contains a record for each installed Django model.
Required. 100 characters or fewer. Example: 'can_vote'.
Permission objects have the standard data-access methods like any other Django model.
Group objects have the following fields:
Required. 80 characters or fewer. Any characters are permitted. Example: 'Awesome Users'.
Many-to-many field to Permissions:
group.permissions = [permission_list]
group.permissions.add(permission, permission, ...)
group.permissions.remove(permission, permission, ...)
group.permissions.clear()
The auth framework uses two signals that can be used for notification when a user logs in or out.
Sent when a user logs in successfully.
Arguments sent with this signal:
Sent when the logout method is called.
Sent when the user failed to login successfully
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.
The following backends are available in django.contrib.auth.backends:
This is the default authentication backend used by Django. It authenticates using usernames and passwords stored in the User model.
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.
Dec 23, 2012