Administrator Documentation

Use IPSIS OneRoster with Brightspace Parent & Guardian

IPSIS OneRoster can send user relationships between a parent/legal guardian and child to Brightspace. Brightspace Parent & Guardian IPSIS OneRoster integration is only available to clients in the US, Canada, Australia, and Ireland.

Currently only the following roles are considered relevant for relationship:

Parent
Guardian
Student

All other roles will be ignored.

Steps to set up OneRoster

On the IPSIS Administration page, open the Configuration tab.
If you have a OneRoster 1.1 - CSV source system, the SFTP credentials are displayed. Copy the host, username, and password (these are needed by your SIS to send CSV files to Brightspace).
If you have a OneRoster 1.1 – REST, source system, you must select the OAuth method.
1. OAuth1.0a is selected by default. Enter the valid endpoint URL, consumer key, consumer secret, and select the OAuth Signature Method.
2. If OAuth2 is selected, enter the valid Client Id and Client Secret.
Map the SIS Parent or Guardian role to your Brightspace role for parents/guardians.
Map the SIS Learner role to your Brightspace role for learners.
Map the SIS Org School to a Brightspace Org Unit Type.
Review other settings and click Save.

Note: Based on your Data exchange format, upload either .CSV file to create parent-child relationships, or make a REST request to create parent/guardian-child relationships. See below for a sample CSV file and REST request.

Sample CSV file

sourcedId,status,dateLastModified,enabledUser,orgSourcedIds,role,username,userIds,givenName,familyName,middleName,identifier,email,sms,phone,agentSourcedIds,grades,password
{studentsourceId},active,,TRUE,{orgSourcedIds},student,{learner username},{userId},{learner given Name},{learner family name},,,{learner email},,, "{parentsourceId1}, {parentsourceId2}",,{password}
{parentsourceId1},active,,TRUE,{orgSourcedIds},parent,{parent username},{userIds},{parent given name},{parent family name},,,{parent email},,,{studentsourceId},,{ password}
{parentsourceId2},active,,TRUE,{orgSourcedIds},parent,{parent username},{userId},{parent given name},{parent family name},,,{parent email},,,{studentsourceId},,{ password}

REST request

In order to create parent/guardian-child relationships, REST user creation request must include parent/guardian information in agent field.

For detailed information on REST requests, refer to REST mapping values below.

REST JSON sample with relationships defined

For a learner:

{
	"users": [{
		"sourcedId": "user1",
		"status": "active",
		"dateLastModified": "2017-06-05T22:15:00.000Z",
		"username": "userone",
		"givenName": "Richard",
		"middleName": "",
		"familyName": "Deckard",
		"role": "student",
		"identifier": "user1",
		"enabledUser": true,
		"grades": [],
		"userIds": [],
		"orgs": [{
			"sourcedId": "District1",
			"href": "https://oneroster.infinitec",
			"type": "org"
		},
		{
			"sourcedId": "School1",
			"href": "https://some_url/learningdata/v1p1/schools/5C354F4D-DFD0-406D-8B83-7D5C8B64EF8B",
			"type": "org"
		}],
		"agents": [{
			"sourcedId": "Parent1",
			"href": "https://some_url/learningdata/learningdata/v1p1/users/Parent1",
			"type": "user"
		},
		{
			"sourcedId": "Parent2",
			"href": "https://some_url/learningdata/learningdata/v1p1/users/Parent2",
			"type": "user"
		}]
	}]
}

For a parent/guardian:

{
	"users": [{
		"sourcedId": "Parent1",
		"status": "active",
		"dateLastModified": "2017-06-05T22:15:00.000Z",
		"username": "Parent1",
		"givenName": "James",
		"middleName": "",
		"familyName": "Deckard",
		"role": "parent",
		"identifier": "Parent1",
		"enabledUser": true,
		"grades": [],
		"userIds": [],
		"orgs": [{
			"sourcedId": "District1",
			"href": "https://oneroster.infinitec",
			"type": "org"
		},
		{
			"sourcedId": "School1",
			"href": "https://some_url/learningdata/v1p1/schools/5C354F4D-DFD0-406D-8B83-7D5C8B64EF8B",
			"type": "org"
		}]
	}]
}

CSV mapping values

In order to create parent/guardian-child relationships, AgentSourceIds in the users.CSV file need to be updated for both parents/guardians and learners.

Academic Sessions

