Update LDAP documentation #1135

Closed
opened 2025-12-29 16:29:19 +01:00 by adam · 3 comments
Owner

Originally created by @bdlamprecht on GitHub (Aug 1, 2017).

Pretty straightforward request, but I noticed this is not called out in the documentation:

Currently, the LDAP.md file contains the following section:

AUTH_LDAP_USER_ATTR_MAP = {
    "first_name": "givenName",
    "last_name": "sn",
}

I tried adding "email_address": "mail" as an additional dict value, but I needed to use the key name email instead of email_address.

In summary, the page for LDAP documentation should be updated to reflect the following:

AUTH_LDAP_USER_ATTR_MAP = {
    "first_name": "givenName",
    "last_name": "sn",
    "email": "mail"
}
Originally created by @bdlamprecht on GitHub (Aug 1, 2017). Pretty straightforward request, but I noticed this is not called out in the documentation: Currently, the `LDAP.md` file contains the following section: ``` AUTH_LDAP_USER_ATTR_MAP = { "first_name": "givenName", "last_name": "sn", } ``` I tried adding "email_address": "mail" as an additional `dict` value, but I needed to use the key name `email` instead of `email_address`. In summary, the page for LDAP documentation should be updated to reflect the following: ``` AUTH_LDAP_USER_ATTR_MAP = { "first_name": "givenName", "last_name": "sn", "email": "mail" } ```
adam added the type: documentation label 2025-12-29 16:29:19 +01:00
adam closed this issue 2025-12-29 16:29:19 +01:00
Author
Owner

@jeremystretch commented on GitHub (Aug 1, 2017):

Looks good, could you put in a PR for this please?

@jeremystretch commented on GitHub (Aug 1, 2017): Looks good, could you put in a PR for this please?
Author
Owner

@bdlamprecht commented on GitHub (Aug 2, 2017):

Done. Pull #1386

FYI - I also noticed that the links on netbox.readthedocs.io to both "View" and "Edit" the page (bottom left corner under the heading "On GitHub") the page doesn't work properly. Wasn't sure the exact problem, but manually found the .md file.

@bdlamprecht commented on GitHub (Aug 2, 2017): Done. Pull #1386 FYI - I also noticed that the links on [netbox.readthedocs.io](http://netbox.readthedocs.io) to both "View" and "Edit" the page (bottom left corner under the heading "On GitHub") the page doesn't work properly. Wasn't sure the exact problem, but manually found the .md file.
Author
Owner

@jeremystretch commented on GitHub (Aug 2, 2017):

Thanks!

@jeremystretch commented on GitHub (Aug 2, 2017): Thanks!
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#1135