Enable SIS Permissions for MingaSync

Approve the Minga application in Clever. Your District Admin will be responsible for this step. Click here for instructions on approving the Minga application in Clever.​

Approve and share the Minga application by school.

Reach out to [email protected] with the following:

Our integration specialists will then set up your school and push a manual sync to populate your students, teachers, and class rosters.

Open the Apps tab in ClassLink
○ Use a ClassLink admin account that can add roster server applications.​

Click + Add
○ The add application flow opens.​

Turn on Show Development Apps
○ Use the toggle to expose development apps in search results.

Search for Minga and click + Add
○ Add the Minga app(s) you want to add.

Open vendor permission settings for the app.
○ Permissions define how much access Minga has to rostering data.​

Select a permissions model.
○ Select Full Permissions, or select Rule Based Permissions if you manage access by rules.​

Enable required fields if using rule-based permissions.
○ Rule-based permissions must include sharing for the following in order for Minga to work effectivly:
○ Classes and Courses
○ Parent or Guardian info
○ Student ID
○ Grade
○ Name
○ Email

Email Minga Support when sharing permissions are enabled.
○ Email [email protected] so the team can locate required information in the ClassLink Partner Portal and complete setup.

Email Minga Support to request a Connection Request.

In your email, include the following information:
○ The name of your district.
○ The name of the school you are rostering.
○ The name and email address of the district IT contact who manages SIS integration.

Complete the Connection Request and PowerSchool Plugin setup.
○ Download the PowerSchool Instructions and PowerSchool plugin.
○ Enter the API Endpoint, Client ID, and Client Secret in the connection request.​

Confirm the initial sync is run.
○ Minga integration specialists set up your school and run a manual sync to populate students, teachers, and class rosters.​

Configure sync settings in Minga.
○ After the initial sync, configure sync settings so overnight syncing can run.

Enable the Aeries OneRoster API.
○ Administrator access is required to enable the OneRoster API for roster access.

Create an API Security entry for Minga.
○ In the Aeries Administrator Console, open Security and select API Security.
○ Add a new entry with Product Name set to “Minga” and set the type to OneRoster. Further instructions can be found in Aeries' API Security help guide.
​
​

​

After an entry for Minga has been created, continue to work in the Security | API Security page. First, select Minga. You will see Product Information listed as shown below.
○ The OneRoster URL can be changed by accessing School Options at the District level.
​
​

Enable required READ permissions for OneRoster.
○ Enable READ permissions for:
○ Student Data
○ Schools
○ Terms
○ Teacher Data
○ Master Schedule
○ Course Data
○ Classes
​
​

​

Enable OneRoster access for Minga.
○ Select Change in the API Security form.
○ Check the OneRoster checkbox and click Update.
​
​

​

Capture the Consumer ID and Consumer Secret Key.
○ Check Display Consumer ID & Secret Keys for OneRoster.
○ Record the Consumer ID and Consumer Secret Key shown.
○The core security of the OneRoster API is different from that of the regular Aeries API. For OneRoster, we will NOT use the Aeries Certificate, but will use the Consumer ID and Secret Key instead.
​
​

​

Perform an IIS reset after OneRoster setting changes.
○ Any OneRoster setting changes require a full IIS reset to take effect.
○ Resetting IIS terminates current user sessions, so schedule this after working hours.
​

Request a Minga connection request.
○ Email [email protected] with:
○ The name of your district and school.
○ The name of your SIS
○ The name and email address of the district IT contact who manages SIS integration.
​

Complete the connection request and notify Minga Support.
○ Enter the API Endpoint, Client ID, and Client Secret in the connection request.
○ Click Save and Done, then notify Minga Support.
​

Confirm the initial sync and configure settings in Minga.
○ Minga integration specialists run an initial manual sync.
○ Configure sync settings after setup is complete.

Open the Digital Learning Application Configuration area.
○ Navigate to Instruction → Settings → Digital Learning Application Configuration, or navigate to System Administration → Learning Interoperability in Classic Navigation.

Add a new application connection.
○ Click Add Application.
○ Scroll to the bottom and click Connect to Other Applications.
○ Enter “Minga” as the application name.
​
​

​

Generate a new OneRoster connection.
○ Click Generate New OneRoster Connection.
​
​

​

Select the OneRoster and authentication settings.
○ Select OneRoster 1.1 with OAuth 2.0.
○ Click Generate.
​
​

