Skip to main content

Other Integrations

Purpose

Mosyle is organized so the management of devices is as intuitive as possible, allowing you to assign configurations based on the user who is using the device and/or the location, grade level, or class the user is associated with. Since configurations can be assigned to specific users and/or their association with a grade level or class, or to a specific group of shared devices, it's important users are assigned or associated with the specific device or devices they use and/or devices are assigned to the appropriate shared device group. Assignment of devices can be fully automated so that users simply authenticate with their school or district credentials and Mosyle will automatically pair the user with the device. In order to do this, users must be imported into Mosyle.

You can quickly import users, locations, grade levels, and courses/classes from Apple School Manager using the ASM integration. If your data has not been imported into Apple School Manager, you can use Active Directory, the Mosyle API, a Spreadsheet import, or create any hierarchical data manually if needed.

Once the school or district data is imported into Mosyle and devices are assigned to their corresponding user, you can effectively scope configurations based on the specific user needs. For example:

  • A specific app that needs to be deployed to all students in a specific grade level;
  • Restrictions that should only be enforced on devices assigned to students.

Resources

  • Access to a Mosyle Education account
  • User account with Administrator or User privileges in Apple School Manager or Active Directory

Configuring Apple School Manager Integration

Location, Grade Levels, Courses/Classes, and Users can be imported into Mosyle from Apple School Manager. Apple School Manager provides multiple methods for importing the school or district data, including from a Student Information System (SIS) directly into ASM, using an SFTP upload, or importing users from Google Workspace or Microsoft Azure AD

When importing data from ASM into Mosyle, in order for a user to be properly assigned to a location, grade level, and user type (Student or Teacher), they must be associated with a Class. Currently, ASM does not provide information regarding a user's type or location. In order to correctly import users as Students or Teachers and assign them to the appropriate location and grade level within Mosyle, the user's association with a Class is used to infer the user type and location. If users are not assigned to a Class, they will not be imported unless the option to “Import Users without a Location” is selected in the Sync Parameters.

Complete the steps below to import data into Mosyle from Apple School Manager:

  1. If the MDM server has already been created in Apple School Manager, skip this step and go to step 2. Otherwise, go to My School > Apple Basic Setup > Apple School Manager > Add new account. Follow the on-screen instructions to complete the integration.
  2. After the integration is complete, click Sync Hierarchy under the Apple School Manager token
  3. Click "Edit Sync Preferences" to configure the following settings:
    • Sync automatically: configure the time of day the daily automatic sync will run
    • Only add new data and do not edit existing data
    • User ID (Identifier): Choose what to use for the user's ID when syncing data from ASM. Choices include Person Number, Person ID, Managed Apple ID Prefix, SIS username, Email address, Managed Apple ID.
    • E-mail: Choose what to use for the user's email address when syncing data from ASM. Choices include the same e-mail address registered in ASM, the Managed Apple ID, or the Managed Apple ID without the subdomain. Students are not required to have an email address registered in Mosyle, click the checkbox “Do not import email attribute for students” if you do not wish to have the student email addresses imported into Mosyle.
    • User without Location: This option exists due to Mosyle being unable to import users unless a class is assigned. Select this option if you have users without a class that need to be imported into Mosyle. The users will be imported without any grade level or location assigned.
    • Class Period Name: Choose what to use for the name of the class when syncing data from ASM. Choices include Class ID, Class Number, Name, or Display Name.
    • Locations to Sync: Check the box next to all locations to be synced from ASM. Locations not selected will not be imported.

Once the integration is completely set up, you can click Pull fresh data to preview the data to be imported into Mosyle. If needed, make any necessary changes under “Edit Sync Preferences” and Pull fresh data again. When all data in the preview looks correct, click Start Integration to begin importing the data.

Mosyle identifies users via the user ID and/or the email address. In the event a user's information needs to be updated, make the changes as needed in Apple School Manager or in the Sync Parameters, making sure at least one of the identifiers remain the same. Pull fresh data and complete the integration to update the user.

Configuring Active Directory Integration

Complete the steps below to add an Active Directory integration and import users, grade levels, and/or class periods into Mosyle Education:

  1. Go to My School > Integrations > + Activate New Integration
  2. Select Active Directory
  3. After Activating the integration, click “Add new profile” > Active Directory LDAP

When configuring the Active Directory integration three tabs will be available, two of which need to be configured to successfully import users and user groups: Setup and Synchronization. The Setup tab is where the Active Directory server information will be added. Be sure to release the IPs listed in the interface so that Mosyle is able to establish a connection. Mosyle only supports secure connections (LDAPS or LDAP over TLS).

The Synchronization tab is where mapping and configurations will be made to import users, grade levels, and/or class periods. In this area you can specify the following sync options:

  • Only add new data and do not edit existing data
  • Welcome email
  • Setup and configure the time for the automatic sync

When completing the mapping, filter the users, grade levels, and/or class periods by specific filters or attributes so that only the users and groups you wish to import are imported into Mosyle.

Once the integration is completely set up, you can click the integration name to request a fresh data sync and import users.

Configure the Authentication tab to allow users to authenticate in Mosyle with their Active Directory credentials. Check the box to indicate “Use the AD to validate user and password” and enter the attribute that is used to authenticate. Be sure to test the integration to make sure all is authenticating as expected.

NOTE: AD FS and General OAuth are available for user authentication purposes only. Users, grade levels, and class periods cannot be imported using these integrations.

If you need any assistance with the Active Directory integration, visit the Help Center for more information or submit a Support Ticket.

Configuring Spreadsheet and Mosyle API Integrations

If your school or district doesn't have Apple School Manager or Active Directory, users, grade levels, and classes can be imported using a Spreadsheet or the Mosyle API Integration.

Complete the steps below to add an integration and import users and user groups in Mosyle Education:

  1. Go to My School > Integrations > + Activate New Integration
  2. Choose from: Mosyle API Integration or Spreadsheet Importing
  3. After Activating the integration, toggle on the API Integration or Download the templates for the Spreadsheet integration.

Mosyle API Integration

After toggling on the API Integration, you can choose to restrict the access to specific IPs or leave it open by editing the Access Method.

To create users via the API, you'll make requests to the /users endpoint. To create classes via the API, you'll make requests to the /classes endpoint. Additional documentation, as well as a sample json that is compatible with Postman and Insomnia, is available in the Mosyle interface.

Spreadsheet Integration

Users, grade levels, locations, and courses/classes can be imported directly into Mosyle from a CSV or XLSX Spreadsheet. After downloading the template for the Spreadsheet integration, fill it out and upload the file to Mosyle. Be sure to not delete any headers or sheets (even if empty).

No Comments
Back to top