Importing users from a CSV file

This article will show you how to import users from a CSV file.  This can be helpful if you are migrating a lot of users from a different system.

You can import the same user more than once without creating duplicate users. If ScreenSteps finds a user in the system that matches a user in the CSV file then the user settings will be updated with the settings included in the CSV file.

Prepare file

Prepare your CSV file according to the formats described below.

IMPORTANT: You must export the file as a CSV file. You cannot import a .xls file.

A note on Roles:

You can add one of the following roles to each user:

  • Reader
  • Learner
  • Editor
  • Admin

Each account has unlimited readers, but depending on your plan, you will have a limit on the number of Learner, Editor, or Admin users you can add. If your CSV file contains too many of these users the import will fail.

If you don't include a role, the user will be set as a Reader user.

Including Editable Sites for Editor users

Editable Sites

Editable Sites only apply to Editor roles. The column should be left blank for all other roles.

Editable Sites can be a comma separated list of Site titles that you want the Editor to have access to. By default they will have full access to those sites. 

This list will not remove any editable sites that the user is already assigned to. It can only be used to add additional editable sites.

Editing Permissions

Editing Permissions will default to "Full Access" if you leave the column blank.

If you would like to define specific permissions then you can include the following as comma separated values:

  • uncategorized only
  • publish
  • delete
  • moderate comments

Which every value you include will be set to true. All others will be set to false.

For standard users

When importing standard users ScreenSteps searches for an existing user first by email address and then by login. If you try to import a user with an existing login but a different email address then an error will occur.

This is an example of the CSV format for importing reader users who will be logging in through ScreenSteps.

Prepare file
For remote authentication users

When importing a remote authentication user you must import the email address that is used by the remote system. When the user tries to login ScreenSteps will use the email address provided by the remote system to find a user with a matching email in ScreenSteps.

This is an example of the CSV format that is used for importing users that will be logging in through an external system (using Single Sign-on).

The RemoteUser heading column is required and the value must be blank.

Click on Account > Users

Click on Import Users

Upload File

Choose a file (the CSV file that you exported) and then select Upload.  Your users will be imported. If you included an email address then they will be sent an email notification of their new account.


Hemanth Vinay A C

Hi Team,
is there any API to create/delete/update/get USER.

Trevor DeVore

@Hemanth - We support user provisioning with SCIM:

Nicola Carraro

Is there any way to not send the email notification when creating remote users via the csv import?

Trevor DeVore

@Nicola Just uncheck the "Send Email notification" checkbox that appears above the "Upload File" button.

Add your comment

E-Mail me when someone replies to this comment