Skip to content

Commit 2f540a1

Browse files
committed
update changelog and release notes
1 parent 5fb6a84 commit 2f540a1

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed

.changelog/changelog.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,76 @@
1+
| tag | date | title |
2+
|---------|------------|------------------------|
3+
| v2.11.0 | 2024-12-12 | User Sync Tool v2.11.0 |
4+
5+
# New Features
6+
7+
This release introduces the **Users In Multiple Groups** (UMG) feature for Sign Sync. This feature allows Sign Sync to target Sign accounts with UMG enabled to fully utilize the User Sync Tool.
8+
9+
UMG sync can be enabled in the `user_sync` config setting:
10+
11+
```yaml
12+
user_sync:
13+
sign_only_limit: 100
14+
sign_only_user_action: reset
15+
# default is False
16+
umg: True
17+
```
18+
19+
With UMG enabled, the `sign_group` setting in a group mapping can be a list of Sign groups to target:
20+
21+
```yaml
22+
- directory_group: Sign Users
23+
sign_group:
24+
- Group 1
25+
- Group 2
26+
```
27+
28+
Group admin status is assigned differently. If `group_admin` is set to `True`, then groups for the user to admin must be specified in their own list.
29+
30+
```yaml
31+
- directory_group: Sign Users
32+
sign_group:
33+
- Group 1
34+
- Group 2
35+
# groups specified in "group_admin" list must be present in
36+
# sign_group list
37+
group_admin: True
38+
admin_groups:
39+
- Group 1
40+
```
41+
42+
(note: `group_admin` is actually deprecated and can be omitted. `admin_groups` is sufficient for managing group admin status)
43+
44+
Account admin status is also handled differently in this release. The `account_admin` field inside a group mapping rule is still permitted for now, but is deprecated. Instead, directory groups that grant account admin status should be set using `account_admin_groups`.
45+
46+
```yaml
47+
account_admin_groups:
48+
- Sign Admins 1
49+
- Sign Admins 2
50+
```
51+
52+
Finally, since a user's primary group impacts several key aspects of user experience, if UMG is enabled, then rules must be specified to designate primary groups for all users. `primary_group_rules` is a new config construct that specifies rules to designate a primary group given different sets of Sign groups.
53+
54+
**NOTE:** Primary group rules are evaluated after group management rules are resolved. `sign_groups` may contain groups that aren't specified in group mappings.
55+
56+
```yaml
57+
primary_group_rules:
58+
# sign_groups list can specify groups that aren't necessarily assigned
59+
# the user in the sync tool
60+
- sign_groups:
61+
- Sign Group 1
62+
- Sign Group 2
63+
# assign the primary group only if the user is a member of all groups
64+
# specified in sign_groups
65+
primary_group: Sign Group 2
66+
```
67+
68+
# Notes
69+
70+
* **Sign Sync:** Cache funtionality is disabled for the time being
71+
72+
---
73+
174
| tag | date | title |
275
|------------|------------|---------------------------|
376
| v2.11.0rc1 | 2024-11-08 | User Sync Tool v2.11.0rc1 |

.changelog/latest.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,14 @@ Group admin status is assigned differently. If `group_admin` is set to `True`, t
3737

3838
(note: `group_admin` is actually deprecated and can be omitted. `admin_groups` is sufficient for managing group admin status)
3939

40+
Account admin status is also handled differently in this release. The `account_admin` field inside a group mapping rule is still permitted for now, but is deprecated. Instead, directory groups that grant account admin status should be set using `account_admin_groups`.
41+
42+
```yaml
43+
account_admin_groups:
44+
- Sign Admins 1
45+
- Sign Admins 2
46+
```
47+
4048
Finally, since a user's primary group impacts several key aspects of user experience, if UMG is enabled, then rules must be specified to designate primary groups for all users. `primary_group_rules` is a new config construct that specifies rules to designate a primary group given different sets of Sign groups.
4149

4250
**NOTE:** Primary group rules are evaluated after group management rules are resolved. `sign_groups` may contain groups that aren't specified in group mappings.

0 commit comments

Comments
 (0)