Update documentation including Sync Mode

This commit is contained in:
Martin Idel 2020-04-16 11:35:58 +02:00 committed by Stian Thorgersen
parent 3a42d9e1bc
commit eb3e2d468f
6 changed files with 11 additions and 0 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 178 KiB

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 178 KiB

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 36 KiB

View file

@ -79,4 +79,8 @@ Regardless of which identity provider you are creating, you'll see the following
|Post Login Flow
|Authentication flow that is triggered after the user finishes logging in with the external identity provider.
|Sync Mode
|Strategy of how to update user information from the idp through mappers: When choosing `legacy`, the current behavior is kept,
`import` will never update user data, while `force` will always update user data when possible. See also the documentation for <<_mappers, Identity Provider Mappers>> for more details.
|===

View file

@ -22,6 +22,13 @@ image:{project_images}/identity-provider-mapper.png[]
Select a mapper from the `Mapper Type` list. Hover over the tooltip to see a description of what the mapper does. The
tooltips also describe what configuration information you need to enter. Click `Save` and your new mapper will be added.
The mapper will update user information when the user logs in repeatedly according to the `Sync Mode Override`:
* Choose legacy to keep the mapper behavior as in the old {project_name} versions.
* Choose import to only import data when the user is first created in {project_name} during the first login to {project_name} with a particular identity provider.
* Choose force to always update user data during every user login.
* Choose `inherit` to use the sync mode configured in the identity provider, all other options will override this sync mode.
For JSON based claims, you can use dot notation for nesting and square brackets to access array fields by index.
For example 'contact.address[0].country'.