Bulk importing users

View as Markdown

Community Platform

runZero administrators can add multiple users at once with a bulk import instead of adding them one at a time. To bulk import users, create a CSV (comma separated values) file with the user information, such as each user’s first name, last name, email, role, and organizational access.

A bulk import only adds new users; it does not update existing ones. If the file contains a user who already exists in the system, the import does not complete. Remove all duplicate users from your CSV file and import it again.

The high-level steps:

  1. Create a CSV file with your user information.
  2. Import the CSV file into runZero.
  3. Verify users have registered their accounts.

Creating the CSV file for importing users

Start from the provided template or create the CSV file from scratch. Either way, follow these guidelines and include the fields below.

  • The first row is the header row, and the file must include it. It names the fields, which must follow this order: first_name, last_name, email, all_orgs_role, org_roles.
  • runZero requires the first_name, last_name, and email fields. The organization-level fields, all_orgs_role and org_roles, are optional.
  • Write org_roles values as orgName=role, and separate multiple definitions with pipes.
  • If you leave out all_orgs_role, users get the no-access role in all organizations.
  • If you leave out orgs_role, users get the role in all_orgs_role. If you leave out both, every user gets the no-access role and must contact the runZero administrator to change their account access.

User fields for the CSV file

The fields you can include:

Field Description Example
first_name The user’s first name. sarah
last_name The user’s last name. smith
email The user’s email address. ssmith@company.org
all_orgs_role The role assigned to the user for all organizations. This is optional. user
org_roles The role assigned to the user for a specific site. Use pipes to separate the organizations. This field is optional. org1=user

The resulting CSV file looks like this:

first_name,last_name, email,all_orgs_role,orgs_role
Sarah,Smith,ssmith@company.org,user,org1=annotator|org2=annotator

Importing users into runZero

  1. Go to your Team Import page.
  2. Choose the CSV file with your user information and upload it.
  3. Import the file.

runZero alerts you to problems with the file. If the file contains an existing user, for example, the import does not complete until you remove all duplicate users and import it again.

Verifying users have registered

Each imported user receives an email invitation to join your team. The email contains a link to register their email address, which prompts them for the name and password for their account. Once the account exists, they can sign in to the runZero console.

The Teams page shows each user’s status and last sign in. Users who completed registration show an Activated status.

Updated