Skip to content

Commit c54a9eb

Browse files
committed
Update additional groups documentation
1 parent e1ad410 commit c54a9eb

File tree

3 files changed

+57
-33
lines changed

3 files changed

+57
-33
lines changed

Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,5 @@ end
2727
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
2828
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
2929

30+
31+
gem "webrick", "~> 1.7"

Gemfile.lock

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
GEM
22
remote: https://rubygems.org/
33
specs:
4-
activesupport (3.2.22.5)
5-
i18n (~> 0.6, >= 0.6.4)
6-
multi_json (~> 1.0)
4+
activesupport (6.0.6)
5+
concurrent-ruby (~> 1.0, >= 1.0.2)
6+
i18n (>= 0.7, < 2)
7+
minitest (~> 5.1)
8+
tzinfo (~> 1.1)
9+
zeitwerk (~> 2.2, >= 2.2.2)
710
addressable (2.8.1)
811
public_suffix (>= 2.0.2, < 6.0)
912
coffee-script (2.4.1)
@@ -20,13 +23,13 @@ GEM
2023
http_parser.rb (~> 0)
2124
ethon (0.16.0)
2225
ffi (>= 1.15.0)
23-
eventmachine (1.2.7-x64-mingw32)
26+
eventmachine (1.2.7)
2427
execjs (2.8.1)
25-
faraday (2.6.0)
28+
faraday (2.7.2)
2629
faraday-net_http (>= 2.0, < 3.1)
2730
ruby2_keywords (>= 0.0.4)
28-
faraday-net_http (3.0.1)
29-
ffi (1.15.5-x64-mingw32)
31+
faraday-net_http (3.0.2)
32+
ffi (1.15.5)
3033
forwardable-extended (2.6.0)
3134
gemoji (3.0.1)
3235
github-pages (227)
@@ -203,24 +206,24 @@ GEM
203206
kramdown-parser-gfm (1.1.0)
204207
kramdown (~> 2.0)
205208
liquid (4.0.3)
206-
listen (3.7.1)
209+
listen (3.8.0)
207210
rb-fsevent (~> 0.10, >= 0.10.3)
208211
rb-inotify (~> 0.9, >= 0.9.10)
209212
mercenary (0.3.6)
210213
minima (2.5.1)
211214
jekyll (>= 3.5, < 5.0)
212215
jekyll-feed (~> 0.9)
213216
jekyll-seo-tag (~> 2.1)
214-
multi_json (1.15.0)
215-
nokogiri (1.13.9-x64-mingw32)
217+
minitest (5.17.0)
218+
nokogiri (1.13.10-arm64-darwin)
216219
racc (~> 1.4)
217220
octokit (4.25.1)
218221
faraday (>= 1, < 3)
219222
sawyer (~> 0.9)
220223
pathutil (0.16.2)
221224
forwardable-extended (~> 2.6)
222225
public_suffix (4.0.7)
223-
racc (1.6.0)
226+
racc (1.6.2)
224227
rake (13.0.6)
225228
rb-fsevent (0.11.2)
226229
rb-inotify (0.10.1)
@@ -242,28 +245,30 @@ GEM
242245
unf (~> 0.1.4)
243246
terminal-table (1.8.0)
244247
unicode-display_width (~> 1.1, >= 1.1.1)
248+
thread_safe (0.3.6)
245249
typhoeus (1.4.0)
246250
ethon (>= 0.9.0)
247-
tzinfo (2.0.5)
248-
concurrent-ruby (~> 1.0)
249-
tzinfo-data (1.2022.6)
250-
tzinfo (>= 1.0.0)
251+
tzinfo (1.2.10)
252+
thread_safe (~> 0.1)
251253
unf (0.1.4)
252254
unf_ext
253-
unf_ext (0.0.8.2-x64-mingw32)
255+
unf_ext (0.0.8.2)
254256
unicode-display_width (1.8.0)
257+
webrick (1.7.0)
258+
zeitwerk (2.6.6)
255259

256260
PLATFORMS
257-
x64-mingw32
261+
arm64-darwin-21
258262

259263
DEPENDENCIES
260264
github-pages
261265
jekyll-feed (~> 0.6)
262266
just-the-docs
263267
tzinfo-data
268+
webrick (~> 1.7)
264269

265270
RUBY VERSION
266-
ruby 2.6.3p62
271+
ruby 3.1.3p185
267272

268273
BUNDLED WITH
269-
2.3.18
274+
2.3.26

en/user-manual/advanced_configuration.md

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -640,7 +640,7 @@ the next batch.
640640
# Additional Group Options
641641

642642
It is possible for the User Sync Tool to sync group relationships that
643-
are not explicitly mapped out in `user-sync-config.yml`. Any LDAP group
643+
are not explicitly mapped out in `user-sync-config.yml`. Any identity source group
644644
that a user belongs to directly can be mapped and targeted to an Adobe
645645
profile or user group using the `additional_groups` configuration
646646
option.
@@ -658,25 +658,42 @@ Possible use cases:
658658
## Additional Group Rules
659659

660660
`additional_groups` is defined in `user-sync-config.yml` in the `groups`
661-
object. It specifies a list of rules to identify and filter groups
662-
present in the `memberOf` LDAP attribute, as well as rules that govern
663-
how corresponding Adobe groups should be named. Groups that are
664-
discovered with this feature will be added to a user's list of
665-
targeted Adobe groups.
661+
object. It consists of a series of rules that can identify groups assigned
662+
to a given user. These rules are used to assign users to groups dynamically
663+
based on information matched in the groups matched from the identity source.
666664

667665
**Note:** Additional group mapping will fail if a multiple source groups
668666
map to the same target group.
669667

670-
## Configure 'dynamic_group_member_attribute'
668+
## Directory Connector Support
671669

672-
From User Sync tool 2.5 onward, you are required to mention the `memberOf`
673-
LDAP attribute in `connector-ldap.yml`. There is no default value and if
674-
`addtional_groups` is defined but `dynamic_group_member_attribute` not defined,
675-
you would see an warning. Here is example:
670+
1. `ldap`
676671

677-
```yaml
678-
dynamic_group_member_attribute: 'memberOf'
679-
```
672+
From User Sync tool 2.5 onward, you are required to mention the `memberOf`
673+
LDAP attribute in `connector-ldap.yml`. There is no default value and if
674+
`addtional_groups` is defined but `dynamic_group_member_attribute` not defined,
675+
you would see an warning. Here is example:
676+
677+
```yaml
678+
dynamic_group_member_attribute: 'memberOf'
679+
```
680+
681+
2. `csv`
682+
683+
The CSV connector supports `additional_groups` rules with no special
684+
configuration. Any groups assigned a user in the `groups` column of the input
685+
file will be checked in the additional groups logic.
686+
687+
3. `adobe_console`
688+
689+
The `adobe_console` connector works similarly to the `csv` connector. All
690+
groups assigned to a user are checked in the Additional Groups rules if
691+
`additional_groups` is enabled.
692+
693+
4. `okta`
694+
695+
`additional_groups` functionality is not supported for the Okta connector due
696+
to the nature of the Okta's group API.
680697

681698
## Additional Group Example
682699

0 commit comments

Comments
 (0)