Mosyle
App Vendor: Mosyle
App Category: Endpoint Management and IT Services
App Version: 1.0.0
API Version: 1.0.0
Mosyle is a device management application for Apple devices. By combining a cloud-native architecture with a focus on usability, automation, and the best support on the market, Mosyle delivers a new approach to Apple device management that is more powerful, efficient, and affordable than legacy solutions.
The Mosyle app built for the Orchestrate application helps security teams to perform email security actions on the Mosyle application and enable security orchestration workflows. You can execute the following actions using the app.
Action Name | Description |
|---|---|
Update Device Group | This action updates a device group. |
Get Device Group Info | This action retrieves information about a device group. |
List Device Group | This action retrieves the list of device groups. |
List User Group | This action retrieves the list of user groups. |
Update User | This action updates a user. |
Create User | This action creates a user. |
List Users | This action retrieves the list of users. |
Unassign Device | This action unassigns a device. |
Assign Device | This action assigns a device. |
Wipe Device | This action wipes a device. |
Update Devices | This action updates a device. |
List Devices | This action retrieves the list of devices. |
Configuration Parameters
The following configuration parameters are required for the Mosyle App to communicate with the Mosyle application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Email Address | Enter the email address to log into the Mosyle application. Example: exampleuser@abc.com | Text | Required | |
Password | Enter the password for your Mosyle account. Example: examplePassword | Password | Required | |
API Token | Enter the API Token of the Mosyle application. | Text | Required |
Action: Update Device Group
This action updates a device group.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device Group ID | Enter the device group ID to get the details. Example: mpdxxxxlkjCbPpzHixxxcMZxxLLE | Text | Required | |
Add List | Enter the list of devices to add to the device group. You can add multiple devices as comma separated list. Example: [device 1, device 2] | List | Optional | |
Remove List | Enter the list of devices to remove from the device group. You can add multiple devices as comma separated list. Example: [device 3, device 4] | List | Optional |
Example Request
[
{
"device_group_id": "mpdxxxxlkjCbPpzHixxxcMZxxLLE"
}
]Action: Get Device Group Info
This action retrieves information about a device group.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device Group ID | Enter the device group ID to get the details. Example: mpdxxxxlkjCbPpzHixxxcMZxxLLE | Text | Required |
Example Request
[
{
"device_group_id": "mpdxxxxlkjCbPpzHixxxcMZxxLLE"
}
]Action: List Device Group
This action retrieves the list of device groups.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
OS | Enter the OS groups to get the device groups. Example: ios | Text | Required | Allowed values:
|
Page | Enter the page number to get the list of device groups. Example: 3 | Text | Optional | Default value:
|
Example Request
[
{
"os": "Windows"
}
]Action: List User Group
This action retrieves the list of user groups.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Page | Enter the page number to get the list of user groups. Example: 3 | Text | Optional | Default value:
|
Name Like | Enter the name of the user group to search. Example: "Analyst User Group" | Text | Optional | |
Extra Params | Enter any additional parameters to use for the search. | Key Value | Optional | Allowed keys:
|
Example Request
[
{
"page": "3",
"name_like": "Analyst User Group"
}
]Action: Update User
This action updates a user.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the unique ID of the user to update the user. Example: mpdxxxxlkjCbPpzHixxxcMZxxLLE | Text | Required | |
Username | Enter the username to update. Example: exampleUsername | Text | Optional | |
User Type | Enter the user type to update the details. Example: exampleUserType | Text | Optional | |
User Email | Enter the email of the user to update. Example: exampleuser@abc.com | Text | Optional |
Example Request
[
{
"user_id": "mpdxxxxlkjCbPpzHixxxcMZxxLLE"
}
]Action: Create User
This action creates a user.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the unique ID of the user to create. Example: mpdxxxxlkjCbPpzHixxxcMZxxLLE | Text | Required | |
Username | Enter the username for the user. Example: exampleUsername | Text | Required | |
User Type | Enter the user type for the user. Example: exampleUserType | Text | Required | |
User Email | Enter the email of the user. Example: exampleuser@abc.com | Text | Required | |
Welcome Email Status | Enter the welcome email status to assign. Example: 1 | Integer | Required |
Example Request
[
{
"user_id": "mpdxxxxlkjCbPpzHixxxcMZxxLLE",
"username": "exampleUsername"
"user_type": "exampleUserType",
"user_email": "exampleuser@abc.com"
"welcome_email_status" : "1"
}
]Action: List Users
This action retrieves the list of users.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User Type List | Enter the type of users list to filter. Example: "exampleUserType" | List | Required | |
User Name Like | Specify the username to search for user type list. Example: "exampleuser" | Text | Optional | |
Page | Enter the page number to get the user type list. Example: 2 | Text | Optional | |
Extra Params | Enter any extra parameters to get the list of users. | Key Value | Optional | Allowed keys:
|
Example Request
[
{
"user_type_list": "exampleUserType"
}
]Action: Unassign Device
This action unassigns a device.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device UID List | Enter the list of unique IDs of devices that you want to unassign. Example: [mpdxxxxlkjCbPpzHixxxcMZxxLLE, afcxxxxlkjFbUpzKixxxcTYxxBBC] | List | Required |
Example Request
[
{
"device_uid_list": "[mpdxxxxlkjCbPpzHixxxcMZxxLLE, afcxxxxlkjFbUpzKixxxcTYxxBBC]"
}
]Action: Assign Device
This action assigns a device.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Serial Number | Enter the serial number to assign to the device. Example: SNO Device 110 | Text | Required | |
User ID | Enter the user ID to assign to the device. Example: mpdxxxxlkjCbPpzHixxxcMZxxLLE | Text | Required |
Example Request
[
{
"serial_number": "SNO Device 110",
"user_id": "mpdxxxxlkjCbPpzHixxxcMZxxLLE"
}
]Action: Wipe Device
This action wipes a device.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device UID List | Enter the list of unique IDs of devices that you want to wipe. Example: [mpdxxxxlkjCbPpzHixxxcMZxxLLE, afcxxxxlkjFbUpzKixxxcTYxxBBC] | List | Required | |
Extra Params | Enter any extra parameters that you want to include to wipe a device. | Key Value | Optional |
Example Request
[
{
"device_uid_list": "[mpdxxxxlkjCbPpzHixxxcMZxxLLE, afcxxxxlkjFbUpzKixxxcTYxxBBC]"
}
]Action: Update Devices
This action updates a device.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Serial Number | Enter the serial number of the device to update. Example: SNO Device 110 | Text | Required | |
Tag List | Enter the list of tags to update the device. Example: Business Critical | List | Optional | |
Device Name | Enter the device name to update. Example: sampleDeviceName | Text | Optional | |
Notes | Enter the notes to update the device. Example: Sample Note | Text | Optional | |
Lock Message | Enter the lock message to appear on the lock screen. Example: Sample Lock Message | Text | Optional | |
Extra Params | Enter the extra parameters to update the device. | Key Value | Optional |
Example Request
[
{
"serial_number": "SNO Device 110"
}
]Action: List Devices
This action retrieves the list of devices.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
OS | Enter the OS of the device to retrieve the list. Example: Windows | Text | Required | |
Device ID List | Enter the list of unique device IDs to filter. Example: [mpdxxxxlkjCbPpzHixxxcMZxxLLE, afcxxxxlkjFbUpzKixxxcTYxxBBC] | List | Optional | |
Page | Enter the page number to retrieve the list. Example: 4 | Text | Optional | Default value:
|
Extra Params | Enter any extra parameters to retrieve the list. | Key Value | Optional |
Example Request
[
{
"os": "Windows"
}
]