Offboarding - Overview
Follow the steps below to set up the offboarding integration between Firstbase and Microsoft Entra ID.
Note: Prior to setting up your integration, please ensure you have admin access and connect your account to Microsoft Entra ID if you haven’t done so by following these steps.
The offboarding integration will offboard an employee in Firstbase and start the return process for their equipment (if they have equipment to return) whenever you terminate a user in Microsoft Entra ID. It will then check if the user is active in Firstbase, and if so, start the offboarding process in Firstbase.
1. When does the offboarding integration run?
The Offboarding Integration runs once a day every 24 hours. It’ll run each day at the same time you start the offboarding workflow the first time. It may take 1-2 hours to run depending on the amount of employees in your system.
We will offboard employees the day after the effective termination date we receive via Microsoft Entra ID . We do this to avoid possible scenarios where an employee is terminated in Microsoft Entra ID before they are notified.
2. How does the offboarding integration work?
The integration will ingest a list of terminated employees and start the offboarding process for any employee with an effective termination date of the day before today, that's still active in Firstbase.
3. How do I set the offboarding integration up?
1. Visit your Microsoft Entra ID Integrations page
2. Configure your "Offboarding Integration" (Optional)
The offboarding integration can be optionally configured to only offboard certain employees based on a criteria you determine. To do so, follow these steps:
- Open up the "Offboard User" flow within your Microsoft Entra ID Integration page
- Click on "Configure"
The following modal will open up. Choose "Add row"
- Set up your configuration options:
Here, you can choose the fields you want to use to exclude/include only certain employees when the integration runs using one of the six available operators. See FAQs here for more info on the available operators if needed.
All conditions are AND conditions, meaning we'll consider all when assigning a package. There's no OR conditions today.
The integration fields available to configure your offboarding workflow include only the "Country" field.
Let's go through an example of how to set this up:
-
I'd like to only offboard employees based in Singapore and UK
For this option, you'll need to configure your customization settings the following way:
- Country IN SG, UK
Note: When setting up country values please follow standard standard 2 character ISO country codes. More info here -> https://www.iban.com/country-codes.
3. Start your "Offboard User" Integration
Click on the “Start” button in the Offboard User flow and you should be ready to go.