roles.csv
Roles specify whether users are Students, Parents, Teachers, or Account Admins.
Column Order and Optionality
The columns of the roles.csv file must be in the following order:
1
sourcedId
yes
no
Required by OneRoster
2
status
yes
must be blank for bulk, must be populated for delta
Follows OneRoster convention
3
dateModified
yes
must be blank for bulk, must be populated for delta
Follows OneRoster convention
4
userSourcedId
yes
no
Required by OneRoster
5
roleType
yes
no
Required by OneRoster
6
role
yes
no
Required by OneRoster
7
beginDate
yes
yes
MB does not use this field
8
endDate
yes
yes
MB does not use this field
9
orgSourcedId
yes
no
Required by OneRoster
10
userProfileSourcedId
yes
yes
MB does not use this field
Relational Columns
All of the following columns are required:
sourcedId
Uniquely identifies the record
Used referentially
role
The user role
Cannot be modified
roleType
Primary or secondary
Cannot be modified
orgSourcedId
For students: Indicates the associated program; for others should be school
Cannot be modified
userSourcedId
Points to the row in the user.csv
file
Used referentially
Import Validations
Only rows with
role
value of either "systemAdministrator", "teacher" "parent", "student", and are consumed; all others are skippedOnly rows with
roleType
value of "primary" are consumed; all others are skippedThe roles supported are:
ManageBac Role
roleType
Value
Student
student
Parent
parent
Teacher
teacher
Admin
systemAdministrator
Bulk Import Behavior
On bulk import, users not listed in the source are archived, except for Observer user types.
Export Behavior
All users are exported with one role and "primary" roleType
Core Columns
There are no columns for this entity that are required but not relational, i.e. no "Core" columns.
Non-core Columns
beginDate
Not used
Ignored
endDate
Not used
Ignored
userProfileSourcedId
Not used
Ignored
The following columns values depend on the import or export mode:
status
Must be present but emtpy
Must be present and either "active" or "tobedleted"
dateLastModified
Must be present but empty
Must be present and a date
Example file
4d74...ed70
4d74...ed70
primary
student
6a9d...2d8f
b403...558b
b403...558b
primary
student
6a9d...2d8f
Last updated
Was this helpful?