Configuration API Calls

Get a List of Device Configurations

This call returns a list of all available device configurations.

Authentication

This call requires tenant admin credentials.

HTTP Method

GET

Request URI

/api/v1/policy?dmPartitionId=id&tag=DEVICE_CONFIGURATION

Request Parameters

Parameter	Argument Type	Description	Example Value
dmPartitionId	Path	dmPartitionId is the tenant’s device space ID. You can get this with the GET /api/v1/metadata/tenant call.	23000
tag=DEVICE_CONFIGURATION	Path	Directs the call to retrieve all device configurations.	tag=DEVICE_CONFIGURATION

Example Request

https://[Ivanti Neurons for MDM]/api/v1/policy?dmPartitionId=23000&tag=DEVICE_CONFIGURATION 

Response Fields

Field	Description
errors
result
totalCount
queryTime
searchResults
id
name
systemName
description
policyType
policyRuleType
uuid
enabled
priority
totalDeviceCount
installedDeviceCount
violationDeviceCount
modifiedAt
modifiedBy
id
displayName
emailAddress
firstName
lastName
actions
offset
limit

Example Response

{

  "errors": null,

  "result": {

    "totalCount": 10,

    "queryTime": 0,

    "searchResults": [

      {

        "id": 35000,

        "name": "System Root Certificate",

        "systemName": "systemRootCert",

        "description": "The CA certificate for the system's root certificate authority. All certificates issued to mobile devices chain back to this certificate authority.",

        "policyType": "CERTIFICATE",

        "policyRuleType": "NONE",

        "uuid": "839454aa-bc50-4aae-9120-c8931161b24d",

        "enabled": true,

        "priority": 1,

        "totalDeviceCount": 0,

        "installedDeviceCount": 0,

        "violationDeviceCount": 0,

        "modifiedAt": 1381909930374,

        "modifiedBy": {

          "id": 1,

          "displayName": "System",

          "emailAddress": "System",

          "firstName": "System",

          "lastName": "System"

        },

        "actions": null

      },

…

    ],

    "offset": 0,

    "limit": 50

  }

}

Assign Configuration to Device Group

This call assigns a configuration to a device group.

Authentication

This call requires tenant admin credentials.

HTTP Method

PUT

Request URI

/api/v1/policy/configId/rule_groups?ruleGroupIds=ruleGroupId

Request Parameters

Parameter	Argument Type	Description	Example Value
configId	Path	configId  is the ID of the device configuration. You can get this with the /api/v1/policy?dmPartitionId=id&tag=DEVICE_CONFIGURATION call.	31540
ruleGroupId	Path	The ID of the device group to which to assign the configuration. You can get this with the /api/v1/rule_group?dmPartitionId=id&type=DEVICE call.	38002

Example Request

https://[Ivanti Neurons for MDM]/api/v1/policy/35140/rule_groups?ruleGroupIds=38002

Response Fields

Field	Description
errors	null if successful.
result	true if successful.

Example Response

{

    "errors": null,

    "result": true

}