​

Request and complete the Minga Connection Request.
○ Email [email protected] with:
○ The name of your district.
○ The name of the school you are rostering.
○ The name and email address of the district IT contact who manages SIS integration.
○ Enter the API Endpoint, Client ID, and Client Secret in the connection request, then click Save and Done.
​
​

​

Confirm setup and configure sync settings
○ Minga integration specialists run a manual sync and confirm setup by email.
○ Configure sync settings after setup is complete.

Request a Minga Connection Request and API documentation.
○ Email [email protected] with:
○ The name of your district and school you are rostering
○ The name and version of your Skyward.
○ The name and email address of the district IT contact who manages SIS integration.​

Review the API Quick Start Guide.

Complete the steps in the API Quick Start Guide and request a Connection Request.

○ Ensure you have installed the Skyward API (the API is a separate IIS web application from the main Skyward application.)
○ Request a connection request from Minga Support.

Complete the connection request and notify Minga Support.
○ Enter the API Endpoint, Client ID, and Client Secret in the connection request.
○ Click Save and Done, then notify Minga Support.

Navigate to the exports area in Skyward SMS.
○ Go to Student Management → Administration → SkyBuild → Exports.

Select OneRoster Export.
○ Locate and select OneRoster Export (this is typically listed under Other Exports).

Click Add to create a new template.
○ Click Add to create a new OneRoster export template.

Enter a template description.
○ In Template Description, enter a clear name (example: “Your App OneRoster”).​

Select the export version.
○ In Export Version, select OneRoster v1.1.

Configure the required Export Options
○ Set these values under Export Options:
○ Include All Entities = ON
○ Allow multiple Users.csv records = OFF
○ Include Guardians = OFF
○ Send File via FTP = ON
○ Save File via UNC Path = OFF

Configure Version Specific Options – v1.1
○ Set these values under Version Specific Options – v1.1:
○ Use GUIDS = OFF
○ Academic Sessions = Bulk
○ Categories = Do Not Export
○ Classes = Bulk
○ Courses = Bulk
○ Demographics = Bulk
○ Enrollments = Bulk
○ Line Items = Do Not Export
○ Orgs = Bulk
○ Results = Do Not Export
○ Users = Bulk

Save and run the export template
○ Save your OneRoster export template.
○ Click Export or Print to run the export once and confirm it processes.
​

Open the Print Queue
○ Navigate to your Skyward Print Queue and locate the export job that is processing.
​

Open scheduling for the export job
○ Highlight the export job in the Print Queue.
○ Select Tasks or Scheduled Tasks on the right side.
​

Schedule the export to run daily
○ Set the schedule so the export is delivered daily to the configured FTP/SFTP destination.

Navigate to Administrative Access → API → Integration
○ Type Ednition into the Vendor search box.
○ Click the Open button to open the vendor integration record.
○ Screenshot description (step1.png): The Integration page shows a Vendor search field containing “Ednition” and an Open button next to the search results.

​

Open the Integration Access tab.
○ Click the Integration Access tab to view existing access records for this vendor.
​

​

Click Add Integration access.
○ Click Add Integration access to create a new access record.
​

​

Enter the Integration Access details.
○ Enter values for these required fields (any fields not listed can stay at the default value):
○ Name: Enter a label tied to your organization or purpose (example: “ACME Company 2026” or “ACME Company Testing”).
○ Key: Enter the OAuth Client ID and do not change it after setup. This value must be unique.
○ Authentication Type: Select OAuth 2.0 or Any.
​

Add a OneRoster Configuration
○ In OneRoster Configuration, click the down arrow.
○ Click Add One Roster Configuration.
​

​

Add a One Roster Vendor and complete the configuration
○ In One Roster Vendor, click the down arrow and select Add One Roster Vendor.
○ Enter the vendor name (example: “ACME Company”).
○ Click Save to create the vendor record.
○ Complete these fields in the OneRoster Configuration record:
○ Code: Enter a shortened vendor name with no spaces or special characters (example: acmeco).
○ District: Select your district.
○ Click Save to complete the OneRoster Configuration record.
​

Save the Integration Access record
○ Return to the Integration Access page for the record you created.
○ Confirm the details are correct, then click Save.
​

