Users can be created and updated using CSV Imports.
Users can typically update this information on the Account Settings page if needed.
The email address must uniquely identify the user and is used as the username at login. Also, if you use a Learning Management System, user email addresses between systems must match.
The fields requested for the update are the same as those requested for create, except that the update requires the User ID. A User Export provides all the data you need for an Update-action import.
Imported files must have all fields / columns requested: If the Update-import example contains a field, that field MUST be included in the final import, even if you are not making changes to the values for that field. As noted below, if an optional field is blank, the value is removed for that item. Similarly, if the FIELD is missing from the import file for an optional field, that value will be removed from all items in the update file. If the field is required, it must both exist in the import file and have a value.
Remove or Append Field Values on Update
Since you can copy existing values from an export into an update-action import file, we expect that if you wish to retain the existing values, those will be present in the import. This means that for updates:
- To REMOVE the value(s) for a field where the value is optional, remove the existing value and leave the field blank.
- If the value is required and the field is blank, the row will be rejected.
- If the value is optional and the field is blank, the value will be removed from the object's properties.
- If the value is optional and the field is missing from the import (the column is not present), that value will be removed from ALL items in the update.
- To REPLACE the value for a field, remove the existing value and replace it with the new/updated value.
- To APPEND the values in a field where multiple values are allowed, retain the existing values but add the new values into the field (separating with a semicolon).
Create User
Download a sample CSV file and enter your new users' values into the fields provided. Then import your new file.
| Field Name | Description | Example |
|---|---|---|
Email (required) |
Email address of the user | jdoe@university.edu |
First Name (required) |
First name of the user | Jane |
Last Name (required) |
Last name of the user | Doe |
Roles (required) |
The role(s) the user has in the system; valid values include Admin, Instructor, Teaching Assistant, Scheduler, Student Separate multiple values with semicolons; Example - Scheduler;Student |
Admin or Teaching Assistant;Student |
Profile Image (optional) |
URL of the location of the profile image (avatar) to use for the user. | http://image.url |
Time Zone (optional) |
Time zone where the user is located; used to display local time for the user | US/Eastern |
SSO_id |
Identifier for the user as recognized by your Single Sign-On solution | bsmith or User ID number in external system |
External ID (optional) |
External system identifier of the user | Determined by the external system |
Update User
Generate a User Export, then select and update the necessary information for the import file. Then import your new file.
IMPORTED FILES MUST HAVE ALL FIELDS/COLUMNS REQUESTED: If the Update-import example contains a field, that field MUST be included in the final import, even if you are not making changes to the values for that field. As cited above, if a value is blank for an optional field, the value is removed for that item. Similarly, if the FIELD is missing from the import file for an optional field, that value will be removed from all items in the update file. If the field is required, it must both exist in the import file and have a value.
| Field Name | Description | Example |
|---|---|---|
User ID (required) |
System ID of the user being updated | 4401894a-eb32-423c-aa74-a25000b4a91b |
Email (required) |
Email address of the user | jdoe@university.edu |
First Name (required) |
First name of the user | Jane |
Last Name (required) |
Last name of the user | Doe |
Roles (required) |
The role(s) the user has in the system; valid values include Admin, Instructor, Teaching Assistant, Scheduler, Student Separate multiple values with semicolons; Example - Scheduler;Student |
Admin or Instructor;Teaching Assistant |
Profile Image (optional) |
URL of the location of the profile image (avatar) to use for the user | http://image.url |
Time Zone (optional) |
Time zone where the user is located; used to display local time for the user | US/Eastern |
SSO_id |
Identifier for the user as recognized by your Single Sign-On solution | bsmith or User ID number in external system |
External ID (optional) |
External system identifier of the user | Determined by the external system |