Configuring Mappers in the Identity Broker
A common practice for managing AtScale users is the programmatic mapping of users to the appropriate AtScale groups or roles. When users authenticate through AtScale (either from Design Center or BI tools), they are automatically assigned to an AtScale group/role based on the mapped IdP group.
The following sections describe how to map an IdP group to an AtScale group. Similar steps can be followed for auto-assignment to roles.
Mappings are based on what is sent in an assertion (claims, attributes). Every IdP has specific mappings; for example, Entra ID uses Object Ids, and Okta uses attributes. The following procedures are based on the most common protocols (OIDC and SAML) and include examples from common identity providers (Entra ID and Okta).
Depending on your IdP, the actual configuration steps may be slightly different than what is shown below. AtScale recommends cross referencing with external tooling and validating your assertions before mapping IdP groups to AtScale groups or roles.
Prerequisites
Before continuing, verify that you meet the following requirements:
- You have the
admin
role assigned in the Identity Broker. - Your IdP is connected to AtScale. For more information, see Using External Authentication.
- You created the AtScale groups you require. For instructions, see Managing Users with the Identity Broker.
Configure mappers for OIDC IdPs
To configure mappers for IdPs that use OIDC:
-
In Design Center, open the main menu and select Security. The Identity Broker opens.
-
Log in using your AtScale admin credentials.
-
In the left-hand navigation, click Identity Providers, then click on your IdP.
-
Go to the Mappers tab.
-
Click Add mapper. A blank mapper appears.
-
Complete the following fields:
- Name: Enter a name for the mapper.
- Sync mode override: Select a sync mode override. AtScale recommends using Force, which updates the user during every login.
- Mapper type: Select the type of mapper you want to create. For example, if you want to map to groups, select Advanced Claim to Group. If you want to map to roles, select Advance Claim to Role.
-
Add a claim:
- Click Add Claims.
- In the Key field, enter an appropriate group identifier. For example,
group
. - In the Value field, enter the group identifier used by your IdP. For example, for Entra ID, this would be
Object Id
.
-
In the Group field, select the AtScale group you want to map to.
-
Click Save.
The mapper is added to the Identity Broker. You should repeat the steps above for every combination of claims (usually a single IdP group) you want to auto-map to an AtScale group/role.
Configure mappers for SAML IdPs
To configure mappers for IdPs that use SAML:
-
In Design Center, open the main menu and select Security. The Identity Broker opens.
-
Log in using your AtScale admin credentials.
-
In the left-hand navigation, click Identity Providers, then click on your IdP.
-
Go to the Mappers tab.
-
Click Add mapper. A blank mapper appears.
-
Complete the following fields:
- Name: Enter a name for the mapper.
- Sync mode override: Select a sync mode override. AtScale recommends using Force, which updates the user during every login.
- Mapper type: Select the type of mapper you want to create. For example, if you want to map to groups, select Advanced Attribute to Group. If you want to map to roles, select Advanced Attribute to Role.
-
Add an attribute:
- Click Add Attributes.
- In the Key field, enter an appropriate group identifier. For example, if you use Entra Id, this should be
http://schemas.microsoft.com/ws/2008/06/identity/claims/groups
. - In the Value field, enter the group identifier used by your IdP. For example, for Entra ID, this would be
Object Id
.
-
In the Group field, select the AtScale group you want to map to.
-
Click Save.
The mapper is added to the Identity Broker. You should repeat the steps above for every combination of claims (usually a single IdP group) you want to auto-map to an AtScale group/role.
Additional information
- For information on how mappers function in the Identity Broker, refer to the Keycloak documentation.
- For information on the default roles available in AtScale, see Identity Broker Default Roles.