From b13c331776d1d4a636311ef2c8d559e1dd7a0911 Mon Sep 17 00:00:00 2001
From: Simon Shanks <59612559+sshanks-kx@users.noreply.github.com>
Date: Wed, 3 May 2023 17:26:09 +0100
Subject: [PATCH] Clarify some details
Add link to unbind/search docs from ldap.com, add some clarity around security mech
---
docs/reference.md | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/docs/reference.md b/docs/reference.md
index 1cee02a..64b8f9b 100644
--- a/docs/reference.md
+++ b/docs/reference.md
@@ -41,7 +41,7 @@ name | type | content | default
-----|------|---------|--------
`dn` | string or symbol | user to authenticate | Anonymous simple authentication. (Typical for SASL authentication as most SASL mechanisms identify the target account within the encoded credentials.)
`cred` | char/byte list or symbol | LDAP credentials, e.g. password | Assume no password required.
-`mech` | string or symbol | SASL mechanism for authentication | `LDAP_SASL_SIMPLE`
Query the attribute `supportedSASLMechanisms` from the server’s `rootDSE` for the list of SASL mechanisms the server supports.
+`mech` | string or symbol | SASL mechanism for authentication | If not present, defaults to LDAP_SASL_SIMPLE (simple authentication) which is represented by an empty string.
Query the attribute `supportedSASLMechanisms` from the server’s `rootDSE` for the list of SASL mechanisms the server supports.
Result dictionary:
@@ -233,6 +233,9 @@ Where
returns results as a dictionary.
+:globe_with_meridians:
+[The LDAP search operation](https://ldap.com/the-ldap-search-operation/)
+
Search options (`opts`):
name | type | content | default
@@ -353,6 +356,9 @@ q).ldap.unbind[0i]
0i
```
+:globe_with_meridians:
+[The LDAP unbind operation](https://ldap.com/the-ldap-unbind-operation/)
+
## Scope