Skip to content

Commit 6fab5e9

Browse files
Use dn instead of username
1 parent d5d55fd commit 6fab5e9

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

docs/specs/ldap.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ When the connection URL starts with `ldaps://`, then Authgear will connect to th
3434
It is very common that before a LDAP client can run any [Search Operation](https://datatracker.ietf.org/doc/html/rfc4511#section-4.5),
3535
the LDAP client must perform [Bind Operation](https://datatracker.ietf.org/doc/html/rfc4511#section-4.2) first.
3636

37-
Authgear supports Simple Bind with username and password.
37+
Authgear supports Simple Bind with DN and password, according to https://datatracker.ietf.org/doc/html/rfc4513#section-5.1.3
3838

3939
## Configuration of LDAP servers
4040

@@ -86,14 +86,16 @@ secrets:
8686
- data:
8787
items:
8888
- name: default
89-
username: authgear
89+
# According to https://datatracker.ietf.org/doc/html/rfc4513#section-5.1.3,
90+
# Simple Bind takes a DN and a password.
91+
dn: cn=authgear,dc=example,dc=com
9092
password: secret1
9193
key: ldap
9294
```
9395

9496
- `items.name`: To associate a LDAP server in `authgear.yaml`.
95-
- `items.username`: Optional. The username Authgear uses to authenticate itself to the LDAP server. If it is not provided, then Authgear does not authenticates itself, and assumes the LDAP server allows anonymous requests.
96-
- `items.password`: Optional. The password Authgear uses to authenticate itself to the LDAP server. If `username` is provided, then `password` is required.
97+
- `items.dn`: Optional. The DN of the LDAP entry Authgear uses to authenticate itself to the LDAP server. If it is not provided, then Authgear does not authenticates itself, and assumes the LDAP server allows anonymous requests.
98+
- `items.password`: Optional. The password of the LDAP entry Authgear uses to authenticate itself to the LDAP server. If `dn` is provided, then `password` is required.
9799

98100
## Validation on the configuration
99101

0 commit comments

Comments
 (0)