Configure mappers
To use your external identity provider (IDP) metadata for user profile information or automatic group assignment, you must define mappers within your IDP configuration.
Mapper types
Four types of mappers are available within the IDP configuration:
-
Hardcoded group: assigns the user to the specified group.
-
Attribute importer: imports user profile information, if any, from the identity provider JSON into the specified user attribute.
-
Hardcoded attribute: sets a predefined value to a specific user attribute when importing the user from the provider.
-
Advanced claim to group: assigns the user to the designated group if all specified claims exist. This mapper type is exclusively available for OpenID Connect IDPs.
Configuration
To configure an IDP mapper:
-
In the navigation drawer of the Site Administration interface, select Identity providers.
-
Select an IDP from the list.
The IDP editor opens. -
Select the Mappers tab.
-
Click the Add mapper button.
The Add mapper dialog opens. -
In the dialog:
-
Select a provider type from the Type drop-down menu.
-
Enter a name for the new mapper in the Name field.
-
Click Confirm.
The newly created mapper appears in the list.
-
-
Click the mapper to configure it.
The mapper editor opens. -
Enter the configuration properties using the table below for reference.
General
Property | Definition |
---|---|
Name |
Name of the mapper. |
Type |
Type of the mapper, as described in Mapper types. |
Sync mode override |
Overrides the default sync mode of the IDP for this mapper. Possible values are:
|
Group |
Only applicable if the mapper type is Hardcoded group. |
Claim |
Only applicable if the mapper type is Attribute importer and IDP type is OpenID Connect. |
Social profile JSON field path |
Only applicable if the mapper type is Attribute importer and IDP type is Google or Microsoft. |
User attribute name |
Only applicable if the mapper type is Hardcoded attribute. |
User attribute |
Only applicable if the mapper type is Hardcoded attribute. |
User attribute value |
Only applicable if the mapper type is Hardcoded attribute. |
Claims |
Only applicable if the mapper type is Advanced claim to group. |
Regex claim values |
Only applicable if the mapper type is Advanced claim to group. |
Group |
Only applicable if the mapper type is Advanced claim to group. |