Skip to content
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.

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

Update couchbase-cli-setting-ldap.adoc #19

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
24 changes: 11 additions & 13 deletions docs/modules/cli/pages/cbcli/couchbase-cli-setting-ldap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ include::{partialsdir}/cbcli/part-common-options.adoc[]
--authorization-enabled <1|0>::
Enables using LDAP to give users authorization

--host <host_list>::
--hosts <host_list>::
Specifies a comma separated list of LDAP hosts.

--port <port>::
Expand All @@ -56,7 +56,7 @@ include::{partialsdir}/cbcli/part-common-options.adoc[]
The timeout for LDAP requests in milliseconds.

--user-dn-mapping <mapping>::
User to DN mapping, if not specified username is used as user's DN.
User to distinguished name (DN) mapping, if not specified username is used as user's DN.

--max-parallel-connections <max>::
Maximum number of parallel connections that can be established with LDAP
Expand All @@ -69,21 +69,19 @@ include::{partialsdir}/cbcli/part-common-options.adoc[]
Lifetime of values in cache in milliseconds. Default 300000 ms.

--query-dn <dn>::
DN for groups synchronization
DN for user search and groups synchronization

--query-pass <pass>::
Password for groups synchronization
Password for user search and groups synchronization

--group-query <query>::
LDAP query to get users' group by username. RFC4516 format, like
'%D?memberOf?base'. This option works the following way: if attribute is
present in the query the list of attributes in the query result is considered
as list of user’s groups (single entry result is expected). %u and %D
placeholders could be used.
%u - username,
%D - user’s DN.
If attribute is not present in the query every returned entry is considered
as a group;
LDAP query, to get the users' groups by username in RFC4516 format.
The %u and %D placeholders can be used, for username and user's DN respectively.
If attribute is present in the query, the list of attribute values in the
search result is considered as list of user's groups (single entry result
is expected): for example: '%D?memberOf?base'.
If the attribute is not present in the query, every returned entry is
considered a group: for example, 'ou=groups,dc=example,dc=com??one?(member=%D)'

--nested-groups-enabled <0|1>::
If enabled Couchbase server will try to recursively search for groups for
Expand Down