ScreenSteps Help

How to Format Your CSV File for Bulk User Import

Updated on

Choose the Import Type

Import typeUse it when
Invite new usersYou're adding new users who will log in with a ScreenSteps password. Each user gets an invitation email to set up their account.
Preload users (SSO)You use Single Sign-On (e.g., Microsoft Entra, Google, Salesforce) and want to set up users and their groups before they first log in. No invitation emails are sent, and password login is disabled.
Update existing usersYou want to change roles, groups or other details for users who are already in ScreenSteps.

Format for Invite New Users

EmailRoleGroupsFirst NameLast NameTime ZonePreferred Site
[email protected]Site UserGroup ASteveYoung employee-kb
  • Required: Email, Role (account admin or site user)
  • Optional: Groups, First Name, Last Name, Time Zone, Preferred Site
  • Preferred Site can be a site domain (such as employee-kb) or a hostname (such as help.company.com).

Format for Preload Users (SSO)

EmailRoleGroupsFirst NameLast NameTime Zone
[email protected]Site UserGroup ASteveYoung 
[email protected]AdminGroup BJoeMontana 
  • Required: Email, Role (account admin or site user)
  • Optional: Groups, First Name, Last Name, Time Zone

Format for Update Existing Users

  • Required: Public ID or Email. ScreenSteps uses this to find each user.
  • Optional: Role, Groups, First Name, Last Name, Login, Time Zone, Deactivated, Disable Password Login
  • Login: usually the same as the email address.
  • Deactivated: leave blank unless deactivating the user. Use true to deactivate.
  • Disable Password Login: use true to stop the user from logging in with a ScreenSteps password.

Accounts That Assign Roles Through Groups

If your account assigns roles through groups, the import doesn't use a Role column. Leave it out and assign roles with the Groups column instead.

Save and Upload

  1. Save your file as a CSV

     

  2. Open Import users
    1. Click Settings > Users.
    2. Click Add > Import users.

  3. Choose the import type and upload your file
    1. Select the import type: Invite new users, Preload users (SSO) or Update existing users.
    2. Check the CSV requirements for the required and optional headers.
    3. Drag your CSV into the upload area, or click to upload.
    4. Click Import.

Previous Article Overview of Importing Users into ScreenSteps with CSV
Next Article Download a Sample CSV File for Importing Users in Bulk