Upload Users Sync Profile

Running a sync

This sync profile type provides an API endpoint where users can upload a file. Please create a ticket for more information on interacting with and authenticating to this API.

The CSV File

For the sync profile to be able to create and update users your CSV file will need a minimum of 4 columns: Username, Email, Firstname and Lastname. The minimum the CSV file requires just to update the users is Username.

The CSV file should have a header row whose column names match the values supplied in the Attribute Mapping section when setting up the Upload Users Sync in your sync profile settings. Each of the fields described below can be included in your CSV file and colums in the CSV file that aren't mapped to one of these fields will become a custom attribute.

Username

The minimum required field for the CSV to update users, this field is mapped via the Username Field. This will populate the Cloudwork Username and must be valid with the rules set for Usernames.

First Name

This field is mapped via the First Name Mapping Field, this will populate the first name in Cloudwork.

Last Name

This field is mapped via the Last Name Mapping Field, this will populate the last name in Cloudwork.

Primary Email

This field is mapped via the Primary Email Mapping Field, this field must contain a valid email address and will populate the primary email field in Cloudwork.

Secondary Email

This field is mapped via the Secondary Email Mapping Field, similarly to Primary Emails, it must contain a valid email address. This will populate the secondary email field in Cloudwork.

SIS ID

This field is mapped via the SIS ID Mapping Field, this will populate the SIS ID field in Cloudwork.

Role

This field is mapped via the Role Mapping Field, this will most likely be something from our list of roles:

• Teacher
• Student
• Alum
• Staff
• Employee
• Parent

Password

This field is mapped via the Password Mapping Field and will populate the password in Cloudwork.

Recovery Details

Recovery Email Addresses are mapped via the Recovery Email Mapping Field and Recovery Phone Numbers are mapped via the Recovery Phone Mapping Field. This will populate the recovery information in Cloudwork.

Form

This field is mapped via the Form Mapping Field.