example_configs: make the zitadel doc more comprehensive

fixed `Userbase` attribute; added `Preferred username attribute`; added `Automatic creation`
This commit is contained in:
Haoyu Xu
2023-12-25 12:48:07 -05:00
committed by GitHub
parent ff0ea51121
commit b6e6269956
+7 -3
View File
@@ -4,8 +4,9 @@ In Zitadel, go to `Instance > Settings` for instance-wide LDAP setup or `<Organi
## Identity Providers Setup ## Identity Providers Setup
Click `Identity Providers` and select `Active Directory/LDAP`. Click `Identity Providers` and select `Active Directory/LDAP`.
Replace every instance of `dc=example,dc=com` with your configured domain.
**Group filter is not supported in `Zitadel` at the time of writing.** **Group filter is not supported in `Zitadel` at the time of writing.**
Replace every instance of `dc=example,dc=com` with your configured domain.
### Connection ### Connection
* Name: The name to identify your identity provider * Name: The name to identify your identity provider
* Servers: `ldaps://<FQDN or Host IP>:<Port for LADPS>` or `ldap://<FQDN or Host IP>:<Port for LADP>` * Servers: `ldaps://<FQDN or Host IP>:<Port for LADPS>` or `ldap://<FQDN or Host IP>:<Port for LADP>`
@@ -14,9 +15,9 @@ Replace every instance of `dc=example,dc=com` with your configured domain.
* Bind Password: `<user password>` * Bind Password: `<user password>`
### User binding ### User binding
* Userbase: `ou=people,dc=example,dc=com` * Userbase: `dn`
* User filters: `uid`. `mail` will not work. * User filters: `uid`. `mail` will not work.
* User Object Classes: `inetOrgPerson` * User Object Classes: `person`
### LDAP Attributes ### LDAP Attributes
* ID attribute: `uid` * ID attribute: `uid`
@@ -24,6 +25,7 @@ Replace every instance of `dc=example,dc=com` with your configured domain.
* Email attribute: `mail` * Email attribute: `mail`
* Given name attribute: `givenName` * Given name attribute: `givenName`
* Family name attribute: `lastName` * Family name attribute: `lastName`
* Preferred username attribute: `uid`
### optional ### optional
The following section applied to `Zitadel` only, nothing will change on `LLDAP` side. The following section applied to `Zitadel` only, nothing will change on `LLDAP` side.
@@ -36,6 +38,8 @@ The following section applied to `Zitadel` only, nothing will change on `LLDAP`
**DO NOT** enable `Automatic update` if you haven't setup a smtp server. Zitadel will update account's email and sent a verification code to verify the address. **DO NOT** enable `Automatic update` if you haven't setup a smtp server. Zitadel will update account's email and sent a verification code to verify the address.
If you don't have a smtp server setup correctly and the email adress of `ZITADEL Admin` is changed, you are **permanently** locked out. If you don't have a smtp server setup correctly and the email adress of `ZITADEL Admin` is changed, you are **permanently** locked out.
`Automatic creation` can automatically create a new account without user interaction when `Given name attribute`, `Family name attribute`, `Email attribute`, and `Preferred username attribute` are presented.
## Enable Identity Provider ## Enable Identity Provider
After clicking `Save`, you will be redirected to `Identity Providers` page. After clicking `Save`, you will be redirected to `Identity Providers` page.