Skip to content

Commit

Permalink
Clarify some details
Browse files Browse the repository at this point in the history
Add link to unbind/search docs from ldap.com, add some clarity around security mech
  • Loading branch information
sshanks-kx committed Jun 8, 2023
1 parent 4dd1d1d commit b13c331
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`<br><br>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.<br><br>Query the attribute `supportedSASLMechanisms` from the server’s `rootDSE` for the list of SASL mechanisms the server supports.

Result dictionary:

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -353,6 +356,9 @@ q).ldap.unbind[0i]
0i
```

:globe_with_meridians:
[The LDAP unbind operation](https://ldap.com/the-ldap-unbind-operation/)


## Scope

Expand Down

0 comments on commit b13c331

Please sign in to comment.