Skip to content

Commit 664ca83

Browse files
rajujithrajujith
authored
Revise LDAP configuration items in accounts.rst
Updated LDAP configuration table format and descriptions.
1 parent e0dbfce commit 664ca83

File tree

1 file changed

+38
-15
lines changed

1 file changed

+38
-15
lines changed

‎source/adminguide/accounts.rst‎

Lines changed: 38 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -484,21 +484,44 @@ In addition to those shown in the example script above, the following
484484
configuration items can be configured on a Global or on a per Domain level (the default values are for
485485
OpenLDAP)
486486

487-
| Setting | OpenLDAP / Active Directory | Description |
488-
|--------------------------------|------------------------------------------------------------------|-----------------------------------------------------------------------------|
489-
| `ldap.basedn` | `OU=APAC,`<br>`DC=company,DC=com` | Sets the base DN for LDAP searches. |
490-
| `ldap.search.group.principle` | `CN=ACSGroup,`<br>`DC=company,DC=com` | *(Optional)* If set, only users belonging to this group are listed. |
491-
| `ldap.bind.principal` | `CN=ACSServiceAccount,OU=APAC,`<br>`DC=company,DC=com` | Service account used to list users under the configured base DN. Avoid using privileged accounts such as `Administrator`. |
492-
| `ldap.bind.password` | `****************` | Password for the bind DN. Entered in plain text but stored encrypted. |
493-
| `ldap.user.object` | OpenLDAP: `inetOrgPerson`<br>Active Directory: `user` | LDAP object class representing user accounts. |
494-
| `ldap.email.attribute` | `mail` | Attribute used to retrieve the user email address. |
495-
| `ldap.firstname.attribute` | `givenName` | Attribute used to retrieve the user first name. |
496-
| `ldap.lastname.attribute` | `sn` | Attribute used to retrieve the user last name. |
497-
| `ldap.group.object` | OpenLDAP: `groupOfUniqueNames`<br>Active Directory: `group` | LDAP object class representing groups. |
498-
| `ldap.group.user.uniquemember` | `uniqueMember` | Attribute defining user membership within a group. |
499-
| `ldap.username.attribute` | OpenLDAP: `uid`<br>Active Directory: `sAMAccountName` | Sets the username attribute used within LDAP. |
500-
| `ldap.nested.groups.enable` | `true` | If true, nested groups will also be queried. |
501-
| `ldap.provider` | OpenLDAP: `openldap`<br>Active Directory: `microsoftad` | LDAP provider (e.g. `openldap`, `microsoftad`). |
487+
.. cssclass:: table-striped table-bordered table-hover
488+
489+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
490+
| Setting | OpenLDAP / Active Directory | Description |
491+
+======================================+===============================================+========================================================================+
492+
| ``ldap.basedn`` | ``OU=APAC,`` | Sets the base DN for LDAP searches. |
493+
| | ``DC=company,DC=com`` | |
494+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
495+
| ``ldap.search.group.principle`` | ``CN=ACSGroup,`` | *(Optional)* If set, only users belonging to this group are listed. |
496+
| | ``DC=company,DC=com`` | |
497+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
498+
| ``ldap.bind.principal`` | ``CN=ACSServiceAccount,OU=APAC,`` | Service account used to list users under the configured base DN. |
499+
| | ``DC=company,DC=com`` | Avoid using privileged accounts such as ``Administrator``. |
500+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
501+
| ``ldap.bind.password`` | ``****************`` | Password for the bind DN. Entered in plain text but stored encrypted. |
502+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
503+
| ``ldap.user.object`` | OpenLDAP: ``inetOrgPerson`` | LDAP object class representing user accounts. |
504+
| | Active Directory: ``user`` | |
505+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
506+
| ``ldap.email.attribute`` | ``mail`` | Attribute used to retrieve the user email address. |
507+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
508+
| ``ldap.firstname.attribute`` | ``givenName`` | Attribute used to retrieve the user first name. |
509+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
510+
| ``ldap.lastname.attribute`` | ``sn`` | Attribute used to retrieve the user last name. |
511+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
512+
| ``ldap.group.object`` | OpenLDAP: ``groupOfUniqueNames`` | LDAP object class representing groups. |
513+
| | Active Directory: ``group`` | |
514+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
515+
| ``ldap.group.user.uniquemember`` | ``uniqueMember`` | Attribute defining user membership within a group. |
516+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
517+
| ``ldap.username.attribute`` | OpenLDAP: ``uid`` | Sets the username attribute used within LDAP. |
518+
| | Active Directory: ``sAMAccountName`` | |
519+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
520+
| ``ldap.nested.groups.enable`` | ``true`` | If true, nested groups will also be queried. |
521+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
522+
| ``ldap.provider`` | OpenLDAP: ``openldap`` | LDAP provider (e.g. ``openldap``, ``microsoftad``). |
523+
| | Active Directory: ``microsoftad`` | |
524+
+--------------------------------------+-----------------------------------------------+------------------------------------------------------------------------+
502525

503526

504527

0 commit comments

Comments
 (0)