If you need to import multiple teams, follow the steps below to bulk import your teams.
To learn more about managing and editing your teams, check out Team management and Team details.
Note: You can use either the Flow REST API or the Teams Page to bulk upload.
Who can use this?
| Core | Plus | ||
| ✓ | ✓ |
Preparing to bulk import teams
Before bulk importing users, create a .csv file with the following columns:
- Name
- Team name
- Parent team name, if applicable
- Membership visibility: Yes, No, or Inherit
- Membership type: Viewer or Contributor
Important: When adding a new user or team, if membership visibility is left blank, we will default to Inherit. For an existing user or team, if membership visibility is left blank, we will not update this field.
Example .csv file:
Bulk importing teams via the API
You can bulk import teams from an API client.
To bulk import teams via the API:
- Create an API key. To learn more about creating an API key, see Flow REST API introduction.
- Enter the following URL into your preferred API client:
https://flow.pluralsight.com/v3/customer/core/team_membership/bulk_import/
- Choose the CSV file you created.
- Specify the import_type as either overwrite or update.
- Set any additional parameters for your upload. Find these additional parameters below.
- Click Send.
Additional parameters for Overwrite
- add_new_apex_users
- remove_memberships
- remove_empty_teams
- remove_teams
Additional parameters for Update
- add_new_apex_users
Additional parameter details:
| Name | Type | Description |
|---|---|---|
| csv_file | file | Required, CSV file of teams, team memberships |
import_type | string | Required, overwriteor update |
add_new_apex_users | boolean | True/false |
remove_memberships | boolean | True/false (only with overwrite) |
remove_empty_teams | boolean | True/false (only with overwrite) |
| remove_teams | boolean | True/false (only with overwrite) |
To verify whether or not the CSV was successful:
- In the Flow app, click Settings.
- Under User management, click Teams.
- At the top of the page, a banner indicates the import’s progress.
- If the import was successful, click the link to view the results.
Bulk importing teams via the Teams page
Note: If you're importing multi-tiered nested teams see the Bulk importing multi-tiered nested teams section below.
To bulk-import teams via the Teams page:
- Click Settings in the top navigation in Flow.
- Click Teams in the left navigation under User Management. This will take you to the Team import history page.
- Click the Integration import button or the CSV button in the top right.
- Click the Choose File button and select your .csv file.
- Click the Next button once you've chosen your .csv file.
- Select the circle for Update or Overwrite.
- Update means that Flow adds the bulk imported teams to the ones you already set up in the Flow platform.
- Overwrite means the teams you had set up in Flow will be replaced with the ones you created within the .csv file. For the overwrite option, you can fine-tune what you want to keep and what you want to officially overwrite.
Note: Selecting Update or Overwrite will display different checkbox options on the right side of the modal. You may check whichever options you wish to include.
- Update means that Flow adds the bulk imported teams to the ones you already set up in the Flow platform.
- Click Next once you finish selecting any additional options.
- Double check the settings you selected.
- Click Yes, Import to confirm the import if your settings are correct. This starts the import and takes you to the Team import history page.
- Check the status of your recent import.
- If there were no errors in the CSV and the import was successful, a success message appears in the status column.
- If there are errors in the import, an error message appears in the status column.
If there are errors in the import, Flow creates an updated .csv file stating any errors during the import process. Click the download CSV button on the right side to download a copy of the updated .csv file.
Rectify the errors and reupload the .csv file to complete the process.
Bulk importing multi-tiered nested teams
When importing teams that include multiple nested team levels, use the parent_team column to associate the nested team to the most immediate parent_team.
Tip: If one or multiple parent teams has nested users but no native users, you may need to add a fake user to the empty team in order to recreate the hierarchy.
Alternatively, manually create any empty team once you’ve imported your file, then nest the nested teams. To learn how to manually nest teams, see the Nesting a team section of How to create teams.
Example Team Structure:
- King of the Castle: 0 users, 10 nested users
- Front End: 0 users, 10 nested users
- FE A: 2 users, 0 nested users
- FE B: 1 users, 2 nested users
- FE B1: 2 users, 0 nested users
In the above team structure, the top two team levels, King of the castle and Front end, do not have any native users.
In this case, Flow creates the Front end team because of its immediate association to its nested teams, FE A and FE B. The main parent team, King of the castle, must be added manually.
Alternatively, a user must be added to either the King of the castle or to the Front end team.
The image below shows what the file looks like without adding an additional user, fake or otherwise:
To create the top-level team, add the team to the file:
- Line 7 adds a user directly to the top parent team.
- Line 8 adds a user directly to the Front End team, thereby associating Front End to the parent_team.
Once you have your team structure mapped out in your file, follow the steps in the previous sections to upload and import it.
If you need help, please contact Pluralsight Support.