OneRoster	Supported values	Brightspace mappings	Required	Notes
SourcedId			Y
Status	active, tobedeleted		N	Field is required for files in delta mode.
DateLastModified			N	Field is required for files in delta mode. Date Format YYYY-MM-DDTHH:mm:SS.sssZ
Title		Org Unit Name and Org Unit Code	Y
Type			Y	Org Unit Type
StartDate			Y	YYYY-MM-DD
EndDate			Y	YYYY-MM-DD
ParentSourcedId			N	Not Used
SchoolYear			N	Not Used

Orgs

OneRoster	Supported values	Brightspace mappings	Required	Notes
SourcedId			Y
Status	active, tobedeleted		N	Field is required for files in delta mode.
DateLastModified			N	Field is required for files in delta mode. Date Format YYYY-MM-DDTHH:mm:SS.sssZ
Name		Org Unit Name and Org Unit Code	Y	If the Identifier field is empty, the Name is copied in the Org Unit Code in Brightspace
Type	national, state, local, district, school, department		Y	Defines the OrgUnitType in Brightspace. http://www.imsglobal.org/oneroster-v11-final-specification#_Toc480452024
Identifier		Org Unit Code (if provided)	N
ParentSourcedId			N	This field specifies the parent org unit.

Courses

OneRoster	Supported values	Brightspace mappings	Required	Notes
SourcedId			Y
Status	active, tobedeleted		N	Field is required for files in delta mode.
DateLastModified			N	Field is required for files in delta mode. Date Format YYYY-MM-DDTHH:mm:SS.sssZ
SchoolYearSourcedId			N	Not used
Title		Org Unit Name and Org Unit Code	Y	Creates a Brightspace Course Template. If the CourseCode field is empty, the Title is copied into the OrgUnitCode.
CourseCode		Org Unit Code	N	If provided
Grades			N	Not used
OrgSourcedId			Y	This field specifies the parent org unit.
Subjects			N	Not used
SubjectCodes			N	Not used

Classes

OneRoster	Supported values	Brightspace mappings	Required	Notes
SourcedId			Y
Status	active, tobedeleted		N	Field is required for files in delta mode.
DateLastModified			N	Field is required for files in delta mode. Date Format YYYY-MM-DDTHH:mm:SS.sssZ
Title		Org Unit Name and Org Unit Code	Y	Creates a Brightspace Section and Course Offering. If the ClassCode field is empty, the Title is copied into the Org Unit Code.
Grades			N	Not used
CourseSourcedId			Y	This field specifies the parent org unit
ClassCode		Org Unit Code (if provided)	N	If provided
ClassType			Y	Not used
Location			N	Not used
SchoolSourcedId			Y	Not used
TermsSourcedIds			N	Not used
Subjects			N	Not used
SubjectCodes			N	Not used
Periods			N	Not used

Users

OneRoster	Supported values	Brightspace mappings	Required	Notes
SourcedId		OrgDefinedId	Y	If the Identifier field is not populated, the SourcedId is copied into the OrgDefinedId.
Status	active, tobedeleted		N	Field is required for files in delta mode.
DateLastModified			N	Field is required for files in delta mode. Date Format YYYY-MM-DDTHH:mm:SS.sssZ
EnabledUser			Y	Not used
OrgSourcedIds		Upper Org Unit Enrollments (with role in org)	Y	Enrollment in the school org units
Role	administrator, aide, guardian, parent, proctor, relative, student, teacher		Y	Role in org
UserName		UserName	Y
UserIds			N	Not used
GivenName		FirstName	Y
FamilyName		LastName	Y
MiddleName		MiddleName	N
Identifier		OrgDefinedId	N	If provided
Email		ExternalEmail	N
Sms		MobilePhone	N
Phone		HomePhone	N
AgentSourcedIds			N	Used for Brightspace Parent & Guardian. This field asserts the parent-child relationship. Both the child and parent rows must reference each other’s sourcedIds.
Grades			N	Not used
Password		Password	N

Enrollments

OneRoster	Supported values	Brightspace mappings	Required	Notes
SourcedId			Y
Status	active, tobedeleted		N	Field is required for files in delta mode.
DateLastModified			N	Field is required for files in delta mode. Date Format YYYY-MM-DDTHH:mm:SS.sssZ
UserSourcedId			Y	User to Enroll
ClassSourcedId	YYYY-MM-DD		Y	Brightspace enrollment
SchoolSourcedId			N	Not used
Role	administrator, aide, guardian, parent, proctor, relative, student, teacher	Role	Y
Primary			N	Not used
BeginDate			N	YYYY-MM-DD
EndDate			N	YYYY-MM-DD

REST mapping values