Skip to content

Added docs for LDAP user provider with default (null) values #10443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Added docs for LDAP user provider with default (null) values #10443

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cd0917
IssuE #10336. Added docs for LDAP user provider with default (null) v…
hiddewie Oct 7, 2018
64e9bad
Fix empty code snippet
hiddewie Oct 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions security/ldap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,19 +257,22 @@ and will not be considered as authenticated fully.
uid_key
.......

**type**: ``string`` **default**: ``sAMAccountName``
**type**: ``string`` **default**: ``null``

This is the entry's key to use as its UID. Depends on your LDAP server
implementation. Commonly used values are:

* ``sAMAccountName``
* ``sAMAccountName`` (default)
* ``userPrincipalName``
* ``uid``

If you configure the value ``null`` for the UID key, the default UID key
``sAMAccountName`` is used.

filter
......

**type**: ``string`` **default**: ``({uid_key}={username})``
**type**: ``string`` **default**: ``null``

This key lets you configure which LDAP query will be used. The ``{uid_key}``
string will be replaced by the value of the ``uid_key`` configuration value
Expand All @@ -279,6 +282,9 @@ replaced by the username you are trying to load.
For example, with a ``uid_key`` of ``uid``, and if you are trying to
load the user ``fabpot``, the final string will be: ``(uid=fabpot)``.

If you configure this key with the value ``null``, the default filter
``({uid_key}={username})`` is used.

Of course, the username will be escaped, in order to prevent `LDAP injection`_.

The syntax for the ``filter`` key is defined by `RFC4515`_.
Expand Down