Skip to content

[Ldap] minor: better query string docs #11454

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 1 commit into from
Closed

[Ldap] minor: better query string docs #11454

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 4 additions & 5 deletions security/ldap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,12 +313,11 @@ providers with different ``base_dn``. The value of this option must be a valid
search string (e.g. ``uid="{username}"``). The placeholder value will be
replaced by the actual username.

When this option is used, ``dn_string`` has to be updated accordingly. Following
the previous example, if your users have the following two DN:
When this option is used, ``query_string`` will search in the DN specified by ``dn_string``
and the DN resulted of the ``query_string`` will be used to authenticate the user with
their password. Following the previous example, if your users have the following two DN:
``dc=companyA,dc=example,dc=com`` and ``dc=companyB,dc=example,dc=com``, then
``dn_string`` should be ``dc=example,dc=com``. If the ``query_string`` option is
``uid="{username}"``, then the authentication provider can authenticate users
from both DN.
``dn_string`` should be ``dc=example,dc=com``.

Bear in mind that usernames must be unique across both DN, as the authentication
provider won't be able to select the correct user for the bind process if more
Expand Down