Configure connection

Last updated: November 5, 2026NIM service baseline: v7.0.1866

Mosyle Manager guide

Configure API access, collect Mosyle Manager data, and validate user and device actions before scheduling automation.

Before you begin

• Use the Mosyle Manager connector with Windows PowerShell 5.1 or later.
• Prepare a Mosyle Manager account with API access and permissions for the collections and actions you need, plus its API access token. Confirm API availability and permission requirements in your Mosyle tenant.
• Allow HTTPS access from the connector host to managerapi.mosyle.com, directly or through your configured proxy.
• Identify a test user and device for the write actions you intend to use.

The API address is fixed in this connector. There is no Hostname field, and Mosyle Business credentials and endpoints are not interchangeable with this Manager connection.

Prepare the account and token

1. In Mosyle Manager, obtain the API access token for the integration and enable the API access required by your process.
2. Record the email address and password of the account used to authenticate API requests.
3. Review access separately for user retrieval, other read collections, and each planned write action. See Prepare connector permissions.

The connector sends the account email, password, and access token to POST /v2/login, then uses the returned Authorization header for subsequent calls. The Access Token setting is the integration token; you do not manually supply the temporary authorization header.

Enter the connection settings

1. In NIM Studio, open Systems > Overview and add a Mosyle Manager system, or select the existing system.
2. Open Connection, enter the following settings, and save.

NIM setting	Value
Username (email)	The email address of the Mosyle Manager API account.
Password	The password of that account.
Access Token	The Mosyle Manager integration access token.
Use Proxy	Enable only if the connector host must use a proxy.
Proxy Address	Absolute HTTP or HTTPS proxy URL, required when Use Proxy is enabled. The displayed default is http://127.0.0.1:8888; replace it with your actual proxy.
Use Proxy Credentials	Enable if the proxy requires authentication.
Proxy Username / Proxy Password	Both are required when Use Proxy Credentials is enabled.
Page Size	Default 100; positive integer. Some endpoints may ignore the requested size.
Max. number of retry attempts	Default 10; total attempts including the initial request, from 1 to 20.
Seconds to wait for retry	Default 15; initial exponential-backoff delay, from 1 to 60 seconds. A longer server Retry-After takes precedence.

Test user retrieval and select collections

1. Select Test Connection. The connector authenticates and requests the first page from POST /v2/listusers with id,name,managedappleid,type,email.
2. Review the Users collection and its Specific columns setting. The default columns also define its output schema; use comma-separated Mosyle column names.
3. Select other required collections and configure their table settings before collecting data.
4. Collect data and inspect the results in NIM before building filters, reports, or mappings.

Collections	Settings and interpretation
Devices	os defaults to mac. Select the intended platform; supported OS values are ios, mac, tvos, and visionos, subject to endpoint support. Optional filters include tags, osversions, and serial_numbers.
DeviceCustomAttributeValues	Flattens attributes from device responses into DeviceID, Name, CustomAttributeUniqueID, and Value. Uses device collection filters.
Classes, ClassTeachers, ClassStudents, ClassCoordinators	Collects classes and their teacher, student, and coordinator relationships. Related collections share the class snapshot within a PowerShell session.
DynamicDeviceGroups, DeviceGroupDevices	Select the OS and is_security_group; membership collection also supports security_compliance_status.
DynamicGroupDevices	Optionally set iddevicegroup. Leave it blank to collect memberships for all dynamic groups in the selected OS.
SharedDeviceGroups	Set the OS and, if needed, idshareddevicegroup or idaccount filters.
IOSSecurityCompliance	Set rule_name. If blank, the connector skips this table with a warning. Review security_compliance_status as well.
Accounts	Collects Mosyle account records; these are distinct from the Users collection.
CustomDeviceAttributes	Collects custom attribute definitions for the selected OS.

Devices, Classes, and SharedDeviceGroups also expose Specific columns. Nested selected values are returned as compact JSON. Device records are cached within the PowerShell session for related collections.

The connection test validates authentication and first-page user retrieval only. It does not verify full pagination, all other collections, or write permissions.

Validate intended changes

1. Review the available actions and choose only those needed by your process.
2. Configure a mapping or action against a known test record, then inspect its evaluated changes before execution.
3. Execute the intended change and confirm the result in Mosyle Manager. For device commands, also verify completion on the device where applicable.
4. Enable scheduled automation only after the intended reads and writes have been validated.

Action	Input requirements to check
UserCreate	Requires id, name, type, locations, and welcome_email. Types are S (student), T (teacher), or STAFF. Teachers require email; student locations require grade_level. Each location requires name. welcome_email is 0 or 1.
UserUpdate	Requires id and at least one supported user attribute to change. The optional account identifier alone is not an attribute update.
UserAssignDevice	Uses id and serial_number.
DeviceUpdate	Uses serialnumber and at least one supported device attribute. The parameter spelling differs from UserAssignDevice.
DeviceUnassign	Supply a nonempty devices or groups array.
DeviceUpdateLimboLocation	Requires devices and location; groups is optional.
DeviceLock	Requires devices. If supplied, pincode must be exactly six digits.
Group membership actions	Supply the group identifier and a nonempty add or remove array. Account and group identifiers must be positive integers.
CustomDeviceAttributeUpdate	Requires os, old_unique_id, unique_id, name, and value.

The user read field is managedappleid; the corresponding write parameter is managed_appleid. Do not copy field names between reads and writes without checking the function parameters.

Step 1 of 4

Troubleshooting

Symptom	What to check
Authentication fails	Confirm all three credential settings, Manager API access, and account permissions. The connector refreshes rejected authorization once; persistent rejection requires correcting access or credentials.
Proxy connection fails	Confirm Use Proxy, a valid absolute proxy URL, and both proxy credentials if authentication is enabled.
Expected devices are missing	Check the selected os and device filters; mac is the default, not an all-platform selection.
Compliance table is skipped	Set the required rule_name for IOSSecurityCompliance.
Import reports repeated or empty pages before the total	Review the connector log and API response. The connector aborts rather than silently accepting incomplete pagination.
Write is rejected	Check required parameters, field spelling, array values, identifiers, and action-specific permissions. A successful connection test does not establish write access.
Lock command accepted but device is unchanged	Verify command status and device connectivity in Mosyle; command acceptance is not device completion.

This guide is based on source review of connector package 2.0.0. Validate your tenant's permissions and API behavior separately.

Report a problem with this page

Found an error or a missing step? Open the feedback form and describe what needs changing. The article details and Documentation topic are filled in for you.

Need help with your NIM environment? Contact Support.