Manage device settings - iOS only

This API updates specific iOS settings based on the device identifiers in the request. The supported settings are:

•Personal hotspot

•Data roaming

Mobile data needs to be switched on in the device to allow enabling of the hotspot. WiFi and Bluetooth are not required for enablement, but for other devices to connect to the hotspot.

The API returns the count of devices for which the settings was successfully updated. The call silently ignores any invalid device identifiers specified in the request.

HTTP Method

POST

Request URI

/msa/v1/cps/device/settings

Request parameters

Parameter

Description

Sample Value

identifiers

Required

Parameter Type: Request body

Data Type: String

List of UEM identifiers in this format:

{

"identifiers":["mdm-id-1", "mdm-id-2"]

}

See List of identifiers.

 

{
    "identifiers": [
        "b9a0d7d05fb4204f52264f805932526b848ca61d"
    ], 
    "settings": {
        "type": "PERSONAL_HOTSPOT", 
        "value": {
            "enabled": true
        }
    }
}

settings

Required

Parameter Type: Request body

Data Type: String

JSON container for the type and value parameters.

 

{
    "identifiers": [
        "b9a0d7d05fb4204f52264f805932526b848ca61d"
    ], 
    "settings": {
        "type": "PERSONAL_HOTSPOT", 
        "value": {
            "enabled": true
        }
    }
}

type

Required

Parameter Type: Request body

Data Type: String

The settings to update. Can be:

•PERSONAL_HOTSPOT

•DATA_ROAMING

 
{
    "identifiers": [
        "b9a0d7d05fb4204f52264f805932526b848ca61d"
    ], 
    "settings": {
        "type": "PERSONAL_HOTSPOT", 
        "value": {
            "enabled": true
        }
    }
}

value

Required

Parameter Type: Request body

Data Type: String

The value to set for the settings. Can be:

•true

•false

 
{
    "identifiers": [
        "b9a0d7d05fb4204f52264f805932526b848ca61d"
    ], 
    "settings": {
        "type": "PERSONAL_HOTSPOT", 
        "value": {
            "enabled": true
        }
    }
}

Response fields

API returns the count of devices for which attributes were successfully updated along with HTTP status 200.

See Number result.

Example requests

Turn on personal hotspot:

POST /msa/v1/cps/device/settings
{
    "identifiers": [
        "b9a0d7d05fb4204f52264f805932526b848ca61d"
    ], 
    "settings": {
        "type": "PERSONAL_HOTSPOT", 
        "value": {
            "enabled": true
        }
    }
}

Turn off data roaming:

POST /msa/v1/cps/device/settings
{
    "identifiers": [
        "b9a0d7d05fb4204f52264f805932526b848ca61d"
    ], 
    "settings": {
        "type": "DATA_ROAMING", 
        "value": {
            "enabled": false
        }
    }
}

Example response

{
    "result": 1
}

In case all the identifiers are invalid, then response code will still be 200, with result as 0.