This lesson provides information on how to setup the Microsoft School Directory Sync API and the configuration of front-end settings which are required to enable assignment grades to be imported from Teams to eSchoolData.
Organizations must be using OneRoster to use the Microsoft Grade Sync.
GURU API Permissions
To synchronize staff, students, classes, and rosters via the Microsoft Teams SDS (School Directory Sync) API:
- Login to GURU.
- Navigate to Configuration and expand the menu.
- Select Vendors.
- Select Create new Vendor.
- Enter a Vendor Name to align with the integration.
- Copy and Paste the Client ID and Client Secret. These will be entered into Microsoft to enable
the connection along with the API URL for your region. (The GURU URL with /API appended at
the end.) - Toggle on Service Account.
- Select Next.
- Enable all of the OneRoster API endpoints (all endpoints which begin with OneRoster).
- When entering the information into Microsoft you will be asked to provide a Token URL. This
should be your GURU URL with /api/v1/auth/token added to the end.
Corresponding API permissions must also be enabled for the District Admin role.
Microsoft Teams Setup
- Go to Interoperability.
- Select Partners.
- Choose Microsoft from the side menu.
-
To enable the connection between eSD and Microsoft Teams, you will need to enter:
- Tenant ID
- Client ID
- Client Secret
- Select Save.
To attain the required tokens from Microsoft Team, you will need to register the Renaissance eSD application within the Azure portal.
-
Registration to Attain Client ID:
- Go to the Azure portal and navigate to "App registrations."
- Select "New registration" and enter Renaissance eSD as the name of the application. Select the "Accounts in any organizational directory (Any Azure AD directory - Multitenant)" option - Switch this to Single Tenant
-
Attain Client Secret
- Navigate to App Registrations> Renaissance eSD > Certificates and Secrets
- Select Client Secrets + New Client Secret.
- This is the Client Secret that will be entered into eSD
-
Define Permissions
- In the registered app, go to "API permissions."
- Select "Add a permission" and select "Microsoft Graph."
- Under "Application permissions," select the required permissions for the Education Graph API (e.g., EduRoster.Read.All)
API Endpoints and GURU Permissions
Microsoft | GURU Permissions |
---|---|
POST /v1/categories DELETE /v1/categories/{id} GET /v1/categories GET /v1/categories/{id} GET /v1/sections/{id}/categories PUT /v1/categories PUT /v1/categories/{id}/updateName PUT /v1/categories/{id}/updateWeight PUT /v1/categories/{id}/updateDropLowest PUT /v1/categories/{id}/updateDropHighest POST /v1/assignmentMarks DELETE /v1/assignmentMarks/{id} GET /v1/assignmentMarks GET /v1/assignmentMarks/{id} GET /v1/assignments/{id}/assignmentMarks GET /v1/sectionEnrollments/{id}/assignmentMarks GET /v1/sections/{id}/assignmentMarks PUT /v1/assignmentMarks PUT /v1/assignmentMarks/{id}/updateScore PUT /v1/assignmentMarks/{id}/updateAlphaScore PUT /v1/assignmentMarks/{id}/updateComment PUT /v1/assignmentMarks/{id}/updatePenalty PUT /v1/assignmentMarks/{id}/updateBonus POST /v1/assignments DELETE /v1/assignments/{id} GET /v1/categories/{id}/assignments GET /v1/assignments GET /v1/assignments/{id} GET /v1/sections/{id}/assignments PUT /v1/assignments PUT /v1/assignments/{id}/updateName PUT /v1/assignments/{id}/updateDescription PUT /v1/assignments/{id}/publish PUT /v1/assignments/{id}/updateDueDate PUT /v1/assignments/{id}/updateMaxPoints GET /v1/teachers GET /v1/teachers/{id} GET /v1/schools/{id}/teachers GET /v1/sections GET /v1/courses/{id}/sections GET /v1/teachers/{id}/sections GET /v1/schools/{id}/sections GET /v1/sections GET /v1/sections/{id} GET /v1/household/{id}/students GET /v1/advisors/{id}/students GET /v1/teachers/{id}/students GET /v1/schools/{id}/students GET /v1/sections/{id}/students GET /v1/students GET /v1/students/{id} GET /v1/schools/{id}/markingPeriods GET /v1/sections/{id}/markingPeriods GET /v1/markingPeriod GET/v1/markingPeriod{id} |
Assignment Categories > Create Assignment Categories > Delete Assignment Categories > Read Assignment Categories > Update Assignment Marks > Create Assignment Marks > Delete Assignment Marks > Read Assignment Marks > Update Assignments > Create Assignments > Delete Assignments > Read Assignments > Update Class Sections > Read Marking Period Terms > Read Students > Read Teachers > Read |
Microsoft Resources
For general support for SDS, go to:
https://aka.ms/sdssupport
For assistance with OneNote and grade pass back, go to:
https://aka.ms/edusupport and select OneNote Class Notebook to submit a ticket.