If you need to import multiple teams follow the steps below to bulk import your teams. Prepare a .csv file with the following columns:
- Name
- Team name
- Parent team name (if applicable)
- Membership visibility (Yes, No, 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.
Your file should look something like this:
Note: You have the option of using either the Flow REST API, or the Teams Page to perform the bulk upload. Both methods are outlined below.
In this article
Bulk importing via the API
To import your CSV via the API, you’ll need to create an API key.
Then, enter the below URL into your preferred API client, for eg. Postman:
https://flow.pluralsight.com/v3/customer/core/team_membership/bulk_import
Then choose the CSV file you created.
Specify the import_type as either overwrite or update. In either case, you can set additional parameters for your upload:
Overwrite
- add_new_apex_users
- remove_memberships
- remove_empty_teams
- remove_teams
Update
- add_new_apex_users
See the table below for descriptions of parameters entered:
| Name | Type | Description |
|---|---|---|
| csv_file | file | Required, CSV file of teams, team memberships |
import_type | string | Required, overwrite or 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) |
Now you’re ready to hit Send!
You can verify whether or not the CSV was successful by navigating to the Teams page in the Flow app. Here, you’ll see either a banner message indicating the import’s progress. If the import was successful, you’ll see a link to view the results.
Bulk importing via the Teams page
If you are importing multi-tiered nested teams see the Multi-tiered Nested Teams section below.
- Starting on your Flow home page, go to the top navigation bar and click Settings. Using the left navigation under User Management, click Teams.
Click on Import Teams button in the top right hand corner of your screen.
- This will take you to the Team import history page. You can use an Integration import, or a .csv import. If you're using a .csv import, click the CSV import button in the top right.
- You will then be prompted to choose a csv file, then click Next.
- You have the option to update or overwrite the current teams.
Update means that the bulk import teams will be added in addition to the ones you had 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 hand side of the modal. You may check whichever options you wish to include.
Once you have selected to update or overwrite, click Next.
This step outlines what changes will occur based on your selection. In this example, we are updating and adding new users. Click Yes, Import to confirm the import.
You will return to the Team import history page. There, you can check the status of your recent import.
If there were no errors in the CSV, and the import was successful, you’ll see a success status in the status column. If there are errors in the import, you’ll see an error message in the status column. To download an updated version of the original CSV you uploaded, click on the download CSV button on the right hand side. This CSV states the errors encountered during the import process. You can then rectify the errors, and reupload the CSV to complete the process.
For more information about managing you teams and editing your teams check out the following help documents:
Multi-tiered nested teams
When importing teams that include multiple nested team levels you will use the parent_team column to associate the nested team to the most immediate parent_team. This is illustrated in the following example below:
Example Team Structure:
- King of the Castle - 0 Users, 10 Nested Users
- Front End - 0 Users, 10 Nested Users
- FE A - 2 Users
- FE B - 1 Users, 2 Nested Users
- FE B1 - 2 Users
In the above team structure, notice that the top two team levels ("King of the Castle" and "Front End") do not have any native users? In this case, the "Front End" team would be created because we would be creating it with it's immediate association to it's nested teams ("FE A" and "FE B"). The main parent team ("King of the Castle") would need to be added manually or by adding a user to either the King of the Castle or to the Front End team.
Here is what our file would look like without adding an additional user (fake or otherwise) to create "King of the Castle":
In order for the top level team to be created you will need a user to create it in the file:
- Line 7 would be adding a user directly to the top parent team
- Line 8 would be adding 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 to upload and import it above.
If you need help, please email support@pluralsight.com for 24/7 assistance.