Overview:
This article will show you how to import users from a CSV file. This will come in handy if you want to:
- Add Readers, Contributors, or Admins to your account in bulk.
- Assign Readers, Contributors, or Admins to a User Group in bulk.
- Update current user roles (e.g. from Reader to Contributor) in bulk.
Steps for importing a CSV file of your users
1. Navigate to Users
2. Click Import Users
3. Upload a CSV file
Make sure to uncheck the box next to Send Email notification if you do NOT want to send an email to users after their user account has been created in ScreenSteps.
4. Download applicable CSV template and follow instructions
The CSV file you download, and the instructions you follow, will depend on whether you are using Single Sign-on to authenticate users to ScreenSteps.
Are you using Single Sign-on?
If using Single Sign-on, download this template and follow the instructions
1. Download this CSV Template
2. Update fields
The file will have the following values on the first line:
FirstName,LastName,RemoteUser,Login,Password,Email,Group,Role,DeactivatedThe subsequent lines in the CSV file will contain the information for each user you want to import or update. Here are some things to be aware of when creating your file:
- Users will be uniquely identified by their email address.
- Put
truein the third column (RemoteUser). - ScreenSteps will not require a password for the user in this case.
- If you want to associate a user with multiple groups then place a comma between each group name and place quotes around all of the group names as a whole. Example:
,Group 1,Group 2,
If you are working with the CSV in Excel, there is no need to add quotes (" ") to separate the groups as it will automatically add those quotes to the file.
If you do add quotes to a group name in Excel, it will create a new group with quotation marks in its name (either before, after, or both).
- For the Role column you can use
admin,contributor,reader, orapi_access. - If you are updating an existing user do not include the password.
- The FirstName and LastName columns are optional.
- When adding users via CSV, they will not show up in the "Pending Invitations" list because their accounts are automatically activated as part of the upload process.
- A user will not be removed from groups they are already assigned to if the group name does not appear in the CSV file.
If NOT using Single Sign-on, download this template and follow the instructions
1. Download CSV Template
2. Update Fields
The file will have the following values on the first line:
FirstName,LastName,Login,Password,Email,Group,Role,DeactivatedThe subsequent lines in the CSV file will contain the information for each user you want to import or update. Here are some things to be aware of when creating your file:
- Users will be uniquely identified by their email address.
- Include a password for the user (required)
- If you want to associate a user with multiple groups then place a comma between each group name and place quotes around all of the group names as a whole. Example:
,Group 1,Group 2,
If you are working with the CSV in Excel, there is no need to add quotes (" ") to separate the groups as it will automatically add those quotes to the file.
If you do add quotes to a group name in Excel, it will create a new group with quotation marks in its name (either before, after, or both).
- For the Role column you can use
admin,contributor,reader, orapi_access. - If you are updating an existing user do not include the password.
- The FirstName and LastName columns are optional.
- When adding users via CSV, they will not show up in the "Pending Invitations" list because their accounts are automatically activated as part of the upload process.
- A user will not be removed from groups they are already assigned to if the group name does not appear in the CSV file.