Users can be created and updated using CSV Imports.
Users can typically update any of this information in the Account Settings page if needed.
Email address must uniquely identify the user and is used as the username on login. In addition if you are using a Learning Management System, the email addresses for users between systems must be identical.
The fields requested for the update are identical to those requested for create, with the exception of needing the User ID for making updates. Generating a User Export will provide 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 cited below, if a value is blank for an optional field, the value is removed for that item. Similarly, if the FIELD itself is missing from the import file for an optional field, that value will be removed from ALL of the items in the update file. If the field is required, it must both exist in the import file and must have a value in it.
Removing or Appending 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 resident 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 (the column is not resident) from the import, that value will be removed from ALL of the 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 semi-colon.
Create User
Download a sample CSV file and enter the values for your new users 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 semi-colons; 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 itself is missing from the import file for an optional field, that value will be removed from ALL of the items in the update file. If the field is required, it must both exist in the import file and must have a value in it.
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 semi-colons; 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 |