Skip to content

Commit 7d5482f

Browse files
defguard-communitygitbook-bot
authored andcommitted
GITBOOK-374: change request with no subject merged in GitBook
1 parent 7bc897a commit 7d5482f

File tree

3 files changed

+31
-16
lines changed

3 files changed

+31
-16
lines changed

.gitbook/assets/image (94).png

35.3 KB
Loading

enterprise/all-enteprise-features/ldap-and-active-directory-integration/settings-table.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ description: List with description of settings for LDAP found in settings page.
44

55
# Settings table
66

7-
| Field | Description | Default |
8-
| ------------------------------ | --------------------------------------------------------- | ---------------------------------------- |
9-
| URL | URL that points to your LDAP server. | empty |
10-
| Bind Username | Bind DN used for authentication. | cn=admin,dc=example,dc=org |
11-
| Bind Password | Password used for authentication. | empty |
12-
| Member Attribute | Naming attribute for group membership. | memberOf |
13-
| Username Attribute | Naming attribute for users. | cn |
14-
| User Search Base | Relative Distinguished Name (RDN) of your user entries. | ou=users,dc=example,dc=org |
15-
| User Object Class | Object class used for user entries. | inetOrgPerson |
16-
| Additional User Object Classes | Auxiliary classes for user entries | simpleSecurityObject, sambaSamAccount |
17-
| Groupname Attribute | Naming attribute for groups. | cn |
18-
| Group Object Class | Object class used for group entries. | groupOfUniqueNames |
19-
| Group Member Attribute | Naming attribute for group membership. | uniqueMember |
20-
| Group Search Base | Relative Distinguished Name (RDN) of your group entries. | ou=groups,dc=example,dc=org |
21-
| User RDN attribute | The attribute used in the user's DN to identify the user. | None, defaults to the username attribute |
7+
| Field | Description | Default |
8+
| ------------------------------ | ---------------------------------------------------------------------------------- | ---------------------------------------- |
9+
| URL | URL that points to your LDAP server. | empty |
10+
| Bind Username | Bind DN used for authentication. | cn=admin,dc=example,dc=org |
11+
| Bind Password | Password used for authentication. | empty |
12+
| Member Attribute | Naming attribute for group membership. | memberOf |
13+
| Username Attribute | Naming attribute for users. | cn |
14+
| User Search Base | Relative Distinguished Name (RDN) of your user entries. | ou=users,dc=example,dc=org |
15+
| User Object Class | Object class used for user entries. | inetOrgPerson |
16+
| Additional User Object Classes | Auxiliary classes for user entries | simpleSecurityObject, sambaSamAccount |
17+
| Groupname Attribute | Naming attribute for groups. | cn |
18+
| Group Object Class | Object class used for group entries. | groupOfUniqueNames |
19+
| Group Member Attribute | Naming attribute for group membership. | uniqueMember |
20+
| Group Search Base | Relative Distinguished Name (RDN) of your group entries. | ou=groups,dc=example,dc=org |
21+
| User RDN attribute | The attribute which is a part of the user's DN (the leftmost component of the DN). | None, defaults to the username attribute |
2222

2323
## Settings in depth
2424

@@ -31,7 +31,8 @@ There are a few settings that may be not so obvious:
3131
Changing the RDN attribute may cause your users to be re-added to Defguard, causing potential loss of Defguard-specific user data, e.g. their device information.
3232
{% endhint %}
3333

34-
* `User RDN attribute`: The attribute used in your user's DN. It will be used to link users between LDAP and Defguard. Depending on your setup, it may be different than the attribute used for usernames. 
34+
* `User RDN attribute`: The attribute used in your user's DN. It will be used to link users between LDAP and Defguard. Depending on your setup, it may be different than the attribute used for usernames. If left empty, your username attribute will be used instead. For example:\
35+
Given a user DN of `cn=user1,cn=users,dc=ad,dc=example,dc=com` you would set the RDN attribute to `cn`.
3536
* `Username attribute`: The username attribute which will be used to set the username of a Defguard user. The following restrictions apply:
3637
* Only alphanumeric characters except for <kbd>.</kbd>, <kbd>-</kbd> or <kbd>\_</kbd>
3738
* At least 1 and at most 64 characters

features/setting-up-your-instance/upgrading.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,20 @@ icon: chevrons-up
99
Before doing any updates please remember to **backup your database.**
1010
{% endhint %}
1111

12+
## 1.3.0 any previous alpha -> alpha 4
13+
14+
### Core
15+
16+
LDAP integration received a major overhaul of how users are mapped to Defguard users when the two way synchronization is enabled. Now users are always identified by their leftmost DN value.&#x20;
17+
18+
A new synchronization may cause some of your users to be re-added, which in turn may cause the loss of some of their Defguard specific data (e.g. their devices). This will happen if your leftmost DN component's attribute (referred to as RDN) is not the same as your current username attribute. This issue is only related to the two way synchronization mechanism and occurs only if you used one of the previous alphas of 1.3.0. Upgrading from any previous release to alpha 4 (skipping the alphas before) should not result in this happening.
19+
20+
Before an upgrade, turn off the two way synchronization. After upgrading you will have access to a new option, the RDN user attribute:
21+
22+
<figure><img src="../../.gitbook/assets/image (94).png" alt=""><figcaption></figcaption></figure>
23+
24+
Set it according to your LDAP server setup. This should be the DN's leftmost component attribute, e.g. in the case of `cn=user1,cn=users,dc=ad,dc=example,dc=com` this would be "cn". This attribute is needed to properly identify users in your LDAP server. The username attribute will be mapped to Defguard usernames. Read [settings-table.md](../../enterprise/all-enteprise-features/ldap-and-active-directory-integration/settings-table.md "mention") for a description of those settings options. After you configured this value, you can re-enable the two way synchronization.
25+
1226
## 1.3.0 (alpha)
1327

1428
* If you used the LDAP integration previously, it will be off by default after upgrading. You will have to manually enable it in the settings in the LDAP tab:\

0 commit comments

Comments
 (0)