Generate and copy the secret
○ On the next page, click Generate Secret.
○ Click Copy and paste the secret into a secure notepad so it is available for the connection request.
○ Check the I have copied this data checkbox.
○ Click Run Process to complete secret generation.
​

Regenerate the secret from the Integration Accesses list (if needed)
○ If you did not generate the secret after creating the record, or if you need a new secret, open the Integration Accesses list.
○ Click the arrow next to the relevant Integration Access record.
○ Follow the on-screen steps to generate a new secret.
​

Collect the API values for the connection request
○ Open the Integration Access Details page for the integration you created.
○ Copy the values needed for RosterStream.
○ The secret is the only value not shown on the details page because it was generated and copied in the earlier steps.
​

Provide the required fields to RosterStream
○ API Endpoint: Copy the value from the API URL field.
○ Example format: https://district.skyward.com/API
○ OAuth2 Token Endpoint: Append /oauth/token to the end of the API Endpoint value.
○ Example format: https://district.skyward.com/API/oauth/token
○ OAuth2 Client ID: Copy the value from the Key field.
○ OAuth2 Client Secret: Use the secret you generated and copied in the previous steps.

​

Click Administrative Access.
○ Log in to Skyward Qmlativ and open Administrative Access.

Click Reporting → Report Manager.
○ In the left menu, click Reporting and select Report Manager.
​

Search for OneRoster reports.
○ In Report Manager, search for “OneRoster” to display the available OneRoster templates.

Choose which OneRoster export approach you will use.
○ Use one of the following export options based on what data you want to share:
○ Option A: OneRoster zip export: Export One Roster (.zip) to deliver all OneRoster files together.
○ Option B: Individual file exports: Export the specific OneRoster reports you want to include.

Open a OneRoster report template.
○ In Report Manager, click the OneRoster report you want to export.

Click Clone Report.
○ Click Clone Report in the top right to create your own copy.
​

​

Rename the cloned report.
○ Rename the report so it is easy to identify later.
○ Example format: “VendorName - AcademicSession”.​

Set Encoding Type to UTF-8.
○ Confirm Encoding Type is set to UTF-8 so exported files use the correct character encoding.

Click Save.
○ Click Save in the top left to store the report settings.

Confirm required fields (and add optional fields if needed)
○ Review the selected fields.
○ Add optional fields from the Fields section in the left panel if your export requires additional data.

Click Run Report.
○ Click Run Report to generate the output.
​

​

Click Run Report again on the output page.
○ On the next page, click Run Report again at the top of the page to complete generation.

Return to Report Manager and locate the cloned report.
○ Find the report you just cloned and renamed.

Open the report details.
○ Click the arrow symbol next to the report to open the details panel.

Click Publish Report, then click Save.
○ Click Publish Report to make the report available for scheduling.
○ Click Save to finalize publishing.
​

Open Scheduled Reports.
○ In the left navigation, click Scheduled Reports.

Click Add Scheduled Report
○ Click Add Scheduled Report to create a new scheduled export job.
​

​

Name the scheduled report and set the schedule.
○ Enter a clear scheduled report name.
○ Set the schedule to a daily export.
○ Use a Start Time after business hours.
​

Click Save & Add Export Location.
○ Click Save & Add Export Location to attach the export destination.
​

Create a new SFTP connection (first time only).
○ If you have not created an SFTP connection yet, click Add FTP/SFTP Connection.
○ This only needs to be done once.
​

​

Enter the SFTP connection details.
○ On the Add FTP Connection page, enter:
○ Name: Enter your vendor name (example: “Vendor Name”).
○ Username, Password, Host, Port: Use the values provided in the RosterStream connection request form.

Test and save the connection.
○ Click Test Connection to confirm the settings are correct.
○ If successful, click Save.​

Select the SFTP connection as the file destination.
○ In File Destination, select the SFTP connection you created.
○ Use the same SFTP connection for all OneRoster exports.
​

Disable automatic file naming.
○ Make sure Automate File Name is unchecked.

Enable overwrite behavior.
○ Make sure Overwrite Existing File is checked.

Enter the export file name.
○ In Export File Name, enter a standard OneRoster file name that matches the report being exported:
○ academicSessions
○ classes
○ courses
○ demographics
○ enrollments
○ orgs
○ users

Click Save, then click Save again.
○ Click Save to store the export settings.
○ On the following page, click Save again to finalize.