The following sample includes 5 rows of content for a user along with the required header line. The file consists of 10 to 15 mandatory columns, depending on the version of D2L Standard CSV that you're using. Each must be populated with a valid value or left empty depending on the file format.
type,action,username,org_defined_id,first_name,last_name,password,is_active,role_name,email,relationships,pref_first_name,pref_last_name,sort_last_name,pronouns
user,UPDATE,jparent,jparent1,Joseph,Parent,,1,Parent,jparent@brightspacedemo.com,,Joe,,,they/them
user,UPDATE,pparent,pparent1,Patricia,van der Berg,,1,Parent,pparent@brightspacedemo.com,,Patty,,Berg,she/her
user,UPDATE,tteacher,tteacher1,Tammy,Teacher,,1,Teacher,tteacher@brightspacedemo.com,,Tamtam,,,
user,UPDATE,sstudent,sstudent1,Sammy,Student,,1,Student,sstudent@brightspacedemo.com,Parent:jparent1|Parent:pparent1,Sam,,,
user,UPDATE,wstudent,wstudent1,Will,van Baas,,1,Student,wstudent@brightspacedemo.com,Parent:jparent1|Parent:pparent1,Joe Jr.,,Baas,he/him/they
| Column |
Field |
Required |
Possible Values |
Notes |
| 1 |
type |
Required |
user |
Must be lowercase. |
| 2 |
action |
Optional |
CREATE, UPDATE, DELETE |
Case insensitive. If not specified, default is UPDATE |
| 3 |
username |
Required |
Max length: 256 |
Brightspace requires unique usernames for user accounts. |
| 4 |
org_defined_id |
Required |
Max length: 256 |
This ID must be a unique value that identifies a single user. D2L recommends using the SIS’s unique user identifier. This ID becomes the unique user identifier (also called the Sourced ID) in IPSIS. You can also update it in the User Sourced Id tab of IPSIS Administration. |
| 5 |
first_name |
Required |
Max length: 64 |
|
| 6 |
last_name |
Required |
Max length: 64 |
|
| 7 |
password |
Optional |
Max length: 50 |
If a password is not specified, Brightspace will generate a password.
If a password is not specified and you are logging in using native authentication, on the Brightspace login page, click Forgot your password to reset your password. |
| 8 |
is_active |
Required |
1, 0, TRUE, FALSE |
Case insensitive. |
| 9 |
role_name |
Required |
Max length: 60 |
Role name at the organization level |
| 10 |
email |
Optional |
Max length: 256 |
|
| 11 |
relationships |
Optional |
Refer to Relationships for D2L Standard CSV 1.1 or Relationships for D2L Standard CSV 2.0 or higher<![CDATA[ ]]> |
For examples of relationships, refer to Relationships for D2L Standard CSV 1.1 or Relationships for D2L Standard CSV 2.0 or higher.
To remove a relationship, exclude it from the record.
Column required in D2L Standard CSV version 1.1 and higher.
|
| 12 |
pref_first_name |
Optional |
Max length: 64 |
Column required in D2L Standard CSV version 2.0 and higher. |
| 13 |
pref_last_name |
Optional |
Max length: 64 |
Column required in D2L Standard CSV version 2.0 and higher. |
| 14 |
sort_last_name |
Optional |
Max length: 64 |
Column required in D2L Standard CSV version 2.1 and higher. |
| 15 |
pronouns |
Optional |
Max length: 50 |
Column required in D2L Standard CSV version 3.0 and higher. |
For D2L Standard CSV 1.1, the possible values for the relationships field include a JSON array of objects. Each object must be a set of key/value pairs. The pairs specify a relationship type and the Org Defined Id of another user.
The general format of the field is as follows: [{""Type"": ""Parent"", ""Id"": ""org_defined_id""}]"
|
Note: "Type" must be Parent. No other values are supported. |
Example 1: "[{""Type"": ""Parent"", ""Id"": ""bobsmith0763""}]"
Example 2: "[{""Type"": ""Parent"", ""Id"": ""bobsmith0763""}, {""Type"": ""Parent"", ""Id"": ""amandasmith8337""}]"
For D2L Standard CSV 2.0 and higher, the possible values for the relationships field are a pipe-separated list of key/value pairs. Each pair specifies a relationship type, and the Org Defined Id of another user.
The general format of the field is as follows: Type:OrgDefinedId
|
Note: "Type" can be either Parent or Auditor.
|
Example 1: Parent:877299
Example 2: Parent:bobsmith0763|Parent:amandasmith8337
Example 3: Auditor:de_admin_99877