InstallationΒΆ

This authentication backend enables a Django project to authenticate against any LDAP server. To use it, add 'django_auth_ldap.backend.LDAPBackend' to AUTHENTICATION_BACKENDS. Do not add anything to INSTALLED_APPS. LDAP configuration can be as simple as a single distinguished name template, but there are many rich options for working with User objects, groups, and permissions.

Under Python 2, this backend depends on python-ldap; under Python 3, it uses pyldap. It should work with custom user models, but it does assume that a database is present.

Note

LDAPBackend does not inherit from ModelBackend. It is possible to use LDAPBackend exclusively by configuring it to draw group membership from the LDAP server. However, if you would like to assign permissions to individual users or add users to groups within Django, you’ll need to have both backends installed:

AUTHENTICATION_BACKENDS = (
    'django_auth_ldap.backend.LDAPBackend',
    'django.contrib.auth.backends.ModelBackend',
)