From 449d484963a1ac522536a6e0eabd46f4e2c3d399 Mon Sep 17 00:00:00 2001 From: Doris Lam Date: Wed, 15 Feb 2023 16:35:32 -0800 Subject: [PATCH] update ldap doc --- ldap/README.rst | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/ldap/README.rst b/ldap/README.rst index 60fe9e7a4..d912059d6 100644 --- a/ldap/README.rst +++ b/ldap/README.rst @@ -15,7 +15,7 @@ Configuration The base string to use. Required. ldap.provider.url - The provider url, including the base. Required. + The provider url. Required. ldap.provider.userdn The userdn to use to authenticate to the provider. Optional. @@ -24,7 +24,9 @@ Configuration The password to use to authenticate to the provider. Optional. ldap.user.dn.pattern - The dn pattern for the user. Required. + The dn pattern for the user. Required. Can provide multiple separated by `;` + + | `Default: uid={0}` ldap.user.attributes.username The attribute to use for the username. Optional. @@ -36,11 +38,33 @@ Configuration | `Default: mail` + ldap.user.attributes.firstname + The attribute to use for the first name. Optional. + + | `Default: givenname` + + ldap.user.attributes.lastname + The attribute to use for the last name. Optional. + + | `Default: sn` + ldap.group.role.attribute The attribute to use for the group role. Optional. + | `Default: cn` + ldap.group.search.base The base for group search. Optional. ldap.group.search.filter The search filter for group search. Optional. + + | `Default: (uniqueMember={0})` + + ldap.user.search.base + Base for user search. Optional. + + ldap.user.search.filter + Filter for user search. Optional + + | `Default: (uid={0})`