authenticate(**credentials)
[source]
Use authenticate()
to verify a set of credentials. It takes credentials as keyword arguments, username
and password
for the default case, checks them against each authentication backend, and returns a User
object if the credentials are valid for a backend. If the credentials aren’t valid for any backend or if a backend raises PermissionDenied
, it returns None
. For example:
from django.contrib.auth import authenticate user = authenticate(username='john', password='secret') if user is not None: # A backend authenticated the credentials else: # No backend authenticated the credentials
Note
This is a low level way to authenticate a set of credentials; for example, it’s used by the RemoteUserMiddleware
. Unless you are writing your own authentication system, you probably won’t use this. Rather if you are looking for a way to limit access to logged in users, see the login_required()
decorator.
Please login to continue.