If you previously used a custom API integration for user provisioning, you need to update your CSV script files to align with the updated API provisioning format. This update ensures that your API provisioning syncs remain successful and that new users and teams are updated as expected.
Note: Workleap API provisioning supports CSV and JSON API files. This article describes CSV-based user provisioning setups. For JSON setups, click here.
Note: The API remains backward compatible with legacy API files. However, updating is simple and quick and ensures you have access to new features.
Update your legacy API files for API provisioning
Use the tables below to convert your existing files and column headers to the current API provisioning format:
users.csv
Legacy File | New File |
users.csv | members.csv |
Legacy Column Name | New Column Name | Notes |
id | externalMemberId |
|
language | languagePreferences | Use language codes (e.g., fr, en) |
| productAssignations | New column; defaults to Officevibe if no product is specified |
groups.csv
Legacy File | New File |
groups.csv | teams.csv |
Legacy Column Name | New Column Name |
id | externalTeamId |
name | teamName |
groups-mapping.csv
Legacy File | New File |
groups-mapping.csv | teams-mappings.csv |
Legacy Column Name | New Column Name |
groupId | externalTeamId |
userId | externalMemberId |
subGroupId | externalSubteamId |
After you update your files
Generate a new API key.
Set your risk thresholds.
Make sure your provisioning script is up to date (see below).
Update your provisioning script
Important: Workleap API provisioning is only compatible with the up-to-date provisioning script provided below. If you run a legacy script with updated API files, your user provisioning syncs will fail.
Download Workleap's API provisioning script here: provisioning.zip
Adjust the file paths to your updated API provisioning files, then execute the command below in Microsoft PowerShell:
.\api-provisioning-script.ps1 `
-apiKey "<YOUR_API_KEY>" `
-membersCsvPath "C:\Workleap_Sync\SampleData\members.csv" `
-teamsCsvPath "C:\Workleap_Sync\SampleData\teams.csv" `
-teamsMappingsCsvPath "C:\Workleap_Sync\SampleData\teams-mappings.csv"
Note: PowerShell 7 or higher is required to execute the script.