Overview
- Business Units feature must be enabled on your Workpath account
- A working Workpath SAML integration in Entra ID
- Business Units created in Workpath with their External ID field set (see Step 3)
How It Works
- Users are added to any Business Units whose External ID matches an identifier in the SAML response
- Users are removed from any Business Units whose External ID is no longer present in the SAML response
- Identifiers that don't match any Business Unit in Workpath are silently ignored
Choose Your Setup Method
| Method | When to use | SAML attribute |
| Group Claim | You have a single Entra ID group per Business Unit | business_units |
| App Roles | You need to combine multiple Entra groups into one Business Unit, or prefer role-based assignment | Role claim (sent automatically) |
Method 1: Using Group Claims
Step 1: Configure the Group Claim in Entra ID
- Open Entra ID
- In the navigation, select Entra ID > Enterprise apps
- Select your Workpath SAML Integration
- Add the group under Users and groups so that users are entitled to log in
- Go to Single Sign-on
- Click Edit on Attributes & Claims
- Click Add a Group Claim
- Select All groups, or filter for the specific groups that represent Business Units
- Under Advanced options, tick Customize the name of the group claim
- Set the name to:
business_units - Click Save
Your Additional Claims section should now include a claim named
business_units.Step 2: Note the Group Object IDs
a1b2c3d4-e5f6-...). You'll need these in Step 3.Step 3: Set External IDs on Business Units in Workpath
If this is the first Business Unit you're activating, notify your Workpath Client Success Manager to activate the feature.
For each Business Unit in Workpath, set its External ID to the Object ID of the corresponding Entra ID group. This is the identifier Workpath uses to match incoming SAML data to Business Units.
Method 2: Using App Roles
App Roles are sent via the standard Microsoft role claim — no additional attribute configuration is needed in Workpath.
Step 1: Create App Roles in Entra ID
- Open Entra ID
- In the navigation, select Entra ID > App registrations
- Select the app registration associated with your Workpath SAML integration
- Go to App Roles > Create App Role
-
Set:
- Display name: A descriptive name (e.g., the Business Unit name)
- Allowed member types: Users/Groups
- Value: A unique identifier (this is what Workpath will match against the External ID)
- Click Apply
- Repeat for each Business Unit
Step 2: Assign Users or Groups to App Roles
- Go back to Enterprise Applications > your Workpath SAML integration
- Go to Users and groups > Add user/group
- Select the users or groups and assign them to the appropriate App Role
Step 3: Set External IDs on Business Units in Workpath
FAQs
Q: I've changed the BU membership of a user, but don't see the result in Workpath?
A: Workpath can only synchronize BU membership during a login, due to limitations of the underlying protocol, SAML. Ask the user to log out and back in.
Q: What happens when a user logs in and their groups/roles have changed?
A: Workpath performs a full sync on every login. Users are added to BUs matching the new identifiers and removed from BUs that are no longer present. Changes take effect immediately upon login.
Q: Does this work with IdPs other than Microsoft Entra ID?