Skip to content

Commit e0dbfce

Browse files
authored
Refactor LDAP settings table in accounts.rst
Updated LDAP settings table format for clarity and consistency.
1 parent 94b5dd0 commit e0dbfce

File tree

1 file changed

+15
-50
lines changed

1 file changed

+15
-50
lines changed

source/adminguide/accounts.rst

Lines changed: 15 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -484,57 +484,22 @@ 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-
.. list-table:: LDAP Settings
488-
:header-rows: 1
489-
:widths: 20 30 50
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`). |
490502
491-
* - Setting
492-
- OpenLDAP / Active Directory
493-
- Description
494-
* - ``ldap.basedn``
495-
- ``OU=APAC,DC=company,DC=com``
496-
- Sets the base DN for LDAP searches.
497-
* - ``ldap.search.group.principle``
498-
- ``CN=ACSGroup,DC=company,DC=com``
499-
- *(Optional)* If set, only users belonging to this group are listed.
500-
* - ``ldap.bind.principal``
501-
- ``CN=ACSServiceAccount,OU=APAC,DC=company,DC=com``
502-
- Service account used to list users under the configured base DN.
503-
Avoid using privileged accounts such as ``Administrator``.
504-
* - ``ldap.bind.password``
505-
- ``****************``
506-
- Password for the bind DN. Entered in plain text but stored encrypted.
507-
* - ``ldap.user.object``
508-
- * OpenLDAP: ``inetOrgPerson``
509-
* Active Directory: ``user``
510-
- LDAP object class representing user accounts.
511-
* - ``ldap.email.attribute``
512-
- ``mail``
513-
- Attribute used to retrieve the user email address.
514-
* - ``ldap.firstname.attribute``
515-
- ``givenName``
516-
- Attribute used to retrieve the user first name.
517-
* - ``ldap.lastname.attribute``
518-
- ``sn``
519-
- Attribute used to retrieve the user last name.
520-
* - ``ldap.group.object``
521-
- * OpenLDAP: ``groupOfUniqueNames``
522-
* Active Directory: ``group``
523-
- LDAP object class representing groups.
524-
* - ``ldap.group.user.uniquemember``
525-
- ``uniqueMember``
526-
- Attribute defining user membership within a group.
527-
* - ``ldap.username.attribute``
528-
- * OpenLDAP: ``uid``
529-
* Active Directory: ``sAMAccountName``
530-
- Sets the username attribute used within LDAP.
531-
* - ``ldap.nested.groups.enable``
532-
- ``true``
533-
- If true, nested groups will also be queried.
534-
* - ``ldap.provider``
535-
- * OpenLDAP: ``openldap``
536-
* Active Directory: ``microsftad``
537-
- LDAP provider (e.g. ``openldap``, ``microsoftad``).
538503

539504

540505

0 commit comments

Comments
 (0)