Ivanti Endpoint Manager Mobile
App Vendor: Ivanti
App Category: Network Security
Connector Version: 1.1.0
API Version: v2
About App
Ivanti Endpoint Manager Mobile is a mobile-centric security platform that adopts a zero-trust approach, ensuring only authorized users, devices, apps, and services can access business resources. It enables users to secure business data across endpoints, clouds, and networks they own—and even those they don’t.
The Ivanti Endpoint Manager Mobile app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Check All Devices for Compliance | This action checks all devices in the device space for compliance. |
Check Devices for Compliance | This action checks the list of devices for compliance. |
Get Action Types Faucets for Audit Log Categories | This action returns action types facets for audit log categories. |
Get API Version | This action returns the version information about the API. |
Get Device Details | This action retrieves the details of a given device. |
Get Device Spaces | This action returns all device spaces available to the logged in user. |
Lock Device | This action locks a list of devices. |
Search Audit Logs | This action returns action type facets for audit log categories. |
Search Devices | This action queries for devices. |
Unlock Device | This action unlocks a list of devices. |
Generic Action | This is a generic action used to make requests to any Ivanti Endpoint Manager Mobile endpoint. |
Configuration Parameters
The following configuration parameters are required for the Ivanti Endpoint Manager Mobile app to communicate with the Ivanti Endpoint Manager Mobile enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the base URL to your Ivanti Endpoint Manager Mobile. Example: https://micore.domain.tld/ | Text | Required | |
Username | Enter the username to authenticate with Ivanti Endpoint Manager Mobile. | Text | Required | |
Password | Enter the password to authenticate with Ivanti Endpoint Manager Mobile. | Password | Required | |
Verify SSL | Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection. Example: False | Boolean | Optional | By default, verification is diabled. |
Timeout | Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with Ivanti Endpoint Manager Mobile. | Integer | Optional | Allowed range: 15-120 Default value: 15 |
Action: Check All Devices for Compliance
This action checks all devices in the device space for compliance.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Admin device space ID | Enter the admin space ID. Example: 1 | Integer | Optional |
Example Request
[
{
"admin_device_space_id": 1
}
]Action: Check Devices for Compliance
This action checks the list of devices for compliance.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device UUIDs | Enter a list of UUIDs. Example: $LIST[2f051b0b-0104-4ec3-b8b4-103518dc0ae8, 3f051b0b-0104-4ec3-b8b4-103518dc0ae8] | List | Required | |
Admin device space ID | Enter the admin space ID. Example: 1 | Integer | Optional |
Example Request
[
{
"device_uuids": [
"2f051b0b-0104-4ec3-b8b4-103518dc0ae8"
],
"admin_device_space_id": 1
}
]Action: Get Action Types Faucets for Audit Log Categories
This action returns action types facets for audit log categories.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Request type | Enter the request type for the facets API. Example: "actiontype" | Text | Required | |
Admin device space ID | Enter the device space ID of the administrator. Example: 1 | Integer | Optional | |
User action IDs | Enter the comma separated values of user action type IDs. If this is empty, then all the user action types will be considered for the search. Example: $LIST[23, 45] | List | Optional | |
Statuses | Enter comma separated values of audit log status to filter. If this is empty, then returned audit logs may contain all kinds of statuses. Example: $LIST[success] | List | Optional | Allowed values:
|
Subject | Specify the place holder for a device UUID to filter logs for a particular device. Example: "2f051b0b-0104-4ec3-b8b4-103518dc0ae8" | Text | Optional | |
Action start | Enter the start time after which the audit logs are required in the epoch format in milliseconds. Example: 1423559886308 | Integer | Optional | |
Action end | Enter the end time in epoch format in milliseconds. this can be used along with actionstart to form a date range during which the audit logs are required. Example: 1423559886308 | Integer | Optional | |
Sort field | Enter the name of the field to use for sorting. Example: "common.id" | Text | Optional | |
Sort order | Enter the order in which entries are returned. Example: "asc" | Text | Optional | Allowed values:
Default value:
|
Example Request
[
{
"request_type": "user",
"admin_device_space_id": 1
}
]Action: Get API Version
This action returns the version information about the API.
Action Input Parameters
This action does not require any input parameter.
Action: Get Device Details
This action retrieves the details of a given device.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device ID | Enter the UUID of the device to get details. Example: "2f051b0b-0104-4ec3-b8b4-103518dc0ae8" | Text | Required | |
Admin device space ID | Enter the admin space ID. Example: 1 | Integer | Optional |
Example Request
[
{
"device_id": "1b89b568-163a-48d1-85eb-8686846d7f9c"
}
]Action: Get Device Spaces
This action returns all device spaces available to the logged in user.
Action Input Parameters
This action does not require any input parameter.
Action: Lock Device
This action locks a list of devices.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device UUIDs | Enter a list of UUIDs. Example: $LIST[2f051b0b-0104-4ec3-b8b4-103518dc0ae8, 3f051b0b-0104-4ec3-b8b4-103518dc0ae8] | List | Required | |
Note | Enter a note detailing why the device was locked. Example: "Device Quarantined" | Text | Required | |
Admin device space id | Enter the admin space ID. Example: 1 | Integer | Optional |
Example Request
[
{
"note": "Device Quarantined",
"device_uuids": [
"2f051b0b-0104-4ec3-b8b4-103518dc0ae8"
],
"admin_device_space_id": 1
}
]Action: Search Audit Logs
This action returns action type facets for audit log categories.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Admin device space ID | Enter the device space ID of the administrator. Example: 1 | Integer | Optional | |
User action IDs | Enter comma separated values of user action type ids. If this is empty, then all the user action types will be considered for the search. Example: $LIST[23, 45] | List | Optional | |
Statuses | Enter comma separated values of audit log status to filter. If this is empty, then returned audit logs may contain all kinds of statuses. Example: $LIST[success] | List | Optional | Allowed values:
|
Subject | Specify the place holder for a device UUID to filter logs for a particular device. Example: "Example Subject" | Text | Optional | |
Action start | Enter the start time after which the audit logs are required in the epoch format in milliseconds. Example: 1423559886308 | Integer | Optional | |
Action end | Enter the end time in epoch format in milliseconds. this can be used along with actionstart to form a date range during which the audit logs are required. Example: 1423559886308 | Integer | Optional | |
Limit | Specify the maximum number of results to return. Example: 150 | Integer | Optional | Maximum value:
Default value:
|
Offset | Specify the pagination of results to return. Example: 1 | Integer | Optional | Default value:
|
Sort field | Specify the field to sort on. Example: "common.id" | Text | Optional | |
Sort order | Specify the order for the results. The order must be asc or desc. Example: asc | Text | Optional | Default value:
|
Example Request
[
{
"admin_device_space_id": 1
}
]Action: Search Devices
This action queries for devices.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Query | Enter the text or phrase to query for devices. Example: "adminDeviceSpaceId=1&fields=common.os_version,common.uuid&labelId=4&query=test" | Text | Required | Query Character Limit:
You can learn more about the supported queries from Ivanti's API documentation. See Query Operators and Search Fields for complete details on the query operators and search fields you can use to construct the query parameter statement. |
Admin device space ID | Specify an integer to denote the admin space to query for devices. Example: 1 | Integer | Optional | |
Label ID | Specify the label ID for the device. Example: 2 | Integer | Optional | |
Fields | Enter the device fields as a comma-separated list of the names. each field should not be more than 320 characters long. Example: $LIST[user.display_name, common.current_phone_number] | Text | Optional | |
Limit | Specify the maximum number of devices to return. Example: 150 | Integer | Optional | Maximum value:
Default value:
|
Offset | Specify the pagination of results to return. Example: 1 | Integer | Optional | Default value:
|
Sort field | Specify the field to sort on. Example: "common.os_version" | Text | Optional | Supported values:
|
Sort order | Specify the order for the results. The order must be asc or desc. Example: "asc" | Text | Optional | Allowed values:
Default value:
|
Example Request
[
{
"query": "adminDeviceSpaceId=1&labelId=4&fields=common.os_version"
}
]Action: Unlock Device
This action unlocks a list of devices.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device UUIDs | Enter a list of UUIDs. Example: $LIST[2f051b0b-0104-4ec3-b8b4-103518dc0ae8, 3f051b0b-0104-4ec3-b8b4-103518dc0ae8] | List | Required | |
Note | Enter a note detailing why the device is unlocked. Example: "Device Safe for Use" | Text | Required | |
Admin device space ID | Enter the admin space ID. Example: 1 | Integer | Optional |
Example Request
[
{
"note": "Device Safe for Use",
"device_uuids": [
"2f051b0b-0104-4ec3-b8b4-103518dc0ae8"
],
"admin_device_space_id": 1
}
]Action: Generic Action
This is a generic action used to make requests to any Ivanti Endpoint Manager Mobile endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Method | Enter the HTTP methods to make the request. | Text | Required | Allowed values: GET, PUT, POST, DELETE |
Endpoint | Enter the endpoint to make the request to. Example: api/v2/devices | Text | Required | |
Query Params | Enter the query parameters to pass to the API. | Key Value | Optional | |
Payload | Enter the payload to pass to the API. | Any | Optional | |
Extra Fields | Enter the extra fields to pass to the API. | Key Value | Optional | Allowed keys: payload_json, custom_output, download, files, filename, retry_wait, retry_count, response_type |