Introduction
API Base URL
On-Premises
{ServerURL}/
MDM's APIs allow you to perform all the basic management done with the MDM web client.
ManageEngine MDM APIs are built using REST principles which ensures predictable URLs that makes writing applications easy. This API follows HTTP rules, enabling a wide range of HTTP clients can be used to interact with the API.
Every resource is exposed as a URL. The URL of each resource can be obtained by accessing the API Root Endpoint.
Cloud
https://mdm.manageengine.com.au/
Getting Started
Example
$ curl https://mdm.manageengine.com.au/api/v1/devices -H 'Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5'
To use our API you must satisfy these prerequistes
- An API Key (MDM On-Premises)
- A valid Zoho username and password.(MDM Cloud)
Multiple data centres
Mobile Devices Manager cloud is hosted at multiple data centers, and therefore available on different domains. There are 9 different domains for Mobile Devices Manager cloud APIs, so you can use the one that is applicable to you.
Data Center | Domain | Base API URI |
---|---|---|
United States | .com | https://mdm.manageengine.com.au/ |
Europe | .eu | https://mdm.manageengine.eu/ |
India | .in | https://mdm.manageengine.in/ |
Australia | .com.au | https://mdm.manageengine.com.au.au/ |
Japan | .jp | https://mdm.manageengine.jp/ |
Canada | .ca | https://mdm.manageengine.ca/ |
China | .cn | https://mdm.manageengine.cn/ |
Saudi Arabia | .sa | https://mdm.manageengine.sa/ |
United Kingdom | .uk | https://mdm.manageengine.uk/ |
The APIs on this page are intended for organizations hosted on the .com domain. If your organization is on a different domain, replace ".com" with the appropriate domain for the API endpoints before using them.
Note: You can find out which domain you're accessing by checking the URL while accessing Mobile Device Manager.
Authentication
In case of MDM On-Premises, the authentication is done using using the API key.
Generating an API key
- On the MDM server, click on Admin tab from the top menu and select API Key Generation, present under Integrations.
- Follow the on-screen instructions to generate an API key.
Calling An API
API key can be passed only in header and cannot be passed in the request param.
- Header name should be
Authorization
- Header value should be
{api_key}
Note: The API key generated is valid for 6 months.
OAuth
In case of MDM Cloud Zoho REST APIs are used, where the authorization and authentication done using OAuth 2.0. It provides secure access to protect resources thereby reducing the hassle of asking for a username and password every time a user logs in. Follow the steps listed here, to access Zoho’s APIs using OAuth 2.0
Step 1: Registering New Client
You will have to first register your application with Zoho's Developer console in order get your
Client ID
and
Client Secret
.
To register your application, login to Zoho Developer's Console and click on
Add Client ID
. Provide the required details to register your application.
On successful registration, you will be provided with a set of OAuth 2.0 credentials such as a
Client ID
and
Client Secret
, known to both Zoho and your application. Do not share this credentials
Step 2: Generating Grant Token
Redirect to the following authorization URL with the given params
https://accounts.zoho.com/oauth/v2/auth?
Request Example
https://accounts.zoho.com/oauth/v2/auth?scope=MDMOnDemand.MDMInventory.CREATE,MDMOnDemand.MDMInventory.READ&client_id=1000.0SRSZSY37WMZ69405H3TMYI2239V&state=testing&response_type=code&redirect_uri=http://www.mdm.manageengine.com.au&access_type=offline
Parameter | Description |
---|---|
scope * | SCOPE for which the token to be generated. Multiple scopes can be given which has to be separated by commas.
Ex :
MDMOnDemand.MDMInventory.CREATE |
client_id * | Client ID obtained during Client Registration |
state | An opaque string that is round-tripped in the protocol; ie., whatever value given to this will be passed back to you. |
response_type * |
code
|
redirect_uri * | One of the redirect URI given in above step. This param should be same redirect url mentioned while registering the Client |
access_type | The allowed values are
offline and
online . The
online access_type gives your application only the access_token which is valid for one hour.
The
offline access_type will give the application an access_token as well as a refresh_token. By
default it is taken
as
online
|
prompt | Prompts for user consent each time your app tries to access user credentials. Ex:
Consent
|
Note: Fields marked with
*
are mandatory
On this request, you will be shown with a "user consent page".
Upon clicking “Accept”, Zoho will redirect to the given redirect_uri with
code
and
state
param. This code value is mandatory to get the access token in the next step and this code is
valid for 60 seconds.
On clicking “Deny”, the server returns an error
Step 3: Generate Access and Refresh Token
After getting
code
from the above step, make a POST request for the following URL with given params, to generate the
access_token
.
https://accounts.zoho.com/oauth/v2/token?
Request Example
https://accounts.zoho.com/oauth/v2/token?code=1000.dd7e47321d48b8a7e312e3d6eb1a9bb8.b6c07ac766ec11da98bf6a261e24dca4&client_id=1000.0SRSZSY37WMZ69405H3TMYI2239V&client_secret=fb0196010f2b70df8db2a173ca2cf59388798abf&redirect_uri=http://www.mdm.manageengine.com.au&grant_type=authorization_code
Parameter | Description |
---|---|
code * |
code which is obtained in the above step
|
client_id * | Client ID obtained during Client Registration |
client_secret * | Client secret obtained during Client Registration |
redirect_uri * | This param should be same redirect url mentioned while adding Client |
grant_type * |
authorization_code
|
scope | SCOPE for which token to be generated. Ex :
MDMOnDemand.MDMInventory.CREATE . Multiple scopes has to be separated by commas.
|
state | An opaque string that is round-tripped in the protocol; that is to say, value will be passed back to you. |
Note: Fields with
*
are mandatory
In the response, you will get both
access_token
and
refresh_token
.
1. The
access_token
will expire after a particular period (as given in
expires_in
param in the response).
2. The
refresh_token
is permanent and will be used to regenerate new
access_token
, if the current access token is expired.
Note: Each time a re-consent page is accepted, a new refresh token is generated. The maximum limit is 20 refresh tokens per user. If this limit is crossed, the first refresh token is automatically deleted to accommodate the latest one. This is done irrespective of whether the first refresh token is in use or not.
Step 4: Generate Access Token From Refresh Token
Access Tokens have limited validity. In most general cases the access tokens expire in one hour. Until then, the access token has unlimited usage. Once it expires, your app will have to use the refresh token to request for a new access token. Redirect to the following POST URL with the given params to get a new access token
https://accounts.zoho.com/oauth/v2/token?
Request Example
https://accounts.zoho.com/oauth/v2/token?code=1000.dd7e47321d48b8a7e312e3d6eb1a9bb8.b6c07ac766ec11da98bf6a261e24dca4&client_id=1000.0SRSZSY37WMZ69405H3TMYI2239V&client_secret=fb0196010f2b70df8db2a173ca2cf59388798abf&redirect_uri=http://www.mdm.manageengine.com.au&grant_type=authorization_code
Parameter | Description |
---|---|
refresh_token | REFRESH TOKEN which is obtained in the above step |
client_id | Client ID obtained during Client Registration |
client_secret | Client secret obtained during Client Registration |
redirect_uri | This param should be same redirect url mentioned while registering Client |
grant_type |
refresh_token
|
Step 5: Revoking a Refresh Token
To revoke a refresh token, call the following POST URL with the given params
https://accounts.zoho.com/oauth/v2/token/revoke?
Request Example
https://accounts.zoho.com/oauth/v2/token/revoke?refresh_token=1000.8ecd474019e31d522f94aad6c5cb7.4638677ebc14f2f2ee0b6dfb6cebdc
Parameter | Description |
---|---|
refresh_token | REFRESH TOKEN which is to be revoked |
Step 6: Calling An API
Access Token can be passed only in header and cannot be passed in the request param.
- Header name should be
Authorization
- Header value should be
Zoho-oauthtoken {access_token}
List of scopes available :
Scope | Description |
---|---|
Inventory | To access inventory related APIs
Availabe types: MDMOnDemand.MDMInventory.CREATE, MDMOnDemand.MDMInventory.UPDATE, MDMOnDemand.MDMInventory.READ, MDMOnDemand.MDMInventory.DELETE
|
Device Management | To access profiles, apps, groups and user_groups related APIs
Availabe types: MDMOnDemand.MDMDeviceMgmt.CREATE, MDMOnDemand.MDMDeviceMgmt.UPDATE, MDMOnDemand.MDMDeviceMgmt.READ, MDMOnDemand.MDMDeviceMgmt.DELETE
|
User | To access user related APIs
Availabe types: MDMOnDemand.MDMUser.CREATE, MDMOnDemand.MDMUser.UPDATE, MDMOnDemand.MDMUser.READ, MDMOnDemand.MDMUser.DELETE
|
Errors
Error Response Example
HTTP/1.1 404 Not Found Content-Type: application/json;charset=UTF-8 { "error_code": 1002, "error_description": "Unknown ID", "localized_error_description" : "Unknown ID" }
In general, status codes in the 2xx range means success, 4xx range means there was an error in the provided information, and those in the 5xx range indicate server side errors. Commonly used HTTP status codes are listed below.
HTTP Status Codes
Status Code | Descriptions |
---|---|
2xx | Success |
4xx | Bad request sent to server |
5xx | Server side error |
Status Code | Description |
---|---|
200 | Success The request was successfully completed. |
201 | Created The request was a success and one or more resources have been created. |
400 | Bad request The request cannot be performed. Usually because of malformed parameter or missing parameter. |
401 | Unauthorized (Invalid AuthToken) Request was rejected because of invalid AuthToken. | 403 | Forbidden The user does not have enough permission or possibly not an user of the respective organization to access the resource. |
404 | URL Not Found The URL you’ve sent is wrong. It’s possible that the resource you’ve requested has been moved to another URL. |
405 | Method Not Allowed The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method. |
406 | Not Acceptable The requested response type is not supported by the client. |
429 | Too many requests Too many requests within a certain time frame. To know more about api call limits, click here. |
500 | Server errorA Server error has occurred. |
Common Error codes
The error codes returned by the server is listed below.
Error Code | HTTP status | Error Description |
---|---|---|
COM0001 | 405 | Method not implemented / Invalid URL |
COM0002 | 429 | API Limit Exceeded |
COM0003 | 400 | Invalid paging params |
COM0004 | 500 | Internal server error, Please try again in a moment |
COM0005 | 400 | Parameters in post were invalid or missing |
COM0006 | 400 | No request data recieved |
COM0007 | 412 | Assist is not Integrated. |
COM0008 | 404 | Unknown Resource |
COM0009 | 422 | Insufficient Data for Processing Request |
COM0010 | 409 | Resource Already Exists |
COM0011 | 422 | Invalid / Missing headers |
COM0012 | 400 | Invalid API version |
COM0013 | 401 | Not Authorised/ Invalid auth token |
COM0014 | 400 | Bad Request |
LOC0001 | 412 | Location Fetch error |
SDE0003 | 412 | Assign User failed |
CMD0001 | 412 | Command not applicable for Device |
CMD0002 | 412 | Unable to suspend command |
APP0001 | 400 | App Upload Regected |
APP0002 | 412 | Unable to delete app or profile |
COM00020 | 400 | Device license limit reached |
FIL0001 | 400 | File upload rejected |
COM0015 | 412 | Precondition Failed |
COM0021 | 400 | Invalid delta token |
PAY0001 | 400 | The image uploaded must be less than the size specified! |
PAY0002 | 400 | Specify all the requisite fields to proceed further! |
PAY0004 | 400 | Verify the values specified for the requisite fields! |
Devices
Devices Meta information
Example
{ "action_info": "--", "actions": [ { "is_enabled": true, "localized_name": "Create container", "name": "zylker iPhone", "localized_action_info": "--", "status_code": 2, "action_info": "--", "localized_status_description": "Command Initiated", "status_description": "Command Success" } ], "added_by": 9007199254740996, "added_by_name": "admin", "added_time": 1523370360750, "addedby": "admin", "address": "Zoho Corporation Pvt Ltd, Estancia, Chennai", "agent_type": 1, "agent_version": "9.2.432.A", "agent_version_code": -1, "allow_activation_lock": -1, "allow_air_command": -1, "allow_air_view": -1, "allow_airplane_mode": -1, "allow_android_beam": -1, "allow_android_browser": 1, "allow_android_market": 0, "allow_app_notification_mode": 1, "allow_audio_record": 1, "allow_background_data": -1, "allow_background_process_limit": -1, "allow_bluetooth": -1, "allow_bluetooth_tethering": -1, "allow_bt_data_transfer": -1, "allow_bt_discoverable": -1, "allow_bt_outgoing_calls": -1, "allow_bt_pairing": -1, "allow_bt_pc_connection": -1, "allow_call": -1, "allow_camera": 1, "allow_cellular_data": -1, "allow_clipboard": -1, "allow_clipboard_share": 1, "allow_contacts_outside": 1, "allow_date_time_change": -1, "allow_developer_mode": -1, "allow_disabling_cellular_data": -1, "allow_disabling_gps": 3, "allow_emergency_calls_only": -1, "allow_factory_reset": -1, "allow_firmware_recovery": -1, "allow_gmail": -1, "allow_google_account_auto_sync": 1, "allow_google_backup": -1, "allow_google_crash_report": -1, "allow_google_maps": -1, "allow_headphone": -1, "allow_home_key": -1, "allow_incoming_call": -1, "allow_incoming_mms": -1, "allow_incoming_sms": -1, "allow_install_app": 1, "allow_kill_activity_on_leave": -1, "allow_knox_app_store": 1, "allow_lock_screen_menu": -1, "allow_lock_screen_view": -1, "allow_microphone": 1, "allow_mms": -1, "allow_mock_location": -1, "allow_nfc": -1, "allow_non_market_apps": -1, "allow_ota_upgrade": -1, "allow_other_keypad": 1, "allow_outgoing_call": -1, "allow_outgoing_mms": -1, "allow_outgoing_sms": -1, "allow_power_off": -1, "allow_roaming_data": -1, "allow_roaming_push": -1, "allow_roaming_sync": -1, "allow_roaming_voice_calls": -1, "allow_s_beam": -1, "allow_s_finder": -1, "allow_s_voice": 1, "allow_safe_mode": -1, "allow_screen_capture": 0, "allow_sd_card": -1, "allow_sd_card_write": -1, "allow_sdcard_move": -1, "allow_settings": -1, "allow_sharelist": 1, "allow_smart_clip_mode": -1, "allow_sms": -1, "allow_statusbar_expansion": -1, "allow_stop_system_app": 1, "allow_tethering": -1, "allow_uninstall_app": 1, "allow_usb": -1, "allow_usb_debug": -1, "allow_usb_host_storage": -1, "allow_usb_media_player": -1, "allow_usb_tethering": -1, "allow_use_network_time": -1, "allow_user_add_accounts": -1, "allow_user_creation": -1, "allow_user_mobile_data_limit": -1, "allow_user_profile": -1, "allow_video_record": 1, "allow_voice_dialer": -1, "allow_vpn": -1, "allow_wallpaper_change": -1, "allow_whitelist_wifi_only": 0, "allow_wifi": -1, "allow_wifi_direct": -1, "allow_wifi_tethering": -1, "allow_you_tube": -1, "apn_password": null, "apn_username": "zylker", "app_category_name": "Games", "app_count": 1, "app_details": [ { "app_id": 9007199254740996, "release_label_id": 90086789628394940 } ], "app_id": 9007199254740996, "app_ids": [ 1, 2, 3 ], "app_name": "Red Ball 4 (Ad Supported)", "app_permission_policy": -1, "app_type": 1, "app_version": "0.1.187945513", "app_version_code": 187945513, "applicable_for": [ 1, 2 ], "applied_time": 1232132131, "apps": [ { "app_version": "0.1.187945513", "app_version_code": 187945513, "platform_type": 2, "identifier": "com.google.android.apps.googleassistant", "app_name": "Red Ball 4 (Ad Supported)", "app_id": 9007199254740996, "added_time": 1523370360750, "modified_time": 1231231231, "platform": 2, "icon": "https://serverimae.com/icon.png" } ], "asset_owner": "Sysadmin", "asset_tag": "TestDevice", "associated_by": "admin", "associated_by_user_id": 1, "associated_by_user_name": "admin", "associated_on": 1522066653883, "available_device_capacity": 13.200405, "available_external_capacity": 20.47, "available_ram_memory": 983, "battery_level": 22, "bluetooth_mac": "2c:f0:ee:b6:a8:97", "browser_allow_autofill": 1, "browser_allow_cookies": 1, "browser_allow_fraud_warning": 1, "browser_allow_javascript": 1, "browser_allow_popups": 1, "build_version": "NRD90M", "carrier_setting_version": "--", "cellular_technology": 1, "certificateexpiry": 4696305454000, "certificateissuername": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "certificatename": "ManageEngineCA", "certificates": { "unmanagedcertificates": [ { "signaturealgorithmoid": "1.2.840.113549.1.1.11", "certificatename": "ManageEngineCA", "certificatesubjectname": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "serialnumber": 5482640642439599000, "certificateexpiry": 4696305454000, "isidentity": false, "certificateissuername": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "signaturealgorithmname": "SHA256withRSA" } ], "managedcertificates": [ { "signaturealgorithmoid": "1.2.840.113549.1.1.11", "certificatename": "ManageEngineCA", "certificatesubjectname": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "serialnumber": 5482640642439599000, "certificateexpiry": 4696305454000, "isidentity": false, "certificateissuername": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "signaturealgorithmname": "SHA256withRSA" } ] }, "certificatesubjectname": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "command_history_id": 9007199254740996, "command_id": 9007199254741304, "command_life": [ { "updated_time": 1560141503246, "status_description": "Command Success", "command_id": 9007199254741304, "status_code": 2, "added_by": 9007199254740996, "command_name": "AssetScan", "added_by_name": "admin", "remarks": "The app is not compatible for this platform" } ], "command_name": "AssetScan", "command_status": 2, "commands": [ { "command_status": 2, "managed_status": 2, "command_id": 9007199254741304, "command_name": "AssetScan", "added_time": 1523370360750, "device_id": 9007199254741000, "added_by": 9007199254740996, "command_history_id": 9007199254740996, "added_by_name": "admin", "command_life": [ { "updated_time": 1560141503246, "status_description": "Command Success", "command_id": 9007199254741304, "status_code": 2, "added_by": 9007199254740996, "command_name": "AssetScan", "added_by_name": "admin", "remarks": "The app is not compatible for this platform" } ], "remarks_args": null, "remarks": "The app is not compatible for this platform" } ], "configuration_profiles": [ { "payload_uuid": "unknown-uuid", "payload_identifier": "com.apple.applebetasoftware", "payload_description": "No description available", "payload_organization": "Unknown", "payload_type": "com.apple.defaults.managed", "payload_version": 1, "payload_has_rem_password": false, "payload_is_encrypted": false, "payload_display_name": "iOS Configuration Payload", "payload_unremovable": false, "payloadcontent": [ { "payload_uuid": "unknown-uuid", "payload_identifier": "com.apple.applebetasoftware", "payload_description": "No description available", "payload_organization": "Unknown", "payload_type": "com.apple.defaults.managed", "payload_version": 1, "payload_display_name": "iOS Configuration Payload" } ] } ], "container_last_updated_time": -1, "container_remarks": null, "container_state": -1, "container_status": 20004, "created_time": 2313123123, "created_user": "admin", "current_carrier_network": "airtel", "current_mcc": "in", "current_mnc": 40, "data_roaming_enabled": true, "delta-token": "aHR0cDovL2xvY2FsaG9zdDo5MDIwL2FwaS92MS9tZG0vcHJvZmlsZXMvc2NlcHNldHRpbmdzOjoxNTQyOTU0OTEzOTI0", "description": "Belong to Zoho Corp", "device_admin_enabled": -1, "device_capacity": 24.81, "device_count": 2, "device_id": 9007199254741000, "device_name": "admin_Pixel 3 XL", "device_rooted": false, "devices": [ { "device_id": 9007199254741000, "os_version": 7, "is_lost_mode_enabled": false, "owned_by": 2, "is_removed": false, "product_name": "samsung", "device_name": "admin_Pixel 3 XL", "platform_type": 2, "platform_type_id": 2, "udid": "4fcacfdf446bf211", "serial_number": "RZ8H60ASLHR", "model": "SM-G935F", "user": { "user_name": "admin", "user_id": 9007199254741000, "user_email": "admin@zylker.com" }, "imei": 357327071694307, "summary": { "profile_count": 0, "app_count": 1, "doc_count": 1, "group_count": 1 } } ], "disable_bug_report": 2, "disable_remote_control": 1, "disable_wipe": 0, "do_not_uninstall": true, "doc_count": 1, "eas_device_identifier": "QEGJKADSR14D1AEAA4F29FM0IC", "efrp_account_details": [ { "emailids": [ "example1@gmail.com", "example2@gmail.com", "example3@gmail.com" ], "addedby": "admin", "profilename": "MyProfile1" } ], "efrp_status": 1, "emailids": [ "example1@gmail.com", "example2@gmail.com", "example3@gmail.com" ], "ethernet_ip": "--", "ethernet_macs": "--", "executed_version": 1, "export_batch_id": 900234566788909, "external_capacity": 29.82, "external_storage_encryption": -1, "fetch_device_name": 0, "fetch_installed_app": 0, "fetch_location": 0, "fetch_phone_number": 0, "filevault": { "filevault_status": 10, "is_institution_recovery_key": true, "is_personal_recovery_key": true, "resource_id": 9508000000013120, "is_encryption_enabled": false }, "filevault_status": 10, "firmware_mode": 1, "firmware_password": "SampleFirmwarePassword@123", "group": [ { "group_id": 9007199254741632, "group_name": "Test group 1557134860919" } ], "group_count": 1, "group_id": 9007199254741632, "group_name": "Test group 1557134860919", "groups": [ "9007199254741597", "9007199254741595" ], "hardware_encryption_caps": -1, "iccid": 8991400912981718000, "icon": "https://serverimae.com/icon.png", "identifier": "com.google.android.apps.googleassistant", "imei": 357327071694307, "imsi": "--", "incoming_network_usage": 0, "incoming_wifi_usage": 0, "installed_apps": [ { "release_label_details": { "release_label_name": "Production", "release_label_id": 90086789628394940 }, "app_version": "0.1.187945513", "platform_type": 2, "identifier": "com.google.android.apps.googleassistant", "app_name": "Red Ball 4 (Ad Supported)", "app_id": 9007199254740996, "app_version_code": 187945513 } ], "invite_user": true, "is_activation_lock_enabled": true, "is_cloud_backup_enabled": false, "is_device_locator_enabled": true, "is_dnd_in_effect": false, "is_enabled": true, "is_encryption_enabled": false, "is_firmware_change_pending": false, "is_firmware_password_exists": false, "is_institution_recovery_key": true, "is_ios_native_app_registered": false, "is_itunes_account_active": true, "is_lost_mode_enabled": false, "is_paid_app": false, "is_personal_hotspot_enabled": false, "is_personal_recovery_key": true, "is_removed": false, "is_roaming": true, "is_roms_allowed": false, "is_supervised": false, "isidentity": false, "islatestver": true, "knox_actions": [ { "is_enabled": true, "localized_name": "Create container", "name": "zylker iPhone", "localized_action_info": "--", "action_info": "--" } ], "knox_details": { "container_state": -1, "container_remarks": null, "container_status": 20004, "container_last_updated_time": -1, "knox_version": 2 }, "knox_restricions": { "browser_allow_fraud_warning": 1, "allow_safe_mode": -1, "allow_s_beam": -1, "allow_video_record": 1, "allow_other_keypad": 1, "allow_sdcard_move": -1, "allow_app_notification_mode": 1, "resource_id": 9508000000013120, "allow_whitelist_wifi_only": 0, "allow_roaming_sync": -1, "allow_wifi_tethering": -1, "allow_roaming_data": -1, "allow_camera": 1, "browser_allow_javascript": 1, "allow_user_mobile_data_limit": -1, "allow_emergency_calls_only": -1, "app_permission_policy": -1, "allow_usb_tethering": -1, "allow_usb": -1, "allow_lock_screen_view": -1, "allow_user_creation": -1, "allow_factory_reset": -1, "allow_google_account_auto_sync": 1, "allow_voice_dialer": -1, "allow_smart_clip_mode": -1, "allow_outgoing_call": -1, "allow_lock_screen_menu": -1, "allow_date_time_change": -1, "allow_roaming_push": -1, "allow_install_app": 1, "allow_user_profile": -1, "allow_incoming_call": -1, "allow_power_off": -1, "allow_usb_debug": -1, "allow_statusbar_expansion": -1, "allow_android_browser": 1, "allow_you_tube": -1, "browser_allow_popups": 1, "allow_activation_lock": -1, "allow_disabling_gps": 3, "allow_outgoing_mms": -1, "browser_allow_cookies": 1, "allow_user_add_accounts": -1, "device_admin_enabled": -1, "allow_home_key": -1, "allow_mock_location": -1, "allow_android_market": 0, "allow_bt_discoverable": -1, "allow_bluetooth_tethering": -1, "allow_roaming_voice_calls": -1, "allow_airplane_mode": -1, "allow_sharelist": 1, "allow_bt_outgoing_calls": -1, "allow_sms": -1, "allow_disabling_cellular_data": -1, "allow_uninstall_app": 1, "allow_nfc": -1, "allow_use_network_time": -1, "allow_contacts_outside": 1, "scope": 1, "allow_clipboard": -1, "allow_background_process_limit": -1, "allow_s_finder": -1, "allow_s_voice": 1, "allow_audio_record": 1, "allow_microphone": 1, "allow_stop_system_app": 1, "allow_ota_upgrade": -1, "allow_clipboard_share": 1, "allow_bluetooth": -1, "allow_usb_host_storage": -1, "allow_cellular_data": -1, "allow_sd_card": -1, "allow_google_maps": -1, "allow_gmail": -1, "allow_call": -1, "allow_incoming_sms": -1, "allow_bt_data_transfer": -1, "allow_headphone": -1, "allow_tethering": -1, "allow_firmware_recovery": -1, "allow_google_backup": -1, "allow_outgoing_sms": -1, "allow_air_view": -1, "allow_non_market_apps": -1, "browser_allow_autofill": 1, "allow_kill_activity_on_leave": -1, "allow_vpn": -1, "allow_bt_pairing": -1, "allow_usb_media_player": -1, "allow_sd_card_write": -1, "allow_android_beam": -1, "allow_air_command": -1, "allow_mms": -1, "allow_background_data": -1, "allow_knox_app_store": 1, "allow_settings": -1, "allow_wifi_direct": -1, "allow_google_crash_report": -1, "allow_developer_mode": -1, "allow_incoming_mms": -1, "allow_wallpaper_change": -1, "allow_screen_capture": 0, "allow_bt_pc_connection": -1, "allow_wifi": -1 }, "knox_version": 2, "last_cloud_backup_date": -1, "last_contact_time": 1557128715277, "last_modified_time": 1231231231, "last_modified_user": "admin", "latest_version": 5, "latitude": 12.8282, "localized_action_info": "--", "localized_name": "Create container", "localized_remark": "--", "localized_remarks": "Applied", "localized_status_description": "Command Initiated", "located_time": 1523370128573, "locations": [ { "added_time": 1523370360750, "latitude": 12.8282, "longitude": 80.0512, "located_time": 1523370128573 } ], "longitude": 80.0512, "managed_device_id": 9508000000013120, "managed_password_id": -1, "managed_status": 2, "managedcertificates": [ { "signaturealgorithmoid": "1.2.840.113549.1.1.11", "certificatename": "ManageEngineCA", "certificatesubjectname": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "serialnumber": 5482640642439599000, "certificateexpiry": 4696305454000, "isidentity": false, "certificateissuername": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "signaturealgorithmname": "SHA256withRSA" } ], "meid": "SM-G935F", "metadata": { "total_record_count": 4 }, "model": "SM-G935F", "model_id": 9007199254740996, "model_name": "hero2ltexx", "model_type": 1, "modem_firmware_version": "G935FXXU1DQIL", "modified_time": 1231231231, "na_list": [ { "device_id": 9007199254741000, "remarks": "The app is not compatible for this platform", "status": "SCHEDULED" } ], "name": "zylker iPhone", "network": { "outgoing_network_usage": 0, "incoming_wifi_usage": 0, "resource_id": 9508000000013120, "outgoing_wifi_usage": 0, "incoming_network_usage": 0 }, "network_usage": { "outgoing_network_usage": 0, "incoming_wifi_usage": 0, "device_id": 9007199254741000, "outgoing_wifi_usage": 0, "incoming_network_usage": 0 }, "next": "http://localhost:9020/api/v1/mdm/profiles/scepsettings?skip-token=MjozOjE6MTU0Mjk1NDkxMzkxOA%3D%3D", "next_poll_time": 1542869208225, "no_of_days": 7, "not_applicable_count": 1, "notify_user_via_email": true, "office": "North Plaza,CA", "os": { "platform_type": 2, "build_version": "NRD90M", "os_version": 7, "resource_id": 9508000000013120, "serial_number": "RZ8H60ASLHR" }, "os_name": "NOUGAT", "os_version": 7, "outgoing_network_usage": 0, "outgoing_wifi_usage": 0, "owned_by": 2, "paging": { "next": "http://localhost:9020/api/v1/mdm/profiles/scepsettings?skip-token=MjozOjE6MTU0Mjk1NDkxMzkxOA%3D%3D" }, "passcode_complaint": false, "passcode_complaint_profiles": true, "passcode_present": false, "payload_description": "No description available", "payload_display_name": "iOS Configuration Payload", "payload_has_rem_password": false, "payload_identifier": "com.apple.applebetasoftware", "payload_is_encrypted": false, "payload_organization": "Unknown", "payload_type": "com.apple.defaults.managed", "payload_unremovable": false, "payload_uuid": "unknown-uuid", "payload_version": 1, "payloadcontent": [ { "payload_uuid": "unknown-uuid", "payload_identifier": "com.apple.applebetasoftware", "payload_description": "No description available", "payload_organization": "Unknown", "payload_type": "com.apple.defaults.managed", "payload_version": 1, "payload_display_name": "iOS Configuration Payload" } ], "platform": 2, "platform_type": 2, "platform_type_id": 2, "play_protect": true, "processor_speed": 1586000, "product_name": "samsung", "profile_count": 0, "profile_description": "Test Profile", "profile_id": 12354, "profile_ids": [ 1 ], "profile_name": "Test Profile", "profilename": "MyProfile1", "profiles": [ { "profile_id": 12354, "profile_name": "Test Profile", "status": "SCHEDULED", "remarks": "The app is not compatible for this platform", "localized_remarks": "Applied", "profile_description": "Test Profile", "applied_time": 1232132131, "group_count": 1, "device_count": 2, "created_user": "admin", "created_time": 2313123123, "last_modified_user": "admin", "last_modified_time": 1231231231, "platform_type": 2 } ], "purchase_date": 1527984000000, "purchase_order_number": "SR2Ik56779", "purchase_price": 65000, "purchase_type": "Reseller", "registered_time": 1540655566627, "release_label_details": { "release_label_name": "Production", "release_label_id": 90086789628394940 }, "release_label_id": 90086789628394940, "release_label_name": "Production", "remark": "Executed Successfully", "remarks": "The app is not compatible for this platform", "remarks_args": null, "resource_id": 9508000000013120, "safetynet_availabiity": true, "safetynet_basic_integrity": true, "safetynet_cts": true, "scope": 1, "security": { "passcode_complaint": false, "external_storage_encryption": -1, "storage_encryption": false, "hardware_encryption_caps": -1, "passcode_complaint_profiles": true, "device_rooted": false, "passcode_present": false }, "serial_number": "RZ8H60ASLHR", "serialnumber": 5482640642439599000, "signaturealgorithmname": "SHA256withRSA", "signaturealgorithmoid": "1.2.840.113549.1.1.11", "silent_install": true, "sim_id": 9508000000013204, "sims": [ { "subscriber_carrier_network": "airtel", "iccid": 8991400912981718000, "is_roaming": true, "sim_id": 9508000000013204, "current_mnc": 40, "subscriber_mnc": 40, "current_carrier_network": "airtel", "resource_id": 9508000000013120, "imei": 357327071694307, "subscriber_mcc": "in", "current_mcc": "in" } ], "status": "SCHEDULED", "status_code": 2, "status_description": "Command Success", "storage_encryption": false, "subscriber_carrier_network": "airtel", "subscriber_mcc": "in", "subscriber_mnc": 40, "success_count": 1, "success_list": [ { "device_id": 9007199254741000, "remarks": "The app is not compatible for this platform", "status": "SCHEDULED" } ], "summary": { "profile_count": 0, "app_count": 1, "doc_count": 1, "group_count": 1 }, "total_count": 3, "total_ram_memory": 3533, "total_record_count": 4, "udid": "4fcacfdf446bf211", "unmanagedcertificates": [ { "signaturealgorithmoid": "1.2.840.113549.1.1.11", "certificatename": "ManageEngineCA", "certificatesubjectname": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "serialnumber": 5482640642439599000, "certificateexpiry": 4696305454000, "isidentity": false, "certificateissuername": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "signaturealgorithmname": "SHA256withRSA" } ], "unregistered_time": -1, "updated_time": 1560141503246, "used_device_space": 12.86491, "used_external_space": 25.38, "user": { "user_name": "admin", "user_id": 9007199254741000, "user_email": "admin@zylker.com" }, "user_email": "admin@zylker.com", "user_id": 9007199254741000, "user_name": "admin", "view_privacy_settings": true, "voice_roaming_enabled": false, "wait": 500, "warranty_expiration_date": 1530057600000, "warranty_number": "SJSU64728372", "warranty_type": "WithService", "wifi_ip": "--", "wifi_mac": "2c:f0:ee:b6:a8:96", "limit": 10, "offset": 3 }
Attribute
:id
Long
ID of the managed device
about_flags_access
Integer
Specify whether the users can access the about:flags page in Microsoft Edge. 0 - Users can access the about:flags page in Microsoft Edge. 1 - Users can't access the about:flags page in Microsoft Edge.
action_center_notifications
Integer
Specify whether the Action Center is allowed. 1 - Allow Action Center 0 - Restrict Action Center
action_info
String
Information of actions that can be performed on Samsung Knox devices
action_name
String
Name of the action :
actions
list
Details of actions that can be performed on devices
is_enabled
Boolean
Specify whether a specific action is enabled
localized_name
String
Localized name of knox action
name
String
Name of the device
localized_action_info
String
Localized knox action information
status_code
int
Scan command status code 0: failed, 1: Initiated, 2: Success, 4: In progress
action_info
String
Information of actions that can be performed on Samsung Knox devices
localized_status_description
String
Current status of the action
status_description
String
Next poll time for device
add_prov_package
Integer
Specify whether addition of provisioning packages is allowed. 1-Allow addition of provisioning packages. 0-Restrict addition of provisioning packages.
added_by
long
User ID of users who initiated a command
added_by_name
String
User name of users who initiated a command
added_time
String
Timestamp when location was recorded on the server
addedby
String
Users who added the account
address
String
Address corresponding to the latitude and longitude
agent_type
Integer
Used to identify which type of agent is installed
agent_version
String
MDM agent version
agent_version_code
String
Version code of the agent. Required for upgrading agent version
allow_account_modification
Integer
Specify whether account settings can be modified
allow_activation_lock
String
Current setting of Activation Lock.
allow_activity_continuation
Integer
Returns if Activity continuation be disabled.
allow_adding_game_friends
Integer
Returns whether the user is allowed to add game center friends.
allow_address_bar_dropdown
Integer
Specify whether the address bar dropdown is allowed 0 - Address bar drop-down is disabled. 1 - Address bar drop-down is enabled.
allow_air_command
String
Current setting of Air Command.
allow_air_view
String
Current setting of Air View.
allow_airdrop
Integer
Specify whether users are allowed to use AirDrop
allow_airplane_mode
String
Current setting of Airplane Mode
allow_airprint
Integer
Specify whether users are allowed to use AirPrint
allow_airprint_credential_storage
Integer
Specify whether users are allowed to store AirPrint credentials
allow_airprint_ibeacon_discovery
Integer
Specify whether users are allowed to discover the iBeacon
allow_android_beam
String
Current setting of Android Beam.
allow_android_browser
String
Specify whether users are allowed to use Android browser
allow_android_market
String
Current status of Android Market
allow_app_cellular_data
Integer
Specify whether users can change apps that can use cellular data
allow_app_installation
Integer
Specify whether the users can install apps on devices
allow_app_notification_mode
String
Current setting of Application Notification Mode
allow_app_removal
Integer
Specify whether users can remove apps from devices
allow_assist_when_locked
Integer
Specify whether Siri is allowed on locked devices
allow_assistant
Integer
Specify whether Siri is allowed on the device
allow_assistant_user_content
Integer
Specify whether user-generated content is allowed in Siri
allow_audio_record
String
Current setting of Audio Record.
allow_auto_app_download
Integer
Allow apps to be downloaded automatically.
allow_auto_correction
Integer
Specify if autocorrect is enabled
allow_autofill
Integer
Specify whether autofill is enabled. 0 - Restricted.1 - Allowed.
allow_background_data
String
Specify whether auto sync is allowed while Roaming is enabled
allow_background_process_limit
String
Current setting of Background Process Limit.
allow_backup_restore
Integer
Current setting of backup and restore of data.
allow_bluetooth
String
Current setting of Bluetooth.
allow_bluetooth_modification
Integer
Specify whether Bluetooth modification is allowed
allow_bluetooth_tethering
String
Current setting of Bluetooth tethering.
allow_bt_data_transfer
String
Current setting of Bluetooth Data Transfer
allow_bt_discoverable
String
Current setting of Bluetooth Discoverable.
allow_bt_outgoing_calls
String
Current setting of Bluetooth Outgoing Calls.
allow_bt_pairing
String
Current setting of Bluetooth Pairing.
allow_bt_pc_connection
String
Current setting of Bluetooth Desktop Connection.
allow_call
String
Current setting of Incoming and outgoing SMS for core Android.
allow_camera
String
Current setting of camera.
allow_camera_in_keyguard
Integer
Disable camera in keyguard
allow_cellular_data
String
Current setting of cellular data.
allow_classroom_remoteview
Integer
Allow teachers to view the screen from their device
allow_clipboard
String
Current setting of Clipboard.
allow_clipboard_share
String
Current setting of Clipboard Share.
allow_cloud_backup
Integer
Returns whether cloud backup is allowed in the device.
allow_cloud_document_sync
Integer
Returns whether Cloud Document Sync is allowed in the device.
allow_cloud_keychain_sync
Integer
Returns if cloud keychain synchronization is disabled.
allow_cloud_photo_lib
Integer
Allow cloud photo library.
allow_contacts_outside
String
Current setting of contact sharing to device.
allow_cookies
Integer
Specify whether Cookies is enabled in the browser. 1-Allowed 0-Restricted
allow_date_time_change
String
Current setting of Date Time Change.
allow_developer_mode
String
Current setting of Developer Mode.
allow_developer_tools
Integer
Specify whether autofill is enabled. 0 - Restricted.1 - Allowed.
allow_diag_sub_modification
Integer
Specify whether diagnostic submission modification is enabled.
allow_diagnostic_submission
Integer
Returns if Diagnostic data be sent to Apple.
allow_dictation
Integer
Specify whether News should be disabled
allow_dictionary_lookup
Integer
Specify if dictionary lookup is enabled
allow_disabling_cellular_data
String
Specify if users are allowed to change the cellular data setting
allow_disabling_gps
String
Current setting of disabling GPS data.
allow_donot_track
Integer
Specify whether do not track requests are allowed. 1-Allow do not track requests. 0-Restrict do not track requests.
allow_emergency_calls_only
String
Specify whether emergency calls are allowed
allow_enabling_restriction
Integer
Specify if restrictions can be enabled
allow_erase_content_settings
Integer
Specify if Erase all contents and settings is allowed
allow_explicit_content
Integer
Returns whether the Explicit content is allowed in the device .
allow_extensions
Integer
Specify whether autofill is enabled. 0 - Restricted.1 - Allowed.
allow_face_time
Integer
Specify whether FaceTime is allowed on the device
allow_factory_reset
String
Specify whether users are allowed to use Android browser
allow_find_my_friends_mod
Integer
Specify whether users can modify the Find My Friends settings
allow_firmware_recovery
String
Current setting of Firmware Recovery.
allow_flash
Integer
Specify whether autofill is enabled. 0 - Restricted.1 - Allowed.
allow_game_center
Integer
Specify whether the users can use the Game Center
allow_gmail
String
Current setting of Gmail.
allow_google_account_auto_sync
String
Current setting of Google Auto Sync
allow_google_backup
String
Current setting of Google backup.
allow_google_crash_report
String
Specify whether users are allowed to use Android browser
allow_google_maps
String
Current setting of Google Maps.
allow_headphone
String
Enable/disable headphone functionality
allow_home_key
String
Current setting of Home Key.
allow_host_pairing
Integer
Enable/Disable host pairing
allow_ibookstore_erotica_media
Integer
If set to false, the user will not be able to download media from the iBookstore that has been tagged as erotica. This will default to true. Supervised only. Available in iOS 6.0 and later.
allow_imessage
Integer
Specify whether the user can use iMessage
allow_inapp_purchase
Integer
Specify whether in app purchase is allowed
allow_incoming_call
String
Current setting of incoming calls
allow_incoming_mms
String
Current setting of Incoming MMS.
allow_incoming_sms
String
Current setting of incoming SMS
allow_inprivate
Integer
Specify whether private browsing is allowed on the device. 1-Allowed 0-Restricted
allow_install_app
String
Current setting of Install App
allow_itunes
Integer
When false, the iTunes Music Store is disabled and its icon is removed from the Home screen. Users cannot preview, purchase, or download content.
allow_keyboard_shortcut
Integer
Allow the user to use the keyboard shortcuts.
allow_keyguard_notifications
Integer
0 - Allow notification, 1- Notifications with Hide Content 2 - Hide Notification
allow_keyguard_trust_agents
Integer
Specify whether keyguard trust agents are allowed
allow_kill_activity_on_leave
String
Current setting of Killing Activity On Leave.
allow_knox_app_store
String
Current setting of Knox app store.
allow_lock_screen_menu
String
Current setting of Lock Screen
allow_lock_screen_view
String
Current setting of Lock Screen View
allow_managed_app_cloud_sync
Integer
Prevent managed application from using cloud sync.
allow_managed_app_trust
Integer
Allow enterprise app trust
allow_managed_book_backup
Integer
Specify if enterprise book backup is enabled
allow_managed_book_sync
Integer
Specify whether enterprise book notes and highlights can be synced
allow_managed_write_unmanaged_contact
Integer
Specify whether managed apps can write in unmanaged account
allow_microphone
String
Current setting of Microphone.
allow_mms
String
Current setting of Incoming and outgoing SMS for core Android.
allow_mock_location
String
Current setting of Mock Location.
allow_modifi_device_name
Integer
Specify whether the users can modify the device name
allow_modifi_passcode
Integer
Specify whether the users can modify the device passcode
allow_modifi_wallpaper
Integer
Specify whether the users can modify the device wallpaper
allow_modify_touch_id
Integer
Specify whether the users can add or modify fingerprint settings
allow_multiplayer_gameing
Integer
Specify whether the users can use Multiplayer Gaming
allow_music_service
Integer
Specify if music services are allowed on the device
allow_news
Integer
Specify if news is allowed on the device
allow_nfc
String
Specify if users are allowed to use NFC
allow_non_market_apps
String
Specify whether users can install non-market apps on devices
allow_open_doc_in_managed
Integer
Specify if documents in unmanaged apps can be accessed using managed apps
allow_open_doc_in_unmanaged
Integer
Specify if documents in managed apps can be accessed using unmanaged apps
allow_ota_pki_updates
Integer
Specify whether certificate trust settings can be automatically updated
allow_ota_upgrade
String
Specify whether users are allowed to use Android browser
allow_other_keypad
String
Current setting of other keypad.
allow_outgoing_call
String
Current setting of outgoing calls
allow_outgoing_mms
String
Current setting of Outgoing MMS
allow_outgoing_sms
String
Current setting of Outgoing SMS
allow_paired_watch
Integer
Specify if pairing watch is allowed
allow_passbook_when_locked
Integer
Specify whether passbook notification will be displayed on the lock screen. By default, this settings is allowed. Available in iOS 6.0 and later.
allow_passmgr
Integer
Specify whether password management is allowed on browser 1. Allowed 0. Restricted
allow_password_autofill
Integer
Specify whether Autofill is allowed in Safari and other apps
allow_password_proximity
Integer
Specify whether devices can request passwords in proximity
allow_password_sharing
Integer
Specify whether password sharing is enabled on the device
allow_personal_space_non_market_apps
Integer
Specify whether users can install non-market apps in the personal space
allow_photo_stream
Integer
Specify whether photo streaming is allowed on the device
allow_play_protect_monitoring
Integer
Specify whether Google Play Protect monitoring is enabled on the device.
allow_podcasts
Integer
Specify whether Podcast is allowed on the device
allow_popups
Integer
Specify whether pop-up is enabled on the browser. 0 - Allowed. 1 - Restricted.
allow_power_off
String
Current setting of power off
allow_predictive_keyboard
Integer
Specify whether automatic predictive keyboard is allowed on the device
allow_profile_installation
Integer
Specify whether the user is allowed to install configuration profiles and certificates interactively.
allow_proximity_for_newdevice
Integer
Specify whether proximity detection is allowed for new devices
allow_radio_service
Integer
Specify whether radio services is allowed on the device
allow_roaming_data
String
Current setting of roaming data.
allow_roaming_push
String
Current setting of roaming push.
allow_roaming_sync
String
Specify whether users are allowed to use Android browser
allow_roaming_voice_calls
String
Specify whether roaming voice calls are allowed on the device
allow_s_beam
String
Current setting of S Beam
allow_s_finder
String
Current setting of S Finder.
allow_s_voice
String
Current setting of S Voice.
allow_safari
Integer
Specify whether Safari is allowed on the device
allow_safe_mode
String
Current setting of Safe Mode.
allow_screen_capture
String
Specify whether screen capture is allowed on the device
allow_sd_card
String
Specify whether SD card is allowed on the device
allow_sd_card_write
String
Specify whether SD card write is allowed on the device
allow_sdcard_move
String
Current setting of SD Card Move.
allow_searchsuggest
Integer
Specify whether search suggestions are allowed on the browser. 1- Allowed. 0- Restricted
allow_settings
String
Specify whether the Settings app is allowed on the device
allow_shared_stream
Integer
Specify whether Shared Photo Stream is allowed. The default value is True.
allow_sharelist
String
Current setting of share via list
allow_smart_clip_mode
String
Current setting of Smart Clip Mode.
allow_smartscreen
Integer
Specify whether smartscreen filter is allowed on the browser. 1 - Allowed 0 - Restricted
allow_sms
String
Current setting of Incoming and Outgoing SMS for core Android
allow_spellcheck
Integer
Specify if Spell Check is allowed on the device
allow_spotlight_result
Integer
Specify whether Spotlight Internet search results are allowed on the device
allow_statusbar_expansion
String
Specify whether Status Bar expansion is allowed on the device
allow_stop_system_app
String
Current setting of System App Stop
allow_sync_while_roaming
Integer
Specify whether roaming sync is allowed
allow_tethering
String
Specify whether users are allowed to use Android browser
allow_touch_id
Integer
Specify if users can use Touch ID to unlock the device. Available in iOS 7.0 and later
allow_uninstall_app
String
Specify whether users are allowed to use Android browser
allow_unmanaged_read_managed_contact
Integer
Specify whether unmanaged contacts can be accessed from managed apps
allow_untrust_tls_prompt
Integer
Specify whether untrusted TLS prompts is allowed on the device
allow_usb
String
Current setting of USB tethering.
allow_usb_debug
String
Specify whether users are allowed to use Android browser
allow_usb_host_storage
String
Current setting of USB Host Storage.
allow_usb_media_player
String
Current setting of USB media player.
allow_usb_restriction_mode
Integer
Specify whether USB restriction mode is restricted on the device
allow_usb_tethering
String
Current setting of USB tethering.
allow_use_network_time
String
Current setting of using Network time
allow_use_of_ibookstore
Integer
Specify whether user is allowed to use iBooks store
allow_user_add_accounts
String
Current setting of Add Accounts.
allow_user_creation
String
Current setting of User Creation.
allow_user_mobile_data_limit
String
Current setting of User Mobile Data Limit.
allow_user_profile
String
Current setting of User Profile.
allow_video_record
String
Current setting of Video Record.
allow_voice_dialer
String
Current setting of Voice Dialer App
allow_voice_dialing
Integer
Specify whether voice dialing is allowed on the device
allow_voice_recording
Integer
Specify whether voice recording is allowed on the device
allow_vpn
String
Current setting of VPN
allow_vpn_creation
Integer
Specify whether the user is allowed to configure VPNs on the device
allow_wallpaper_change
String
Specify whether the user can change the wallpaper.
allow_whitelist_wifi_only
String
Current setting of allowlisted WiFi.
allow_wifi
String
Current setting of WiFi
allow_wifi_direct
String
Current setting of WiFi Direct
allow_wifi_tethering
String
Current setting of WiFi tethering
allow_you_tube
String
Current setting of YouTube app
anti_theft_mode
Integer
Current setting of anti-theft mode. 1-Default Device Configuration. 0-Not Allowed.
apn_password
String
To configure the APN password for the device.
apn_username
String
To configure the APN Username for the device. Such that it can be used as dynamic variable in APN Payloads.
app_category_name
String
The name of the app category
app_count
String
Apps count of the device
app_details
list
List of apps to be distributed
app_id
String
The app id
release_label_id
String
Release label ID
app_id
String
The app id
app_ids
String
List of IDs of apps to be distributed
app_name
String
The name of the app
app_permission_policy
String
App permission policy
app_store_auto_update
Integer
Specify whether automated store app updates are allowed. 0 - Restricted 1 - Allowed
app_type
Integer
The App type
app_version
String
The App version
app_version_code
String
The app version code
applicable_for
String
applied_time
Long
Applied time of the profile
apps
list
Array of app details
app_version
String
The App version
app_version_code
String
The app version code
platform_type
String
Platform type of the device
identifier
String
The identifier of the app
app_name
String
The name of the app
app_id
String
The app id
added_time
String
Timestamp when location was recorded on the server
modified_time
String
The modified time of the app
platform
String
The platform type
icon
String
The icon of the app
apps_rating_value
String
Apps rating value
asset_owner
String
Asset Owner of the device
asset_tag
String
Asset Tag information of the device
associated_by
String
The name of the user who associated the app to the group
associated_by_user_id
String
The ID of the user who associated the profile to the group
associated_by_user_name
String
The name of the user who associated the profile to the group
associated_on
String
The date when the profile was associated to the group
audit_message
String
A message for audit purposes when enabling lost mode
authenticate_before_autofill
Integer
Mandate authentication before using autofill in the browser
auto_connect_to_wifi_hotspot
Integer
Specify whether the device can automatically connect to a Wi-Fi network. 1 - Allowed 0 - Restricted
available_device_capacity
String
Available free space on the device
available_external_capacity
String
Available free space on the device
available_ram_memory
Integer
Available free RAM space in the device
battery_level
Integer
The current battery levels of the device
bluetooth
Integer
Current Bluetooth settings
bluetooth_advertising
Integer
Specify whether Bluetooth advertising is allowed. 1 - Allowed 0 - Restricted
bluetooth_discoverable
Integer
Specify whether Bluetooth discovery is allowed. 1 - Allowed 0 - Restricted
bluetooth_mac
String
Bluetooth MAC address.
bluetooth_prepairing
Integer
Specify whether Bluetooth pre-pairing is allowed. 1 - Allowed 0 - Restricted
browser
Integer
Current settings of the Browser
browser_allow_autofill
String
Current setting of Autofill.
browser_allow_cookies
String
Current setting of Cookies.
browser_allow_fraud_warning
String
Current setting of Fraud warning.
browser_allow_javascript
String
Current setting of Javascript.
browser_allow_popups
String
Specify whether popups are allowed in the Edge browser
build_version
String
The OS Build Version
camera
Integer
The current Camera settings
carrier_setting_version
String
Version of the currently-installed carrier settings file.
cellular_data
Integer
Settings for cellular data 0 - Allow users to turn on 1 - Allow users to turn off 2 - Force on
cellular_technology
Integer
The type of cellular technology. (GSM/CDMA).
certificateexpiry
String
Validity of the certificate.
certificateissuername
String
Issuer name of the certificate
certificatename
String
Name of the certificate
certificates
object
Certificate details
unmanagedcertificates
list
Array of unmanaged certificates
signaturealgorithmoid
String
Signature Algorithm OID of the certificate
certificatename
String
Name of the certificate
certificatesubjectname
String
Certificate subject name
serialnumber
String
Serial number of the certificate
certificateexpiry
String
Validity of the certificate.
isidentity
Boolean
Specify whether an identity certificate is present
certificateissuername
String
Issuer name of the certificate
signaturealgorithmname
String
Name of the signature algorithm
managedcertificates
list
Array of managed certificates
signaturealgorithmoid
String
Signature Algorithm OID of the certificate
certificatename
String
Name of the certificate
certificatesubjectname
String
Certificate subject name
serialnumber
String
Serial number of the certificate
certificateexpiry
String
Validity of the certificate.
isidentity
Boolean
Specify whether an identity certificate is present
certificateissuername
String
Issuer name of the certificate
signaturealgorithmname
String
Name of the signature algorithm
certificatesubjectname
String
Certificate subject name
clear_browsing_data_exit
Integer
Specify whether the browser data should be cleared on exit. 0 - Should not be cleared. 1 - Should be cleared
clear_data_for_all_apps
Boolean
Clear all app data
command_history_id
long
ID of command history
command_id
long
Command ID of command
command_life
list
List of command status and time when the command status was updated
updated_time
long
Time of updating status of command
status_description
String
Next poll time for device
command_id
long
Command ID of command
status_code
int
Scan command status code 0: failed, 1: Initiated, 2: Success, 4: In progress
added_by
long
User ID of users who initiated a command
command_name
String
Name of last command invoked
added_by_name
String
User name of users who initiated a command
remarks
String
The remarks for the App associated to the group
command_name
String
Name of last command invoked
command_status
int
The status of the command 0: failed, 1: Initiated, 2: Success, 3: In progress, -1: not applicable
commands
list
List of commands that have been sent to the device
command_status
int
The status of the command 0: failed, 1: Initiated, 2: Success, 3: In progress, -1: not applicable
managed_status
Integer
Management status of the device 0 - Enrollment failed 1 - Yet to enroll 2 - Enrolled successfully 3 - Waiting for approval 4. Unmanaged 5. Waiting for user assignment
command_id
long
Command ID of command
command_name
String
Name of last command invoked
added_time
String
Timestamp when location was recorded on the server
device_id
String
Unique identifer of the device
added_by
long
User ID of users who initiated a command
command_history_id
long
ID of command history
added_by_name
String
User name of users who initiated a command
command_life
list
List of command status and time when the command status was updated
updated_time
long
Time of updating status of command
status_description
String
Next poll time for device
command_id
long
Command ID of command
status_code
int
Scan command status code 0: failed, 1: Initiated, 2: Success, 4: In progress
added_by
long
User ID of users who initiated a command
command_name
String
Name of last command invoked
added_by_name
String
User name of users who initiated a command
remarks
String
The remarks for the App associated to the group
remarks_args
String
Arguments for remark of the command
remarks
String
The remarks for the App associated to the group
configuration_profiles
list
JSONArray of JSONObjects. Each JSONObject contains the configuration profile details
payload_uuid
String
Unique If not available returns "unknown-udid"
payload_identifier
String
Payload identifier string set by the source that installed the profile
payload_description
String
Full description of the configuration. Returns no description enabled if value is not available
payload_organization
String
Organization name set by the source that installed the profile
payload_type
String
Payload type of the profile. The payload type strings are defined by Apple
payload_version
Integer
Payload version set by the source that installed the profile
payload_has_rem_password
Boolean
Specify whether a payload is removable and whether a payload removal password is required
payload_is_encrypted
Boolean
Specify whether the payload is encrypted. The payload content cannot be read if enabled
payload_display_name
String
A display name
payload_unremovable
Boolean
The payload installed cannot be removed
payloadcontent
list
JSONArray of JSONObjects. Each JSONObject contains the payload details. The definition of the payload keys are same as above.
payload_uuid
String
Unique If not available returns "unknown-udid"
payload_identifier
String
Payload identifier string set by the source that installed the profile
payload_description
String
Full description of the configuration. Returns no description enabled if value is not available
payload_organization
String
Organization name set by the source that installed the profile
payload_type
String
Payload type of the profile. The payload type strings are defined by Apple
payload_version
Integer
Payload version set by the source that installed the profile
payload_display_name
String
A display name
container_last_updated_time
String
Time when the status of the container was changed
container_remarks
String
Container status remarks
container_state
String
State of container
container_status
String
Container status
copy_paste
Integer
Specify whether copy/paste is allowed on the device 1 - Allowed 0 - Restricted
cortana
Integer
Specify whether Cortana is allowed on the device 1 - Allowed 0 - Restricted
created_time
String
The profile created time
created_user
String
The user who created the user
current_carrier_network
String
Name of the current carrier network
current_mcc
String
Current Mobile Country Code
current_mnc
Integer
Current Mobile Network Code
data_roaming
Integer
Specify whether data is allowed during Roaming 1. Allowed 0 - Restricted
data_roaming_enabled
Boolean
The current setting of the Data Roaming setting.
date_time
Integer
Specify whether data time configurations is allowed 1 - Allowed 0 - Restricted
delta-token
String
Delta token
description
String
Description of the profile
dev_encrypt
Integer
Specify whether device ecnryption is required 1 - Required 0 - Not required
developer_unlock
Integer
Specify whether developer unlock is allowed. 1 - Allowed 0 - Restricted
device_admin_enabled
String
Device Admin State
device_capacity
String
Total device Capacity
device_count
String
The device count to which the profile associated
device_id
String
Unique identifer of the device
device_name
String
Name of the device
device_rooted
Boolean
Device rooted or jailbroken status
devices
list
Array of device details
device_id
String
Unique identifer of the device
os_version
String
The OS version
is_lost_mode_enabled
Boolean
Specify whether Lost Mode is enabled on the device
owned_by
String
Specify whether the device is corporate or personally-owned
is_removed
String
(Deprecated field) is device removed from management
product_name
String
Name of the product
device_name
String
Name of the device
platform_type
String
Platform type of the device
platform_type_id
String
Platform type ID
udid
String
Device Unique ID
serial_number
String
Holds the device serial number
model
String
Device Unique Model ID
user
object
The user object details
user_name
String
The user name
user_id
String
The user ID
user_email
String
The user email address
imei
Long
International Mobile Equipment Identity
summary
object
The Summary of the device
profile_count
String
Profiles count of the device
app_count
String
Apps count of the device
doc_count
String
Document count on the device
group_count
String
Groups count of the device
disable_bug_report
Integer
Disable bug reports on devices 1. user controlled 2. disabled
disable_remote_control
Integer
Disable remote commands 1. Enabled 2. User controlled 3. Disabled
disable_wipe
Integer
Disable device wipe 1. Enabled 2. User controlled 3. Disabled
do_not_uninstall
Boolean
Restrict app uninstallation
doc_count
String
Document count on the device
eas_device_identifier
String
The Device IDentifier string reported to Exchange ActiveSync
edit_device_name
Integer
Specify whether the device name can be edited. 1 - Allowed 0 - Restricted
efrp_account_details
list
This field will be available only if
emailids
String
Array of mail ids
addedby
String
Users who added the account
profilename
String
Name of the profile
efrp_status
Integer
Current EFRP status 0. Not Configured 1. Configured 3. Not applicable
email_address_list
String
The email address list. Required field for remote_debug when retry is set to false
email_sent_to_admin
Boolean
Email sent to the admin. Required field for reset_password
email_sent_to_user
Boolean
Email sent to the admin. Required field for reset_password
emailids
String
Array of mail ids
ethernet_ip
String
Ethernet IP address if currently connected. IPv4 and IPv6 addresses separated by a comma.
ethernet_macs
String
Ethernet MAC addresses. Available in iOS 7 and later.
executed_version
String
The Executed version of the profile
export_batch_id
Long
ID used to query the result of the location details request
external_capacity
String
Available free space on the device
external_storage_encryption
Integer
External Storage Encryption Status
fetch_device_name
Integer
Fetching device details. 1. Enabled 2. User controlled 3. Disabled
fetch_installed_app
Integer
Fetching installed apps 1. Enabled 2. User controlled 3. Disabled
fetch_location
Integer
Fetching device location 1. Enabled 2. User controlled 3. Disabled
fetch_phone_number
Integer
Fetching device phone number 1. Enabled 2. User controlled 3. Disabled
filevault
object
FileVault information on the device
filevault_status
integer
is_institution_recovery_key
Boolean
The Institutional Recovery Key for FileVault. Default value is False
is_personal_recovery_key
Boolean
Whether it is personal recovery key. Default false
resource_id
Long
Resource Identifier
is_encryption_enabled
Boolean
If FDE is enabled. Default value is false.
filevault_status
integer
fips_policy
Integer
Specify whether FIPS algorithm is allowed 1. Allowed 0 - Restricted
firmware_mode
Integer
Firmware mode of device
firmware_password
String
Firmware password of device
force_airdrop_unmanaged
Integer
Force AirDrop unmanaged
force_airplay_incoming_pwd
Integer
Returns if this device is requested to use pairing password on incoming airplay request.
force_airplay_outgoing_pwd
Integer
Returns if all device is forced to receive airplay request from this device to use pairing password.
force_airprint_tls
Integer
Specify whether devices need to have trusted certificate for TLS printing
force_assist_profanity_filter
Integer
Specify whether profanity filter should be applied on Siri
force_classroom_appdevicelock
Integer
Specify whether users receive a prompt for app and device lock in unmanaged classrooms
force_classroom_auto_join
Integer
Specify whether users can join unmanaged classroms automatically
force_classroom_remoteview
Integer
Specify whether users receive a prompt before screen recording in unmanaged classrooms
force_date_time
Integer
To force the date and time in the device with timezone.
force_encrypted_backup
Integer
Specify whether force encrypted backup is allowed
force_istore_pwd_entry
Integer
Specify whether the user will be forced to enter iTunes Store password
force_limited_ad_tracking
Integer
Specify whether ad tracking should be limited. Available in iOS 7.0 and later
force_watch_wrist_detect
Integer
Specify whether watch wrist detection is enabled on the device
force_wifi_whitelisting
Integer
Specify whether the device should connect only to the Wi-Fi policies distributed via MDM
from
Long
Start date and time in milliseconds from where the location data for the device should be fetched
group
list
List of groups
group_id
String
Identifier of the group
group_name
String
Name of the group
group_count
String
Groups count of the device
group_id
String
Identifier of the group
group_name
String
Name of the group
groups
String
List of groups for which command has to been executed
hardware_encryption_caps
Integer
The underlying hardware encryption capabilities of the device
iccid
Long
Integrated Circuit Card ID of the SIM
icon
String
The icon of the app
identifier
String
The identifier of the app
imei
Long
International Mobile Equipment Identity
imsi
String
The international mobile subscriber identity for every user
inclusion
Boolean
Determines whether to include/exclude the listed app_ids(required field for clear_app_data if clear_data_for_all_apps is false)
incoming_network_usage
Integer
Incoming network usage
incoming_wifi_usage
Integer
Incoming Wi-Fi usage
installed_apps
list
apps list (the apps returned are based on the app scan settings)
release_label_details
object
Details of the release label for the installed version of app
release_label_name
String
Display name of the release label
release_label_id
String
Release label ID
app_version
String
The App version
platform_type
String
Platform type of the device
identifier
String
The identifier of the app
app_name
String
The name of the app
app_id
String
The app id
app_version_code
String
The app version code
invite_user
Boolean
Send enrollment request to user if device not present (only user groups)
is_activation_lock_enabled
Boolean
Whether the device has Activation Lock enabled.
is_cloud_backup_enabled
Boolean
Specify whether the user has enabled Cloud backup on the device
is_device_locator_enabled
Boolean
Whether the device has a device locator service (such as Find My iPhone) enabled. Applicable only in iOS7 and above.
is_dnd_in_effect
Boolean
Whether Do Not Disturb is in effect. This returns true whenever Do Not Disturb is turned on, even if the device is not currently locked. Applicable only in iOS7 and above.
is_enabled
Boolean
Specify whether a specific action is enabled
is_encryption_enabled
Boolean
If FDE is enabled. Default value is false.
is_firmware_change_pending
Boolean
If a restart is required for the Firmware changes to take effect
is_firmware_password_exists
Boolean
Specify whether the Firmware password is enabled manually or through MDM
is_institution_recovery_key
Boolean
The Institutional Recovery Key for FileVault. Default value is False
is_ios_native_app_registered
Boolean
Specify whether the native iOS app is registered or not
is_itunes_account_active
Boolean
Specify whether the user is currently logged into an active iTunes Store account. Available in iOS 7 and later.
is_lost_mode_enabled
Boolean
Specify whether Lost Mode is enabled on the device
is_paid_app
String
Specify whether the app is paid or free
is_personal_hotspot_enabled
Boolean
Whether the Personal Hotspot feature is currently turned on. This value is available only with certain carriers. Applicable only in iOS 7 and above.
is_personal_recovery_key
Boolean
Whether it is personal recovery key. Default false
is_removed
String
(Deprecated field) is device removed from management
is_roaming
Boolean
Specify whether the device is currently in roaming
is_roms_allowed
Boolean
If ROMS loading are allowed
is_supervised
Boolean
Specify whether the device is Supervised or not. Applicable only in iOS 6 and above
isidentity
Boolean
Specify whether an identity certificate is present
islatestver
boolean
Specify whether the app is at its latest version
kb_url
String
The KB_URL to be displayed in case of command failure
knox_actions
list
Knox action details
is_enabled
Boolean
Specify whether a specific action is enabled
localized_name
String
Localized name of knox action
name
String
Name of the device
localized_action_info
String
Localized knox action information
action_info
String
Information of actions that can be performed on Samsung Knox devices
knox_details
object
Knox details of device
container_state
String
State of container
container_remarks
String
Container status remarks
container_status
String
Container status
container_last_updated_time
String
Time when the status of the container was changed
knox_version
String
Knox version
knox_restricions
object
Knox restrictions
browser_allow_fraud_warning
String
Current setting of Fraud warning.
allow_safe_mode
String
Current setting of Safe Mode.
allow_s_beam
String
Current setting of S Beam
allow_video_record
String
Current setting of Video Record.
allow_other_keypad
String
Current setting of other keypad.
allow_sdcard_move
String
Current setting of SD Card Move.
allow_app_notification_mode
String
Current setting of Application Notification Mode
resource_id
Long
Resource Identifier
allow_whitelist_wifi_only
String
Current setting of allowlisted WiFi.
allow_roaming_sync
String
Specify whether users are allowed to use Android browser
allow_wifi_tethering
String
Current setting of WiFi tethering
allow_roaming_data
String
Current setting of roaming data.
allow_camera
String
Current setting of camera.
browser_allow_javascript
String
Current setting of Javascript.
allow_user_mobile_data_limit
String
Current setting of User Mobile Data Limit.
allow_emergency_calls_only
String
Specify whether emergency calls are allowed
app_permission_policy
String
App permission policy
allow_usb_tethering
String
Current setting of USB tethering.
allow_usb
String
Current setting of USB tethering.
allow_lock_screen_view
String
Current setting of Lock Screen View
allow_user_creation
String
Current setting of User Creation.
allow_factory_reset
String
Specify whether users are allowed to use Android browser
allow_google_account_auto_sync
String
Current setting of Google Auto Sync
allow_voice_dialer
String
Current setting of Voice Dialer App
allow_smart_clip_mode
String
Current setting of Smart Clip Mode.
allow_outgoing_call
String
Current setting of outgoing calls
allow_lock_screen_menu
String
Current setting of Lock Screen
allow_date_time_change
String
Current setting of Date Time Change.
allow_roaming_push
String
Current setting of roaming push.
allow_install_app
String
Current setting of Install App
allow_user_profile
String
Current setting of User Profile.
allow_incoming_call
String
Current setting of incoming calls
allow_power_off
String
Current setting of power off
allow_usb_debug
String
Specify whether users are allowed to use Android browser
allow_statusbar_expansion
String
Specify whether Status Bar expansion is allowed on the device
allow_android_browser
String
Specify whether users are allowed to use Android browser
allow_you_tube
String
Current setting of YouTube app
browser_allow_popups
String
Specify whether popups are allowed in the Edge browser
allow_activation_lock
String
Current setting of Activation Lock.
allow_disabling_gps
String
Current setting of disabling GPS data.
allow_outgoing_mms
String
Current setting of Outgoing MMS
browser_allow_cookies
String
Current setting of Cookies.
allow_user_add_accounts
String
Current setting of Add Accounts.
device_admin_enabled
String
Device Admin State
allow_home_key
String
Current setting of Home Key.
allow_mock_location
String
Current setting of Mock Location.
allow_android_market
String
Current status of Android Market
allow_bt_discoverable
String
Current setting of Bluetooth Discoverable.
allow_bluetooth_tethering
String
Current setting of Bluetooth tethering.
allow_roaming_voice_calls
String
Specify whether roaming voice calls are allowed on the device
allow_airplane_mode
String
Current setting of Airplane Mode
allow_sharelist
String
Current setting of share via list
allow_bt_outgoing_calls
String
Current setting of Bluetooth Outgoing Calls.
allow_sms
String
Current setting of Incoming and Outgoing SMS for core Android
allow_disabling_cellular_data
String
Specify if users are allowed to change the cellular data setting
allow_uninstall_app
String
Specify whether users are allowed to use Android browser
allow_nfc
String
Specify if users are allowed to use NFC
allow_use_network_time
String
Current setting of using Network time
allow_contacts_outside
String
Current setting of contact sharing to device.
scope
String
scope
allow_clipboard
String
Current setting of Clipboard.
allow_background_process_limit
String
Current setting of Background Process Limit.
allow_s_finder
String
Current setting of S Finder.
allow_s_voice
String
Current setting of S Voice.
allow_audio_record
String
Current setting of Audio Record.
allow_microphone
String
Current setting of Microphone.
allow_stop_system_app
String
Current setting of System App Stop
allow_ota_upgrade
String
Specify whether users are allowed to use Android browser
allow_clipboard_share
String
Current setting of Clipboard Share.
allow_bluetooth
String
Current setting of Bluetooth.
allow_usb_host_storage
String
Current setting of USB Host Storage.
allow_cellular_data
String
Current setting of cellular data.
allow_sd_card
String
Specify whether SD card is allowed on the device
allow_google_maps
String
Current setting of Google Maps.
allow_gmail
String
Current setting of Gmail.
allow_call
String
Current setting of Incoming and outgoing SMS for core Android.
allow_incoming_sms
String
Current setting of incoming SMS
allow_bt_data_transfer
String
Current setting of Bluetooth Data Transfer
allow_headphone
String
Enable/disable headphone functionality
allow_tethering
String
Specify whether users are allowed to use Android browser
allow_firmware_recovery
String
Current setting of Firmware Recovery.
allow_google_backup
String
Current setting of Google backup.
allow_outgoing_sms
String
Current setting of Outgoing SMS
allow_air_view
String
Current setting of Air View.
allow_non_market_apps
String
Specify whether users can install non-market apps on devices
browser_allow_autofill
String
Current setting of Autofill.
allow_kill_activity_on_leave
String
Current setting of Killing Activity On Leave.
allow_vpn
String
Current setting of VPN
allow_bt_pairing
String
Current setting of Bluetooth Pairing.
allow_usb_media_player
String
Current setting of USB media player.
allow_sd_card_write
String
Specify whether SD card write is allowed on the device
allow_android_beam
String
Current setting of Android Beam.
allow_air_command
String
Current setting of Air Command.
allow_mms
String
Current setting of Incoming and outgoing SMS for core Android.
allow_background_data
String
Specify whether auto sync is allowed while Roaming is enabled
allow_knox_app_store
String
Current setting of Knox app store.
allow_settings
String
Specify whether the Settings app is allowed on the device
allow_wifi_direct
String
Current setting of WiFi Direct
allow_google_crash_report
String
Specify whether users are allowed to use Android browser
allow_developer_mode
String
Current setting of Developer Mode.
allow_incoming_mms
String
Current setting of Incoming MMS.
allow_wallpaper_change
String
Specify whether the user can change the wallpaper.
allow_screen_capture
String
Specify whether screen capture is allowed on the device
allow_bt_pc_connection
String
Current setting of Bluetooth Desktop Connection.
allow_wifi
String
Current setting of WiFi
knox_version
String
Knox version
last_cloud_backup_date
String
The date of the last cloud backup
last_contact_time
String
Last contact time of the device
last_modified_time
String
The profile modified time
last_modified_user
String
The profile modified user
latest_version
String
The Latest Version of the profile
latitude
String
Latitude of device location
limit_appdata_to_sys_vol
Integer
Mandate the app data to be stored only in the system volume storage
limit_appinstall_to_sys_vol
Integer
Mandate app installation to the system volume storage
localized_action_info
String
Localized knox action information
localized_name
String
Localized name of knox action
localized_remark
String
The remarks for the App
localized_remarks
String
The remarks for the profile
localized_status_description
String
Current status of the action
located_time
String
Timestamp of when the device was present at a particular location
location
Integer
Device location
locations
list
Array of location (by default last 3 days information is provided in professional edition and last known location in standard edition)
added_time
String
Timestamp when location was recorded on the server
latitude
String
Latitude of device location
longitude
String
Longitude of device location
located_time
String
Timestamp of when the device was present at a particular location
lock_message
String
A message for audit purposes when enabling lost mode
longitude
String
Longitude of device location
managed_device_id
Long
Managed device identifier
managed_password_id
Long
Managed password ID set on the device. -1 - The password was not set through MDM
managed_status
Integer
Management status of the device 0 - Enrollment failed 1 - Yet to enroll 2 - Enrolled successfully 3 - Waiting for approval 4. Unmanaged 5. Waiting for user assignment
managedcertificates
list
Array of managed certificates
signaturealgorithmoid
String
Signature Algorithm OID of the certificate
certificatename
String
Name of the certificate
certificatesubjectname
String
Certificate subject name
serialnumber
String
Serial number of the certificate
certificateexpiry
String
Validity of the certificate.
isidentity
Boolean
Specify whether an identity certificate is present
certificateissuername
String
Issuer name of the certificate
signaturealgorithmname
String
Name of the signature algorithm
manual_mdm_unenrollment
Integer
Specify whether user can manually unenroll devices 1 - Allowed 0 - Restricted
manual_root_cert_install
Integer
Specify whether the installation of manual root certificate is allowed 1- Allowed 0 - Restricted
manual_wifi_config
Integer
Specify whether the user can manually configure Wi-Fi. 1 - Allowed 0 - Restricted
meid
String
A mobile equipment identifier
metadata
object
Information about the content
model
String
Device Unique Model ID
model_id
String
Device Unique Model ID
model_name
String
Device Unique Model Name
model_type
Integer
The devices model number
modem_firmware_version
String
The baseband Firmware version
modified_time
String
The modified time of the app
movies_rating_value
String
Movies rating value.
ms_acc_connection
Integer
Specify whether Microsoft account connection is allowed 1-Allowed 0-Restricted
ms_feedback_notif
Integer
Specify whether Microsoft Feedback notifications will be displayed 0 - User controlled 1- Restricted
na_list
list
List of devices for which command is not applicable
device_id
String
Unique identifer of the device
remarks
String
The remarks for the App associated to the group
status
String
Denotes whether the request is scheduled or not
name
String
Name of the device
net_sharing
Integer
Specify whether net sharing is allowed.
network
object
Network details
outgoing_network_usage
Integer
Outgoing network usage
incoming_wifi_usage
Integer
Incoming Wi-Fi usage
resource_id
Long
Resource Identifier
outgoing_wifi_usage
Integer
Outgoing Wi-Fi usage
incoming_network_usage
Integer
Incoming network usage
network_usage
object
Network details
outgoing_network_usage
Integer
Outgoing network usage
incoming_wifi_usage
Integer
Incoming Wi-Fi usage
device_id
String
Unique identifer of the device
outgoing_wifi_usage
Integer
Outgoing Wi-Fi usage
incoming_network_usage
Integer
Incoming network usage
next
String
Next set of commands sent to device
next_poll_time
long
Next poll time for device
no_of_days
Integer
Specify the number of days to retain location details. Default set to 3
non_ms_acc
Integer
Specify whether Microsoft account connection is allowed 1-Allowed 0-Restricted
not_applicable_count
int
Count of devices that are not applicable
notify_user_via_email
Boolean
Notify user via email when a new app is pushed
office
String
Office of the device object
OS details
platform_type
String
Platform type of the device
build_version
String
The OS Build Version
os_version
String
The OS version
resource_id
Long
Resource Identifier
serial_number
String
Holds the device serial number
os_name
String
Name of the OS installed on the device
os_version
String
The OS version
outgoing_network_usage
Integer
Outgoing network usage
outgoing_wifi_usage
Integer
Outgoing Wi-Fi usage
owned_by
String
Specify whether the device is corporate or personally-owned
paging
object
Dividing content into discrete set of data
next
String
Next set of commands sent to device
previous
String
Previous set of commands sent to device
passcode
String
Email sent to the admin. Required field for reset_password
passcode_complaint
Boolean
Specify whether the passcode is compliant with all the requirements, including Exchange and other accounts
passcode_complaint_profiles
Boolean
Specify whether the users passcode is compliant with the Passcode profile requirement
passcode_present
Boolean
Specify is a passcode is available on the device
payload_description
String
Full description of the configuration. Returns no description enabled if value is not available
payload_display_name
String
A display name
payload_has_rem_password
Boolean
Specify whether a payload is removable and whether a payload removal password is required
payload_identifier
String
Payload identifier string set by the source that installed the profile
payload_is_encrypted
Boolean
Specify whether the payload is encrypted. The payload content cannot be read if enabled
payload_organization
String
Organization name set by the source that installed the profile
payload_type
String
Payload type of the profile. The payload type strings are defined by Apple
payload_unremovable
Boolean
The payload installed cannot be removed
payload_uuid
String
Unique If not available returns "unknown-udid"
payload_version
Integer
Payload version set by the source that installed the profile
payloadcontent
list
JSONArray of JSONObjects. Each JSONObject contains the payload details. The definition of the payload keys are same as above.
payload_uuid
String
Unique If not available returns "unknown-udid"
payload_identifier
String
Payload identifier string set by the source that installed the profile
payload_description
String
Full description of the configuration. Returns no description enabled if value is not available
payload_organization
String
Organization name set by the source that installed the profile
payload_type
String
Payload type of the profile. The payload type strings are defined by Apple
payload_version
Integer
Payload version set by the source that installed the profile
payload_display_name
String
A display name
phone_number
String
Holds the phone number of the managed user. A message for audit purposes will be displayed when enabling lost mode
platform
String
The platform type
platform_type
String
Platform type of the device
platform_type_id
String
Platform type ID
play_protect
Boolean
Whether Play Protect is enabled
previous
String
Previous set of commands sent to device
private_store_only
Integer
Specify the store where app is available. 0 - Available on both public and private store 1 - Available on private store
processor_speed
String
Processor speed in GHz
product_name
String
Name of the product
profile_count
String
Profiles count of the device
profile_description
String
The description of the profile
profile_id
String
The profile ID
profile_ids
String
List of IDs of apps to be distributed
profile_name
String
The name of the profile
profilename
String
Name of the profile
profiles
list
Array of profile details
profile_id
String
The profile ID
profile_name
String
The name of the profile
status
String
Denotes whether the request is scheduled or not
remarks
String
The remarks for the App associated to the group
localized_remarks
String
The remarks for the profile
profile_description
String
The description of the profile
applied_time
Long
Applied time of the profile
group_count
String
Groups count of the device
device_count
String
The device count to which the profile associated
created_user
String
The user who created the user
created_time
String
The profile created time
last_modified_user
String
The profile modified user
last_modified_time
String
The profile modified time
platform_type
String
Platform type of the device
purchase_date
Long
Purchase date for the device. This should be given in milliseconds.
purchase_order_number
String
Purchase order number of the device
purchase_price
Long
Purchase price for the device
purchase_type
String
Purchase type of the device
re_enter_time
Long
Specify the duration after which Kiosk Mode should be re-enabled.
registered_time
String
Time at which the device is registered
release_label_details
object
Details of the release label for the installed version of app
release_label_name
String
Display name of the release label
release_label_id
String
Release label ID
release_label_id
String
Release label ID
release_label_name
String
Display name of the release label
remark
String
The remarks for the profile associated to the group
remarks
String
The remarks for the App associated to the group
remarks_args
String
Arguments for remark of the command
remove_prov_package
Integer
Specify whether addition of provisioning packages is allowed. 1-Allow addition of provisioning packages. 0-Restrict addition of provisioning packages.
request_to_leave_classroom
Integer
Request to leave the classroom
resource_id
Long
Resource Identifier
retry
Boolean
To retry the remote debug command - required field for remote_debug
run_flash_automatically
Integer
0 - Adobe Flash content is automatically loaded and run by Microsoft Edge. 1 - Users must click the content, click a Click-to-Run button, or have the site appear on an auto-allow list before Microsoft Edge loads and runs Adobe Flash content
safari_accept_cookies
Integer
Control when Safari accepts cookies. -1 -> NA, 0 - Never, 1 - From visited sites, 2 - Always.
safari_allow_autofill
Integer
Specify whether Autofill is allowed on Safari.
safari_allow_java_script
Integer
Specify whether Java Script is allowed on Safari
safari_allow_popups
Integer
Specify whether popups are allowed in Safari
safari_force_fraud_warning
Integer
Specify whether Force Fraud Warning is allowed in Safari
safe_search_permissions
Integer
Specify the level of Safe Search for filtering adult content 0 - Strict 1 - Moderate
safetynet_availabiity
Boolean
Specify whether SafetyNet is applicable for the device
safetynet_basic_integrity
Boolean
Basic integrity status of the device.
safetynet_cts
Boolean
CTS status of the device
save_as_of_office_files
Integer
Specify whether Microsoft account connection is allowed 1-Allowed 0-Restricted
scope
String
scope
screen_capture
Integer
Specify whether screen capture is allowed 1 - Allowed 0 - Restricted
sd_card
Integer
Specify whether the use of SD card is allowed 1 - Allowed 0 - Restricted
search_use_location
Integer
Specify whether search can use location 1 - Allowed 0 - Restricted
security
object
Security details of the device
passcode_complaint
Boolean
Specify whether the passcode is compliant with all the requirements, including Exchange and other accounts
external_storage_encryption
Integer
External Storage Encryption Status
storage_encryption
Boolean
Specify whether device encryption is enabled
hardware_encryption_caps
Integer
The underlying hardware encryption capabilities of the device
passcode_complaint_profiles
Boolean
Specify whether the users passcode is compliant with the Passcode profile requirement
device_rooted
Boolean
Device rooted or jailbroken status
passcode_present
Boolean
Specify is a passcode is available on the device
send_email_to_user
boolean
A message for audit purposes when enabling lost mode
serial_number
String
Holds the device serial number
serialnumber
String
Serial number of the certificate
share_office_files
Integer
Specify whether Microsoft account connection is allowed 1-Allowed 0-Restricted
show_control_center
Integer
Specify whether the Control Center should be displayed on the Lock Screen. Available in iOS 7.0 and later.
show_notification_center
Integer
Specify whether the Notification Center should be displayed on the Lock Screen
show_today_view
Integer
Specify whether the Today View should be displayed on the Lock Screen
signaturealgorithmname
String
Name of the signature algorithm
signaturealgorithmoid
String
Signature Algorithm OID of the certificate
silent_install
Boolean
Should app be installed silently if possible
sim_id
Long
ID of the SIM
sims
list
SIM details
subscriber_carrier_network
String
Name of the home carrier network
iccid
Long
Integrated Circuit Card ID of the SIM
is_roaming
Boolean
Specify whether the device is currently in roaming
sim_id
Long
ID of the SIM
current_mnc
Integer
Current Mobile Network Code
subscriber_mnc
Integer
Subscriber Mobile Network Code
current_carrier_network
String
Name of the current carrier network
resource_id
Long
Resource Identifier
imei
Long
International Mobile Equipment Identity
subscriber_mcc
String
Home Mobile Country Code
current_mcc
String
Current Mobile Country Code
smartscreen_files
Integer
Specify whether smart screen prompt for files is allowed on the browser. 1 - Allowed 0 - Restrict
smartscreen_prompt
Integer
Specify whether smart screen prompt for websites is allowed on the browser. 1 - Allowed 0 - Restrict
status
String
Denotes whether the request is scheduled or not
status_code
int
Scan command status code 0: failed, 1: Initiated, 2: Success, 4: In progress
status_description
String
Next poll time for device
storage_encryption
Boolean
Specify whether device encryption is enabled
store
Integer
store
store_img_from_vision_search
Integer
Specify whether images from vision search can be stored. 1 - Allowed 0 - Restricted
subscriber_carrier_network
String
Name of the home carrier network
subscriber_mcc
String
Home Mobile Country Code
subscriber_mnc
Integer
Subscriber Mobile Network Code
success_count
int
Count of devices where commands are executed successfully
success_list
list
List of devices for which command has been sent
device_id
String
Unique identifer of the device
remarks
String
The remarks for the App associated to the group
status
String
Denotes whether the request is scheduled or not
summary
object
The Summary of the device
profile_count
String
Profiles count of the device
app_count
String
Apps count of the device
doc_count
String
Document count on the device
group_count
String
Groups count of the device
sync_my_settings
Integer
Specify whether sync my settings is allowed 1 - Allowed 0 - Restricted
telemetry
Integer
Specify whether Telemetry is allowed. 2-Allowed 1-Allowed except secondary data requests 0-Not Allowed.
ticket_id
String
A message for audit purposes when enabling lost mode
to
Long
End date and time in milliseconds till when the location data for the device should be fetched
toast
Integer
Specify whether toast messages should be displayed on the lock screen 1 - Allowed 0 - Restricted
total_count
int
Total count of devices selected
total_ram_memory
Integer
Total RAM space of the device
total_record_count
Integer
Total number of commands sent to device
trusted_apps_install
Integer
tv_shows_rating_value
String
TV Shows rating value.
udid
String
Device Unique ID
unlock_pin
String
A message for audit purposes when enabling lost mode
unmanagedcertificates
list
Array of unmanaged certificates
signaturealgorithmoid
String
Signature Algorithm OID of the certificate
certificatename
String
Name of the certificate
certificatesubjectname
String
Certificate subject name
serialnumber
String
Serial number of the certificate
certificateexpiry
String
Validity of the certificate.
isidentity
Boolean
Specify whether an identity certificate is present
certificateissuername
String
Issuer name of the certificate
signaturealgorithmname
String
Name of the signature algorithm
unregistered_time
Integer
Time at which the device is unregistered.
updated_time
long
Time of updating status of command
usb
Integer
Specify whether the use of USB is allowed
used_device_space
Double
Device space thats used
used_external_space
String
External space thats used
user
object
The user object details
user_name
String
The user name
user_id
String
The user ID
user_email
String
The user email address
user_email
String
The user email address
user_id
String
The user ID
user_name
String
The user name
user_reset_phone
Integer
Specify whether users can reset the phone 1 - Allowed 0 - Restrict
view_privacy_settings
Boolean
Specify whether privacy settings is visible
voice_roaming_enabled
Boolean
The current setting of the Voice Roaming. This is only available on certain carriers.
vpn
Integer
VPN Settings
vpn_roaming
Integer
Specify whether the use of VPN is allowed during roaming. 1 - Restricted 0 - Allowed
vpn_setting
Integer
VPN Settings
wait
Integer
Time in seconds to wait before trying the GET api for obtaining the result
warranty_expiration_date
Long
Warranty number of the device. This should be given in milliseconds.
warranty_number
String
Warranty number of the device
warranty_type
String
Warranty type of the device
wifi
Integer
Wi-Fi settings
wifi_hotspot_reporting
Integer
Specify whether Wi-Fi HotSpot reporting is allowed. 1 - Allowed 0 - Restricted
wifi_ip
String
Wi-Fi IP address if currently connected. IPv4 and IPv6 addresses separated by a ,.
wifi_mac
String
Wi-Fi MAC address.
wipe_but_retain_mdm
Boolean
Specify whether the device should be completely wiped by management should be retained. Optional field for complete wipe
wipe_lock_pin
String
Specify whether the device should be completely wiped by management should be retained. Optional field for complete wipe
wipe_sd_card
Boolean
Specify whether the device should be completely wiped by management should be retained. Optional field for complete wipe
limit
int
Specifies the maximum number of records to return. If not specified, a default value will be 50.
offset
int
Specifies the number of records to skip before starting to return records. This is useful for pagination.
|
Get device list
Get a list of managed devicesoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices
Request Example
$ curl {BaseURL}/api/v1/mdm/devices -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "devices": [ { "device_id": 9007199254741296, "os_version": "8.0.0", "is_lost_mode_enabled": false, "owned_by": 2, "is_removed": false, "product_name": "samsung", "device_name": "admin_SM-G935F", "platform_type": "android", "platform_type_id": 2, "udid": "f8c4071d394ef48e", "serial_number": "2321bkbkqgidga1", "model": "SM-G935F", "user": { "user_name": "admin", "user_id": 9007199254741000, "user_email": "admin@zylker.com" }, "imei": [ "12123123123123", "12312312312442" ], "summary": { "profile_count": 5, "app_count": 10, "doc_count": 1, "group_count": 2 } } ], "paging": { "next": "http://{Base_URL}/api/v1/mdm/profiles/scepsettings?skip-token=MjozOjE6MTU0Mjk1NDkxMzkxOA%3D%3D", "previous": "http://{Base_URL}/api/v1/mdm/devices?skip-token=NDo1OjE6MTU2ODcyMzM5NjUwOQ%3D%3D" } }
Query Params
include_all
Optional
To display all the devices accessible to the users
search
Optional
The search by device name
group_id
Optional
Filter based on group ID as a member of the group
exclude_removed
Optional
To exclude the removed, unmanaged, retired, old and repaired device
imei
Optional
Filter devices based on the IMEI number
owned_by
Optional
To filter based on device owned either corporate or personal :
device_type
Optional
To filter based on comma separated device type :
serial_number
Optional
To filter based on serial number
email
Optional
The email address of the assigned user
platform
Optional
comma separated platform type
next
Optional
Token to retrieve the next set of records. This token is provided in the response of the previous request.
previous
Optional
Token to retrieve the previous set of records. This token is provided in the response of the previous request.
limit
Optional
Specifies the maximum number of records to return. If not specified, a default value will be 50.
offset
Optional
Specifies the number of records to skip before starting to return records. This is useful for pagination.
|
Get device details
Get Deviceoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "warranty_number": "--", "cellular_technology": 1, "used_device_space": 12.86491, "is_ios_native_app_registered": false, "warranty_expiration_date": 0, "purchase_order_number": "--", "model": "ME437B", "available_external_capacity": 0, "available_ram_memory": 0, "owned_by": 0, "warranty_type": "--", "modem_firmware_version": "10.10.00", "purchase_price": 0, "purchase_date": 0, "managed_status": 2, "network_usage": { "outgoing_network_usage": 0, "incoming_wifi_usage": 0, "device_id": 9007199254741296, "outgoing_wifi_usage": 0, "incoming_network_usage": 0 }, "sims": [ { "subscriber_carrier_network": "--", "iccid": "8991 8031 1445 1834 5232", "is_roaming": false, "sim_id": 9007199254740996, "current_mnc": 64, "subscriber_mnc": 80, "current_carrier_network": "CellOne", "device_id": 9007199254741296, "imei": "35 205206 145115 4", "subscriber_mcc": "--", "current_mcc": 404, "imsi": "--", "carrier_setting_version": "--", "phone_number": 919999999999 } ], "external_capacity": 0, "knox_details": { "container_state": -1, "container_remarks": null, "container_status": 20004, "container_last_updated_time": -1, "knox_version": 2 }, "asset_owner": "--", "apn_password": "--", "battery_level": 94, "is_itunes_account_active": true, "is_supervised": false, "serial_number": "F17N607GFFGG", "last_cloud_backup_date": -1, "agent_version_code": -1, "meid": "--", "is_dnd_in_effect": false, "office": "--", "apn_username": "--", "model_name": "iPhone 5s(Global)", "registered_time": 1540655566627, "purchase_type": "--", "asset_tag": "--", "is_activation_lock_enabled": true, "available_device_capacity": 13.200405, "product_name": "iPhone6,2", "agent_type": 1, "is_device_locator_enabled": true, "device_capacity": 26.065315, "added_time": 1540655566627, "eas_device_identifier": "QEGJKADSR14D1AEAA4F29FM0IC", "description": "--", "is_lost_mode_enabled": false, "network": { "is_personal_hotspot_enabled": false, "is_roaming": false, "device_id": 9007199254741296, "current_carrier_network": "CellOne", "current_mnc": 64, "subscriber_mnc": 80, "ethernet_ip": "--", "data_roaming_enabled": true, "ethernet_macs": "--", "subscriber_carrier_network": "--", "wifi_ip": "--", "iccid": "8991 8031 1445 1834 5232", "bluetooth_mac": "2c:f0:ee:b6:a8:97", "carrier_setting_version": "--", "wifi_mac": "2c:f0:ee:b6:a8:96", "phone_number": 919999999999, "subscriber_mcc": "--", "current_mcc": 404, "voice_roaming_enabled": false }, "device_name": "123s iPhone", "security": { "passcode_complaint": true, "external_storage_encryption": -1, "storage_encryption": true, "hardware_encryption_caps": 3, "passcode_complaint_profiles": true, "device_rooted": false, "passcode_present": false, "safetynet_availabiity": true, "safetynet_basic_integrity": true, "safetynet_cts": true, "efrp_account_details": [ { "emailids": [ "example1@gmail.com", "example2@gmail.com", "example3@gmail.com" ], "addedby": "admin", "profilename": "MyProfile1" } ], "efrp_status": 1, "play_protect": true, "device_id": 9007199254741296 }, "udid": "9a5c3ef0f07b2f702d622057c16996696c098634", "summary": { "profile_count": 1, "app_count": 0, "doc_count": 0, "group_count": 3 }, "os": { "platform_type": 1, "build_version": "16A366", "os_version": 12, "device_id": 9007199254741296 }, "is_cloud_backup_enabled": false, "model_type": 1, "model_id": 9007199254740996, "total_ram_memory": 0, "used_external_space": 0, "remarks": "dc.mdm.db.agent.enroll.agent_enroll_finished", "unregistered_time": -1 }
Query Params
:summary
Optional
To get the summary details like profile_count, apps_count, doc_count and group_count |
Get device Summary
Get device Summaryoauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/devices/{{device_id}}/summary
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/summary -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "doc_count": 1, "device_id": 9007199254741000, "group_count": 1, "agent_version": "9.2.432.A", "device_name": "admin_Pixel 3 XL", "platform_type": 2, "last_contact_time": 1557128715277, "profile_count": 0, "app_count": 1, "group": [ { "group_id": 9007199254741632, "group_name": "Test group 1557134860919" } ] }
Get Device Certificates
Get Device Certificatesoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/certificates
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/certificates -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "certificates": { "unmanagedcertificates": [ { "signaturealgorithmoid": "1.2.840.113549.1.1.11", "certificatename": "ManageEngineCA", "certificatesubjectname": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "serialnumber": 5482640642439599000, "certificateexpiry": 4696305454000, "isidentity": false, "certificateissuername": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "signaturealgorithmname": "SHA256withRSA" } ], "managedcertificates": [ { "signaturealgorithmoid": "1.2.840.113549.1.1.11", "certificatename": "ManageEngineCA", "certificatesubjectname": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "serialnumber": 5482640642439599000, "certificateexpiry": 4696305454000, "isidentity": false, "certificateissuername": "CN=ManageEngineCA, O=Zoho Corporation, OU=ManageEngine, ST=CA, C=US", "signaturealgorithmname": "SHA256withRSA" } ] } }
Query Params
expiry
Optional
filter |
Update device details
Update the value of device details such as device name, asset tag etc. This will update the value of the device details only if the existing field values are not affected. To revert to the default values, provide the empty string and -1.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
PUT /api/v1/mdm/devices/{{device_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}} -X PUT -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "purchase_type": "Reseller", "warranty_number": "SJSU64728372", "apn_password": null, "asset_tag": "TestDevice", "description": "Belong to Zoho Corp", "office": "North Plaza,CA", "warranty_type": "WithService", "apn_username": "zylker", "warranty_expiration_date": 1530057600000, "name": "zylker iPhone", "purchase_price": 65000, "asset_owner": "Sysadmin", "purchase_order_number": "SR2Ik56779", "purchase_date": 1527984000000 }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "meid": "SM-G935F", "warranty_number": "SJSU64728372", "cellular_technology": 1, "office": "North Plaza,CA", "apn_username": "zylker", "model_name": "hero2ltexx", "warranty_expiration_date": 1530057600000, "purchase_order_number": "SR2Ik56779", "model": "SM-G935F", "purchase_type": "Reseller", "available_external_capacity": 20.47, "asset_tag": "TestDevice", "available_ram_memory": 983, "warranty_type": "WithService", "product_name": "samsung", "modem_firmware_version": "G935FXXU1DQIL", "purchase_price": 65000, "purchase_date": 1527984000000, "device_capacity": 24.81, "sims": [ { "subscriber_carrier_network": "airtel", "iccid": 8991400912981718000, "is_roaming": true, "sim_id": 9508000000013204, "current_mnc": 40, "subscriber_mnc": 40, "current_carrier_network": "airtel", "resource_id": 9508000000013120, "imei": 357327071694307, "subscriber_mcc": "in", "current_mcc": "in" } ], "is_lost_mode_enabled": false, "description": "Belong to Zoho Corp", "managed_device_id": 9508000000013120, "network": { "outgoing_network_usage": 0, "incoming_wifi_usage": 0, "resource_id": 9508000000013120, "outgoing_wifi_usage": 0, "incoming_network_usage": 0 }, "external_capacity": 29.82, "security": { "passcode_complaint": false, "external_storage_encryption": -1, "storage_encryption": false, "hardware_encryption_caps": -1, "passcode_complaint_profiles": true, "device_rooted": false, "passcode_present": false }, "processor_speed": 1586000, "asset_owner": "Sysadmin", "udid": "4fcacfdf446bf211", "apn_password": null, "battery_level": 22, "os": { "platform_type": 2, "build_version": "NRD90M", "os_version": 7, "resource_id": 9508000000013120, "serial_number": "RZ8H60ASLHR" }, "model_type": 1, "total_ram_memory": 3533, "used_external_space": 25.38, "os_name": "NOUGAT" }
ARGUMENTS
purchase_type
Optional
Purchase type of the device
warranty_number
Optional
Warranty number of the device
apn_password
Optional
To configure the APN password for the device.
asset_tag
Optional
Asset Tag information of the device
description
Optional
Description of the profile
office
Optional
Office of the device
warranty_type
Optional
Warranty type of the device
apn_username
Optional
To configure the APN Username for the device. Such that it can be used as dynamic variable in APN Payloads.
warranty_expiration_date
Optional
Warranty number of the device. This should be given in milliseconds.
name
Optional
Name of the device
purchase_price
Optional
Purchase price for the device
asset_owner
Optional
Asset Owner of the device
purchase_order_number
Optional
Purchase order number of the device
purchase_date
Optional
Purchase date for the device. This should be given in milliseconds. |
Get device restrictions
Get Device Restrictionsoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/restrictions
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/restrictions -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "knox_restricions": { "browser_allow_fraud_warning": 1, "allow_safe_mode": -1, "allow_s_beam": -1, "allow_video_record": 1, "allow_other_keypad": 1, "allow_sdcard_move": -1, "allow_app_notification_mode": 1, "resource_id": 9007199254741296, "allow_whitelist_wifi_only": 0, "allow_roaming_sync": -1, "allow_wifi_tethering": -1, "allow_roaming_data": -1, "allow_camera": 1, "browser_allow_javascript": 1, "allow_user_mobile_data_limit": -1, "allow_emergency_calls_only": -1, "app_permission_policy": -1, "allow_usb_tethering": -1, "allow_usb": -1, "allow_lock_screen_view": -1, "allow_user_creation": -1, "allow_factory_reset": -1, "allow_google_account_auto_sync": 1, "allow_voice_dialer": -1, "allow_smart_clip_mode": -1, "allow_outgoing_call": -1, "allow_lock_screen_menu": -1, "allow_date_time_change": -1, "allow_roaming_push": -1, "allow_install_app": 1, "allow_user_profile": -1, "allow_incoming_call": -1, "allow_power_off": -1, "allow_usb_debug": -1, "allow_statusbar_expansion": -1, "allow_android_browser": 1, "allow_you_tube": -1, "browser_allow_popups": 1, "allow_activation_lock": -1, "allow_disabling_gps": 3, "allow_outgoing_mms": -1, "browser_allow_cookies": 1, "allow_user_add_accounts": -1, "device_admin_enabled": -1, "allow_home_key": -1, "allow_mock_location": -1, "allow_android_market": 0, "allow_bt_discoverable": -1, "allow_bluetooth_tethering": -1, "allow_roaming_voice_calls": -1, "allow_airplane_mode": -1, "allow_sharelist": 1, "allow_bt_outgoing_calls": -1, "allow_sms": -1, "allow_disabling_cellular_data": -1, "allow_uninstall_app": 1, "allow_nfc": -1, "allow_use_network_time": -1, "allow_contacts_outside": 1, "scope": 1, "allow_clipboard": -1, "allow_background_process_limit": -1, "allow_s_finder": -1, "allow_s_voice": 1, "allow_audio_record": 1, "allow_microphone": 1, "allow_stop_system_app": 1, "allow_ota_upgrade": -1, "allow_clipboard_share": 1, "allow_bluetooth": -1, "allow_usb_host_storage": -1, "allow_cellular_data": -1, "allow_sd_card": -1, "allow_google_maps": -1, "allow_gmail": -1, "allow_call": -1, "allow_incoming_sms": -1, "allow_bt_data_transfer": -1, "allow_headphone": -1, "allow_tethering": -1, "allow_firmware_recovery": -1, "allow_google_backup": -1, "allow_outgoing_sms": -1, "allow_air_view": -1, "allow_non_market_apps": -1, "browser_allow_autofill": 1, "allow_kill_activity_on_leave": -1, "allow_vpn": -1, "allow_bt_pairing": -1, "allow_usb_media_player": -1, "allow_sd_card_write": -1, "allow_android_beam": -1, "allow_air_command": -1, "allow_mms": -1, "allow_background_data": -1, "allow_knox_app_store": 1, "allow_settings": -1, "allow_wifi_direct": -1, "allow_google_crash_report": -1, "allow_developer_mode": -1, "allow_incoming_mms": -1, "allow_wallpaper_change": -1, "allow_screen_capture": 0, "allow_bt_pc_connection": -1, "allow_wifi": -1 } }
Get FileVault details
Get FileVault details of the deviceoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/filevault
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/filevault -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "filevault": { "filevault_status": 10, "is_institution_recovery_key": true, "is_personal_recovery_key": true, "resource_id": 902, "is_encryption_enabled": false } }
Get firmware details
Get Firmware details of the Mac machineoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/firmware
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/firmware -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "is_firmware_change_pending": false, "is_roms_allowed": false, "is_firmware_password_exists": false, "firmware_mode": 1, "managed_password_id": -1 }
Get firmware password
Get firmware passwordoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/firmware/password
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/firmware/password -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "firmware_password": "SampleFirmwarePassword@123", "resource_id": 1542869208225 }
Get device location
Get the details of device locationoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/locations
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/locations -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "locations": [ { "added_time": 1523370360750, "latitude": 12.8282, "longitude": 80.0512, "located_time": 1523370128573 } ] }
Get device location with address
Get result of the location with address requests submitted via POST methodoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/locations_with_address
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/locations_with_address -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "locations": [ { "added_time": 1523370360750, "latitude": 12.8282, "longitude": 80.0512, "located_time": 1523370128573, "address": "Zoho Corporation Pvt Ltd, Estancia, Chennai" } ] }
Query Params
export_batch_id
Optional
Batch ID returned for location with address post request. Check POST request below.
:id
Optional
ID of the managed device |
Device Location Request
Request for the location of the device with address details (by default last 3 days information is provided in professional edition and last known location in standard edition)oauthscope : MDMOnDemand.MDMInventory.CREATE
POST /api/v1/mdm/devices/{{device_id}}/locations_with_address
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/locations_with_address -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "no_of_days": 7 }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "export_batch_id": 900234566788909, "wait": 500, "status": "SCHEDULED" }
ARGUMENTS
:id
Optional
ID of the managed device
no_of_days
Optional
Specify the number of days to retain location details. Default set to 3
from
Optional
Start date and time in milliseconds from where the location data for the device should be fetched
to
Optional
End date and time in milliseconds till when the location data for the device should be fetched |
Associate profiles to devices
Associate profiles to devicesoauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/devices/{{device_id}}/profiles
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/profiles -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "profile_ids": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
profile_ids
Required
List of IDs of profiles to be distributed |
Disassociate Profiles To Device
Disassociate profiles from devicesoauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/devices/{{device_id}}/profiles
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/profiles -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "profile_ids": [ 1 ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
profile_ids
Required
List of IDs of apps to be distributed |
Get a details of profiles on device
Get a details of profiles associated to the deviceoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/profiles/{{profile_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/profiles/{{profile_id}} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "created_time": 2313123123, "last_modified_user": "admin", "last_modified_time": 1231231231, "created_user": "admin", "associated_by_user_name": "admin", "remark": "Executed Successfully", "applied_time": 1232132131, "profile_description": "Test Profile", "associated_by_user_id": 1, "localized_remarks": "Applied", "profile_name": "Test Profile", "platform_type": 1, "latest_version": 5, "executed_version": 1, "profile_id": 12354, "associated_on": 1522066653883, "status": 6 }
Get device profiles
Get the list of profiles installed on the deviceoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/profiles
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/profiles -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "profiles": [ { "profile_id": 12354, "profile_name": "Test Profile", "status": 1, "remarks": "Applied", "localized_remarks": "Applied", "profile_description": "Test Profile", "applied_time": 1232132131, "group_count": 2, "device_count": 2, "created_user": "admin", "created_time": 2313123123, "last_modified_user": "admin", "last_modified_time": 1231231231, "platform_type": 1 } ] }
Query Params
summary
Optional
The summary details if needed |
Get Device Configuration Profiles
Returns all installed configuration profiles from the device. The list includes both user installed and MDM-installed profiles.oauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/configurationprofiles
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/configurationprofiles -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "configuration_profiles": [ { "payload_uuid": "unknown-uuid", "payload_identifier": "com.apple.applebetasoftware", "payload_description": "No description available", "payload_organization": "Unknown", "payload_type": "com.apple.defaults.managed", "payload_version": 1, "payload_has_rem_password": false, "payload_is_encrypted": false, "payload_display_name": "iOS Configuration Payload", "payload_unremovable": false, "payloadcontent": [ { "payload_uuid": "unknown-uuid", "payload_identifier": "com.apple.applebetasoftware", "payload_description": "No description available", "payload_organization": "Unknown", "payload_type": "com.apple.defaults.managed", "payload_version": 1, "payload_display_name": "iOS Configuration Payload" } ] } ] }
Query Params
payload_identifier
Optional
To get the specific payload identifier
installed_source
Optional
Installed source of the profile. 1- MDM Installed 0 - User installed |
Associate apps to device
Associate apps to devicesoauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/devices/{{device_id}}/apps
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/apps -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "invite_user": true, "do_not_uninstall": true, "app_details": [ { "app_id": 21312312312, "release_label_id": 123213213 } ], "notify_user_via_email": true, "silent_install": true }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
invite_user
Required
Send enrollment request to user if device not present (only user groups)
do_not_uninstall
Required
Restrict app uninstallation
:id
Optional
MDM ID for the device
app_details
Required
List of apps to be distributed
app_id
Optional
ID of the app to be distributed
release_label_id
Optional
Release label of the app to be distributed
notify_user_via_email
Required
Notify user via email when a new app is pushed
silent_install
Required
Should app be installed silently if possible |
Dissociate apps from devices
Dissociate apps from devicesoauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/devices/{{device_id}}/apps
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/apps -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "app_ids": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
app_ids
Required
List of IDs of apps to be distributed |
Get device app list
Get the list of apps installed on the deviceoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/apps
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/apps -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "installed_apps": [ { "app_version": "0.1.187945513", "platform_type": "android", "identifier": "com.google.android.apps.googleassistant", "app_name": "Assistant", "app_id": 9007199254740996 } ], "apps": [ { "app_version": "0.1.187945513", "platform_type": "android", "identifier": "com.google.android.apps.googleassistant", "app_name": "Assistant", "app_id": 9007199254740996 } ] }
Query Params
:include
Optional
Include the apps details
|
Get a details of apps on the device
Get a details of app on the device distributed through MDMoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/apps/{{app_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/apps/{{app_id}} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "islatestver": true, "localized_remark": "--", "app_type": 1, "app_category_name": "Games", "is_paid_app": false, "app_name": "Red Ball 4 (Ad Supported)", "release_label_details": { "release_label_name": "Production", "release_label_id": 90086789628394940 }, "platform_type": 1, "latest_version": "1.3.25", "executed_version": "1.3.25", "associated_by": "admin", "app_id": 9007199254740996, "associated_on": 1557314477009, "remarks": "The app is not compatible for this platform", "status": 8 }
Query Params
id
Optional
Device ID
app_id
Optional
App ID |
Refresh App Status For Device
Refresh app status for deviceoauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/devices/{{device_id}}/apps/refreshstatus
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/apps/refreshstatus -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "app_ids": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
app_ids
Required
List of IDs of apps to be refreshed. If an empty array will refresh status for all apps. |
Next poll time for the device
Returns next poll time for the deviceoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/polltime
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/polltime -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "next_poll_time": 1542869208225 }
Get device applicable actions
Get Applicable actions for the deviceoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/actions
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/actions -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "knox_actions": [ { "is_enabled": true, "localized_name": "Create container", "name": "create_container", "localized_action_info": "--", "action_info": "--" } ], "actions": [ { "is_enabled": true, "localized_name": "Create container", "name": "create_container", "localized_action_info": "--", "status_code": 1, "action_info": "--", "localized_status_description": "Command Initiated", "status_description": "Command Initiated" } ] }
Post device applicable actions
Apply action to the device
POST /api/v1/mdm/devices/{{device_id}}/actions/{{action_name}}
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/actions/{{action_name}} -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{}'
Response Example
HTTP/1.1 202 Accepted
ARGUMENTS
send_email_to_user
Optional
A message for audit purposes when enabling lost mode
lock_message
Optional
A message for audit purposes when enabling lost mode
clear_data_for_all_apps
Optional
Clear all app data
re_enter_time
Optional
Specify the duration after which Kiosk Mode should be re-enabled.
email_sent_to_user
Optional
Email sent to the admin. Required field for reset_password
email_sent_to_admin
Optional
Email sent to the admin. Required field for reset_password
wipe_but_retain_mdm
Optional
Specify whether the device should be completely wiped by management should be retained. Optional field for complete wipe
description
Optional
The email address list. Required field for remote_debug when retry is set to false
wipe_sd_card
Optional
Specify whether the device should be completely wiped by management should be retained. Optional field for complete wipe
audit_message
Optional
A message for audit purposes when enabling lost mode
ticket_id
Optional
A message for audit purposes when enabling lost mode
unlock_pin
Optional
A message for audit purposes when enabling lost mode
inclusion
Optional
Determines whether to include/exclude the listed app_ids(required field for clear_app_data if clear_data_for_all_apps is false)
action_name
Required
Name of the action :
phone_number
Optional
Holds the phone number of the managed user. A message for audit purposes will be displayed when enabling lost mode
wipe_lock_pin
Optional
Specify whether the device should be completely wiped by management should be retained. Optional field for complete wipe
passcode
Optional
Email sent to the admin. Required field for reset_password
retry
Optional
To retry the remote debug command - required field for remote_debug
remarks
Optional
Specify the duration after which Kiosk Mode should be re-enabled.
email_address_list
Optional
The email address list. Required field for remote_debug when retry is set to false |
Gets last scan status for device
Gets last scan status for deviceoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/scan
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/scan -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "status_description": "Command Success", "status_code": 2 }
Query Params
id
Optional
device ID for device |
Get Device Privacy
Get Device Privacyoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/privacy
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/privacy -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "fetch_location": 0, "view_privacy_settings": true, "disable_wipe": 0, "fetch_device_name": 0, "fetch_installed_app": 0, "disable_bug_report": 2, "applicable_for": [ 1, 2 ], "disable_remote_control": 1, "fetch_phone_number": 0 }
Execute command for bulk resources
Execute bulk device commands
POST /api/v1/mdm/actions/<command_name>
Request Example
$ curl {BaseURL}/api/v1/mdm/actions/<command_name> -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "devices": [ "9007199254741599" ], "command_name": "Restart", "groups": [ "9007199254741597", "9007199254741595" ] }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "success_list": [ { "device_id": 9007199254741004, "remarks": "Not Applicable", "status": 3 } ], "total_count": 3, "not_applicable_count": 1, "success_count": 1, "na_list": [ { "device_id": 9007199254741004, "remarks": "Not Applicable", "status": 3 } ] }
ARGUMENTS
devices
Required
List of devices for which command has to been executed
command_name
Required
Command name to be executed. Allowed values are shutdown, restart
groups
Required
List of groups for which command has to been executed |
Get command history for device
Get command history for deviceoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/commandhistory
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/commandhistory -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "metadata": { "total_record_count": 4 }, "paging": { "next": "http://localhost:9020/api/v1/mdm/profiles/scepsettings?skip-token=MjozOjE6MTU0Mjk1NDkxMzkxOA%3D%3D" }, "delta-token": "aHR0cDovL2xvY2FsaG9zdDo5MDIwL2FwaS92MS9tZG0vcHJvZmlsZXMvc2NlcHNldHRpbmdzOjoxNTQyOTU0OTEzOTI0", "commands": [ { "command_status": 2, "managed_status": 2, "command_id": 9007199254741304, "command_name": "Scan Now", "added_time": 1560141503246, "device_id": 9007199254741296, "added_by": 9007199254740996, "command_history_id": 9007199254740996, "added_by_name": "admin", "command_life": [ { "updated_time": 1560141503246, "status_description": "Command Initiated", "command_id": 9007199254741304, "status_code": 1, "added_by": 9007199254740996, "command_name": "Scan Now", "added_by_name": "admin", "remarks": null } ], "remarks_args": null, "remarks": null } ] }
Query Params
start_time
Optional
Custom range start time
limit
Optional
To get the specified set / length of commands to devices
end_time
Optional
Custom range end time
days
Optional
No of days for which command history has to be fetched
id
Optional
device ID for device |
Gets last initiated command status for device
Gets last initiated command status for deviceoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/devices/{{device_id}}/actions/recent_command
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/actions/recent_command -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "status_description": "Command Success", "status_code": 2, "command_name": "AssetScan" }
Apply Knox actions to the device
Apply Knox actions to the device
POST /api/v1/mdm/devices/{{device_id}}/knox_actions/{{action_name}}
Request Example
$ curl {BaseURL}/api/v1/mdm/devices/{{device_id}}/knox_actions/{{action_name}} -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{}'
Response Example
HTTP/1.1 202 Accepted
ARGUMENTS
action_name
Optional
|
Remove action
Remove action if it is not peformed on the device oauthscope : MDMOnDemand.MDMInventory.DELETE
DELETE /devices/{device_id}/actions/{action_name}
Request Example
$ curl {BaseURL}/devices/{device_id}/actions/{action_name} -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Groups
Simplify device management by organizing devices into groups.
Example
{ "group_id": 99731238129, "name": "MDM", "description": "Group for MDM", "group_type": 7, "domain": "ZOHOCORP" }
Attribute
group_id
long
Unique Identifier for the group
name
string
Name of the group
description
string
Description of the group
group_type
integer
Type of group:
domain
String
Domain in which the group exists (if AD is synced)
|
Get Group list
Get a list of Groups available in MDM oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/groups
Request Example
$ curl {BaseURL}/api/v1/mdm/groups -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "groups": [ { "group_id": 99731238129, "name": "MDM", "group_type": 7, "domain": "ZOHOCORP" } ] }
Get Group details
Get details of a particular Group available in MDM oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/groups/{group_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/groups/{group_id} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "group_id": 99731238129, "name": "MDM", "group_type": 7, "domain": "ZOHOCORP", "description": "Group for MDM" }
Query Params
:include
Optional
Types:
|
Create a Group
Create a Group for managing devices oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/groups
Request Example
$ curl {BaseURL}/api/v1/mdm/groups -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "name": "MDM", "group_type": 7, "description": "Group for MDM" }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "group_id": 99731238129, "name": "MDM", "group_type": 7, "description": "Group for MDM" }
ARGUMENTS
name
Required
Name of the group
group_type
Required
Type of group:
description
Optional
Description of the group
|
Get members present in a Group
Get a list of members present in a particular Group oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/groups/{group_id}/members
Request Example
$ curl {BaseURL}/api/v1/mdm/groups/{group_id}/members -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "member_ids": [ 12, 213123, 21312 ] }
Query Params
:include
Optional
Include the members details
|
Add members to a Group
Add multiple members simultaneously to an existing Group oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/groups/{group_id}/members
Request Example
$ curl {BaseURL}/api/v1/mdm/groups/{group_id}/members -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "member_ids": [ 12, 213123, 21312 ] }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "member_ids": [ 12, 213123, 21312 ] }
ARGUMENTS
member_ids
Required
List of member IDs which may be either Device Ids or User Ids depands on the Group Type
|
Add a member to a Group
Add a particular member to a selected Group oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/groups/{group_id}/members/{member_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/groups/{group_id}/members/{member_id} -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 202 Accepted
Remove a member from a Group
Remove a member from a particular Group oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/groups/{group_id}/members/{member_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/groups/{group_id}/members/{member_id} -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Delete an existing Group
Delete a Group available in MDMoauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/groups/{group_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/groups/{group_id} -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Associate apps to a Group
Associate apps to a Group in MDMoauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/groups/{group_id}/apps
Request Example
$ curl {BaseURL}/api/v1/mdm/groups/{group_id}/apps -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "app_details": [ { "app_id": 12, "release_label_id": 123 } ], "silent_install": true, "notify_user_via_email": true }'
Response Example
HTTP/1.1 202 Accepted
ARGUMENTS
app_details
Required
The list of app with version details
app_id
Required
The app Id
release_label_id
Required
ID to denote whether the app version is Stable or Beta
silent_install
Optional
Whether the app should be installed silently on devices
notify_user_via_email
Optional
Notify user via email about the distributed app
|
Associate profiles to a Group
Associate profiles to a Group in MDM oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/groups/{group_id}/profiles
Request Example
$ curl {BaseURL}/api/v1/mdm/groups/{group_id}/profiles -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "profile_ids": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 202 Accepted
ARGUMENTS
profile_ids
Required
List of profile IDs for the profiles to be associated to the Group
|
Disassociate apps from a Group
Disassociate apps from a Group in MDM oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/groups/{group_id}/apps
Request Example
$ curl {BaseURL}/api/v1/mdm/groups/{group_id}/apps -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "app_ids": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
app_ids
Required
List of app IDs
|
Disassociate profiles from a Group in MDM
Disassociate profiles from a Group in MDM oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/groups/{group_id}/profiles
Request Example
$ curl {BaseURL}/api/v1/mdm/groups/{group_id}/profiles -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "profile_ids": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
profile_ids
Required
List of profile IDs for the profiles to be associated to the Group
|
Move devices from one group to other groups
Move a set of member from one group to other Groups oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
PUT /api/v1/mdm/groups/{group_id}/targetgroups
Request Example
$ curl {BaseURL}/api/v1/mdm/groups/{group_id}/targetgroups -X PUT -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "member_ids": [ 12, 213123, 21312 ], "target_group_ids": [ 123, 213, 298 ] }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "success": true }
ARGUMENTS
member_ids
Required
List of member IDs for the devices to be moved
target_group_ids
Required
List of member IDs for the Groups to which the devices must be moved.
|
Files
Add a file to MDM for usage in other API.
Example
{ "content_type": "image/png", "file_name": "check.png", "file_id": 123124, "expiry_time": 15987913528, "content_length": 1479 }
Attribute
content_type
string
Content Type :
file_name
string
Name of File
file_id
long
Unique Identifier for the file
expiry_time
long
Timestamp until when the file is valid
content_length
integer
Length of the file (in bytes)
|
Upload a file to MDM
Upload a file oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/files
Request Example
$ curl {BaseURL}/api/v1/mdm/files -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -H "Content-Disposition: filename="customprofile.json"" -d '{ "stream": "1231231234916349eq" }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "content_type": "image/png", "file_name": "check.png", "file_id": 123124, "expiry_time": 15987913528, "content_length": 1479 }
ARGUMENTS
stream
Required
bytestream of the file
|
Profiles
Profiles API Endpoint (for aditional help click here )
Example
{ "creation_time": 12312321312312, "last_modified_time": 213123213123, "profile_version": 1, "payloads": [], "last_modified_by": 21312312312312, "profile_description": "Test IOS Restrictions Policy", "created_by": 21321312312, "collection_id": 2132131231241, "profile_name": "IOS Restrictions Policy", "profile_status": "Yet To Deploy", "platform_type": 1, "is_moved_to_trash": false, "profile_id": 12321312312, "scope": 0, "profile_status_id": 1 }
Attribute
creation_time
long
Creation time
last_modified_time
long
Last modified time
profile_version
int
Current version of the profile
payloads
array
list of payloads in the profile
last_modified_by
int
User ID of the user who last modified the profile
profile_description
str
Description
created_by
int
User ID of the user who created the profile
collection_id
int
Collection ID of the profile
profile_name
string
Name of the profile
profile_status
str
Status of the profile
platform_type
integer
Profile platform type:
is_moved_to_trash
bool
Is profile trashed
profile_id
int
Unique identifier for the profile
scope
integer
Scope of the profile (default - 0): Android Profile : ( 0 - devices, 1 - knox container)
Chrome Profile : (0 - devices, 2 - user)
profile_status_id
int
Status ID for the profile : 1 - Yet to Deploy, 110 - Published
|
Create a profile
Create a profile oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/profiles
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "profile_name": "IOS Restrictions Policy", "profile_description": "Test IOS Restrictions Policy", "platform_type": 1, "scope": 0 }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "creation_time": 12312321312312, "last_modified_time": 213123213123, "profile_version": 1, "payloads": [], "last_modified_by": 21312312312312, "profile_description": "Test IOS Restrictions Policy", "created_by": 21321312312, "collection_id": 2132131231241, "profile_name": "IOS Restrictions Policy", "profile_status": "Yet To Deploy", "platform_type": 1, "is_moved_to_trash": false, "profile_id": 12321312312, "scope": 0, "profile_status_id": 1 }
ARGUMENTS
profile_name
Required
Name of the profile
profile_description
Optional
Description
platform_type
Required
Profile platform type:
scope
Optional
Scope of the profile (default - 0): Android Profile : ( 0 - devices, 1 - knox container)
Chrome Profile : (0 - devices, 2 - user) |
Get List of profiles
Get List of profiles oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/profiles
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "profiles": [ { "creation_time": 12312321312312, "last_modified_time": 213123213123, "profile_version": 1, "payloads": [], "last_modified_by": 21312312312312, "profile_description": "Test IOS Restrictions Policy", "created_by": 21321312312, "collection_id": 2132131231241, "profile_name": "IOS Restrictions Policy", "profile_status": "Yet To Deploy", "platform_type": 1, "is_moved_to_trash": false, "profile_id": 12321312312, "scope": 0, "profile_status_id": 1 } ] }
Trash or delete profile
On first API call the profile is trashed, if profile is already trashed it will be deleted permanently oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/profiles
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "profile_ids": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
profile_ids
Required
List of profile IDs
|
Get Particular profile details
Get Particular profile details oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/profiles/{profile_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles/{profile_id} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "creation_time": 12312321312312, "last_modified_time": 213123213123, "profile_version": 1, "payloads": [], "last_modified_by": 21312312312312, "profile_description": "Test IOS Restrictions Policy", "created_by": 21321312312, "collection_id": 2132131231241, "profile_name": "IOS Restrictions Policy", "profile_status": "Yet To Deploy", "platform_type": 1, "is_moved_to_trash": false, "profile_id": 12321312312, "scope": 0, "profile_status_id": 1 }
Modify a profile
Modify a profile oauthscope : MDMOnDemand.MDMDeviceMgmt.UDPATE
PUT /api/v1/mdm/profiles/{profile_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles/{profile_id} -X PUT -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "profile_name": "IOS Restrictions Policy", "profile_description": "Test IOS Restrictions Policy" }'
Response Example
HTTP/1.1 202 Accepted
ARGUMENTS
profile_name
Optional
Name of the profile
profile_description
Optional
Description
|
Get List of payloads
Get List of payloads for profile. oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/profiles/{profile_id}/payloads
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles/{profile_id}/payloads -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "payloads": [ "restrictionspolicy" ] }
Add a payload to the profile
For information regarding the payload request JSON of each payload type please refer here. Example of IOS Passocde Payload is given here. oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles/{profile_id}/payloads/{payload_name} -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "max_passcode_age": 150, "require_alphanumeric": true, "max_failed_attempts": 9, "min_passcode_length": 5, "min_complex_chars": 2, "no_of_passcode_maintained": 50, "allow_simple_value": false, "auto_lock_idle_for": 3, "max_grace_period": 0 }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "payload_id": 123123123, "max_passcode_age": 150, "require_alphanumeric": true, "max_failed_attempts": 9, "min_passcode_length": 5, "min_complex_chars": 2, "no_of_passcode_maintained": 50, "allow_simple_value": false, "auto_lock_idle_for": 3, "max_grace_period": 0 }
ARGUMENTS
max_passcode_age
Optional
Maximum Passcode Age in days. Allowed values : 1-170
require_alphanumeric
Optional
Mandates the use of alphanumeric values as passcode.
max_failed_attempts
Optional
Maximum number of failed attempts. The device will be factory reset when the maximum number is exceeded. Allowed values 3-9
min_passcode_length
Optional
Minimum passcode length. The user must configure a password longer than the length configured here. Allowed values : 1-16
min_complex_chars
Optional
Mandates the minimum number of special characters to be used in the passcode. Allowed values : 1-4
no_of_passcode_maintained
Optional
Number of passcodes to be maintained in the history. The user cannot reuse the passcode stored in the history. Allowed values: 1-50
allow_simple_value
Optional
Allow numerical values to be configured as passcode.
auto_lock_idle_for
Optional
Maximum idle time allowed before auto-lock. The device user can select any value less than the value configured here. (Allowed valued - 1,2,3,4,5,10,15)
max_grace_period
Optional
Maximum time to unlock device without prompting for a passcode (in minutes). Allowed values: 0-240
|
Get payload IDs for particular payload type
Get payload IDs for particular payload type. refer here for payload details oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles/{profile_id}/payloads/{payload_name} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "payload_name": "restrictionspolicy", "payloaditems": [ "9007199254741295" ] }
Remove Particular payload from profile.
Remove Particular payload from profile. refer here for payload details oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles/{profile_id}/payloads/{payload_name} -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Get particular payload details
Get particular payload details. For information regarding the payload JSON of each payload type please refer here.
Example of IOS Passocde Payload is given here. oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}/payloaditems/{payload_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}/payloaditems/{payload_id} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "payload_id": 123123123, "max_passcode_age": 150, "require_alphanumeric": true, "max_failed_attempts": 9, "min_passcode_length": 5, "min_complex_chars": 2, "no_of_passcode_maintained": 50, "allow_simple_value": false, "auto_lock_idle_for": 3, "max_grace_period": 0 }
Remove Particular payload item
Remove Particular payload item. refer here for payload details oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}/payloaditems/{payload_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}/payloaditems/{payload_id} -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Modify a payload in the profile
Modify a payload in the profile,For information regarding the payload request JSON of each payload type please refer here. Example of IOS Passocde Payload is given here. oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
PUT /api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}/payloaditems/{payload_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}/payloaditems/{payload_id} -X PUT -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "max_passcode_age": 150, "require_alphanumeric": true, "max_failed_attempts": 9, "min_passcode_length": 5, "min_complex_chars": 2, "no_of_passcode_maintained": 50, "allow_simple_value": false, "auto_lock_idle_for": 3, "max_grace_period": 0 }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "payload_id": 123123123, "max_passcode_age": 150, "require_alphanumeric": true, "max_failed_attempts": 9, "min_passcode_length": 5, "min_complex_chars": 2, "no_of_passcode_maintained": 50, "allow_simple_value": false, "auto_lock_idle_for": 3, "max_grace_period": 0 }
ARGUMENTS
max_passcode_age
Optional
Maximum Passcode Age in days. Allowed values : 1-170
require_alphanumeric
Optional
Mandates the use of alphanumeric values as passcode.
max_failed_attempts
Optional
Maximum number of failed attempts. The device will be factory reset when the maximum number is exceeded. Allowed values 3-9
min_passcode_length
Optional
Minimum passcode length. The user must configure a password longer than the length configured here. Allowed values : 1-16
min_complex_chars
Optional
Mandates the minimum number of special characters to be used in the passcode. Allowed values : 1-4
no_of_passcode_maintained
Optional
Number of passcodes to be maintained in the history. The user cannot reuse the passcode stored in the history. Allowed values: 1-50
allow_simple_value
Optional
Allow numerical values to be configured as passcode.
auto_lock_idle_for
Optional
Maximum idle time allowed before auto-lock. The device user can select any value less than the value configured here. (Allowed valued - 1,2,3,4,5,10,15)
max_grace_period
Optional
Maximum time to unlock device without prompting for a passcode (in minutes). Allowed values: 0-240
|
Publish a profile
Publish a profile. Every profile needs to published so that it can be distributed oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/profiles/{profile_id}/publish
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles/{profile_id}/publish -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Profile Update all
Update a profiles to all devices and groups oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
PUT /api/v1/mdm/profiles/{profile_id}/update_all
Request Example
$ curl {BaseURL}/api/v1/mdm/profiles/{profile_id}/update_all -X PUT -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 202 Accepted
Apps
Add Store or enterprise apps to the App Repository for simpler app management.
Example
{ "app_id": 99731238129, "app_name": "ME MDM", "app_category": "Education", "app_type": 2, "bundle_identifier": "com.manageengine.mdm.iosagent", "version": "1.1.1", "platform_type": 2, "description": "The is an enterprise app", "icon": "https://mdm.manageengine.com.au/mdm-logo.png", "store_url": "https://itunes.apple.com/in/app/manageengine-mdm/id720111835?mt=8", "is_app_paid": false, "country_code": "US", "store_id": "720111835", "added_time": 192031023091, "modified_time": 192831120931, "release_labels": [ { "release_label_type": 1, "release_label_name": "Stable", "release_label_id": 12345, "app_version": "12.3.45" } ] }
Attribute
app_id
long
A unique identifier for the app
app_name
string
Name of the app
app_category
string
Category of the app
app_type
integer
App type:
bundle_identifier
string
App's bundle identifier
version
string
Version of the app
platform_type
integer
The platform for which the app is available:
description
string
A custom description of the app
icon
string
A link for the icon image (if available)
store_url
string
Store URL for the app (iOS only)
is_app_paid
boolean
Select 'True' if the app is a paid app (In case of Store apps)
country_code
string
The country code for App Store (iOS only)
store_id
string
Identifier for the App Store (iOS only)
added_time
long
Time when the app was added to the MDM server
modified_time
long
Time when the app was last modified
release_labels
list
The app version details
release_label_type
integer
Determines the version of the app
release_label_name
string
Specifies whether the app version is Stable or Beta
release_label_id
long
ID to denote whether the app version is Stable or Beta (Example To create release lable id)
app_version
string
The version of the App
|
Get App List
Get a list of apps available in the App Repository on the MDM server. oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/apps
Request Example
$ curl {BaseURL}/api/v1/mdm/apps -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "apps": [ { "app_id": 99731238129, "app_name": "ME MDM", "app_category": "Education", "app_type": 2, "version": "1.1.1", "platform_type": 2, "description": "The is an enterprise app", "icon": "https://mdm.manageengine.com.au/mdm-logo.png", "added_time": 192031023091, "modified_time": 192831120931, "release_labels": [ { "release_label_type": 1, "release_label_name": "Stable", "release_label_id": 12345, "app_version": "12.3.45" } ] } ] }
Get App Details
Get details of a particular app oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/apps/{app_id}/labels/{release_lable_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/apps/{app_id}/labels/{release_lable_id} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "app_id": 99731238129, "app_name": "ME MDM", "app_category": "Education", "app_type": 2, "bundle_identifier": "com.manageengine.mdm.iosagent", "version": "1.1.1", "platform_type": 2, "description": "The is an enterprise app", "icon": "https://mdm.manageengine.com.au/mdm-logo.png", "store_url": "https://itunes.apple.com/in/app/manageengine-mdm/id720111835?mt=8", "is_app_paid": false, "country_code": "US", "store_id": "720111835", "added_time": 192031023091, "modified_time": 192831120931, "release_labels": [ { "release_label_type": 1, "release_label_name": "Stable", "release_label_id": 12345, "app_version": "12.3.45" } ] }
Create app channel
Used for maintaining multiple versions of enterprise apps. Different versions will be mapped to different label ids. If not present app will be added in default stable channel. oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/labels
Request Example
$ curl {BaseURL}/api/v1/mdm/labels -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "channel_name": "Production" }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "release_label_id": 12345 }
ARGUMENTS
channel_name
Required
Channel name for lable
|
Add an app to MDM server
Add either a Store app or enterprise app to the MDM Server oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/apps
Request Example
$ curl {BaseURL}/api/v1/mdm/apps -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "app_name": "ME MDM", "app_type": 2, "app_file": 91273987129, "app_category_id": 2, "supported_devices": 3, "release_label_id": 12345, "display_image": 91273987129, "description": "The is an enterprise app", "app_store_country_code": "US", "bundle_identifier": "com.manageengine.mdm.iosagent", "prevent_backup": false, "full_image": 91273987129 }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "app_id": 99731238129, "app_name": "ME MDM", "app_category": "Education", "app_type": 2, "bundle_identifier": "com.manageengine.mdm.iosagent", "version": "1.1.1", "platform_type": 2, "description": "The is an enterprise app", "icon": "https://mdm.manageengine.com.au/mdm-logo.png", "store_url": "https://itunes.apple.com/in/app/manageengine-mdm/id720111835?mt=8", "is_app_paid": false, "country_code": "US", "store_id": "720111835", "added_time": 192031023091, "modified_time": 192831120931 }
ARGUMENTS
app_name
Required
Name of the app
app_type
Required
App type:
app_file
Required
File ID of the app package file uploaded to MDM using Files endpoint (Required for enterprise apps only)
app_category_id
Required
Identifier for the app category
supported_devices
Required
Supported Devices
release_label_id
Required
ID to denote whether the app version is Stable or Beta (Example To create release lable id)
display_image
Optional
File ID of the image uploaded to MDM using Files endpoint (Used for app icon)
description
Optional
A custom description of the app
app_store_country_code
Optional
Country code for the App Store (iOS Only)
bundle_identifier
Optional
App's bundle identifier
prevent_backup
Optional
Prevent app data backup during device backup.
full_image
Optional
File ID of the image uploaded to MDM using Files endpoint (Used for app icon)
|
Associate an app to a devices
Associate an app to a particular devices oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /apps/{app_id}/labels/{release_label_id}/devices
Request Example
$ curl {BaseURL}/apps/{app_id}/labels/{release_label_id}/devices -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "device_ids": [ 1, 2, 3 ], "silent_install": true, "notify_user_via_email": true }'
Response Example
HTTP/1.1 202 Accepted
ARGUMENTS
device_ids
Required
List of device IDs
silent_install
Optional
To allow silent installation of the app. Enter 'False' for manual installation from App Catalog.
notify_user_via_email
Optional
Notify users by e-mail upon distributing the app
|
Associate an app to a Groups
Associate an app to a particular Groups oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /apps/{app_id}/labels/{release_label_id}/groups
Request Example
$ curl {BaseURL}/apps/{app_id}/labels/{release_label_id}/groups -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "group_ids": [ 1, 2, 3 ], "silent_install": true, "notify_user_via_email": true }'
Response Example
HTTP/1.1 202 Accepted
ARGUMENTS
group_ids
Required
List of Group IDs
silent_install
Optional
To allow silent installation of the app. Enter 'False' for manual installation from App Catalog.
notify_user_via_email
Optional
Notify users by e-mail upon distributing the app
|
Update an app
Update an app available in the App Repository on the MDM server also update app details in the specific label and to update an app version in the specific label.
(To get app id and release lable id) oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
PUT /api/v1/mdm/apps/{app_id}/labels/{release_label_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/apps/{app_id}/labels/{release_label_id} -X PUT -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "platform_type": 2, "app_type": 2, "app_category_id": 2, "app_name": "ME MDM", "bundle_identifier": "com.manageengine.mdm.iosagent", "app_version": "12.3.45", "supported_devices": 3, "description": "The is an enterprise app", "remove_app_with_profile": true, "prevent_backup": false, "app_file": 91273987129, "force_update_in_label": true }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "app_distributed_devices_count": 100, "app_type": 2, "is_multiple_app_version_available": true, "supported_devices": 3, "is_downgrade_available": true, "is_for_all_customers": true, "profile_name": "ME MDM", "platform_type": 2, "app_version_code": "10822", "release_label_id": 12345, "app_distributed_group_count": 10, "app_id": 99731238129, "app_category_name": "Productivity", "app_group_id": 988272732423, "version": "1.1.1", "remove_app_with_profile": true, "country_code": "US", "release_label_display_name": "Beta", "added_time": 192031023091, "icon": "https://mdm.manageengine.com.au/mdm-logo.png", "description": "The is an enterprise app", "app_category_id": 2, "is_delete_applicable": false, "store_url": "https://itunes.apple.com/in/app/manageengine-mdm/id720111835?mt=8", "app_file": 91273987129, "modified_time": 192831120931, "bundle_identifier": "com.manageengine.mdm.iosagent", "store_id": "720111835", "app_title": "ME MDM", "is_paid_app": false, "private_app": 0, "app_name": "ME MDM", "prevent_backup": false, "is_distributable": true, "is_purchased_from_portal": false, "release_labels": [ { "release_label_type": 1, "release_label_name": "Stable", "release_label_id": 12345, "app_version": "12.3.45" } ] }
ARGUMENTS
platform_type
Optional
The platform for which the app is available:
app_type
Optional
App type:
app_category_id
Optional
Identifier for the app category
app_name
Optional
Name of the app
bundle_identifier
Optional
App's bundle identifier
app_version
Optional
The version of the App
supported_devices
Optional
Supported Devices
description
Optional
A custom description of the app
remove_app_with_profile
Optional
Applicable for IOS store Apps. Needed only for IOS Apps
prevent_backup
Optional
Prevent app data backup during device backup.
app_file
Optional
File ID of the app package file uploaded to MDM using Files endpoint (Required for enterprise apps only)
force_update_in_label
Optional
Must be set true if app details is updated in specific label or to update the app version in the specific label which already has an app. This key has to be set as false for adding the app version as separate in different label.
|
Approve app version
End point to approve app version. oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/apps/{app_id}/labels/{release_lable_id}/approve
Request Example
$ curl {BaseURL}/api/v1/mdm/apps/{app_id}/labels/{release_lable_id}/approve -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "silent_install": true, "retire_old_version": false, "notify_user_via_email": true, "version_label": "Production", "distribute_update": true }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
silent_install
Required
To allow silent installation of the app. Enter 'False' for manual installation from App Catalog.
retire_old_version
Required
Need to have the old version of app. If false we will remove the old versions
notify_user_via_email
Required
Notify users by e-mail upon distributing the app
version_label
Optional
Channel name for lable
distribute_update
Optional
True if the approved version has to be distributed to all the devices/groups which has older versions approved
|
Disassociate an app from a device
Disassociate an app from a particular device oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/apps/{app_id}/devices/{device_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/apps/{app_id}/devices/{device_id} -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Disassociate an app from a Group
Disassociate an app from a Group oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/apps/{app_id}/groups/{group_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/apps/{app_id}/groups/{group_id} -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Delete an existing app
Delete an existing app from the MDM App Repository oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/apps/{app_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/apps/{app_id} -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Delete app specific version
End point to delete specific app version.
Approved app version cannot be deleted (Example to change approved version) oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/apps/{app_id}/labels/{release_lable_id}/delete
Request Example
$ curl {BaseURL}/api/v1/mdm/apps/{app_id}/labels/{release_lable_id}/delete -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Blocklist apps
Blocklist user installed or system apps from managed devices.
Example
{ "identifier": "com.manageengine.mdm.android", "appgroupid": 123123213, "appname": "Manageengine MDM", "platform": 1 }
Attribute
identifier
string
Identifier of the app
appgroupid
long
App group ID
appname
string
Name of the app
platform
integer
App Platform: One of
|
Get the apps available for blocklisting
Apps available for blocklisting in the Inventory oauthscope : MDMOnDemand.MDMDeviceMgmt.GET
GET /api/v1/mdm/blacklist/apps
Request Example
$ curl {BaseURL}/api/v1/mdm/blacklist/apps -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "apps": [ { "identifier": "com.manageengine.mdm.android", "appgroupid": 123123213, "platform": 1, "appname": "Manageengine MDM" } ] }
Query Params
platform
Optional
App Platform: One of
query
Optional
Part or full name of the app to query
|
Add a new app to be blocklisted
Add a new app to the repository to be blocklisted oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/blacklist/apps
Request Example
$ curl {BaseURL}/api/v1/mdm/blacklist/apps -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "apps": [ { "identifier": "com.manageengine.mdm.android", "platform": 1, "appname": "Manageengine MDM" } ] }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "apps": [ { "identifier": "com.manageengine.mdm.android", "appgroupid": 123123213, "platform": 1, "appname": "Manageengine MDM" } ] }
ARGUMENTS
apps
Required
List of apps
identifier
Optional
Identifier of the app
platform
Optional
App Platform: One of
appname
Optional
Name of the app
|
Blocklist apps on devices
Blocklist apps on devices managed by MDM oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/blacklist/devices
Request Example
$ curl {BaseURL}/api/v1/mdm/blacklist/devices -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "resource_ids": [ 1, 2, 3 ], "app_group_ids": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "resource_ids": [ 1, 2, 3 ] }
ARGUMENTS
resource_ids
Required
List of resource IDs
app_group_ids
Required
List of app group IDs
|
Remove blocklisted apps from devices
Remove blocklisted apps from devices managed by MDM oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/blacklist/devices
Request Example
$ curl {BaseURL}/api/v1/mdm/blacklist/devices -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "resource_ids": [ 1, 2, 3 ], "app_group_ids": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "resource_ids": [ 1, 2, 3 ] }
ARGUMENTS
resource_ids
Required
List of resource IDs
app_group_ids
Required
List of app group IDs
|
Blocklist apps from Groups
Blocklist apps from Groups containing devices managed by MDM oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/blacklist/groups
Request Example
$ curl {BaseURL}/api/v1/mdm/blacklist/groups -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "resource_ids": [ 1, 2, 3 ], "app_group_ids": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "resource_ids": [ 1, 2, 3 ] }
ARGUMENTS
resource_ids
Required
List of resource IDs
app_group_ids
Required
List of app group IDs
|
Remove blocklisted apps from Groups
Remove blocklisted apps from Groups oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/blacklist/groups
Request Example
$ curl {BaseURL}/api/v1/mdm/blacklist/groups -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "resource_ids": [ 1, 2, 3 ], "app_group_ids": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "resource_ids": [ 1, 2, 3 ] }
ARGUMENTS
resource_ids
Required
List of resource IDs
app_group_ids
Required
List of app group IDs
|
Get blocklist status
Get the status of the blocklist action on devices oauthscope : MDMOnDemand.MDMDeviceMgmt.GET
GET /api/v1/mdm/blacklist/status
Request Example
$ curl {BaseURL}/api/v1/mdm/blacklist/status -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "Blackliststatus": [ { "status": 4, "resourceId": 1232131232, "identifier": "com.manageengine.mdm.android", "appname": "Manageengine MDM" } ] }
Query Params
resourceId
Optional
Resource ID of the Groups or devices
appgroupid
Optional
App group ID
|
Content Management
Securely distribute documents and media to mobile devices
Example
{ "doc_id": 99731238129, "doc_name": "ME MDM", "added_time": 192031023091, "updated_time": 192831120931, "last_modified_by_name": 21312312312312, "last_modified_by": 21312312312312, "created_by_name": 21312312312312, "created_by": 21312312312312, "size": 6855, "doc_type": 4, "repository_type": 1, "description": "List of Docs" }
Attribute
doc_id
long
A unique identifier for the document or media
doc_name
string
Name of the document or media
added_time
long
Time when the document or media was added to the MDM server
updated_time
long
Time when the document or media was last modified
last_modified_by_name
string
Name of the user who last modified the document or media
last_modified_by
int
User ID of the user who last modified the document or media
created_by_name
String
Name of the usere who created the document or media
created_by
int
User ID of the user who created the document or media
size
long
Document or media size
doc_type
int
Content Type
repository_type
int
Repository from where the media or document is added
description
string
Content description
|
Get content list
Get a list of content available on the MDM server. oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/docs
Request Example
$ curl {BaseURL}/api/v1/mdm/docs -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "docs": [ { "doc_id": 99731238129, "doc_name": "ME MDM", "added_time": 192031023091, "updated_time": 192831120931, "last_modified_by_name": 21312312312312, "last_modified_by": 21312312312312, "created_by_name": 21312312312312, "created_by": 21312312312312, "size": 6855, "doc_type": 4, "repository_type": 1, "description": "List of Docs" } ] }
Get content details
Get details of a particular document or media oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/docs/{doc_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/docs/{doc_id} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "doc_id": 99731238129, "doc_name": "ME MDM", "added_time": 192031023091, "updated_time": 192831120931, "last_modified_by_name": 21312312312312, "last_modified_by": 21312312312312, "created_by_name": 21312312312312, "created_by": 21312312312312, "size": 6855, "doc_type": 4, "repository_type": 1, "description": "List of Docs" }
Add content to MDM server
Add a document or media file to MDM server.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/docs
Request Example
$ curl {BaseURL}/api/v1/mdm/docs -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "tags": [ 3123, 3124 ], "description": "List of Docs", "file_id": 91273987129 }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "doc_id": 99731238129, "doc_name": "ME MDM", "added_time": 192031023091, "updated_time": 192831120931, "last_modified_by_name": 21312312312312, "last_modified_by": 21312312312312, "created_by_name": 21312312312312, "created_by": 21312312312312, "size": 6855, "doc_type": 4, "repository_type": 1, "description": "List of Docs" }
ARGUMENTS
tags
Required
Tag ID to classify content
description
Required
Content description
file_id
Required
File ID of the document or media file uploaded to MDM using Files endpoint
|
Associate content to devices
Associate content to an individual or multiple devices oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/docs/{doc_id}/devices
Request Example
$ curl {BaseURL}/api/v1/mdm/docs/{doc_id}/devices -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "devices": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
devices
Required
List of device IDs
|
Associate content to Groups
Associate content to an individual or multiple Groups oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/docs/{doc_id}/groups
Request Example
$ curl {BaseURL}/api/v1/mdm/docs/{doc_id}/groups -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "groups": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
groups
Required
List of Group IDs
|
Associate content to users
Associate content to an individual or multiple users oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/docs/{doc_id}/users
Request Example
$ curl {BaseURL}/api/v1/mdm/docs/{doc_id}/users -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "users": [ 12, 22, 33 ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
users
Required
List of User IDs
|
Update content
Update the content available on the MDM server oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
PUT /api/v1/mdm/docs/{doc_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/docs/{doc_id} -X PUT -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "tags": [ 3123, 3124 ], "description": "List of Docs", "file_id": 91273987129 }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "doc_id": 99731238129, "doc_name": "ME MDM", "added_time": 192031023091, "updated_time": 192831120931, "last_modified_by_name": 21312312312312, "last_modified_by": 21312312312312, "created_by_name": 21312312312312, "created_by": 21312312312312, "size": 6855, "doc_type": 4, "repository_type": 1, "description": "List of Docs" }
ARGUMENTS
tags
Required
Tag ID to classify content
description
Required
Content description
file_id
Required
File ID of the document or media file uploaded to MDM using Files endpoint
|
Disassociate content from devices
Disassociate document or media from a list of devices oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/docs/{doc_id}/devices
Request Example
$ curl {BaseURL}/api/v1/mdm/docs/{doc_id}/devices -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "devices": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
devices
Required
List of device IDs
|
Disassociate content from Group
Disassociate media or document from the list of Groups oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/docs/{doc_id}/groups
Request Example
$ curl {BaseURL}/api/v1/mdm/docs/{doc_id}/groups -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "groups": [ 1, 2, 3 ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
groups
Required
List of Group IDs
|
Disassociate content from user
Disassociate media or document from the list of users oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/docs/{doc_id}/users
Request Example
$ curl {BaseURL}/api/v1/mdm/docs/{doc_id}/users -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "users": [ 12, 22, 33 ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
users
Required
List of User IDs
|
Delete content
Delete document or media file from MDM oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/docs/{doc_id}
Request Example
$ curl {BaseURL}/api/v1/mdm/docs/{doc_id} -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Announcement
Announcement
Example
{ "ack_button": "Got It", "announcement": [ { "announcement_name": "Test announcement", "announcement_format": 1, "creation_time": 1603910052300, "created_by_user": "admin", "last_modified_time": 1603910052252, "collection_id": 9007199254741136, "profile_id": 9007199254740996, "last_modified_by_user": "admin", "ack_button": "Got It", "announcement_id": 9007199254740996, "is_moved_to_trash": false, "needs_acknowledgement": true, "announcement_detail": { "title_color": "#123123", "title": "Test announcement", "nbar_icon": "/images/announcement/nbaricon/info.png", "detail_message": "<p>Test announcement</p>", "nbar_message": "Test message", "needs_acknowledgement": true, "ack_button": "Got It" } } ], "announcement_detail": { "title_color": "#123123", "title": "Test announcement", "nbar_icon": "/images/announcement/nbaricon/info.png", "detail_message": "<p>Test announcement</p>", "nbar_message": "Test message", "needs_acknowledgement": true, "ack_button": "Got It" }, "announcement_format": 1, "announcement_id": 9007199254740996, "announcement_img_id": 9007199254740996, "announcement_name": "Test announcement", "collection_id": 9007199254741136, "created_by_user": "admin", "creation_time": 1603910052300, "detail_message": "<p>Test announcement</p>", "device_ids": [ "1", "2", "3" ], "devices": [ "1", "2", "3" ], "group_ids": [ "1", "2", "3" ], "groups": [ "1", "2", "3" ], "is_moved_to_trash": false, "last_modified_by_user": "admin", "last_modified_time": 1603910052252, "nbar_icon": "/images/announcement/nbaricon/info.png", "nbar_message": "Test message", "needs_acknowledgement": true, "no_of_devices_distributed": 0, "no_of_groups_distributed": 0, "profile_id": 9007199254740996, "title": "Test announcement", "title_color": "#123123", "user_ids": [ "1", "2", "3" ], "users": [ "1", "2", "3" ] }
Attribute
ack_button
String
Button text to be shown on the device for acknowledgement
announcement
list
Array of Announcements
announcement_name
String
Announcement Name
announcement_format
Integer
Format in which the announcement should be displayed
creation_time
Integer
Announcement creation time
created_by_user
Integer
Announcement created by user
last_modified_time
Integer
Announcement modified time
collection_id
Integer
Collection ID of the announcement
profile_id
Integer
Profile ID of the announcement
last_modified_by_user
Integer
Announcement modified by user
ack_button
String
Button text to be shown on the device for acknowledgement
announcement_id
Integer
Unique ID representing announcement
is_moved_to_trash
Integer
Is announcement deleted
needs_acknowledgement
String
Specify if the announcement needs acknowledgement from the device
announcement_detail
object
Announcement message details
title_color
String
Title color of announcement
title
String
Title of announcement
nbar_icon
String
Message icon to be displayed on the notification bar
detail_message
String
Detailed message to be shown in the app
nbar_message
String
Detailed message to be shown in Notification bar
needs_acknowledgement
String
Specify if the announcement needs acknowledgement from the device
ack_button
String
Button text to be shown on the device for acknowledgement
announcement_detail
object
Announcement message details
title_color
String
Title color of announcement
title
String
Title of announcement
nbar_icon
String
Message icon to be displayed on the notification bar
detail_message
String
Detailed message to be shown in the app
nbar_message
String
Detailed message to be shown in Notification bar
needs_acknowledgement
String
Specify if the announcement needs acknowledgement from the device
ack_button
String
Button text to be shown on the device for acknowledgement
announcement_format
Integer
Format in which the announcement should be displayed
announcement_id
Integer
Unique ID representing announcement
announcement_img_id
String
Image ID for image in notification bar
announcement_name
String
Announcement Name
collection_id
Integer
Collection ID of the announcement
created_by_user
Integer
Announcement created by user
creation_time
Integer
Announcement creation time
detail_message
String
Detailed message to be shown in the app
device_ids
String
Array of device IDs
devices
String
Array of device IDs
group_ids
String
Array of group IDs
groups
String
Array of group IDs
is_moved_to_trash
Integer
Is announcement deleted
last_modified_by_user
Integer
Announcement modified by user
last_modified_time
Integer
Announcement modified time
nbar_icon
String
Message icon to be displayed on the notification bar
nbar_message
String
Detailed message to be shown in Notification bar
needs_acknowledgement
String
Specify if the announcement needs acknowledgement from the device
no_of_devices_distributed
Integer
Number of devices that announcement is distributed
no_of_groups_distributed
Integer
Number of groups that announcement is distributed
profile_id
Integer
Profile ID of the announcement
title
String
Title of announcement
title_color
String
Title color of announcement
user_ids
String
Array of users IDs
users
String
Array of users IDs |
Get All Announcements
Fetches all the announcements that have been created.oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/announcements
Request Example
$ curl {BaseURL}/api/v1/mdm/announcements -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "announcement": [ { "announcement_name": "test1", "announcement_format": 1, "creation_time": 1603910052300, "created_by_user": "admin", "last_modified_time": 1603910052252, "collection_id": 9007199254741136, "profile_id": 9007199254740996, "last_modified_by_user": "admin", "ack_button": "Got it", "announcement_id": 9007199254740996, "is_moved_to_trash": false, "needs_acknowledgement": false, "announcement_detail": { "title_color": "#123123", "title": "test1", "nbar_icon": "/images/announcement/nbaricon/info.png", "nbar_message": "Test message", "announcement_img_id": 9007199254740996, "detail_message": "gr th hregfdvbgb 3w" } } ] }
Create an announcement
Creates a new announcement.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/announcements
Request Example
$ curl {BaseURL}/api/v1/mdm/announcements -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "announcement_name": "Test announcement", "announcement_format": 1, "announcement_detail": { "title_color": "#123123", "title": "Test announcement", "nbar_icon": "/images/announcement/nbaricon/info.png", "detail_message": "<p>Test announcement</p>", "nbar_message": "Test message", "needs_acknowledgement": true, "ack_button": "Got It" } }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
announcement_name
Required
Announcement Name
announcement_format
Required
Format in which the announcement should be displayed
announcement_detail
Required
Announcement message details
title_color
Optional
Title color of announcement
title
Optional
Title of announcement
nbar_icon
Optional
Notification bar message icon
detail_message
Optional
Detailed message to be shown in app
nbar_message
Optional
Detailed message to be shown in notification bar
needs_acknowledgement
Optional
Announcement needs an acknowledgement from the device
ack_button
Optional
Button text to be shown on the device for acknowledgement |
Deletes the Announcements
Deletes an announcement for given announcement IDs.oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/announcements
Request Example
$ curl {BaseURL}/api/v1/mdm/announcements -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "announcement_id": [ "1", "2", "3" ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
announcement_id
Required
Array of announcement IDs to be removed |
Get Announcement details
Fetches the details of an announcement for a given announcement ID.oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/announcements/{{announcement_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/announcements/{{announcement_id}} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "creation_time": 1603910052300, "last_modified_time": 1603910052252, "announcement_name": "test1", "announcement_format": 1, "needs_acknowledgement": false, "last_modified_by_user": "admin", "no_of_devices_distributed": 0, "created_by_user": "admin", "no_of_groups_distributed": 0, "collection_id": 9007199254741136, "ack_button": "Got It", "is_moved_to_trash": false, "profile_id": 9007199254740996, "announcement_id": 9007199254740996, "announcement_detail": { "title_color": "#123123", "title": "test1", "nbar_icon": "/images/announcement/nbaricon/info.png", "nbar_message": "Test message", "announcement_img_id": 9007199254740996, "detail_message": "gr th hregfdvbgb 3w" } }
Modify Announcement
Modifies an existing announcementoauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
PUT /api/v1/mdm/announcements/{{announcement_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/announcements/{{announcement_id}} -X PUT -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "announcement_name": "Test announcement", "announcement_format": 1, "announcement_detail": { "title_color": "#123123", "title": "Test announcement", "nbar_icon": "/images/announcement/nbaricon/info.png", "detail_message": "<p>Test announcement</p>", "nbar_message": "Test message", "needs_acknowledgement": true, "ack_button": "Got It" } }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
announcement_name
Required
Announcement Name
announcement_format
Required
Format in which the announcement should be displayed
announcement_detail
Required
Announcement message details
title_color
Optional
Title color of announcement
title
Optional
Title of announcement
nbar_icon
Optional
Message icon to be displayed on the notification bar
detail_message
Optional
Detailed message to be shown in the app
nbar_message
Optional
Detailed message to be shown in Notification bar
needs_acknowledgement
Optional
Specify if the announcement needs acknowledgement from the device
ack_button
Optional
Button text to be shown on the device for acknowledgement |
Delete Announcement
Deletes an announcement for a specific announcement ID.oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/announcements/{{announcement_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/announcements/{{announcement_id}} -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Distribute Announcement to groups
Distributes an announcement to given group IDs.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/announcements/{{announcement_id}}/groups
Request Example
$ curl {BaseURL}/api/v1/mdm/announcements/{{announcement_id}}/groups -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "group_ids": [ "1", "2", "3" ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
group_ids
Required
Array of group IDs |
Remove announcement from group
Disassociates the announcement from the given group IDs.oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/announcements/{{announcement_id}}/groups
Request Example
$ curl {BaseURL}/api/v1/mdm/announcements/{{announcement_id}}/groups -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "group_ids": [ "1", "2", "3" ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
group_ids
Required
Array of group IDs |
Get Announcement distribution to group details
Fetches the Group IDs to which the announcement is distributed.oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/announcements/{{announcement_id}}/groups
Request Example
$ curl {BaseURL}/api/v1/mdm/announcements/{{announcement_id}}/groups -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "groups": [ "1", "2", "3" ] }
Distribute announcement to devices
Distributes an announcement to the given device IDs.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/announcements/{{announcement_id}}/devices
Request Example
$ curl {BaseURL}/api/v1/mdm/announcements/{{announcement_id}}/devices -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "device_ids": [ "1", "2", "3" ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
device_ids
Required
Array of device IDs |
Remove announcement from devices
Disassociates the announcement from the given device IDs.oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/announcements/{{announcement_id}}/devices
Request Example
$ curl {BaseURL}/api/v1/mdm/announcements/{{announcement_id}}/devices -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "device_ids": [ "1", "2", "3" ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
device_ids
Required
Array of device IDs |
Get Announcement distribution to device details
Fetches the device IDs to which the announcement is distributed.oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/announcements/{{announcement_id}}/device
Request Example
$ curl {BaseURL}/api/v1/mdm/announcements/{{announcement_id}}/device -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "devices": [ "1", "2", "3" ] }
Enrollment Settings
Enrollment Settings
Example
{ "action_threshold": 1814400000, "action_type": 1, "auth_mode": 1, "directory_authentication": "Azure Authentication", "email_unmanaged_alerts": "mdmzoho@xyz.com", "inactive_threshold": 1728000000, "is_ad_integrated": true, "is_authentication_handling_available": true, "notify_device_unmanaged": true, "selected_ad": "Azure Authentication" }
Attribute
action_threshold
Long
threshold period to perform action on inactive device (default - 0 milliseconds)
action_type
Integer
Action type to perform
auth_mode
Integer
Authentication method for enrolling devices using invites
directory_authentication
String
When AD/Zoho Account auth mode is chosen, Need to give if AD auth or Zoho account auth. Values to be given for ZOHO Account: "Zoho Authentication"; Azure AD: "Azure Authentication" ; On Premise AD: "Microsoft On-Premises AD Authentication". This is required only in cloud
email_unmanaged_alerts
String
email addresses to be notified when device gets unmanaged
inactive_threshold
Long
threshold period to move the device to new state
is_ad_integrated
Boolean
Specify whether AD is integrated
is_authentication_handling_available
Boolean
Specify whether Zoho Authentication is available. Applicable only for Cloud. Set to False for on-premises
notify_device_unmanaged
Boolean
Specify whether a mail notification should be triggered when devices are unmanaged
selected_ad
String
The AD name when AD is integrated in Cloud
status
String
Current status. Will be set to acknowledged if successfully saved. |
Delete Inactive Device Policy Settings
Delete devices that have not contacted the MDM server for a specified durationoauthscope : MDMOnDemand.MDMAdmin.DELETE
DELETE /api/v1/mdm/inactive_device_policy_settings
Request Example
$ curl {BaseURL}/api/v1/mdm/inactive_device_policy_settings -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Get Enrollment Settings
Get enrollment settingsoauthscope : MDMOnDemand.MDMAdmin.CREATE
GET /api/v1/mdm/enrollmentsettings
Request Example
$ curl {BaseURL}/api/v1/mdm/enrollmentsettings -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "is_authentication_handling_available": true, "selected_ad": "Azure Authentication", "directory_authentication": true, "auth_mode": 1, "email_unmanaged_alerts": "mdmzoho@xyz.com", "notify_device_unmanaged": true, "is_ad_integrated": true }
Save Enrollment settings
Save enrollment settings for on-premisesoauthscope : MDMOnDemand.MDMAdmin.CREATE
POST /api/v1/mdm/enrollmentsettings
Request Example
$ curl {BaseURL}/api/v1/mdm/enrollmentsettings -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "auth_mode": 1, "email_unmanaged_alerts": "mdmzoho@xyz.com", "notify_device_unmanaged": true }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "status": "Acknowledged" }
ARGUMENTS
auth_mode
Required
Authentication method for enrolling devices using invites
email_unmanaged_alerts
Required
email addresses to be notified when device gets unmanaged
notify_device_unmanaged
Required
Specify whether a mail notification should be triggered when devices are unmanaged |
Save Inactive Device Policy Settings
Save inactive device policy settingsoauthscope : MDMOnDemand.MDMAdmin.CREATE
PUT /api/v1/mdm/inactive_device_policy_settings
Request Example
$ curl {BaseURL}/api/v1/mdm/inactive_device_policy_settings -X PUT -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "action_type": 1, "action_threshold": 1814400000, "inactive_threshold": 1728000000 }'
Response Example
HTTP/1.1 204 No Content Content-Type:application/json;charset=UTF-8 {...}
ARGUMENTS
action_type
Required
Action type to perform
action_threshold
Required
threshold period to perform action on inactive device (default - 0 milliseconds)
inactive_threshold
Required
threshold period to move the device to new state |
Users
Manage the available users
Example
{ "device_count": 0, "device_ids": [ "98765456789", "32456432136" ], "domain": "mdm", "email_address": "user@Zylker.com", "metadata": { "total_record_count": 150 }, "name": "admin", "next": "http://localhost:9020/api/v1/mdm/users?skip-token=NDo1OjE6MTU2ODcyMzM5NjUwOQ%3D%3D", "paging": { "next": "http://localhost:9020/api/v1/mdm/users?skip-token=NDo1OjE6MTU2ODcyMzM5NjUwOQ%3D%3D" }, "phone_number": "+91-9999999999", "total_record_count": 150, "user_email": "hari@aaa.com", "user_id": 9007199254741000, "user_ids": [ "9007199254740999", "9007199254756659" ], "user_name": "harihara", "users": [ { "email_address": "user@Zylker.com", "user_id": 9007199254741000, "name": "admin", "phone_number": "+91-9999999999", "domain": "mdm" } ] }
Attribute
device_count
int
Count of devices
device_ids
String
List of device IDs for managed devices that are assigned to users
domain
String
Domain of the user
email_address
String
email address of the user
metadata
object
Information about the content
name
String
holds name of the managed user
next
String
Next set of users
paging
object
Dividing content into discrete data
next
String
Next set of users
phone_number
String
holds phone number of the managed user
total_record_count
String
Total number of records
user_email
String
email address of the user
user_id
String
unique id of the user
user_ids
String
Manage the available users IDs to be removed
user_name
String
holds name of the managed user
users
list
JSONArray with list of all managed users
email_address
String
email address of the user
user_id
String
unique id of the user
name
String
holds name of the managed user
phone_number
String
holds phone number of the managed user
domain
String
Domain of the user |
Get Manage the available users
Get list of managed usersoauthscope : MDMOnDemand.MDMUser.READ
GET /api/v1/mdm/users
Request Example
$ curl {BaseURL}/api/v1/mdm/users -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "metadata": { "total_record_count": 150 }, "paging": { "next": "http://localhost:9020/api/v1/mdm/users?skip-token=NDo1OjE6MTU2ODcyMzM5NjUwOQ%3D%3D" }, "users": [ { "email_address": "user@Zylker.com", "user_id": 9007199254741000, "name": "admin", "phone_number": "--", "domain": "mdm" } ] }
Query Params
user_identifier
Optional
allowed values: name, email_id
:search
Optional
search key of the device name / User name
search
Optional
search string
:include
Optional
Include the aduserdetails
:user_type
Optional
list of user type of the device in comma separated
:id
Optional
id of the Group
:select_all
Optional
select_all to get all values details |
Add User
Add useroauthscope : MDMOnDemand.MDMUser.CREATE
POST /api/v1/mdm/users
Request Example
$ curl {BaseURL}/api/v1/mdm/users -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "user_email": "hari@aaa.com", "user_name": "harihara", "phone_number": "+91-9999999999" }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "user_email": "hari@aaa.com", "user_id": 9007199254756664, "user_name": "harihara", "phone_number": "+91-9999999999" }
ARGUMENTS
user_email
Required
email address of the user
user_name
Required
holds name of the managed user
phone_number
Required
holds phone number of the managed user |
Get User Details
Get details of a managed useroauthscope : MDMOnDemand.MDMUser.READ
GET /api/v1/mdm/users/{{user_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/users/{{user_id}} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "user_email": "abc@xyz.com", "user_id": 9007199254741000, "name": "admin", "phone_number": "+91-9999999999", "device_count": 0 }
Modify User
Modify user
PUT /api/v1/mdm/users/{{user_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/users/{{user_id}} -X PUT -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "user_email": "hari@aaa.com", "user_name": "harihara", "phone_number": "+91-9999999999" }'
Response Example
HTTP/1.1 202 Accepted
ARGUMENTS
user_email
Required
email address of the user
user_name
Required
holds name of the managed user
phone_number
Required
holds phone number of the managed user |
Remove Individual User
Remove a specific useroauthscope : MDMOnDemand.MDMUser.CREATE
POST /api/v1/mdm/users/{{user_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/users/{{user_id}} -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Remove User
Remove multiple usersoauthscope : MDMOnDemand.MDMUser.CREATE
POST /api/v1/mdm/users
Request Example
$ curl {BaseURL}/api/v1/mdm/users -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "user_ids": [ "9007199254740999", "9007199254756659" ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
user_ids
Required
Manage the available users IDs to be removed |
GetDeviceIdForUser
Get device ids for a useroauthscope : MDMOnDemand.MDMUser.READ
GET /api/v1/mdm/users/devices
Request Example
$ curl {BaseURL}/api/v1/mdm/users/devices -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "device_ids": [ "98765456789", "32456432136" ] }
Query Params
email_id
Required
The email address of the user
domain_name
Required
The domain name of the user |
Compliance
Compliance
Example
{ "action": { "action_attributes": [ { "execution_order": 1, "time_to_execution": 0, "action_attribute_type": 1, "alert_email_ids": [ { "email": "admin@zylker.com", "user_name": "admin" } ], "subject": "Warning", "body_message": "The device is outside its permitted fence." } ] }, "action_attribute_id": 569, "action_attribute_type": 1, "action_attributes": [ { "execution_order": 1, "time_to_execution": 0, "action_attribute_type": 1, "alert_email_ids": [ { "email": "admin@zylker.com", "user_name": "admin" } ], "subject": "Warning", "body_message": "The device is outside its permitted fence." } ], "action_id": 412, "address": "Bucket Building, Grand Southern Trunk Road, Vardhaman Nagar, Guduvancheri, Potheri, Kanchipuram district, Tamil Nadu, 603202, India", "alert_email_ids": [ { "email": "admin@zylker.com", "user_name": "admin" } ], "alert_user": false, "body_message": "The device is outside its permitted fence.", "collection_id": 650, "compliance_file_name_path": ".. webapps DesktopCentral client-data 1 mdm compliance 650 compliance_profile.json", "compliance_id": 350, "compliance_ids": [ "1", "2", "3" ], "compliance_name": "ComplianceUpdated0.8934500788002706", "compliance_policies": [ { "compliance_id": 350, "collection_id": 650, "compliance_status": 110, "compliance_name": "ComplianceUpdated0.8934500788002706", "platform_type": 5, "created_by": 1, "created_by_name": "admin", "creation_time": 1542869208225, "last_modified_by": 1, "last_modified_by_name": "admin", "last_modified_time": 1542869208225, "total_count": 10, "yet_to_evaluate_count": 8, "compliant_devices_count": 0, "non_compliant_devices_count": 1, "not_applicable_count": 1, "notification_sent_count": 1 } ], "compliance_status": 110, "compliant_devices_count": 0, "created_by": 1, "created_by_name": "admin", "creation_time": 1542869208225, "customer_id": 1, "description": "Compliance Profile", "email": "admin@zylker.com", "evaluation_order": 1, "execution_order": 1, "fence_name": "Tower", "geo_fence_id": 1, "is_moved_to_trash": false, "last_modified_by": 1, "last_modified_by_name": "admin", "last_modified_time": 1542869208225, "latitude": 12.831087, "longitude": 80.049305, "non_compliant_devices_count": 1, "not_applicable_count": 1, "notification_sent_count": 1, "platform_type": 5, "policies": [ { "rule": { "rule_name": "Tower", "rule_criterions": [ { "rule_criteria_type": 2, "geo_fence_id": 1, "rule_criteria_state": 2 } ], "evaluation_order": 1, "rule_id": 412 }, "action": { "action_attributes": [ { "execution_order": 1, "time_to_execution": 0, "action_attribute_type": 1, "alert_email_ids": [ { "email": "admin@zylker.com", "user_name": "admin" } ], "subject": "Warning", "body_message": "The device is outside its permitted fence." } ] } } ], "radius": 150, "remove_compliance_file_name_path": ".. webapps DesktopCentral client-data 1 mdm compliance 650 remove_compliance_profile.json", "rule": { "rule_name": "Tower", "rule_criterions": [ { "rule_criteria_type": 2, "geo_fence_id": 1, "rule_criteria_state": 2 } ], "evaluation_order": 1, "rule_id": 412 }, "rule_criteria_state": 2, "rule_criteria_type": 2, "rule_criterions": [ { "rule_criteria_type": 2, "geo_fence_id": 1, "rule_criteria_state": 2 } ], "rule_id": 412, "rule_name": "Tower", "subject": "Warning", "time_to_execution": 0, "total_count": 10, "user_id": 1, "user_name": "admin", "yet_to_evaluate_count": 8 }
Attribute
action
object
Common details of action
action_attributes
list
Collection of actions to be performed on rule satisfaction/violation. Check link for action attribute details
execution_order
Integer
Order of execution of action
time_to_execution
Integer
Time delay to execute action
action_attribute_type
Integer
Type of action
phone_number
Long
Phone number to be displayed on lost device
lock_message
String
Message to be shown on lost device
unlock_pin
Boolean
Unlock pin to be set for lost device
is_remote_alarm
Boolean
Specify whether remote alarm should be initiated on the device in Lost Mode
is_mark_as_non_compliant
Boolean
Flag to enable/disable mark as non compliant action
alert_email_ids
list
Array of alert email ids
email
String
Email ID
user_name
String
Name of the user
subject
String
Subject of the action attribute
body_message
String
Reason for performing the action
action_attribute_id
Boolean
Id of the action attribute
action_attribute_type
Integer
Type of action
action_attributes
list
Collection of actions to be performed on rule satisfaction/violation. Check link for action attribute details
execution_order
Integer
Order of execution of action
time_to_execution
Integer
Time delay to execute action
action_attribute_type
Integer
Type of action
phone_number
Long
Phone number to be displayed on lost device
lock_message
String
Message to be shown on lost device
unlock_pin
Boolean
Unlock pin to be set for lost device
is_remote_alarm
Boolean
Specify whether remote alarm should be initiated on the device in Lost Mode
is_mark_as_non_compliant
Boolean
Flag to enable/disable mark as non compliant action
alert_email_ids
list
Array of alert email ids
email
String
Email ID
user_name
String
Name of the user
subject
String
Subject of the action attribute
body_message
String
Reason for performing the action
action_id
Integer
Id of the action
address
String
Fence address
alert_email_ids
list
Array of alert email ids
email
String
Email ID
user_name
String
Name of the user
alert_user
Boolean
alert a user
body_message
String
Reason for performing the action
collection_id
String
Collection id of the compliance
compliance_file_name_path
String
Path of the compliance file
compliance_id
String
Profile ID of compliance profile which has been modified
compliance_ids
String
Collection of compliance IDs for compliance rules to be deleted
compliance_name
String
Name of the compliance profile
compliance_policies
list
Collection of compliance in existence
compliance_id
String
Profile ID of compliance profile which has been modified
collection_id
String
Collection id of the compliance
compliance_status
int
Status of the compliance
compliance_name
String
Name of the compliance profile
platform_type
String
Type of platform
created_by
Integer
Id of the user who created the rule criteria
created_by_name
String
Name of the user who created the rule criteria
creation_time
Long
Time of creation of rule criteria in milliseconds
last_modified_by
Integer
User who last modified the rule criteria
last_modified_by_name
String
Name of the user who last modified the rule criteria.
last_modified_time
Long
Time of last modification in milliseconds
total_count
Integer
Total count
yet_to_evaluate_count
Integer
Yet to evaluate count
compliant_devices_count
Integer
Count of compliant devices
non_compliant_devices_count
Integer
Count of non compliant devices
not_applicable_count
Integer
Not applicable count
notification_sent_count
Integer
Count of notifications sent
compliance_status
int
Status of the compliance
compliant_devices_count
Integer
Count of compliant devices
created_by
Integer
Id of the user who created the rule criteria
created_by_name
String
Name of the user who created the rule criteria
creation_time
Long
Time of creation of rule criteria in milliseconds
customer_id
String
Customer id
description
String
Short description of compliance profile
email
String
Email ID
evaluation_order
Integer
Order for evaluating the compliance rules
execution_order
Integer
Order of execution of action
fence_name
String
Name of the fence
geo_fence_id
Integer
Fence id of geofence
is_mark_as_non_compliant
Boolean
Flag to enable/disable mark as non compliant action
is_moved_to_trash
Boolean
Whether the compliance profile is deleted or not
is_remote_alarm
Boolean
Specify whether remote alarm should be initiated on the device in Lost Mode
last_modified_by
Integer
User who last modified the rule criteria
last_modified_by_name
String
Name of the user who last modified the rule criteria.
last_modified_time
Long
Time of last modification in milliseconds
latitude
String
Latitude of location
lock_message
String
Message to be shown on lost device
longitude
String
Longitude of the location
non_compliant_devices_count
Integer
Count of non compliant devices
not_applicable_count
Integer
Not applicable count
notification_sent_count
Integer
Count of notifications sent
phone_number
Long
Phone number to be displayed on lost device
platform_type
String
Type of platform
policies
list
Collection of details of rules and actions
rule
object
Common details of rule
rule_name
String
Name of the rule
rule_criterions
list
Collection of criteria which determine rule satisfaction/violation. Check link for rule criteria details
rule_criteria_type
Integer
Rule type
geo_fence_id
Integer
Fence id of geofence
rule_criteria_state
Integer
State to determine satisfaction/violation of rule
evaluation_order
Integer
Order for evaluating the compliance rules
rule_id
Integer
Rule ID of the policy
action
object
Common details of action
action_attributes
list
Collection of actions to be performed on rule satisfaction/violation. Check link for action attribute details
execution_order
Integer
Order of execution of action
time_to_execution
Integer
Time delay to execute action
action_attribute_type
Integer
Type of action
phone_number
Long
Phone number to be displayed on lost device
lock_message
String
Message to be shown on lost device
unlock_pin
Boolean
Unlock pin to be set for lost device
is_remote_alarm
Boolean
Specify whether remote alarm should be initiated on the device in Lost Mode
is_mark_as_non_compliant
Boolean
Flag to enable/disable mark as non compliant action
alert_email_ids
list
Array of alert email ids
email
String
Email ID
user_name
String
Name of the user
subject
String
Subject of the action attribute
body_message
String
Reason for performing the action
radius
String
Radius of the location
remove_compliance_file_name_path
String
Remove compliance file name path
rule
object
Common details of rule
rule_name
String
Name of the rule
rule_criterions
list
Collection of criteria which determine rule satisfaction/violation. Check link for rule criteria details
rule_criteria_type
Integer
Rule type
geo_fence_id
Integer
Fence id of geofence
rule_criteria_state
Integer
State to determine satisfaction/violation of rule
evaluation_order
Integer
Order for evaluating the compliance rules
rule_id
Integer
Rule ID of the policy
rule_criteria_state
Integer
State to determine satisfaction/violation of rule
rule_criteria_type
Integer
Rule type
rule_criterions
list
Collection of criteria which determine rule satisfaction/violation. Check link for rule criteria details
rule_criteria_type
Integer
Rule type
geo_fence_id
Integer
Fence id of geofence
rule_criteria_state
Integer
State to determine satisfaction/violation of rule
rule_id
Integer
Rule ID of the policy
rule_name
String
Name of the rule
send_email_to_user
Boolean
Whether to send email to user or not
subject
String
Subject of the action attribute
time_to_execution
Integer
Time delay to execute action
total_count
Integer
Total count
unlock_pin
Boolean
Unlock pin to be set for lost device
user_id
String
Id of the user
user_name
String
Name of the user
wipe_but_retain_mdm
boolean
Specify whether all the apps except ME MDM should be wiped from the device
wipe_lock_pin
Integer
Pin that unlocks the device after the wipe
wipe_sd_card
boolean
Specify whether the SD card should be wiped
yet_to_evaluate_count
Integer
Yet to evaluate count |
Get All Compliance
Get the list of all compliance profiles availableoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/compliance
Request Example
$ curl {BaseURL}/api/v1/mdm/compliance -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "compliance_policies": [ { "compliance_id": 21493857, "collection_id": 32849797, "compliance_status": 110, "compliance_name": "Device Security COMPLIANCE", "platform_type": 5, "created_by": 237974, "created_by_name": "admin", "creation_time": 9823749823, "last_modified_by": 237974, "last_modified_by_name": "admin", "last_modified_time": 9823749823, "total_count": 10, "yet_to_evaluate_count": 8, "compliant_devices_count": 0, "non_compliant_devices_count": 1, "not_applicable_count": 1, "notification_sent_count": 1 } ] }
Add Compliance Profile
Add a compliance profileoauthscope : MDMOnDemand.MDMInventory.CREATE
POST /api/v1/mdm/compliance
Request Example
$ curl {BaseURL}/api/v1/mdm/compliance -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "policies": [ { "rule": { "rule_name": "Tower", "rule_criterions": [ { "rule_criteria_type": 2, "geo_fence_id": 1, "rule_criteria_state": 2 } ], "evaluation_order": 1 }, "action": { "action_attributes": [ { "execution_order": 1, "time_to_execution": 0, "action_attribute_type": 1, "alert_email_ids": [ { "email": "user@zylker.com", "user_name": "Zylker" } ], "subject": "Warning", "body_message": "The device is outside its permitted fence." } ] } } ], "description": "Compliance Profile", "compliance_name": "DeviceProtection Compliance" }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "policies": [ { "action": { "action_attributes": [ { "execution_order": 1, "action_attribute_type": 1, "alert_email_ids": [ { "email": "user@zylker.com", "user_name": "Zylker" } ], "subject": "Warning", "body_message": "The device is outside its permitted fence.", "action_attribute_id": 302, "alert_user": false } ], "action_id": 302 } } ], "description": "Compliance Profile", "compliance_name": "DeviceProtection Compliance", "collection_id": 602, "is_moved_to_trash": false, "compliance_id": 302 }
ARGUMENTS
policies
Required
Collection of details of rules and actions
rule
Optional
Common details of rule
rule_name
Optional
Name of the rule
rule_criterions
Optional
Collection of criteria which determine rule satisfaction/violation. Check link for rule criteria details
rule_criteria_type
Optional
Rule type
geo_fence_id
Optional
Fence id of geofence
rule_criteria_state
Optional
State to determine satisfaction/violation of rule
evaluation_order
Optional
Order for evaluating the compliance rules
action
Optional
Common details of action
action_attributes
Optional
Collection of actions to be performed on rule satisfaction/violation. Check link for action attribute details
execution_order
Optional
Order of execution of action
time_to_execution
Optional
Time delay to execute action
action_attribute_type
Optional
Type of action
phone_number
Optional
Phone number to be displayed on lost device
lock_message
Optional
Message to be shown on lost device
unlock_pin
Optional
Unlock pin to be set for lost device
is_remote_alarm
Optional
Specify whether remote alarm should be initiated on the device in Lost Mode
is_mark_as_non_compliant
Optional
Flag to enable/disable mark as non compliant action
alert_email_ids
Optional
Array of alert email ids
email
Optional
Email ID
user_name
Optional
Name of the user
subject
Optional
Subject of the action attribute
body_message
Optional
Reason for performing the action
description
Required
Short description of compliance profile
compliance_name
Required
Name given to the compliance profile |
Get Compliance Profile
Gets a specific compliance profileoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/compliance/{{compliance_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/compliance/{{compliance_id}} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "policies": [ { "action": { "action_attributes": [ { "execution_order": 1, "action_attribute_type": 1, "alert_email_ids": [ { "email": "admin@zylker.com", "user_name": "admin" } ], "subject": "Warning", "body_message": "The device is outside its permitted fence.", "action_attribute_id": 569, "alert_user": false } ], "action_id": 412 } } ], "description": "Compliance Profile", "compliance_name": "DeviceSafetyCompliance", "collection_id": 301, "is_moved_to_trash": false, "compliance_id": 1 }
Update Compliance profile
Modifies specified compliance profileoauthscope : MDMOnDemand.MDMInventory.CREATE
PUT /api/v1/mdm/compliance/{{compliance_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/compliance/{{compliance_id}} -X PUT -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "policies": [ { "rule": { "rule_name": "Tower", "rule_criterions": [ { "rule_criteria_type": 2, "geo_fence_id": 1, "rule_criteria_state": 2 } ], "evaluation_order": 1, "rule_id": 412 }, "action": { "action_attributes": [ { "execution_order": 1, "time_to_execution": 0, "action_attribute_type": 1, "alert_email_ids": [ { "email": "admin@zylker.com", "user_name": "admin" } ], "subject": "Warning", "body_message": "The device is outside its permitted fence." } ] } } ], "description": "Compliance Profile", "compliance_name": "DeviceProtection Compliance" }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "collection_id": 650, "user_id": 1, "compliance_file_name_path": ".. webapps DesktopCentral client-data 1 mdm compliance 650 compliance_profile.json", "remove_compliance_file_name_path": ".. webapps DesktopCentral client-data 1 mdm compliance 650 remove_compliance_profile.json", "customer_id": 1, "compliance_id": 350, "compliance_name": "ComplianceUpdated0.8934500788002706" }
ARGUMENTS
policies
Required
Collection of details of rules and actions
rule
Optional
Common details of rule
rule_name
Optional
Name of the rule
rule_criterions
Optional
Collection of criteria which determine rule satisfaction/violation. Check link for rule criteria details
rule_criteria_type
Optional
Rule type
geo_fence_id
Optional
Fence id of geofence
rule_criteria_state
Optional
State to determine satisfaction/violation of rule
evaluation_order
Optional
Order for evaluating the compliance rules
rule_id
Optional
Rule ID of the policy
action
Optional
Common details of action
action_attributes
Optional
Collection of actions to be performed on rule satisfaction/violation. Check link for action attribute details
execution_order
Optional
Order of execution of action
time_to_execution
Optional
Time delay to execute action
action_attribute_type
Optional
Type of action
phone_number
Optional
Phone number to be displayed on lost device
lock_message
Optional
Message to be shown on lost device
unlock_pin
Optional
Unlock pin to be set for lost device
is_remote_alarm
Optional
Specify whether remote alarm should be initiated on the device in Lost Mode
is_mark_as_non_compliant
Optional
Flag to enable/disable mark as non compliant action
alert_email_ids
Optional
Array of alert email ids
email
Optional
Email ID
user_name
Optional
Name of the user
subject
Optional
Subject of the action attribute
body_message
Optional
Reason for performing the action
description
Required
Short description of compliance profile
compliance_name
Required
Name given to the compliance profile |
Delete Compliance Profile
Delete a compliance profileoauthscope : MDMOnDemand.MDMInventory.DELETE
DELETE /api/v1/mdm/compliance/{{compliance_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/compliance/{{compliance_id}} -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Delete Compliance Profiles
Delete compliance profilesoauthscope : MDMOnDemand.MDMInventory.DELETE
DELETE /api/v1/mdm/compliance
Request Example
$ curl {BaseURL}/api/v1/mdm/compliance -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "compliance_ids": [ "1", "2", "3" ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
compliance_ids
Required
Collection of compliance IDs for compliance rules to be deleted |
Compliance Groups
Compliance Groups
Example
{ "compliance_id": 382798473, "compliance_name": "COMPLIANCE 1", "compliance_score": 100, "device_compliance_state": "compliant", "device_id": 1920403, "device_name": "Samsung S9", "device_platform": 2, "devices": [ { "device_id": 1920403, "device_name": "Samsung S9", "device_platform": 2, "device_compliance_state": "compliant", "compliance_score": 100 } ], "group_compliance_state": "non_compliant", "group_id": 302, "group_ids": [ "1", "2", "3" ], "group_list": [ { "group_id": 302, "group_name": "ComplianceGroup", "group_type": 6, "member_count": 1 } ], "group_name": "ComplianceGroup", "group_type": 6, "member_count": 1 }
Attribute
:id
String
Profile ID of compliance profile
compliance_id
String
Compliance ID for the compliance rule
compliance_name
String
Name of the compliance
compliance_score
Integer
Compliance score of the device
device_compliance_state
String
Filter by device compliance status (Allowed values compliant, non_compliant)
device_id
Long
Identifier of the device
device_name
String
Name of the device
device_platform
Integer
devices
list
Device details
device_id
Long
Identifier of the device
device_name
String
Name of the device
device_platform
Integer
device_compliance_state
String
Filter by device compliance status (Allowed values compliant, non_compliant)
compliance_score
Integer
Compliance score of the device
group_compliance_state
String
Filter by compliance status
group_id
Long
Unique identifier of the group
group_ids
String
Collection of group IDs from which compliance needs to be removed
group_list
list
Array of group information
group_id
Long
Unique identifier of the group
group_name
String
Name of the group
group_type
Integer
Type of the group
member_count
Integer
Count of members in the group
group_name
String
Name of the group
group_type
Integer
Type of the group
id
String
Profile ID of compliance profile
id1
String
Profile ID of compliance profile
id2
String
group IDs from which compliance needs to be removed
member_count
Integer
Count of members in the group |
Associate Compliance Profile To Group
Associate compliance rule to a group of devicesoauthscope : MDMOnDemand.MDMInventory.CREATE
POST /api/v1/mdm/compliance/{{compliance_id}}/groups/{{group_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/compliance/{{compliance_id}}/groups/{{group_id}} -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Associate Compliance Profile To Groups
Compliance to device groups distributionoauthscope : MDMOnDemand.MDMInventory.CREATE
POST /api/v1/mdm/compliance/{{compliance_id}}/groups
Request Example
$ curl {BaseURL}/api/v1/mdm/compliance/{{compliance_id}}/groups -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "group_ids": [ "1", "2", "3" ] }'
Response Example
HTTP/1.1 204 No Content
ARGUMENTS
:id
Optional
Profile ID of compliance profile
group_ids
Required
Collection of group ids to which compliance to be associated |
Dis-Associate Compliance Profile To Group
Compliance remove from device groupoauthscope : MDMOnDemand.MDMInventory.DELETE
DELETE /api/v1/mdm/compliance/{{compliance_id}}/groups/{{group_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/compliance/{{compliance_id}}/groups/{{group_id}} -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Dis-Associate Compliance Profile To Groups
Disassociate compliance rule from a group of devicesoauthscope : MDMOnDemand.MDMInventory.DELETE
DELETE /api/v1/mdm/compliance/{{compliance_id}}/groups
Request Example
$ curl {BaseURL}/api/v1/mdm/compliance/{{compliance_id}}/groups -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 204 No Content
Get Group For Compliance profile
Get the list of groups to which the compliance policy is associated and the current compliance status of the group
GET /api/v1/mdm/compliance/{{compliance_id}}/groups/{{group_id}}
Request Example
$ curl {BaseURL}/api/v1/mdm/compliance/{{compliance_id}}/groups/{{group_id}} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "group_id": 743593475, "group_name": "Test group", "devices": [ { "device_id": 1920403, "device_name": "Samsung S9", "device_platform": 2, "device_compliance_state": "compliant", "compliance_score": 100 } ], "group_compliance_state": "non_compliant", "compliance_id": 382798473, "compliance_name": "COMPLIANCE 1" }
Get Groups For Compliance profile
Get the list of groups to which the compliance policy is associated and the current compliance status of the groupoauthscope : MDMOnDemand.MDMInventory.READ
GET /api/v1/mdm/compliance/{{compliance_id}}/groups
Request Example
$ curl {BaseURL}/api/v1/mdm/compliance/{{compliance_id}}/groups -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "group_list": [ { "group_id": 302, "group_name": "ComplianceGroup", "group_type": 6, "member_count": 1 } ], "compliance_id": 382798473 }
Query Params
id
Optional
Compliance ID of compliance rules |
Scheduled Actions
Scheduled Actions
Example
{ "execution_type": 2, "expiry": 600000, "group_action_id": 123452312, "groups": [ "1", "2", "3" ], "monthly_day": 1, "reason_message": "Maintenance", "schedule_once_time": 1627970696000, "schedule_params": { "schedule_type": "Daily", "monthly_perform": "WeekDay", "daily_time": "10/25/2018, 15:30", "monthly_week_day": 1, "days_of_week": 12, "daily_interval_type": "everyDay", "scheduler_disabled": true, "monthly_time": "22:22", "monthly_week_num": 1, "weekly_time": "22:22", "monthly_day": 1, "months_list": "0,1,2" }, "time_zone": "Asia/Kolkata" }
Attribute
execution_type
int
Type of execution
expiry
long
Time at which the scheduled command expires.
group_action_id
long
ID for the action scheduled to be executed on a group.
groups
String
List of groups with devices that need to be restarted or shutdown
monthly_day
String
Day of the month on which the task for monthly schedule to be executed (Exists only for Monthly schedule Type)
reason_message
String
Reason for scheduling the action, to be used for auditing purposes..
schedule_once_time
long
Current time in milliseconds when an action is scheduled to be executed once
schedule_params
object
Parameters for the schedule
schedule_type
String
Schedule Type
monthly_perform
String
Type of monthly schedule (Exists only for Monthly schedule Type)
daily_time
String
Execution time for daily type schedule (Exists only for Daily schedule Type)
monthly_week_day
String
Day of the week for monthly type schedule (Exists only for Monthly schedule Type)
days_of_week
String
Days of the week for Weekly type schedule (Exists only for Weekly schedule Type)
daily_interval_type
String
Type of schedule (Exists if the action is scheduled to be executed daily)
scheduler_disabled
String
Value to disable schedule
monthly_time
String
Execution Time for monthly type schedule (Exists only for Monthly schedule Type)
monthly_week_num
String
Execution Week for monthly type schedule (Exists only for Monthly schedule Type)
weekly_time
String
Execution Time for weekly type schedule (Exists only for Weekly schedule Type)
monthly_day
String
Day of the month on which the task for monthly schedule to be executed (Exists only for Monthly schedule Type)
months_list
String
List of months for monthly schedule (Exists only for Monthly schedule Type)
time_zone
String
TimeZone for which the scheduled action is to be executed
action_name
String
Name of the action :
|
Creating a schedule
Create a schedule to execute Remote Restart and Shutdown on devices in groups, at a specific date, time, week or dayoauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/mdm/actions/scheduled/<action_name>
Request Example
$ curl {BaseURL}/api/mdm/actions/scheduled/<action_name> -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "groups": [ "1", "2", "3" ], "time_zone": "Asia/Kolkata", "schedule_params": { "schedule_type": "Daily", "monthly_perform": "WeekDay", "daily_time": "10/25/2018, 15:30", "monthly_week_day": 1, "days_of_week": 12, "daily_interval_type": "everyDay", "scheduler_disabled": true, "monthly_time": "22:22", "monthly_week_num": 1, "weekly_time": "22:22", "monthly_day": 1, "months_list": "0,1,2" }, "reason_message": "Maintenance", "execution_type": 2, "expiry": 600000, "schedule_once_time": 1627970696000 }'
Response Example
HTTP/1.1 202 Accepted
ARGUMENTS
groups
Required
List of groups for which the action has to be applied
time_zone
Required
TimeZone for which the scheduled action is to be executed
schedule_params
Required
Parameters for the schedule
schedule_type
Optional
Schedule Type
monthly_perform
Optional
Type of monthly schedule (Exists only for Monthly schedule Type)
daily_time
Optional
Execution time for daily type schedule (Exists only for Daily schedule Type)
monthly_week_day
Optional
Day of the week for monthly type schedule (Exists only for Monthly schedule Type)
days_of_week
Optional
Days of the week for Weekly type schedule (Exists only for Weekly schedule Type)
daily_interval_type
Optional
Type of daily schedule (Exists only for Weekly schedule Type)
scheduler_disabled
Optional
Value to disable schedule
monthly_time
Optional
Execution Time for monthly type schedule (Exists only for Monthly schedule Type)
monthly_week_num
Optional
Execution Week for monthly type schedule (Exists only for Monthly schedule Type)
weekly_time
Optional
Execution Time for weekly type schedule (Exists only for Weekly schedule Type)
monthly_day
Optional
Day of the month on which the task for monthly schedule to be executed (Exists only for Monthly schedule Type)
months_list
Optional
List of months for monthly schedule (Exists only for Monthly schedule Type)
reason_message
Required
Reason for scheduling the action, to be used for auditing purposes.
execution_type
Required
Type of execution
expiry
Required
Time at which the scheduled command expires.
schedule_once_time
Required
Current time in milliseconds for ONCE Type execution Type
action_name
Optional
Name of the action :
|
Modifying a schedule
Modify an existing schedule.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
PUT /api/mdm/actions/scheduled/<action_name>
Request Example
$ curl {BaseURL}/api/mdm/actions/scheduled/<action_name> -X PUT -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "group_action_id": 9007199254744908, "groups": [ "1", "2", "3" ], "time_zone": "Asia/Kolkata", "schedule_params": { "schedule_type": "Daily", "monthly_perform": "WeekDay", "daily_time": "10/25/2018, 15:30", "monthly_week_day": 1, "days_of_week": 12, "daily_interval_type": "everyDay", "scheduler_disabled": true, "monthly_time": "22:22", "monthly_week_num": 1, "weekly_time": "22:22", "monthly_day": 1, "months_list": "0,1,2" }, "reason_message": "Maintenance", "execution_type": 2, "expiry": 600000, "schedule_once_time": 1627970696000 }'
Response Example
HTTP/1.1 202 Accepted
ARGUMENTS
group_action_id
Required
ID for the action scheduled to be executed on a group.
groups
Required
List of groups for which the action has to be applied
time_zone
Required
TimeZone for which the scheduled action is to be executed
schedule_params
Required
Parameters for the schedule
reason_message
Required
Reason for scheduling the action, to be used for auditing purposes..
execution_type
Required
Type of execution
expiry
Required
Time at which the scheduled command expires.
schedule_once_time
Required
Current time in milliseconds when an action is scheduled to be executed once
action_name
Optional
Name of the action :
|
Suspending a scheduled action
This will stop an action from being executed on devices in groups.oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/mdm/actions/scheduled/<action_name>
Request Example
$ curl {BaseURL}/api/mdm/actions/scheduled/<action_name> -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "group_action_id": 123452312 }'
Response Example
HTTP/1.1 202 Accepted
ARGUMENTS
group_action_id
Required
ID for the action scheduled to be executed on a group.
action_name
Optional
Name of the action :
|
Validate Group Scheduled Action
Validating groups on which a scheduled action needs to be executed.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/mdm/actions/scheduled/<action_name>/validate
Request Example
$ curl {BaseURL}/api/mdm/actions/scheduled/<action_name>/validate -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "groups": [ "1", "2", "3" ] }'
Response Example
HTTP/1.1 202 Accepted
ARGUMENTS
groups
Required
List of groups with devices that need to be restarted or shutdown
action_name
Optional
Name of the action :
|
Multiple VPP tokens
Multiple VPP tokens
Example
{ "appgroupid": 9007199254741296, "appname": "ManageEngine MDM", "apps": [ { "appgroupid": 9007199254741296, "appname": "ManageEngine MDM", "displayimageloc": "https://is5-ssl.mzstatic.com/image/thumb/Purple125/v4/4a/8b/cf/4a8bcf7c-a770-f53d-d9ca-fccf58fe88f4/source/100x100bb.jpg", "licensecount": 8, "packageid": 9007199254740996, "resourcecount": 12 } ], "apps_with_insufficient_licenses": 0, "businessstore_id": 9007199254741896, "completed_apps_count": 0, "displayimageloc": "https://is5-ssl.mzstatic.com/image/thumb/Purple125/v4/4a/8b/cf/4a8bcf7c-a770-f53d-d9ca-fccf58fe88f4/source/100x100bb.jpg", "email_address": "myaccountadmin@com", "expired": false, "expiry_date": 1639122831000, "failed_apps_count": 0, "if_license_insufficient": false, "if_sync_failed": true, "last_sync_time": 1621574248750, "license_assign_type": 2, "licensecount": 8, "location_name": "Location Name - 2", "non_vpp_app_count": 2, "non_vpp_apps_count": 2, "org_type": 1, "organisation_name": "ZOHO Corporation", "organization_name": "ZOHO Corporation", "other_mdm_hostname": "Sample MDM", "packageid": 9007199254740996, "remarks": null, "remove_from_other_mdm": true, "resourcecount": 12, "status": 0, "successful_apps_count": 0, "total_apps_count": 0, "trash_count": 0, "vpp_sync_details": [ { "if_sync_failed": true, "failed_apps_count": 0, "total_apps_count": 0, "completed_apps_count": 0, "successful_apps_count": 0, "businessstore_id": 9007199254741896, "status": 0, "remarks": null, "other_mdm_hostname": "Sample MDM" } ], "vpp_token_details": [ { "businessstore_id": 9007199254741896, "organisation_name": "ZOHO Corporation", "license_assign_type": 2, "location_name": "Location Name - 2" } ], "vpp_token_file": 121313 }
Attribute
appgroupid
String
Group ID for the app
appname
String
Name of the app
apps
list
List of apps for which the Sync failed
appgroupid
String
Group ID for the app
appname
String
Name of the app
displayimageloc
String
Image given as the icon for the app
licensecount
String
Total number of licenses available
packageid
String
The unique packageid of the app
resourcecount
String
Total number of devices or users associated with the app.
apps_with_insufficient_licenses
String
Number of apps with insufficient licenses
businessstore_id
Long
Unique ID of the location token
completed_apps_count
int
Total number of apps processed successfully from a location token. (This can include apps that have been added successfully, or failed to be added to the App Repository)
displayimageloc
String
Image given as the icon for the app
email_address
String
Email ID added to receive notifications about the server tokens expiry date.
expired
boolean
Location token expiry
expiry_date
String
Time at which the location token expires
failed_apps_count
int
Total number of apps that did not successfully sync
if_license_insufficient
String
This value is true if location token has insufficient licenses for apps
if_sync_failed
String
States if Sync failed
last_sync_time
String
Time at which a sync last occurred.
license_assign_type
Integer
Type of VPP assignment
licensecount
String
Total number of licenses available
location_name
String
Location of the token
non_vpp_app_count
int
Number of non-vpp apps added to MDMs App Repository
non_vpp_apps_count
Integer
Number of non-vpp apps added to MDMs App Repository
org_type
String
The organization type of the location token.
organisation_name
String
Organization Name of the location token
organization_name
String
Organization Name of the location token
other_mdm_hostname
String
Hostname of other MDM in which location token is currently used.(If remarks are set to differentClientContext, then this hostname will be displayed)
packageid
String
The unique packageid of the app
remarks
String
Remarks of location token sync. This can include reasons why the sync failed.
remove_from_other_mdm
String
This option needs to be set as True. This is to revoke licenses still associated with another MDM solution.
resourcecount
String
Total number of devices or users associated with the app.
status
int
Sync status
successful_apps_count
int
Total number of apps successfully synced
total_apps_count
int
Total number of apps associated with a location token
trash_count
Integer
No of iOS apps in Trash
vpp_sync_details
list
JSON details to sync the location token(s)
if_sync_failed
String
States if Sync failed
failed_apps_count
int
Total number of apps that did not successfully sync
total_apps_count
int
Total number of apps associated with a location token
completed_apps_count
int
Total number of apps processed successfully from a location token. (This can include apps that have been added successfully, or failed to be added to the App Repository)
successful_apps_count
int
Total number of apps successfully synced
businessstore_id
Long
Unique ID of the location token
status
int
Sync status
remarks
String
Remarks of location token sync. This can include reasons why the sync failed.
other_mdm_hostname
String
Hostname of other MDM in which location token is currently used.(If remarks are set to differentClientContext, then this hostname will be displayed)
vpp_token_details
list
Details of all added location Tokens
businessstore_id
Long
Unique ID of the location token
organisation_name
String
Organization Name of the location token
license_assign_type
Integer
Type of VPP assignment
location_name
String
Location of the token
vpp_token_file
Long
This is the unique ID of the server token file uploaded to the MDM console. |
Add VPP Account
This adds a new location token (Also known and referred to as VPP token or server token). Any apps added to the App Repository can be associated with its location token.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/apps/account/vpp
Request Example
$ curl {BaseURL}/api/v1/mdm/apps/account/vpp -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "vpp_token_file": 9007199254741896, "email_address": "sample.m@test.com" }'
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "location_name": "MDM Test Location - Apple Team 2", "expired": false, "expiry_date": 1646930122000, "businessstore_id": 9007199254741896, "organisation_name": "ZOHO Corporation" }
ARGUMENTS
vpp_token_file
Required
This is the unique ID of the server token file uploaded to the MDM console.
email_address
Required
Email ID added to receive notifications about the server tokens expiry date. |
Get All VPP Account Details
This fetches the details of all available/added location tokens. These details can be synced with the MDM server using the Sync option.oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/apps/account/vpp
Request Example
$ curl {BaseURL}/api/v1/mdm/apps/account/vpp -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "non_vpp_app_count": 2, "vpp_token_details": [ { "businessstore_id": 9007199254743996, "organisation_name": "ZOHO Corporation", "license_assign_type": 2, "location_name": "test location" } ], "trash_count": 0 }
Get All Vpp Sync Status
This fetches all the sync status of created location tokens.oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/v1/mdm/apps/account/vpp/sync
Request Example
$ curl {BaseURL}/api/v1/mdm/apps/account/vpp/sync -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "vpp_sync_details": [ { "if_sync_failed": true, "failed_apps_count": 0, "total_apps_count": 0, "completed_apps_count": 0, "successful_apps_count": 0, "businessstore_id": 9007199254741896, "status": 0, "remarks": "differentClientContext", "other_mdm_hostname": "Desktop Central MSP" } ] }
Get VPP Account Details
This fetches the details of a specific location token. Its details can be synced with the MDM server using the Sync option.oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/mdm/apps/account/vpp/{{vpp_id}}
Request Example
$ curl {BaseURL}/api/mdm/apps/account/vpp/{{vpp_id}} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "non_vpp_apps_count": 2, "location_name": "Location Name - 2", "total_apps_count": 29, "expiry_date": 1639122831000, "last_sync_time": 1621574222937, "org_type": 1, "organization_name": "ZOHO Corporation", "businessstore_id": 9007199254741896, "license_assign_type": 2 }
Get VPP Failure Details
This fetches the required details if an app added using a location token fails to sync.oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/mdm/apps/account/vpp/{{vpp_id}}/failure
Request Example
$ curl {BaseURL}/api/mdm/apps/account/vpp/{{vpp_id}}/failure -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "apps": [ { "appgroupid": 9007199254741296, "appname": "ManageEngine MDM", "displayimageloc": "https://is5-ssl.mzstatic.com/image/thumb/Purple125/v4/4a/8b/cf/4a8bcf7c-a770-f53d-d9ca-fccf58fe88f4/source/100x100bb.jpg", "licensecount": 8, "packageid": 9007199254740996, "resourcecount": 12 } ] }
Get VPP Sync Status
This fetches the sync status of the location token.oauthscope : MDMOnDemand.MDMDeviceMgmt.READ
GET /api/mdm/apps/account/vpp/sync/{{vpp_id}}
Request Example
$ curl {BaseURL}/api/mdm/apps/account/vpp/sync/{{vpp_id}} -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "if_license_insufficient": false, "if_sync_failed": true, "apps_with_insufficient_licenses": 0, "failed_apps_count": 0, "total_apps_count": 0, "successful_apps_count": 0, "last_sync_time": 1621574248750, "completed_apps_count": 0, "remarks": null, "status": 0, "other_mdm_hostname": "Sample MDM" }
Modify VPP Account
This modifies the details of the location token. The edited details will be displayed on the MDM console.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
PUT /api/mdm/apps/account/vpp/{{vpp_id}}
Request Example
$ curl {BaseURL}/api/mdm/apps/account/vpp/{{vpp_id}} -X PUT -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "vpp_token_file": 121313, "email_address": "myaccountadmin@com" }'
Response Example
HTTP/1.1 202 Accepted
ARGUMENTS
vpp_token_file
Required
This is the unique ID of the server token file uploaded to the MDM console.
email_address
Required
Email ID added to receive notifications about the server tokens expiry date. |
Remove All VPP Accounts
All the created location tokens get deleted from the MDM server. The apps associated with the location tokens will also be removed once the tokens are deleted.oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/v1/mdm/apps/account/vpp
Request Example
$ curl {BaseURL}/api/v1/mdm/apps/account/vpp -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 202 Accepted
Remove VPP Account
This deletes a specific location token from the MDM server. The apps added to the location token will also be removed once the account is deleted.oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE
DELETE /api/mdm/apps/account/vpp/{{vpp_id}}
Request Example
$ curl {BaseURL}/api/mdm/apps/account/vpp/{{vpp_id}} -X DELETE -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 202 Accepted
Sync All VPP Accounts
This syncs all available location tokens.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/v1/mdm/apps/account/vpp/sync
Request Example
$ curl {BaseURL}/api/v1/mdm/apps/account/vpp/sync -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8"
Response Example
HTTP/1.1 202 Accepted
Sync VPP Account
This syncs a location token with the MDM console.oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE
POST /api/mdm/apps/account/vpp/sync/{{vpp_id}}
Request Example
$ curl {BaseURL}/api/mdm/apps/account/vpp/sync/{{vpp_id}} -X POST -H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5" -H "Content-Type: application/json;charset=UTF-8" -d '{ "remove_from_other_mdm": true }'
Response Example
HTTP/1.1 200 OK
ARGUMENTS
remove_from_other_mdm
Required
This option needs to be set as True. This is to revoke licenses still associated with another MDM solution. |
Profile API Help
Steps to create a profile
Steps
- Create a profile using POST /profiles endpoint.
- Add payloads to the profile using POST /profiles/{profile_id}/payloads/{payload_name} endpoint.
- Publish the profile using POST /profiles/{profile_id}/publish endpoint.
iOS PROFILES
PASSCODE_POLICY
payload_id : 172
payload_name : passcodepolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
allow_simple_value | Allow numerical values to be configured as passcode. | Boolean | None | true | true, false |
auto_lock_idle_for | Maximum idle time allowed before auto-lock. The device user can select any value less than the value configured here. | Integer | None | None | 1,2,3,4,5,10,15 |
require_alphanumeric | Mandates the use of alphanumeric values as passcode. | Boolean | None | false | true, false |
min_passcode_length | Minimum passcode length. The user must configure a password longer than the length configured here. | Integer | None | None | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 |
min_complex_chars | Mandates the minimum number of special characters to be used in the passcode. | Integer | None | None | 1, 2, 3, 4 |
max_passcode_age | Maximum Passcode Age in days | Integer | None | None | 1-170 |
no_of_passcode_maintained | Number of passcodes to be maintained in the history. The user cannot reuse the passcode stored in the history. | Integer | None | None | 1-50 |
max_grace_period | Maximum time to unlock device without prompting for a passcode (in minutes) | Integer | None | None | 0-240 |
max_failed_attempts | Maximum number of failed attempts. The device will be factory reset when the maximum number is exceeded. | Integer | None | None | 3-9 |
RESTRICTIONS_POLICY
payload_id : 173
payload_name : restrictionspolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
allow_airprint_credential_storage | Users can store AirPrint credentials in iCloud Keychain. | Boolean | None | true | true, false |
allow_explicit_content | Allow explicit music & Podcasts. | Boolean | None | true | true, false |
show_control_center | Allow Control Center on the devices. | Boolean | None | true | true, false |
show_today_view | Allow Today View on the device lockscreen. | Boolean | None | true | true, false |
allow_classroom_remoteview | Allow AirPlay and screen viewing by teacher's device. | Boolean | None | true | true, false |
allow_account_modification | Allow users to add/modify iCloud, Mail and other accounts on the devices. | Boolean | None | true | true, false |
allow_assistant_user_content | Allow Siri to query from web. | Boolean | None | true | true, false |
allow_managed_book_sync | Allow Enterprise book metadata sync. | Boolean | None | true | true, false |
allow_airprint | Allow AirPrint. | Boolean | None | true | true, false |
allow_music_service | Allow music services. | Boolean | None | true | true, false |
allow_untrusted_tls_prompt | Allow users to accept untrusted TLS certificates. | Boolean | None | true | true, false |
safari_allow_popups | Allow Pop-ups on devices. | Boolean | None | true | true, false |
allow_spotlight_result | Allow Spotlight internet search. | Boolean | None | true | true, false |
allow_passbook_when_locked | Allow Passbook when device is locked. | Boolean | None | true | true, false |
force_watch_wrist_detect | Force Wrist Authentication to access notifications on Apple Watch. | Boolean | None | true | true, false |
allow_use_of_ibookstore | Allow users to download iBooks content on devices. | Boolean | None | true | true, false |
allow_cloud_document_sync | Allow users to sync Documents and Data on devices. | Boolean | None | true | true, false |
allow_touch_id | Allow Touch ID to unlock Device | Boolean | None | true | true, false |
is_rating_enabled | Enable ratings by region. | Boolean | None | true | true, false |
country_code | Country code | String | None | us | None |
movies_rating_value | Movie Rating | String | None | 1000 | None |
tv_shows_rating_value | Allow TV rating | Integer | None | 1000 | None |
apps_rating_value | Apps Rating value | Inetger | None | 1000 | None |
allow_ibookstore_erotica_media | Allow Erotic content on iBooks | Boolean | None | true | true, false |
allow_bluetooth_modification | Allow users to modify the existing Bluetooth settings. | Boolean | None | true | true, false |
allow_assistant_when_locked | Allow users to access Siri when the device is locked. | Boolean | None | true | true, false |
force_istore_pwd_entry | Mandates the iTunes password will accessing iTunes and downloading apps from App Store. | Boolean | None | true | true, false |
allow_app_installation | Users can install unapproved apps on devices. | Boolean | None | true | true, false |
allow_erase_content_settings | Allow user to wipe device by erasing all Content and Settings. | Boolean | None | true | true, false |
allow_airprint_ibeacon_discovery | Devices can discover AirPrint printers using Bluetooth iBeacons | Boolean | None | true | true, false |
allow_auto_app_download | Automatically download apps on multiple devices with same Apple ID. | Boolean | None | true | true, false |
allow_paired_watch | Allow users to pair devices with Apple Watch. | Boolean | None | true | true, false |
allow_vpn_creation | Allow users to configure additional VPN on devices. | Boolean | None | true | true, false |
allow_predictive_keyboard | Allow predictive keyboard on devices. | Boolean | None | true | true, false |
allow_app_removal | Allow users to delete apps from the devices. | Boolean | None | true | true, false |
allow_activity_continuation | Enable Handoff on devices. | Boolean | None | true | true, false |
allow_news | Allow users to access the News app on devices | Boolean | None | true | true, false |
allow_safari | Allow users to access Safari on devices. | Boolean | None | true | true, false |
allow_radio_service | Allow users to access the Radio Services on devices. | Boolean | None | true | true, false |
allow_managed_app_trust | Allow unauthorized Enterprise apps to be installed on devices. | Boolean | None | true | true, false |
allow_spellcheck | Allow Spell Check on devices. | Boolean | None | true | true, false |
safari_accept_cookies | Allow Cookies on device browsers. | Integer | None | 2 | 0 - Never, 1 - From Visited sites, 2 - Always |
force_classroom_appdevicelock | Allow teachers device to lock apps and devices without prompting. | Boolean | None | true | true, false |
allow_itunes | Allow users to access the iTunes Store on devices. | Boolean | None | true | true, false |
allow_managed_app_cloud_sync | Sync Data and Documents from Managed apps. | Boolean | None | true | true, false |
allow_assistant | Allow users to use Siri on devices. | Boolean | None | true | true, false |
allow_find_my_friends_mod | Allow users to modify Find My Friends Settings on devices | Boolean | None | true | true, false |
safari_allow_javascript | Allow JavaScript | Boolean | None | true | true, false |
force_limited_ad_tracking | Force limited Ad tracking | Boolean | None | true | true, false |
force_airplay_incoming_pwd | Force passwords on incoming requests for AirPlay. | Boolean | None | true | true, false |
allow_use_of_youtube | Allow users to access YouTube on devices. (Deprecated on the MDM) | Boolean | None | true | true, false |
force_encrypted_backup | Force encrypted backup of data on devices. | Boolean | None | true | true, false |
allow_voice_dialing | Allow Voice Dial on devices. | Boolean | None | true | true, false |
allow_dictionary_lookup | Allow users to use inline dictionary word lookup. | Boolean | None | true | true, false |
force_assist_profanity_filter | Force Siri profanity filter on devices. | Boolean | None | true | true, false |
force_airprint_tls | Enforce TLS trusted certificates for AirPrint. | Boolean | None | true | true, false |
allow_dictation | Allow Dictation on devices. | Boolean | None | true | true, false |
force_classroom_remoteview | Allow teacher's device to AirPlay and view screen without prompting. | Boolean | None | true | true, false |
allow_face_time | Allow FaceTime on devices. | Boolean | None | true | true, false |
allow_enabling_restriction | Allow users to configure Restrictions/ Screen Time on devices. | Boolean | None | true | true, false |
allow_ota_pki_updates | Automatic updates for trusted certificates on devices. | Boolean | None | true | true, false |
allow_multiplayer_gaming | Allow Multiplayer Gaming on devices. | Boolean | None | true | true, false |
allow_diagnostic_submission | Send diagnostics data to Apple. | Boolean | None | true | true, false |
allow_diag_sub_modification | Modify Diagnostics & Usage pane settings on devices. | Boolean | None | true | true, false |
allow_add_game_center_friend | Allow users to add Game Center Friends on devices. | Boolean | None | true | true, false |
allow_shared_stream | Allow iCloud Shared Stream on devices. | Boolean | None | true | true, false |
allow_sync_while_roaming | Allow automatic sync while roaming. | Boolean | None | true | true, false |
allow_open_doc_in_managed | Share data from Unmanaged apps to Managed apps. | Boolean | None | true | true, false |
allow_photo_stream | Allow iCloud Photo Stream on devices. | Boolean | None | true | true, false |
safari_force_fraud_warning | Force fraudulent website warning on devices. | Boolean | None | true | true, false |
show_notification_center | Allow users to access the Notification Center on devices. | Boolean | None | true | true, false |
allow_airdrop | Allow users to use AirDrop on devices. | Boolean | None | true | true, false |
allow_game_center | Allow access to Game Center on devices. | Boolean | None | true | true, false |
allow_keyboard_shortcut | Shortcuts on External Keyboard | Boolean | None | true | true, false |
allow_modifi_passcode | Allow users to add/modify passcode on the device. | Boolean | None | true | true, false |
allow_profile_installation | Install configuration profiles and certificates interactively on devices. | Boolean | None | true | true, false |
allow_modify_touch_id | Allow users to add or modify fingerprint on devices. | Boolean | None | true | true, false |
allow_cloud_keychain_sync | Allow iCloud Keychain Sync on devices. | Boolean | None | true | true, false |
allow_open_doc_in_unmanaged | Share data from Managed apps to Unmanaged apps. | Boolean | None | true | true, false |
allow_inapp_purchase | Allow in-app purchase on devices. | Boolean | None | true | true, false |
allow_auto_correction | Allow users to configure Auto-Correction on devices. | Boolean | None | true | true, false |
safari_allow_autofill | Allow users to configure AutoFill on devices. | Boolean | None | true | true, false |
allow_app_cellular_data | Allow users to modify cellular data usage for apps. | Boolean | None | true | true, false |
allow_imessage | Allow users to use iMessage on devices. | Boolean | None | true | true, false |
allow_podcasts | Allow users to use the Podcast app on devices. | Boolean | None | true | true, false |
allow_cloud_backup | Allow users to store the device data backup on iCloud. | Boolean | None | true | true, false |
allow_cloud_photo_lib | Allow users to sync the Photo Library on devices to to iCloud. | Boolean | None | true | true, false |
force_wifi_whitelisting | Connect only to the Wi-Fi networks distributed using MDM. | Boolean | None | true | true, false |
force_airplay_outgoing_pwd | Force password on outgoing requests for AirPlay. | Boolean | None | true | true, false |
allow_use_of_camera | Allow users to use the Camera app on devices. | Boolean | None | true | true, false |
allow_modifi_device_name | Allow users to modify the device name. | Boolean | None | true | true, false |
allow_managed_book_backup | Allow users to backup Enterprise books. | Boolean | None | true | true, false |
force_classroom_auto_join | Automatically join classes without prompting. | Boolean | None | true | true, false |
allow_screen_capture | Allow screen capture and screen recording on devices. | Boolean | None | true | true, false |
force_airdrop_unmanaged | Allow users to use AirDrop to share data from Managed apps. | Boolean | None | true | true, false |
force_date_time | Restrict users from modifying the the Date and Time Settings on devices. | Boolean | None | true | true, false |
allow_password_autofill | Allow users to use autoFill in Safari and apps on devices. | Boolean | None | true | true, false |
allow_password_proximity | To restrict devices from requesting passwords from devices in proximity. | Boolean | None | true | true, false |
allow_password_sharing | To restrict users from sharing the device and Wi-Fi passwords to devices using AirDrop. | Boolean | None | true | true, false |
allow_manade_write_unmanaged_contact | Allow the managed contacts to be stored in unmanaged accounts. | Boolean | None | true | true, false |
allow_unmanaged_read_managed_contact | Allows unmanaged apps to access managed contacts | Boolean | None | true | true, false |
allow_usb_restriction_mode | Allow users to configure the USB Restricted Mode on devices. | Boolean | None | true | true, false |
bluetooth_setting | Configure the Bluetooth settings on devices.0 - Off 1 - On 2- Not configured | Integer | None | 2 | 0,1,2 |
EMAIL_POLICY
payload_id : 174
payload_name : emailpolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
account_name | Account name of the e-mail account to be configured on devices. | String | None | None | None |
account_type | Type of the e-mail account to be configured on devices. | String | None | None | None |
account_path_prefix | Path prefix for the account to be configured on devices. | String | None | None | None |
account_user_name | Username of the account to be configured on the devices. | String | None | None | None |
mail_address | E-mail address of the account to be configured on the devices. | String | None | None | None |
prevent_move | Restrict the movement of mails from one account to another. | Boolean | None | false | true, false |
disable_mail_recents_syncing | Prevent users from syncing the e-mails in the configured account. | Boolean | None | false | true, false |
incoming_server_hostname | Incoming host name of the account to be configured on the devices. | String | Required | None | None |
incoming_server_port | Incoming host server port of the account to be configured on the devices. | Integer | None | 143 | None |
incoming_server_username | Username of the incoming host server of the account to be configured on the devices. | Required | None | None | None |
incoming_server_auth | Authentication type of incoming server. | String | Required | password | none,password,md5,ntlm,htpmd5 |
incoming_password | Password for the IMAP server. | String | None | None | None |
incoming_server_use_ssl | Use SSL for communication. | Boolean | None | false | true, false |
outgoing_server_hostname | Outging server host name of the account to be configured on the devices. | String | Required | None | None |
outgoing_server_port | Outgoing server port of the account to be configured on the devices. | Integer | None | 587 | None |
outgoing_server_username | Username for outgoing server of the account to be configured on the devices. | String | Required | None | None |
outgoing_server_auth | Authentication type for outgoing server. | String | Required | password | none,password,md5,ntlm,htpmd5 |
outgoing_password | Password for the outgoing server. | String | None | None | None |
outgoing_pwd_as_income_pwd | Use common passwords for both incoming and outgoing servers. | Boolean | None | false | true, false |
use_only_mail_app | Mandates the use of default Mail app available on devices. | Boolean | None | false | true, false |
outgoing_server_use_ssl | Use SSL for outgoing communication. | Boolean | None | false | true, false |
use_mime_encrypt | Use S/MIME encrypt the mails on devices. | Boolean | None | false | true, false |
signing_cert_id | S/MIME signing certificate ID for the certificates uploaded using the Certificates endpoint. | Long | None | None | None |
encryption_cert_id |
S/MIME encryption certificate ID for the certificates uploaded using the Certificates endpoint. |
Long | None | None | None |
EXCHANGE_ACTIVE_SYNC_POLICY
payload_id : 175
payload_name : exchangeactivesyncpolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
account_name | Account name of the e-mail account to be configures on the devices. | String | None | Exchange ActiveSync | None |
active_sync_host | Host name of the e-mail account to be configured ont he devices. | String | Required | None | None |
prevent_move | Restrict the users from moving mails from one account to another. | Boolean | None | false | true, false |
disable_mail_recents_syncing | Restrict users from syncing mails to iCloud. | Boolean | None | false | true, false |
use_only_mail_app | Mandates the use of the default Mail app available in devices. | Boolean | None | false | true, false |
use_mime_encrypt | Use S/MIME encrypt the mails on devices. | Boolean | None | false | true, false |
signing_cert_id | S/MIME signing certificate ID for the certificates uploaded using the Certificates endpoint. | Long | None | None | None |
encryption_cert_id | S/MIME encryption certificate ID for the certificates uploaded using the Certificates endpoint. | Long | None | None | None |
domain | Domain name of the account to be configured on the devices. | String | None | None | None |
user_name | Username of the account to be configured on the devices. | String | Required | None | None |
email_address | E-mail address of the account to be configured on the devices. | String | Required | None | None |
password | Password for the account to be configured on the devices. | String | None | None | None |
past_days_mail_to_sync | Number of daysfor which the mails are to be synced to the app. 0-Unlimited,1-one day,2-three day,3-one week,4-two week,5-one month | Integer | Required | 2 | 0,1,2,3,4,5 |
identity_cert_id | Certificate identifier for the certificates configured using the Certificates endpoint. | Long | None | None | None |
cert_compatible_ios4 | To make the account compatible to iOS 4. | Boolean | None | false | true, false |
oauth | Mandate if OAuth must be used for authentication. | Boolean | None | false | true, false |
VPN_POLICY
payload_id : 176
payload_name : vpnpolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
connection_name | Name of the VPN connection to be configured on devices. | String | Required | None | None |
vpn_type | Type of the VPN to be configured on the devices. By default 1 is selected. | Integer | Required | None | None |
connection_type | Type of VPN connection to be configured on the devices. 1-L2TP,2-PPTP or IPSec,3-Cisco IPSec(Legacy cisco),4-JuniperSSL,5-F5SSL,6-custom SSL,7-Pulse secure,8-IKEv2,9-Cisco Anyconnect,10-Sonciwall Mobile connect,11- Arubia Via &12- Checkpoint Mobile VPN | Intger | Required | 1 | None |
send_all_nw_traffic | Mandates all the traffic must be routed through the configured VPN | Boolean | None | false | true, false |
enable_vpn_on_demand | To enable VPN on-demand, which automatically enables the VPN when accessing specified websites. | Boolean | None | false | true,false |
ondemandrule | The webpages for which a VPN must be enabled automatically. | Array of JSONObject | None | None | None |
proxy_type | Type of the proxy for the VPN. 0-None, 1-Manual,2-Auto | Integer | None | None | None |
proxy_server | Server address of the proxy. | String | Required if proxy type is 1 | None | None |
proxy_server_port | Sever port of the proxy. | String | Required if proxy type is 1 | None | None |
proxy_user_name | Username for authentication while configuring the VPN. Applicable only if proxy type is 1. | String | None | None | None |
proxy_password | Credential for authentication while configuring VPN. Applicable only if proxy type is 1. | String | None | None | None |
proxy_pac_url | Proxy pac URL while configuring VPN. Applicable only if proxy type is 2 | String | None | None | None |
l2tp | L2TP configuration | JSONObject | None | None | None |
pptp | PPTP configuration. (Deprecated for devices running iOS 10 or above.) | JSONObject | None | None | None |
ipsec | IPSEC configuration | JSONObject | None | None | None |
cisco | Cisco legacy configuration | JSONObject | None | None | None |
juniperssl | Juniper SSL configuration | JSONObject | None | None | None |
f5ssl | F5 SSL configuration | JSONObject | None | None | None |
ikev2 | IKEv2 configuration | JSONObject | None | None | None |
ciscoanyconnect | Cisco AnyConnect configuration | JSONObject | None | None | None |
sonicwall | Sonicwall configuration | JSONObject | None | None | None |
arubavia | Aruba VIA configuration | JSONObject | None | None | None |
checkpoint | Check Point configuration | JSONObject | None | None | None |
customssl | CustomSSL configuration | JSONObject | None | None | None |
custom_data | Custom data of the VPN types. Not applicable for VPN type 1&2 | JSONObject | None | None | None |
ondemandrule
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
connectifneeded | The webpages for which the VPN must be connected when needed. | Array of JSONObject | None | None | None |
connectifneeded
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
vpnodrulesforconeval | OnDemad url rules | JSONObject | None | None | None |
vpnodrulesforconeval
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
domain_name | Domain Name of the URL | String | Required | None | None |
dns_server_address | DNS sever addresss. Not used now | String | None | None | None |
url_probe | url probe. Not used now. | String | None | None | None |
l2tp
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name / host IP address of the VPN to be configured. | String | Required | None | None |
account | Username of the VPN to be configured. | String | Required | None | None |
user_authentication | Type of authentication to be used while enabling the VPN. 0- Password 1-RSA Secure ID | Integer | Required | 0 | 0,1 |
password | Password credential for account used for configuring the VPN. | String | None | None | None |
shared_secret | Shared secret for account used for configuring the VPN. | String | None | None | None |
send_all_nw_traffic | Mandates if all the traffic must be routed through the configured VPN. | Boolean | None | false | false,true |
pptp
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name / host IP address for the VPN to be configured. | String | Required | None | None |
account | Username of the VPN to be configured. | String | Required | None | None |
user_authentication | Type of authentication to be used while enabling the VPN. 0- Password 1-RSA Secure ID | Integer | Required | 0 | 0,1 |
password | Password credential for account used to configure the VPN | String | None | None | None |
encryption_level | Encryption level of communication between server and device. 0 -None 1- Automatic & 2- Maximum | Integer | None | 0 | 0,1,2 |
send_all_nw_traffic | Mandates if all the traffic must be routed through the configured VPN. | Boolean | None | false | false,true |
ipsec
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name/ host IP address of the VPN to be configured. | String | Required | None | None |
account | Username of the VPN to be configured. | String | Required | None | None |
password | Password credential for account used to configure the VPN. | String | None | None | None |
machine_authentication | Type of authentication to be used while enabling the VPN. 0- Shared secret/Group Name 1-Certificate | Integer | Required | 0 | 0,1 |
group_name | Group name for authentication while enabling the VPN. | String | None | None | None |
shared_secret | Shared secret for account used to configure the VPN. | String | None | None | None |
use_hybrid_auth | Mandates if hybrid authentication must be used while enabling VPN. | Boolean | None | false | true,false |
prompt_for_password | Mandates if the users must be prompted to enter their password. | Boolean | None | false | true,false |
certificate_id | Certificate ID for authentication of the certificate configured using the Certificate endpoint. | Long | None | None | None |
include_user_pin | Mandates if the user must be prompted to enter the VPN pin. | Boolean | None | false | true,false |
cisco
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name / host IP address of the VPN to be configured. | String | Required | None | None |
account | Username of the VPN to be configured. | String | Required | None | None |
group_name | Group name for authentication while enabling the VPN. | String | None | None | None |
user_authentication | Type of authentication to be used while enabling VPN. 0- Password and 1-Certificate | Integer | Required | 0 | 0,1 |
password | Password credential for account used to configure VPN. | String | None | None | None |
certificate_id | Certificate ID of the certificate configured for authentication, using the Certificate endpoint. | Long | None | None | None |
juniperssl
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name / host IP address of the VPN to be configured. | String | Required | None | None |
account | Username of the VPN to be configured. | String | Required | None | None |
realm | Realm name for the VPN to be configured. | String | None | None | None |
role | Role for VPN to be configured. | String | None | None | None |
user_authentication | Type of authentication to be used while enabling the VPN. 0- Password and 1-Certificate | Integer | Required | 0 | 0,1 |
password | Password credential for account used to configure the VPN. | String | None | None | None |
certificate_id | Certificate ID of the certificate configured for authentication, using the Certificate endpoint. | Long | None | None | None |
f5ssl
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name / host IP address of the VPN to be configured. | String | Required | None | None |
account | Username of the VPN to be configured. | String | Required | None | None |
user_authentication | Type of authentication to be used while configuring VPN. 0- Password and 1-Certificate | Integer | Required | 0 | 0,1 |
password | Password credential for account used to configure the VPN. | String | None | None | None |
certificate_id | Certificate ID of the certificate created for authentication, using the Certificates endpoint. | Long | None | None | None |
ikev2
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name/host IP address of the VPN to be configured. | String | Required | None | None |
local_id | FQDN, User FQDN, or the address of the client | String | None | None | None |
remote_id | FQDN, UserFQDN, or the address of the remote server | String | None | None | None |
authentication_method | Type of authentication to be used while enabling the VPN. 0- None, 1-Certificate and 2-Shared secret | Integer | Required | 0 | 0,1 |
eap_username | Username for authentication while enabling VPN. | String | None | None | None |
eap_password | Password credential for account used to configure VPN. | String | None | None | None |
client_cert_id | Certificate ID for the certificate configured for authentication using the Certificates endpoint. | Long | None | None | None |
eap_enabling | To enable extended authentication while enabling the VPN. 0-No/ 1-Certificate/ 2-Username | Integer | None | 0 | 0,1,2 |
shared_secret | Shared secret for account used for configuring the VPN. | String | None | None | None |
pfs | Mandates the use of Perfect Forward Secrecy. 0-Disable/ 1-Enable | Integer | None | 0 | 0,1 |
internal_ip_subnet | Enable or disable the internal IP subnet while configuring the VPN. 0-Disable/ 1-Enable | Integer | None | 0 | 0,1 |
mobike | Mandates the use of MOBIKE while configuring VPN. 0-Disable/ 1-Enable | Integer | None | 0 | 0,1 |
redirect | Enable or disable redirection of content from one VPN gateway to another. 0-Disable/ 1-Enable | Integer | None | 0 | 0,1 |
certificate_revocation_check | To check whether the certificate is revoked by the CA. 0-Disable /1-Enable | Integer | None | 0 | 0,1 |
dead_per_detection | To detect whether the connection is interrupted.0-None/ 1-low/ 2-medium/ 3-high | Integer | None | 2 | 0,1,2 |
child_sa_id | Child security association to secure the communication. | JSONObject | None | None | None |
ike_sa_id | IKE security association for establishing communication. | JSONObject | None | None | None |
child_sa_id
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
encryption_algorithm | Encryption algorithm for establishing communication. 0-DES/1-3DES/2-AES-128/3-AES-128-GCM/4-AES-256-GCM | Integer | None | 2 | 0,1,2,3,4 |
integrity_algorithm | Integrity algorithm for establishing communication. 0-SHA1-96/1-SHA1-160/2-SHA2-256/3-SHA2-384/4-SHA2-512 | Integer | None | 2 | 0,1,2,3,4 |
diffie_hellman_group | Group of the Diffie-Hellman algorithm to be used for key exchange. 1,2,5,14,15,16,17,18,19,20 or 21 | Integer | None | 2 | 1,2,5,14,15,16,17,18,19,20,21 |
life_time_in_minutes | Maximum duration of an active connection. | Integer | None | 1440 | 10 to 1440 |
ike_sa_id
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
encryption_algorithm | Encryption algorithm for establishing communication. 0-DES/1-3DES/2-AES-128/3-AES-128-GCM/4-AES-256-GCM | Integer | None | 2 | 0,1,2,3,4 |
integrity_algorithm | Integrity algorithm for establishing communication. 0-SHA1-96/1-SHA1-160/2-SHA2-256/3-SHA2-384/4-SHA2-512 | Integer | None | 2 | 0,1,2,3,4 |
diffie_hellman_group | Group of the Diffie-Hellman algorithm to be used for key exchange. 1,2,5,14,15,16,17,18,19,20 or 21 | Integer | None | 2 | 1,2,5,14,15,16,17,18,19,20,21 |
life_time_in_minutes | Maximum duration of an active connection. | Integer | None | 1440 | 10 to 1440 |
customssl
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
identifier | App identifier for the VPN connection being configured. | String | Required | None | None |
server_name | Server name / host IP address of the VPN to be configured. | String | Required | None | None |
account | Username of the VPN to be configured. | String | Required | None | None |
user_authentication | Type of authentication while enabling the configured VPN. 0- Password and 1-Certificate | Integer | Required | 0 | 0,1 |
password | Password credential for account used while configuring the VPN. | String | None | None | None |
certificate_id | Certificate ID of the certificate configured for authentication, using the Certificate endpoint. | Long | None | None | None |
ciscoanyconnect
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name / host IP address of the VPN to be configured. | String | Required | None | None |
account | Username of the VPN to be configured. | String | Required | None | None |
group_name | Group name for authentication while enabling the VPN. | String | None | None | None |
user_authentication | Type of authentication while enabling the VPN. 0- Password and 1-Certificate | Integer | Required | 0 | 0,1 |
password | Password credential for account used to configure the VPN. | String | None | None | None |
certificate_id | Certificate ID of the certificate configured for authentication, using the Certificate endpoint. | Long | None | None | None |
sonicwall
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name / host IP address of the VPN to be configured. | String | Required | None | None |
account | Username of the VPN to be configured. | String | Required | None | None |
group_name | Group name for authentication while enabling the VPN. | String | None | None | None |
user_authentication | Type of authentication to be used while enabling the VPN. 0- Password and 1-Certificate | Integer | Required | 0 | 0,1 |
password | Password credential for account used to configure the VPN | String | None | None | None |
certificate_id | Certificate ID of the certificate configured for authentication, using the Certificate endpoint. | Long | None | None | None |
arubavia
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name / host IP address of the VPN to be configured. | String | Required | None | None |
account | Username of the VPN to be configured. | String | Required | None | None |
user_authentication | Type of authentication to be used while enabling the VPN. 0- Password and 1-Certificate | Integer | Required | 0 | 0,1 |
password | Password credential for account used to configure the VPN. | String | None | None | None |
certificate_id | Certificate ID of the certificate configured for authentication using the Certificate endpoint. | Long | None | None | None |
checkpoint
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name / host IP address of the VPN to be configured. | String | Required | None | None |
account | Username of the VPN to be configured. | String | Required | None | None |
user_authentication | Type of authentication to be used while enabling the VPN. 0- Password and 1-Certificate | Integer | Required | 0 | 0,1 |
password | Password credential for account used to configure the VPN. | String | None | None | None |
certificate_id | Certificate ID of the certificate configured for authentication using the Certificate endpoint. | Long | None | None | None |
sample json
{
"provider_type": 1,
"connection_type": 3,
"ondemandrule": [{
"connectifneeded":[{
"vpnodrulesforconeval":{
"domain_name":"*.example.com",
"dns_server_address":"",
"url_probe":""
}
}]
}],
"proxy_type": 0,
"send_all_nw_traffic": false,
"proxy_server_port": 0,
"proxy_server": "",
"vpn_type": 1,
"sub_config": "cisco",
"config_id": 176,
"ondemand_match_app_enabled": true,
"proxy_pac_url": "",
"config_type": 3,
"config_name": "vpn_policy",
"cisco": {
"group_name": "",
"account": "",
"password": "",
"user_authentication": 0,
"server_name": "free-nl.hide.me",
"certificate_id": -1
},
"enable_vpn_on_demand": true,
"proxy_user_name": "",
"certificate_uuid": "",
"proxy_password": ""
}
sample json 2
{
"provider_type": 1,
"connection_type": 8,
"ondemandrule": "",
"proxy_type": 0,
"send_all_nw_traffic": false,
"proxy_server_port": 0,
"proxy_server": "",
"vpn_type": 1,
"sub_config": "ikev2",
"config_id": 176,
"ondemand_match_app_enabled": true,
"proxy_pac_url": "",
"config_type": 3,
"config_name": "vpn_policy",
"ikev2": {
"table_name": "vpnikev2",
"shared_secret": "",
"nat_alive_offload_enable": 1,
"ike_sa_id": {
"life_time_in_minutes": 1440,
"table_name": "ikesaparams",
"integrity_algorithm": 2,
"encryption_algorithm": 3,
"diffie_hellman_group": 2
},
"internal_ip_subnet": 0,
"client_cert_id": -1,
"nat_alive_interval": 20,
"dead_per_detection": 2,
"authentication_method": 0,
"eap_enabling": 2,
"certificate_revocation_check": 0,
"server_name": "free-nl.hide.me",
"eap_username": "%username%",
"pfs": 0,
"local_id": "localid",
"eap_password": "",
"child_sa_id": {
"life_time_in_minutes": 1440,
"table_name": "ikesaparams",
"integrity_algorithm": 2,
"encryption_algorithm": 3,
"diffie_hellman_group": 2
},
"mobike": 0,
"redirect": 0,
"remote_id": "remoteid"
},
"connection_name": "vpn configuration",
"enable_vpn_on_demand": false,
"proxy_user_name": "",
"certificate_uuid": "",
"proxy_password": ""
}
WIFI_POLICY
payload_id : 177
payload_name : wifipolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
service_set_identifier | SSID of the Wi-Fi to be configured for the devices. | String | Required | None | None |
hidden_network | Select whether the Wi-Fi is broadcasting or not. | Boolean | Required | None | None |
auto_join | Enable to ensure the devices connect to the configured Wi-Fi when detected. | Boolean | None | true | true,false |
security_type | Security type of the Wi-Fi. 0-None,1-WEP,2- WPA/WPA2 Personal,3-Any personal,4-WEP Enterprise,5-WPA/WPA2 Enterprise,6- Any Enterprose | Integer | Required | None | None |
proxy_type | Type of the proxy to be configured.. 0-None, 1-Manual,2-Auto | Integer | None | None | None |
proxy_server | Server address of the proxy to be configured. | String | Required if proxy type is 1 | None | None |
proxy_server_port | Sever port of the proxy to be configured. | String | Required if proxy type is 1 | None | None |
proxy_user_name | Username for authentication. Applicable only if proxy type is 1 | String | None | None | None |
proxy_password | Credential for authentication. Applicable only if proxy type is 1 | String | None | None | None |
proxy_pac_url | Proxy PAC URL. Applicable only if proxy type is 2. | String | None | None | None |
wifi_enterprise | Wi-Fi enterprise configuration details. | JSONObject | Required if security_type is 4,5,6 | None | None |
wifi_non_enterprise | Wi-Fi non-enterprise configuration details | JSONObject | Required if security_type is 1,2,3 | None | None |
wifi_enterprise
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
ttls | Whether the Wi-Fi to be configured supports TTLS protocol | Boolean | Required | true | true,false |
eap_sim | Whether the Wi-Fi to be configured supports EAP-SIM protocol | Boolean | Required | true | true,false |
peap | Whether the Wi-Fi to be configured supports PEAP protocol | Boolean | Required | true | true,false |
eap_fast | Whether the Wi-Fi to be configured supports EAP-FAST protocol | Boolean | Required | true | true,false |
leap | Whether the Wi-Fi to be configured supports LEAP protocol | Boolean | Required | true | true,false |
tls | Whether the Wi-Fi to be configured supports TLS protocol | Boolean | Required | true | true,false |
use_per_connection_pwd | Mandates whether the user must be prompted to enter the password everytime they connect to the Wi-Fi. | Boolean | None | true | true,false |
user_name | Username for the Wi-Fi connection to be configured. | String | None | None | None |
password | Password for Wi-Fi connection to be configured. | String | None | None | None |
certificate_id | Server certificate ID of the certificate configured using the Certificates endpoint. | Long | None | None | None |
identity_certificate_id | Identity certificate ID of the certificate configured using the Certificates endpoint. Refer ceritificate detail. Supported in TLS,EAP_FAST_TTLS,PEAP | Long | None | None | None |
inner_identity | - | Integer | None | 3 | None |
outer_identity | The alternative name for the authentication. Supported in TTLS,PEAP,EAP-FAST | String | None | None | None |
use_pac | Allow exitinf pac url.Supported in EAP-FAST | Boolean | None | false | true,false |
provision_pac | To enable PAC while configuring Wi-fi.Supported in EAP-FAST | Boolean | None | false | true,false |
provision_pac_anonymous | Enables PAC anonymously. Supported in EAP-FAST | Boolean | None | false | true,false |
wifi_non_enterprise
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
password | Password for non-enterprise Wi-Fi connections. | String | None | None | None |
sample json 1
{
"auto_join": true,
"proxy_type": 0,
"proxy_pac_url": "",
"security_type": 3,
"wifi_enterprise": {
"ttls": false,
"eap_sim": false,
"peap": false,
"eap_fast": false,
"provision_pac": false,
"identity_certificate_id": -1,
"leap": false,
"user_name": "",
"provision_pac_anonymous": false,
"inner_identity": 3,
"password": "",
"use_pac": false,
"outer_identity": "",
"tls": false,
"certificate_id": -1,
"use_per_connection_pwd": false
},
"proxy_server_port": 0,
"proxy_server": "",
"hidden_network": false,
"service_set_identifier": "temp",
"proxy_user_name": "",
"proxy_password": ""
}
sample json 2
{
"auto_join": true,
"proxy_type": 0,
"proxy_pac_url": "",
"security_type": 3,
"sub_config":"WIFI_NON_ENTERPRISE",
"proxy_server_port": 0,
"proxy_server": "",
"hidden_network": false,
"wifi_non_enterprise": {
"password": ""
},
"service_set_identifier": "temp",
"proxy_user_name": "",
"proxy_password": ""
}
LDAP_POLICY
payload_id : 178
payload_name : ldappolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
account_display_name | Display name / description for the account to be confgiured. | String | None | None | None |
account_hostname | Host name of the LDAP server. | String | Required | None | None |
account_username | Username for authentication. Supports dynamic variable to fetch user specific information. | String | None | None | None |
account_password | Password of the configured account, for authentication | String | None | None | None |
use_ssl | Mandates the use of SSL for improved security. | Boolean | None | true | true, false |
CALDAV_POLICY/CALENDARS SYNC
payload_id : 179
payload_name : caldavpolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
account_name | Display name / description for the account to be configured. | String | None | None | None |
account_hostname | Host name for the calendar sync server. | String | Required | None | None |
account_port | Port number for the server. | Integer | Required | 8843 | None |
principal_url | Principal URL for the calendar to be synced. | String | None | None | None |
account_username | Username for authentication. Supports dynamic variable to fetch user specific information. | String | None | None | None |
account_password | Password of the configured account, for authentication | String | None | None | None |
use_ssl | Mandates the use of SSL for improved security. | Boolean | None | true | true, false |
SUBSCRIBED_CALENDARS_POLICY
payload_id : 180
payload_name : subscribedcalendarspolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
account_description | Display name / description for the account to be configured. | String | None | None | None |
calendar_url | URL of the calender file to be synced. | String | Required | None | None |
account_username | Username for authentication. Supports dynamic variable to fetch user specific information. | String | None | None | None |
account_password | Password of the configured account, for authentication | String | None | None | None |
use_ssl | Mandates the use of SSL for improved security. | Boolean | None | true | true, false |
CARDDAV_POLICY/CONTACTS SYNC
payload_id : 181
payload_name : carddavpolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
account_display_name | Display name / description for the account to be configured. | String | None | None | None |
account_hostname | Host Name for the contact sync server. | String | Required | None | None |
account_port | Port number of the server. | Integer | Required | 8843 | None |
principal_url | Principal URL for the contact sync server. | String | None | None | None |
account_username | Username for authentication. Supports dynamic variable to fetch user specific information. | String | None | None | None |
account_password | Password of the configured account, for authentication | String | None | None | None |
use_ssl | Mandates the use of SSL for improved security. | Boolean | None | true | true, false |
WEBCLIP_POLICY
payload_id : 182
payload_name : webclipspolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
webclip_label | Title for the web shortcuts to be displayed on the devices. | String | Required | None | None |
webclip_url | URL for creating the web shortcuts | String | Required | None | None |
is_removal | Prevents the user from removing the web shortcuts from the devices. | Boolean | None | true | true, false |
webclips_file_upload | Image to be used as the web shortcut icon. Enter the File ID of the uploaded file using the Files endpoint. | Long | None | None | None |
icon_file_name | FileId of the image. No need to post only in the return should consider as file url | Long | None | None | None |
use_precomp_icon | Restricts special effects on web shortcuts. | Boolean | None | false | true, false |
allow_full_screen | Determines whether the web shortcut should open in Safari or a different app. | Boolean | None | false | true, false |
APP_LOCK_POLICY/KIOSK_POLICY
payload_id : 183
payload_name : applockpolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
kiosk_mode | Type of Kiosk. 1- single app 2- multiple app | Integer | required | 1 | 1,2 |
disable_touch | Disables touch in the device. Applicable only for kiosk_mode 1. | Boolean | None | false | true, false |
disable_device_rotation | Disables screen rotation. Applicable only for kiosk_mode 1. | Boolean | None | false | true, false |
disable_volume_buttons | Disables volume button on the device. Applicable only for kiosk_mode 1. | Boolean | None | false | true, false |
disable_ringer_switch | Disables the ringer switch on the device. Applicable only for kiosk_mode 1. | Boolean | None | false | true, false |
disable_sleep_button | Disables the sleep button on the device. Applicable only for kiosk_mode 1. | Boolean | None | false | true, false |
disable_auto_lock | Disables Auto-Lock on the device. Applicable only for kiosk_mode 1. | Boolean | None | false | true, false |
voice_over | Disable VoiceOver on the device. Applicable only for kiosk_mode 1. | Boolean | None | true | true, false |
zoom | Disable zoom on the device. Applicable only for kiosk_mode 1. | Boolean | None | false | true, false |
invert_colors | Disable invert colors on the device. Applicable only for kiosk_mode 1. | Boolean | None | false | true, false |
asst_touch | Disable Assitive Touch on the device. Applicable only for kiosk_mode 1. | Boolean | None | false | true, false |
enable_speak_selection | Enable Speak Selection on the device. Applicable only for kiosk_mode 1. | Boolean | None | false | true, false |
enable_mono_audio |
Enable Mono Audio on the device. Applicable only for kiosk_mode 1. |
Boolean | None | false | true, false |
allowed_apps | The apps that should be available on devices in Kiosk. Only one array for kiosk_mode 1. | JSONArray | - | - | - |
autonomous_kiosk_apps | Autonomous kiosk apps. Applicable only for kiosk_mode 2. | JSONArray | - | - | - |
allowed_apps
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
app_id | App ID of the app. | Long | Required | None | None |
is_system_app | Whether the app is a system app. | Boolean | Required | false | true,false |
group_display_name | Display name of the app. | String | Required | None | None |
autonomous_kiosk_apps
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
app_id | App ID of the app. | Long | Required | None | None |
is_system_app | Whether the app is a system app. | Boolean | Required | false | true,false |
group_display_name | Display name of the app. | String | Required | None | None |
sample json 1
{
"kiosk_mode": 2,
"allowed_apps": "[{
"app_id":9007199254741861,
"is_system_app":false,
"group_display_name":"dock"
}
,{
"app_id":9007199254741335,
"is_system_app":false,
"group_display_name":"zoho expense"
}]",
}
sample json 2
{
"disable_touch": false,
"disable_ringer_switch": false,
"invert_colors": false,
"disable_volume_buttons": false,
"kiosk_mode": 1,
"allowed_apps": "[
{
"app_id":9007199254741861,
"is_system_app":false,
"group_display_name":"dock"
}]",
"enable_mono_audio": false,
"asst_touch": false,
"disable_sleep_button": false,
"disable_auto_lock": true,
"config_name": "app_lock_policy",
"enable_speak_selection": false,
"zoom": false,
"disable_device_rotation": false,
"voice_over": false
}
GLOBAL_HTTP_PROXY_POLICY
payload_id : 184
payload_name : globalhttpproxypolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
proxy_type | Type of proxy connection. 0 - None 1 - Manual 2 - Auto. If Manual connection is selected proxy_server & proxy_server_port is required. | Integer | Required | 1 | 0,1,2 |
proxy_server | Proxy server host name / IP address. | String | Required if proxy_type is 1 | None | - |
proxy_server_port | Proxy server port details. | Integer | Required if proxy_type is 1 | None | None |
proxy_user_name | Username for the proxy server. | String | None | None | None |
proxy_password | Password of the configured account for the proxy server. | String | None | None | None |
proxy_pac_url | The URL of the PAC with proxy configurations. | String | None | None | None |
ACCESS POINT NAME/APN_POLICY
payload_id : 187
payload_name : apnpolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
access_point_name | Name of the access point configured in the device. | String | Required | None | None |
access_point_username | Username for configuring the access points. Supports dynamic variable to fetch user specific information. | String | None | None | None |
access_point_password | Password for configuring the access points. | String | None | None | None |
proxy_server | Proxy server(if any) to connect to while configuring the access point. | String | None | None | None |
proxy_server_port | Port for the proxy server. | Integer | None | None | None |
WEB_CONTENT_FILTER_POLICY
payload_id : 188
payload_name : webcontentfilterpolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
enable_auto_filter | Enables auto filter. | Boolean | None | true | true, false |
malicious_content_filter | Madates if all malicious content must be blacklisted. | Boolean | None | true | true, false |
url_filter_type | Whether the mentioned URLs must be blacklisted or whitelisted. | Boolean | None | true | true, false |
create_bookmarks | Create bookmarks for the whitelisted URL. Applicable only if url_filter_type is true | Boolean | None | true | true, false |
url_details | List of URL that need to be blacklisted or whitelisted. | JSONArray | Required | None | None |
url_details
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
url | URL to be whitelisted or blacklisted. | String | Requried | None | None |
bookmark_path | Bookmark path of the URL. | String | None | None | None |
bookmark_titile | Title of the bookmark to be created. | String | None | None | None |
sample json
{
"url_details": "[
{
"bookmark_path":"home/",
"url":"https://zoho.com",
"bookmark_titile":"temp"
},{
"bookmark_path":"home/",
"url":"https://google.com",
"bookmark_titile":"temp"
}
]",
"malicious_content_filter": true,
"create_bookmarks": false,
"url_filter_type": true
"enable_auto_filter": true
}
IOS_CERTIFICATE_POLICY
payload_id : 515
payload_name : ioscertificatepolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
certificate_id | Certificate ID of the certificate created for authentication using the Certificates endpoint. | Long | None | None | None |
IOS_SCEP_POLICY
payload_id : 516
payload_name : iossceppolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
scep_config_id | SCEP Config ID of the configuration. Refer SCEP details | Long | None | None | None |
MANAGED_WEB_DOMAIN_POLICY
payload_id : 517
payload_name : managedwebdomainpolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
url_details | URL details of the webpages to be added as managed web domains. | JSONArray | Required | - | - |
url_details
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
url | URL for managed domain. | String | Requried | None | None |
sample json
{
"url_details": [
{
"url":"https://google.com"
},
{
"url":"https://*.facebook.com"
}]"
}
IOS_WALLPAPER_POLICY
payload_id : 518
payload_name : ioswallpaperpolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
set_wallpaper_position | Position of the wallpaper on the devices. 1-Lockscreen, 2- Homescreen and 3 - common for both 4 - Different for both | Integer | Required | - | - |
below_hdpi_wallpaper | Wallpaper/File ID for the homescreen wallpaper. | Long | Required if set_wallpaper_position is 2,3 & 4 | - | - |
below_hdpi_lock_wallpaper | Wallpaper/ File ID for the lockscreen wallpaper. | Long | Required if set_wallpaper_position is 1 & 4 | - | - |
is_below_hdpi_wall_modified | Specifies whether the homescreen wallpaper is modified. | Boolean | Required | false | true, false |
is_below_hdpi_lock_wall_modified | Specifies whether the lockscreen wallpaper is modified. | Boolean | Required | false | true, false |
allow_wallpaper_change | Mandates whether the user can modify the applied wallpaper. | Boolean | None | false | true, false |
AIRPRINT_POLICY
payload_id : 519
payload_name : airprintpolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
host_address | Specify the host name/ IP address of the printer to be configured. | String | None | None | None |
resource_path | Specify the resouce path of the printer to be configured. | String | None | None | None |
port | Port for the printer. Applicable only for iOS 11 & above. | Integer | None | None | None |
forcetls | Secure the printer communication by TLS. Applicable only for iOS 11 & above. | Boolean | None | false | true, false |
IOS_SSO_POLICY/ENTERPRISE_SSO_POLICY
payload_id : 520
payload_name : iosssopolicy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
account_display_name | Display name for the account to be configured. | String | Required | None | None |
account_type | Type of the account to be configured. 1.kerberos | Integer | None | None | None |
auth_type | Type of authentication. 1-Password & 2-Certificate | Integer | None | None | None |
kerberos_prinicpal_name | Principal name of kerberos. | String | None | None | None |
kerberos_realm | Relam of the kerberos. | String | Required | None | None |
client_cert_id | Identity certificate ID. | Long | None | None | None |
allowed_apps | List of allowed apps. Applicable only if all the apps are not specified. | JSONArray | None | None | None |
url_details | List of URL for which SSO should be enabled. | JSONArray | None | None | None |
allowed_apps
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
group_display_name | App display name for SSO policy. | String | Requried | None | None |
identifier | App identifier for SSO policy. | String | Required | None | None |
url_details
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
url | URL for configuring the SSO policy. | String | Requried | None | None |
sample json
{
"account_type": 1,
"account_display_name": "applesso",
"url_details": [
{
"url":"https://zoho.com"
}]",
"kerberos_realm": "msdam",
"allowed_apps": [{
"group_display_name":"corelocationagent",
"identifier":"com.apple.corelocationagent"
}]",
"client_cert_id": -1,
"kerberos_prinicpal_name": "principal",
"auth_type": 2
}
IOS_PER_APP_VPN
payload_id : 521
payload_name : iosperappvpn
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
connection_name | Name of the connection to be configured. | String | Required | - | - |
vpn_type | Type of the VPN to be configured. By default it is 1. | Integer | Required | - | - |
connection_type | Type of VPN connection. 3-Cisco IPSec(Legacy cisco),4-JuniperSSL,5-F5SSL,6-custom SSL,7-Pulse secure,9-Cisco Anyconnect,10-Sonciwall Mobile connect,11- Arubia Via &12- Checkpoint Mobile VPN | Integer | Required | 1 | - |
send_all_nw_traffic | Mandates if all the traffic should be routed through the VPN. | Boolean | None | false | true, false |
enable_vpn_on_demand | Mandates whether VPN on-demand must be enabled. | Boolean | None | false | true,false |
ondemandrule | - | - | - | - | - |
proxy_type | Type of the proxy. 0-None, 1-Manual,2-Auto | Integer | None | None | None |
proxy_server | Server address of the proxy to be configured. | String | Required if proxy type is 1 | None | None |
proxy_server_port | Sever port of the proxy to be configured. | String | Required if proxy type is 1 | None | None |
proxy_user_name | Username for authentication. Applicable only if proxy type is set to1 | String | None | None | None |
proxy_password | Credential used for authentication. Applicable only if proxy type is set to 1. | String | None | None | None |
proxy_pac_url | Proxy PAC URL. Applicable only if proxy type is set to 2. | String | None | None | None |
allowed_apps | Refer APP_LOCK_POLICY /KIOSK_POLICY | JSONObject | Required | None | None |
cisco | Cisco legacy configuration. Refer VPN_POLICY | JSONObject | Required if specific type. | None | None |
juniperssl | Juniper SSL configuration. Refer VPN_POLICY | JSONObject | Required if specific type. | None | None |
f5ssl | F5 SSL configuration. Refer VPN_POLICY | JSONObject | Required if specific type. | None | None |
ciscoanyconnect | Cisco Anyconnect configuration. Refer VPN_POLICY | JSONObject | Required if specific type. | None | None |
sonicwall | Sonicwall configuration. Refer VPN_POLICY | JSONObject | Required if specific type. | None | None |
arubavia | Arubavia configuration. Refer VPN_POLICY | JSONObject | Required if specific type. | None | None |
checkpoint | Checkpoint configuration. Refer VPN_POLICY | JSONObject | Required if specific type. | None | None |
customssl | CustomSSL configuration. Refer VPN_POLICY | JSONObject | Required if specific type. | None | None |
sample json
{
"provider_type": 1,
"connection_type": 9,
"ondemandrule": "",
"send_all_nw_traffic": false,
"ciscoanyconnect": {
"always_on": false,
"table_name": "vpncisco",
"fips_mode": false,
"vpn_connection_protocol": "",
"allowed_apps": "",
"strict_mode": false,
"group_name": "",
"keychain_cert_alias": "",
"account": "",
"password": "",
"user_authentication": 0,
"cert_revocation": false,
"server_name": "http://me.cicsovpn.com",
"certificate_id": -1,
"ipsec_auth_type": "",
"ike_identity": ""
},
"proxy_type": 0,
"proxy_server": "",
"proxy_server_port": 0,
"proxy_user_name": "",
"proxy_password": "",
"proxy_pac_url": "",
"vpn_type": 2,
"sub_config": "ciscoanyconnect",
"allowed_apps": "[{
"app_id":9007199254741295,
"is_system_app":false,
"group_display_name":"mosyle manager mdm for schools"
}]",
"ondemand_match_app_enabled": true,
"connection_name": "per-app vpn configuration",
"enable_vpn_on_demand": false
}
IOS_LOCK_SCREEN_MESSAGE
payload_id : 522
payload_name : ioslockscreenmessage
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
wallpaper_type | Type of wallpaper to be displayed on the device. 1-Custom wallpaper 2- uploaded wallpaper | Integer | Required | 1 | 1,2 |
bg_colour | Background colour of custom wallpaper. Value must be entered in Hex colour code. Applicable only if wallpaper_type is set to 1. | String | Required if wallpaper_type is 1 | None | None |
wallpaper | Wallpaper File ID for the wallpaper to be configured on the device. | Long | Required if wallpaper_type is 2 | None | None |
wallpaper_modified | Specifies whether the wallpaper can be modified. | Boolean | Required if wallpaper_type is 2 | false | true, false |
orientation | Orientation of the message to be displayed on the device lockscreen. | Integer | None | 1 | 1,2 |
messages | The message to be displayed on the device. | Array of JSONObject | Required | None | None |
messages
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
message | Message to be displayed on the device. | String | Requried | None | None |
text_colour | Color of the text. Value must be specified in Hex colour code. | String | Required | None | None |
offset_position | Offset position at which the text should be writtern. Usually specified in percentage. For first message, 35 is considered as the default value. | Integer | None | None | None |
sample json
{
"messages": [
{
"message": "this is fahath device .",
"text_colour": "#f2580c",
"offset_position": 35
},
{
"message": "dasd",
"text_colour": "#f2580c"
}
],
"wallpaper_type": 2,
"wallpaper": "9007199254741299",
"wallpaper_modified": true,
"orientation": 1
}
MAC_FILE_VAULT
payload_id : 523
payload_name : macfilevault
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
encryption_settings_id | Encryption setting ID. Refer MacFilevault. | Long | None | None | None |
IOS_CUSTOM_PROFILES
payload_id : 525
payload_name : ioscustomprofiles
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
custom_profile_file_id | File Id of the custom profiles. | Boolean | Long | true | -, - |
custom_profile_id | Custom profile id. Only available in get payload. No need to send in post payload. | Boolean | Long | - | -, - |
ANDROID PROFILES
ANDROID_WEB_CONTENT_FILTER
payload_id : 561
payload_name : ANDROID_WEB_CONTENT_FILTER
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
malicious_content_filter | Automatic restriction of malicious content true-- Yes false-- No |
Boolean | Required | true | true,false |
url_filter_type | Filter type true-- Whitelist false-- Blacklist |
Boolean | None | true | true,false |
url_details | URL details | String | None | JSONArray string. Format as mentioned below | |
enable_auto_filter | Should enable automatic enabling of explicit content filter - Hidden | Boolean | Required | true | true,false |
create_bookmarks | Should create bookmarks for whitelisted URLs - Hidden | Boolean | Required | true | true,false |
url_details
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
url | Url for whtelist or blacklist | String | Requried | None | None |
bookmark_path | Bookmark path Opens is url_filter_type is true and create_bookmarks is true |
String | None | None | None |
bookmark_titile | Title of the bookmark Opens is url_filter_type is true and create_bookmarks is true |
String | None | None | None |
Sample json for url_details for url_filter_type true
[
{
"URL": "https://www.google.com",
"BOOKMARK_TITILE": "dnsfj",
"BOOKMARK_PATH": "kjn"
}
{
"URL": "https://www.yahoo.com",
}
]
ANDROID_CERTIFICATE_POLICY
payload_id : 555
payload_name : ANDROID_CERTIFICATE_POLICY
ANDROID_EMAIL_POLICY
payload_id : 553
payload_name : ANDROID_EMAIL_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
account_name | Account Name | String | None | ||
account_type | Configure Email For 2-- Single User 1-- Multiple Users |
Integer | Required | 1 | 1,2 |
default_account | Set as Default Account | Boolean | Required | false | true,false |
incoming_protocol | Incoming Protocol IMAP-- IMAP POP3-- POP |
String | Required | IMAP | IMAP,POP3 |
incoming_server_hostname | Incoming Server Host Name | String | Required | ||
incoming_server_port | Incoming Port | Integer | Required | 143 | |
incoming_user_name | Incoming User Name. %username% fetched appropriate username mapped to the device | String | None | %username% | |
incoming_server_password | Password | String | None | ||
incoming_server_use_ssl | Secure Incoming Mail Communication - Use SSL | Boolean | None | true | true,false |
incoming_server_use_tls | Secure Incoming Mail Communication - Use TLS | Boolean | None | false | true,false |
incoming_server_certificate | Secure Incoming Mail Communication - Accept all certificate(s) | Boolean | None | true | true,false |
outgoing_protocol | Outgoing Protocol POP3-- POP SMTP-- SMTP |
String | Required | SMTPsss | SMTP,POP3 |
outgoing_server_hostname | Outgoing Server Host Name | String | Required | ||
outgoing_server_port | Outgoing Port | Integer | Required | 587 | |
outgoing_user_name | Outgoing User Name %username% fetched appropriate username mapped to the device | String | None | %username% | |
outgoing_server_password | Password | String | None | ||
outgoing_server_use_ssl | Secure outgoing Mail Communication - Use SSL | Boolean | None | true | true,false |
outgoing_server_use_tls | Secure outgoing Mail Communication - Use TLS | Boolean | None | false | true,false |
outgoing_server_certificate | Secure outgoing Mail Communication - Accept all certificate(s) | Boolean | None | true | true,false |
allow_html_content | Allow HTML Format | Boolean | Required | true | true,false |
allow_forward | Allow Forwarding Mails | Boolean | Required | true | true,false |
allow_notify | Allow Notifications | Boolean | Required | true | true,false |
allow_change_setting | Allow User to change settings | Boolean | Required | true | true,false |
signature | Signature to be appended in email | String | None | ||
mail_address | Email Address Opens only when account_type is 2 |
String | Required when account_type is 2 | ||
sender_name | Sender Name Opens only when account_type is 2 |
String | None |
ANDROID_KIOSK_POLICY
payload_id : 557
payload_name : ANDROID_KIOSK_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
kiosk_mode | Kiosk Mode 0-- Single App 1-- Multi App |
Integer | Required | 0 | 0 , 1 |
allowed_apps | List of apps | String | Required | JSONObject string of list of apps. See below for format | |
launcher_type | Choose the launcher to be used in kiosk mode Applicable for Non-Samsung devices provisioned as Device Owner and Samsung devices running 5.0 and above 1-- Default device launcher-Selecting device launcher will ensure the device retains the same look and feel. Only the apps selected in kiosk mode will be displayed and the rest of the apps and functionalities will be hidden. 2-- MDM launcher - A new MDM launcher will be added to the device. The apps selected in kiosk mode will be available on this launcher. Opens only if kiosk_mode is 1 |
Integer | Required | 2 | 2 , 1 |
wallpaper | Wallpaper image [Best Resolution: 960x800; Maximum size: 1 MB; Image Format: PNG,JPG;] |
FormFile | False | ||
is_wallpaper_removed | Is wallpaper image removed - Hidden | Boolean | required | false | true,false |
wallpaper_path | Wallpaper image path - Hidden | String | No | ||
show_me_mdm_app | Show ME MDM App Opens only if kiosk_mode is 1 |
Boolean | Required | true | true , false |
allow_status_bar | Status Bar | Boolean | Required | true | true , false |
allow_status_bar_expansion | Status Bar Expansion Samsung 4.3 or above Restricted - Users cannot access settings by expanding the status bar. You can however, allow the user to view/modify certain basic settings using custom settings app. |
Boolean | Required | true. False if allow_status_bar is false | true , false |
allow_volume_button | Volume Button | Boolean | Required | true | true , false |
allow_power_button | Power Button Restricted - When restricted, device needs to be restarted every time to turn the display on. For Non-Samsung devices running 9.0 or above, this prevents the device from being switched off. |
Boolean | Required | true | true , false |
allow_shutdown | Allow shutdown - Hidden | Boolean | Required | Same as value of allow_power_button | true,false |
allow_back_button | Back Button Samsung 4.3 and above |
Boolean | Required | true | true , false |
allow_key_guard | Unlock device without any passcode | Boolean | Required | true | true , false |
allow_system_error_dialog | Display app crash dialogs Note:Android 9.0 and above |
Boolean | Required | false | true , false |
allow_task_manager | Task Manager It is recommended to restrict Task Manager to prevent users from accessing App Settings and exiting Kiosk Mode on device. Samsung 4.3 and above |
Boolean | Required | true | true , false |
allow_home_button | Home Button-Hidden | Boolean | Required | true | true , false |
allow_notification | Allow notification -Hidden | Boolean | Required | true | true,false |
allow_recent_apps | Allow recent apps - Hidden | Boolean | Required | true | true,false |
allow_custom_settings | Custom settings enabled or not Use Custom Settings app to allow the users to view/modify certain basic settings Use Custom Settings app to allow the users to view/modify certain basic settings. |
Boolean | Required | true | true,false |
kiosk_custom_settings | Custom settings configuration | JSONObject | No |
allowed_apps Sample JSON format
{
"9007199254741039": {
"SHOW_APP_ICON": false,
"APP_GROUP_ID": "9007199254741039",
"GROUP_DISPLAY_NAME": "MyProfile2",
"IDENTIFIER": "com.facebook.katana",
"APP_TYPE": 1,
"DISPLAY_IMAGE_LOC": ""
}
}
kiosk_custom_settings
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
allow_wifi | Wi-Fi settings | Boolean | Required | true | true , false |
allow_flash_light | Flashlight | Boolean | Required | true | true , false |
allow_brightness | Brightness settings | Boolean | Required | true | true , false |
screen_orientation | Screen Rotation 4-- Landscape, 1-- Auto rotate, 2-- User Controlled, 3-- Portrait | Integer | Required | 2 | 2 , 1 , 3 , 4 |
screen_timeout | 0--user
controlled 15--15sec 30--30sec 60--1min 300--5MINS 1800--30MINS 2147483647--always_on |
Integer | Required | 0 | 0,15,30,60,300,1800,2147483647 |
ANDROID_HTTP_PROXY_POLICY
payload_id : 559
payload_name : ANDROID_HTTP_PROXY_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values | Supported for |
---|---|---|---|---|---|---|
proxy_type | Proxy Settings 1- Manual 2- Automatic |
Integer | Required | 1 | 2,1 | Automatic - Samsung : 5.1.1 and above Non-Samsung : Device Owner 5.0 and above Manual - Samsung : 4.4 and above Non-Samsung : Device Owner 5.0 and above |
proxy_server | Server. Opens if proxy_type is 1 | String | Required if proxy_type is 1 | None | None | |
proxy_server_port | Port. Opens if proxy_type is 1 | Integer | Required if proxy_type is 1 | None | None | |
proxy_user_name | Hidden | String | None | |||
proxy_password | Hidden | String | None | |||
proxy_pac_url | Server URL. Opens if proxy_type is 2 | String | Required if proxy_type is 2 | None | None | |
bypass_proxy_url | Bypass URLs | String | False | None | None | Android 5.0 and above |
ANDROID_RESTRICTIONS_POLICY
payload_id : 186
payload_name : ANDROID_RESTRICTIONS_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
allow_camera | Camera 1 - Allow 2 - Restrict Note: Android 4.0 or later Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 1, 2 |
allow_video_record | Video Recording 1 - Allow 2 - Restrict Samsung (OS 4.3 or above) Note : This is dependent of Camera |
Integer | None | 1 | 1, 2 |
allow_microphone | Microphone 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Microphone If this is disabled, users can use the microphone only for receiving and making calls. All other voice applications which requires microphone usage will be restricted. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_audio_record | Audio Recording 1 - Allow 2 - Restrict Samsung (OS 4.3 or above) Note : This is dependent of Microphone |
Integer | None | 1 | 1, 2 |
allow_firmware_recovery | Firmware Recovery 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_ota_upgrade | OS Upgrade 0 - Restrict 1 - Allow OS Upgrade By enabling this, users will be allowed to upgrade the OS on the device. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_screen_capture | Screen Capture 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) Screen Capture Screen capture is restricted only in work profile for devices enrolled as Profile Owner. |
Integer | None | 1 | 0, 1 |
allow_smart_clip_mode | Smart Clip Mode 0 - Restrict 1 - Allow Samsung (OS 5.0 or later) |
Integer | None | 1 | 0, 1 |
allow_s_voice | S Voice 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_user_add_accounts | Add Accounts 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_storage_encryption | Enforce Storage Encryption 1 - Yes 2 - No Android 3.0 or later Samsung (OS 4.3 or above) |
Integer | None | 2 | 1, 2 |
external_storage_encryption | Enforce SD Card Encryption 1 - Yes 2 - No Samsung (OS 4.3 or above) |
Integer | None | 2 | 1, 2 |
allow_factory_reset | Restore Factory Settings 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Restore Factory Settings By enabling this option, user will be allowed to reset factory settings. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_activation_lock | Reactivation Lock 0 - Restrict 1 - Allow Reactivation Lock Reactivation Lock prevents device activation by anyone else when the device is stolen or missing. With Reactivation Lock turned on, users will be required to enter their Samsung account credentials prior to starting a factory reset of the device. Samsung (OS 4.4 or later) |
Integer | None | 1 | 0, 1 |
allow_non_market_apps | Installing Non Market Apps 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Installing Non Market Apps Apps that are not available on Google Play Store Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_clipboard | Clip Board 0 - Restrict 1 - Allow Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_clipboard_share | Clipboard Share 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) Note : This is dependent of Clip Board |
Integer | None | 1 | 0, 1 |
allow_safe_mode | Safe Mode 0 - Restrict 1 - Allow Safe Mode Users enter this mode to boot device when the OS is corrupt or the device malfunctions. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_developer_mode | Developer Mode 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_share_list | "Share via" list 0 - Restrict 1 - Allow "Share via" list A list of Apps that can be used to share photos, videos etc. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_play_protect_monitoring | Google Play Protect 0 - User Controlled 1 - Always On Google Play Protect Google Play Protect regularly checks your apps and device for harmful behavior. If approved, it prompts the user to allow Google Play Protect to scan device for security threats. |
Integer | None | 0 | 0, 1 |
allow_google_backup | Backup data in Google Server 0 - Restrict 1 - Allow Backup data in Google Server By enabling this option, user will be allowed to back the device data in Google server. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_google_account_auto_sync | Google Account Auto Sync 0 - Restrict 1 - Allow Samsung (OS 4.4 or later) |
Integer | None | 1 | 0, 1 |
allow_google_crash_report | Report Crash to Google 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_sd_card | SD Card 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_sd_card_write | Storing Data in SD Card 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) Note : This is dependent of SD Card |
Integer | None | 1 | 0, 1 |
allow_sdcard_move | Move Apps to SD Card 0 - Restrict 1 - Allow Move Apps to SD Card Move applications installed in device memory to SD card. Samsung (OS 4.4 or later) Note : This is dependent of SD Card |
Integer | None | 1 | 0, 1 |
allow_usb_media_player | USB 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_usb_debug | Connections Using USB 0 - Restrict 1 - Allow Connections Using USB This option will allow you to use USB devices, for debugging purpose. Samsung (OS 4.3 or above) Note : This is dependent of USB |
Integer | None | 1 | 0, 1 |
allow_usb_host_storage | Connect a USB Storage Device 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) Note : This is dependent of USB |
Integer | None | 1 | 0, 1 |
allow_install_app | Users can install unapproved Apps 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Installing Apps Disabling this option will restrict the end user from installing Apps. However Apps can still be distributed via MDM App Repository. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_uninstall_app | Uninstalling Apps 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_android_market | Play Store 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_stop_system_app | Stop System App 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_app_notification_mode | Application Notification Mode 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_you_tube | You Tube 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_gmail | Gmail 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_s_finder | S Finder 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
app_permission_policy | Global App Permission Policy 6 - Auto Deny 4 - User Prompt 5 - Auto Grant Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. |
Integer | None | 4 | 4, 5, 6 |
allow_android_browser | Android Browser 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
browser_allow_fraud_warning | Fraud Warning Setting 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Fraud Warning Setting Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) Note : This is dependent of Android Browser |
Integer | None | 1 | 0, 1 |
browser_allow_popups | Pop-ups 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) Note : This is dependent of Android Browser |
Integer | None | 1 | 0, 1 |
browser_allow_javascript | JavaScript 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) Note : This is dependent of Android Browser |
Integer | None | 1 | 0, 1 |
browser_allow_autofill | Autofill 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) Note : This is dependent of Android Browser |
Integer | None | 1 | 0, 1 |
browser_allow_cookies | Cookies 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) Note : This is dependent of Android Browser |
Integer | None | 1 | 0, 1 |
allow_airplane_mode | Airplane Mode 0 - Restrict 1 - Allow Samsung (OS 4.4.2 or later) |
Integer | None | 1 | 0, 1 |
allow_background_data | Background Data 1 - Allow 2 - Restrict Samsung (OS 4.3 or above) |
Integer | None | 1 | 1, 2 |
allow_disabling_cellular_data | Disabling Cellular Data 1 - Allow 2 - Restrict Disabling Cellular Data Cellular data on the device will be used, only when the device is not connected to WiFi Samsung (OS 5.0 or below) |
Integer | None | 1 | 1, 2 |
allow_wifi | Wifi 6 - Always Off 4 - User Controlled 5 - Always On Android 2.3 or later Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) Wifi If WiFi is disabled on the device, end users will not have permissions to enable it. The managed mobile device will be out of network connectivity and even MDM server cannot reach the device until cellular data is enabled on the device |
Integer | None | 1 | 4, 5, 6 |
allow_wifi_direct | Wifi Direct 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) Note : This is dependent of Wifi |
Integer | None | 1 | 0, 1 |
allow_whitelist_wifi_only | Connect to wifi, only if distributed via MDM 0 - No 1 - Yes Android 2.3 or later Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) Note : This is dependent of Wifi |
Integer | None | 0 | 0, 1 |
allow_vpn | Allow users to configure VPN 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) VPN If restricted, only VPN configurations distributed via MDM can be used on the device. In Samsung devices, any previously user-configured VPNs will be deleted. |
Integer | None | 1 | 0, 1 |
allow_roaming_data | Roaming Data 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_roaming_sync | Sync Data while Roaming 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) Note : This is dependent of Roaming Data |
Integer | None | 1 | 0, 1 |
allow_roaming_push | Roaming Push 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) Note : This is dependent of Roaming Data |
Integer | None | 1 | 0, 1 |
allow_roaming_voice_calls | Voice Call While Roaming 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_nfc | NFC 4 - User Controlled 2 - Always Off 1 - Always On NFC Near-Field Communication (NFC) allows to establish a connection with a device in close proximty Samsung (OS 4.3 or above) |
Integer | None | 4 | 1, 2, 4 |
allow_android_beam | Android Beam 0 - Restrict 1 - Allow Android Beam Allows to establish a Bluetooth connection to rapidly share files and content such as web bookmarks, contacts etc. with other Android devices. Samsung (OS 4.3 or above) Note : This is dependent of NFC |
Integer | None | 1 | 0, 1 |
allow_s_beam | S Beam 0 - Restrict 1 - Allow S Beam Allows to establish a Wifi Direct connection between two Samsung devices for data transfer. Samsung (OS 4.3 or above) Note : This is dependent of NFC |
Integer | None | 1 | 0, 1 |
allow_bluetooth | Bluetooth 4 - User Controlled 2 - Always Off 1 - Always On Android 2.3 or later Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Profile Owner Enrolling device running Android 5.0 or later as Profile Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 4 | 1, 2, 4 |
allow_bt_discoverable | Bluetooth Discoverable 1 - Allow 2 - Restrict Samsung (OS 4.3 or above) Note : This is dependent of Bluetooth |
Integer | None | 1 | 1, 2 |
allow_bt_pairing | Bluetooth Pairing 1 - Allow 2 - Restrict Samsung (OS 4.3 or above) Note : This is dependent of Bluetooth |
Integer | None | 1 | 1, 2 |
allow_bt_outgoing_calls | Bluetooth Outgoing Calls 1 - Allow 2 - Restrict Samsung (OS 4.3 or above) Note : This is dependent of Bluetooth |
Integer | None | 1 | 1, 2 |
allow_bt_pc_connection | Bluetooth Desktop/Laptop Connection 1 - Allow 2 - Restrict Samsung (OS 4.3 or above) Note : This is dependent of Bluetooth |
Integer | None | 1 | 1, 2 |
allow_bt_data_transfer | Bluetooth Data Transfer 1 - Allow 2 - Restrict Samsung (OS 4.3 or above) Note : This is dependent of Bluetooth |
Integer | None | 1 | 1, 2 |
allow_tethering | 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) Tethering |
Integer | None | 1 | 0, 1 |
allow_bluetooth_tethering | 0 - Restrict 1 - Allow Bluetooth Tethering Samsung (OS 4.3 or above) Note : This is dependent of |
Integer | None | 1 | 0, 1 |
allow_wifi_tethering | 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) WiFi Tethering Note : This is dependent of |
Integer | None | 1 | 0, 1 |
allow_usb_tethering | USB Tethering 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) USB Tethering By enabling this option end user will be allowed to share the cellular network data through USB Note : This is dependent of |
Integer | None | 1 | 0, 1 |
allow_disabling_gps | Location Services 6 - Always Off 4 - User Controlled 5 - Always On Android 2.3 or later Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 4, 5, 6 |
allow_mock_location | Mock Location 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_google_maps | Google Maps 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_voice_dialer | Google Voice search 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_sms | SMS 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_incoming_sms | Incoming SMS 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) Note : This is dependent of SMS |
Integer | None | 1 | 0, 1 |
allow_outgoing_sms | Outgoing SMS 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) Note : This is dependent of SMS |
Integer | None | 1 | 0, 1 |
allow_mms | MMS 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_incoming_mms | Incoming MMS 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) Note : This is dependent of MMS |
Integer | None | 1 | 0, 1 |
allow_outgoing_mms | Outgoing MMS 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) Note : This is dependent of MMS |
Integer | None | 1 | 0, 1 |
allow_call | Call 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_incoming_call | Incoming Call 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) Note : This is dependent of Call |
Integer | None | 1 | 0, 1 |
allow_outgoing_call | Outgoing Call 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) Note : This is dependent of Call |
Integer | None | 1 | 0, 1 |
allow_use_network_time | Device time settings 0 - Select timezone manually 1 - Use network provider time Samsung (OS 4.3 or above) Use Network Time This restriction can be modified by the user. To restrict the device to use only Network time, enable this option and disable the Date/Time change option |
Integer | None | 1 | 0, 1 |
allow_timezone | Time Zone Samsung (OS 4.0 or later) Time Zone This option allows you to set the selected time zone to the user. This time zone cannot be modified by the user. |
String | None | None | Specific format , None |
allow_date_time_change | Date/Time Change 0 - Restrict 1 - Allow Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_user_creation | Add User 0 - Restrict 1 - Allow Add User Add User functionality can create multiple user in devices which support multi user functionality Device Owner Enrolling device running Android 5.0 or later as Device Owner provides advance configuration and management capabilities. Learn More. Samsung (OS 4.4.2 or later) |
Integer | None | 1 | 0, 1 |
allow_power_off | Turn Off the device using Power Button 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_background_process_limit | Background Process Limit 0 - Restrict 1 - Allow Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_kill_activity_on_leave | Killing Activity On Leave 0 - Restrict 1 - Allow Killing Activity On Leave End the current activity/app on the device, when the user exits. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_settings | Modify Devices default Settings 0 - Restrict 1 - Allow Modify Devices default Settings Disabling this option, end users will not be able access or modify any of the default settings on the mobile device. Samsung (OS 4.3 or above) |
Integer | None | 1 | 0, 1 |
allow_air_command | Air Command 0 - Restrict 1 - Allow Samsung (OS 4.4.4 or later) |
Integer | None | 1 | 0, 1 |
allow_air_view | Air View 0 - Restrict 1 - Allow Samsung (OS 4.4.4 or later) |
Integer | None | 1 | 0, 1 |
allow_date_time_settings | Modify Date/Time Settings false - Restrict true - Allow Android 9.0 and above running as Device Owner Modify Date/Time Settings Restricting this option prevents users from modifying timezone, time format etc. |
Boolean | None | true | false, true |
screen_timeout | Screen Timeout Android 9.0 and above running as Device Owner |
Integer | None | 5 | |
allow_config_screen_timeout | Modifying Screen Timeout settings false - true - Android 9.0 and above running as Device Owner Modifying Screen Timeout settings Restricting this ensures screen timeout duration given above or on the device, cannot be modified. |
Boolean | None | true | false, true |
brightness_value | Set Brightness Android 9.0 and above running as Device Owner |
Integer | None | 126 | 0 - 255 |
allow_brightness_config | Modifying Brightness settings false - true - Android 9.0 and above running as Device Owner Modifying Brightness settings Restricting this ensures brightness given above or on the device, cannot be modified. |
Boolean | None | true | false, true |
allow_ambient_display | Ambient Display false - true - Ambient Display Ambient Display is used for configuring notification settings on the lockscreen, when the device is asleep. Android 9.0 and above running as Device Owner |
Boolean | None | true | false, true |
adaptive_brightness | Adaptive Brightness | Boolean | None | true | true, false |
allow_printing | Printing false - Restrict true - Allow Android 9.0 and above |
Boolean | None | true | false, true |
ANDROID_WEBCLIPS_POLICY
payload_id : 560
payload_name : ANDROID_WEBCLIPS_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
webclip_label | Name of Web Shortcuts Label | String | Required | None | |
webclip_url | URL to be web clipped | String | Required | None | |
webclips_file_upload | Icon image as file | FormFile | False | None | |
allow_full_screen | Open Web Shortcuts in full screen or not 1.true-- Browser with restricted access - Restricted Access ensures the user can only access the contents of the specified URL and the links associated and prevents any other browser-related action. /help/profile_management/android/mdm_android_webclips.html#web_clips_display 2. false-- Browser |
Boolean | Required | false | true,false |
is_removal | Is image removed - Hidden | Boolean | Required | false |
ANDROID_WIFI_POLICY
payload_id : 556
payload_name : ANDROID_WIFI_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
service_set_identifier | Wireless Network Identification | String | Required | ||
auto_join | Connect to this Wi-Fi automatically | Boolean | Required | true | true,false |
security_type | Security Type 3-- 802.1x EAP 0-- None 2-- WPA/WPA2 PSK 1-- WEP |
Integer | Required | 0 | 0,1,2,3 |
proxy_type | Proxy Settings 1-- None 2-- Manual |
Integer | None | 0 | 1,2 |
proxy_server | Server. Opens if proxy_type is 2 |
String | Required if proxy_type is 2 | ||
proxy_server_port | Port. Opens if proxy_type is 2 |
Integer | Required if proxy_type is 2 | ||
bypass_proxy_url | Bypass URLs. Opens if proxy_type is 2 |
String | None | ||
wifi_non_enterprise | Wifi Non Enteprise configuration | JSONObject | Required if security_type is 1 or 2 | ||
wifi_enterprise | Wifi Enteprise configuration | JSONObject | Required if security_type is 3 |
wifi_non_enterprise
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
password | Password [Note : Minimum length should be 8] if security_type is 2 |
String | Required |
wifi_enterprise
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
peap | EAP method PEAP. Any one and only one of peap, tls, ttls, eap_fast must be true |
boolean | Required | true | true,false |
tls | EAP method TLS Any one and only one of peap, tls, ttls, eap_fast must be true |
boolean | Required | false | true,false |
ttls | EAP method TLES Any one and only one of peap, tls, ttls, eap_fast must be true |
boolean | Required | false | true,false |
eap_fast | EAP method EAP_PWD Any one and only one of peap, tls, ttls, eap_fast must be true |
boolean | Required | false | true,false |
inner_identity | Phase 2 Authentication 3-- MSCHAPV2 0-- None 2-- MSCHAP 4-- GTC 1-- PAP Opens if eap_fast is false |
Integer | Required | 3 | 0,4,3,2,1 |
user_name | Identity Specifying %username% fetches the user name, mapped to the device. |
String | None | ||
outer_identity | Anonymous Identity | String | None | ||
identity_certificate_id | Identity Certificate - Hidden | Long | None | -1,-3 | |
password | Password | String | None | ||
certificate_id | CA Certificate (Android 4.3 and above) | Long | None | -1 |
ANDROID_EXCHANGE_ACTIVE_SYNC_POLICY
payload_id : 554
payload_name : ANDROID_EXCHANGE_ACTIVE_SYNC_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
account_name | Account Name | String | False | Corporate E-mail | |
host_type | Exchange Host type True-Office 365 / Exchange Online False-Exchange On-Premise |
Boolean | Required | true | true,false |
active_sync_host | Exchange Server. Not editable if host_type is true - Value outlook.office365.com |
String | Required | if host_type is true - Value outlook.office365.com | |
account_type | Configure Exchange Account For 1-- Multiple Users 2-- Single User Opens only if host_type is false |
Integer | Required only if host_type is false | 1 | 1,2 |
user_name | User Name Use %upn% to map the appropriate user name associated with device Opens if host_type is true Opens if host_type is false and account_type is 2 |
String | Required only if host_type is true | %upn% | |
identity_cert_id | Identity Certificate | Long | Required | -1 | |
use_ssl | Use SSL | Boolean | Required | true | true,false |
accept_all_certificates | Accept All Certificate(s) | Boolean | Required | true | true,false |
default_account | Set as Default Account | Boolean | Required | true | true,false |
retrival_size | Email Retrieval Size 1-- 0.5 KB 6-- 20 KB 5-- 10 KB 3-- 2 KB 9-- Unlimited 2-- 1 KB 4-- 5 KB 0-- Header Only 7-- 50 KB 8-- 100 KB |
Integer | Required | 9 | 0,1,2,3,4,5,6,7,8,9 |
allow_change_mail_settings | Allow Users To Modify Account Settings | Boolean | Required | true | true,false |
allow_forward_email | Allow forwarding mails to mailboxes on the same device | Boolean | Required | true | true,false |
allow_html_content | Allow HTML Format | Boolean | Required | true | true,false |
incoming_attachment_max_size | Allow Incoming Attachments 1-- Upto 1 MB 5-- Upto 5 MB 100-- Upto 100 MB 200-- Upto 200 MB 50-- Upto 50 MB 0-- Unlimited 20-- Upto 20 MB 10-- Upto 10 MB -1-- Never |
Integer | Required | 0 | -1,1,5,10,20,50,100,200,0 |
signature | Signature to append in emails Enter the details to be added to the pre-defined signature. Make use of dynamic variables %username%, %email% to fetch the username and email mapped to the devices.x |
String | Required | ||
allow_notify | Notifications on incoming emails | Boolean | Required | true | true,false |
allow_always_vibrate | Vibrate on incoming mails | Boolean | Required | false | true,false |
sync_mail | Sync Mail. Cannot disable | Boolean. | Required | true | true |
sync_calandar | Sync calendar | Boolean | Required | true | true,false |
sync_contacts | Sync contacts | Boolean | Required | true | true,false |
sync_notes | Sync notes | Boolean | Required | true | true,false |
sync_tasks | Sync tasks | Boolean | Required | true | true,false |
off_peak_days_sycn_frequency | Sync Schedule 1-- Manually 240-- 4 Hrs 60-- 60 Minutes 30-- 30 Minutes 15-- 15 Minutes 2-- Automatically |
Integer | False | 2 | 1,2,15,30,60,240 |
past_days_mail_to_sync | Sync Mails From 1-- Last One day 5-- Last month 3-- Last week 2-- Last Three days 4-- Last Two weeks 0-- Unlimited |
Integer | False | 2 | 1,2,3,4,5,0 |
past_days_to_calander_sync | Sync Calendar From 5-- Last month 6-- Last Three months 4-- Last Two weeks 0-- Unlimited 7-- Last Six months Opens only if sync_calandar is true |
Integer | False | 5 | 4,5,6,7,0 |
roaming_settings | Sync While Roaming 1-- Use the above settings 0-- Manual |
Integer | False | 1 | 0,1 |
peak_days_sycn_frequency | Sync Schedule during Peak Days 1-- Manually 240-- 4 Hrs 60-- 60 Minutes 30-- 30 Minutes 15-- 15 Minutes 2-- Automatically |
Integer | Required | 2 | 1,2,15,30,60,240 |
peak_start_mins | Peak Hours Start time | Integer | False | 8 | 1 to 24 |
peak_end_mins | Peak Hours end time | Integer | False | 17 | 1 to 24 |
domain | Domain - Opens only if host_type is false and account_type is 2 %domainname% will fetch appropriate domain name mapped to device |
String | False | %domainname% | |
email_address | E-mail %email% will fetch appropriate domain name mapped to device Opens only if host_type is false and account_type is 2 |
String | Required if | %email% | |
password | Password Opens only if host_type is false and account_type is 2 |
String | No | ||
peak_days | Peak days for advanced sync settings Value should be sum of selcted values -64-Saturday, 32-Friday, 16-Thurs, 8-Wed, 4-Tue, %domainname%-Mon, 1-Sun |
Integer | No | 0 - if no days selected | Sum of any combination of 1,2,4,8,16,32,64 |
ANDROID_PASSCODE_POLICY
payload_id : 185
payload_name : ANDROID_PASSCODE_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
scope_for_passcode | Specify the Scope in which this Passcode Policy should gets enforeced 1 - Work profile 0 - Device |
Integer | Required | 0 | 0,1 |
passcode_type | Minimum Passcode Type Reuired -1 - None 1 - Simple Value(Pattern) 2 - Numbers 3 - Alphabets 4 - AlphaNumeric 5 - Complex Value |
Integer | Required | -1 | -1,1,2,3,4,5 |
min_passcode_length | Minimum Passcode Length to be set -1 - None (Applicable for passcode_type 2,3,4,5) |
Integer | None | -1 | -1, 4-16 |
max_failed_attempts | Maximum number of failed attempts -1 - None (Note : Device will be completely wiped if the number of failed attempts exceeds the limit defined) |
Integer | None | -1 | -1, 4-16 |
auto_lock_idle_for | Maximum idle time allowed before auto-lock, (seconds) | Integer | None | 0 | 5 - 1800 |
no_of_passcode_maintained | Number of passcodes to be maintained in history | Integer | None | 0 | 0 - 100 |
max_passcode_age | Maximum passcode age in days after which password will get expired and prompt for new | Integer | None | 0 | 0 - 1000 |
grace_period | Minutes after which passcode policy will get enforced (Minutes) | Integer | None | 60 | 1 - 1000 |
max_chars | Maximum Repetition of Characters (Applicable for passcode_type 5 ) |
Integer | None | 0 | 1 - 16 |
max_numeric_sequence | Maximum Numeric Sequence (Applicable for passcode_type 5) |
Integer | None | 0 | 1 - 16 |
min_upper_case_length | Minimum Uppercase length -1 - None (Applicable for passcode_type 5) |
Integer | None | -1 | -1, 1 - 5 |
min_lower_case_length | Minimum lowercase letter length -1 - None (Applicable for passcode_type 5) |
Integer | None | -1 | -1, 1 - 5 |
min_letter_length | Minimum letter length -1 - None (Applicable for passcode_type 5) |
Integer | None | -1 | -1, 1 - 5 |
min_non_letter_length | Minimum Non-Alphabetic Characters -1 - None (Applicable for passcode_type 5) |
Integer | None | -1 | -1, 1 - 5 |
min_numeric_length | Minimum numeric length -1 - None (Applicable for passcode_type 5) |
Integer | None | -1 | -1, 1 - 5 |
min_symbol_length | Minimum symbol length -1 - None (Applicable for passcode_type 5) |
Integer | None | -1 | -1, 1 - 5 |
allow_one_lock | Prevent usage of same passcode for both device and work profile false - Yes true - No |
Boolean | None | true | true, false |
allow_fingerprint | Unlock Device using Fingerprint 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
allow_iris_scan | Iris scanning false - Restrict true - Allow |
Boolean | None | true | true, false |
allow_face_unlock | Face Scanning false - Restrict true - Allow |
Boolean | None | true | true, false |
ANDROID_APN_POLICY
payload_id : 562
payload_name : ANDROID_APN_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
access_point_name | Access Point Name | String | Required | None | None |
access_point_user_name | APN User Name. Opens only when android_apn_extension.auth_type is 1,2 or 3 Use the dynamic variables if APN details has been uploaded previously. You can add the details for each device or add it in bulk, by clicking Bulk Edit Device Details under Devices in the Inventory tab. |
String | False | %apn_username% | None |
access_point_passowrd | APN Password. Opens only when android_apn_extension.auth_type is 1,2 or 3 Use the dynamic variables if APN details has been uploaded previously. You can add the details for each device or add it in bulk, by clicking Bulk Edit Device Details under Devices in the Inventory tab. |
String | False | %apn_password% | None |
proxy_server | Proxy Server name | String | False | None | None |
proxy_server_port | Proxy Port Name | Integer | False | None | None |
android_apn_extension | other APN configuration | JSONObject | None | None | None |
android_apn_extension
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
name | APN Configuration display Name | String | True | Same as value of access_point_name | None |
auth_type | Authentication Type 1- PAP -1- Not set 0- None 3- PAP Or CHAP 2- CHAP |
Integer | Required | -1 | -1,0,1,2,3 |
server | Server Address | String | None | None | None |
protocol | Protocol 1- IPV6 3- PPP 0- IPV4 2- IPV4 Or IPV6 |
Integer | Required | 0 | 0,1,2,3 |
mcc | Mobile Country Code (MCC) Refer to this for identifying the MCC and MNC of your country- https://en-wikipedia-org/wiki/Mobile_country_code | String | Required | None | None |
mnc | Mobile Network Code (MNC) Refer to this for identifying the MCC and MNC of your country- https://en-wikipedia-org/wiki/Mobile_country_code | String | Required | None | None |
type | Access Point Type | String | Required | Default | Comma separated combinations of Default,MMS,SUPL,DUN,HIPRI,CBS,Emergency,FOTA,IA,IMS |
mmsc | MMS Server Address- Opens only if type contains MMS | String | Required if type contains MMS | None | None |
mms_proxy | MMS Proxy Address- Opens only if type contains MMS | String | None | None | None |
mms_port | MMS Port Number- Opens only if type contains MMS | String | None | None | None |
roaming_protocol | Roaming Protocol 1- IPV6 3- PPP 0- IPV4 2- IPV4 Or IPV6 |
Integer | Required | 0 | 0,1,2,3 |
is_prefered_apn | Use as Default APN true- Yes false- No |
Boolean | False | true | true,false |
mvno | Mobile Virtual Network Operator(MVNO) 1- ICCID -1- Select 0- GID 3- SPN 2- IMSI |
Integer | Required | -1 | -1,0,1,2,3 |
ANDROID_WALLPAPER_POLICY
payload_id : 558
payload_name : ANDROID_WALLPAPER_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values | Supported for |
---|---|---|---|---|---|---|
below_hdpi_wallpaper | Low density image file | FormFile | No | None | None | |
above_hdpi_wallpaper | High density image file | FormFile | No | None | None | |
allow_wallpaper_change | Allow User to change Wallpaper false No true Yes |
Boolean | None | true | true,false | Samsung 4.3 and above |
below_hdpi_wallpaper_path | Low density wallpaper path | String | No | None | ||
above_hdpi_wallpaper_path | High density wallpaper path | String | No | None | ||
is_below_hdpi_wall_modified | Whether low density wallpaper is modified | Boolean | Required | None | ||
is_above_hdpi_wall_modified | Whether high density wallpaper is modified | Boolean | Required | None | ||
set_wallpaper_position | Hidden | 3 |
ANDROID_VPN_POLICY
payload_id : 564
payload_name : ANDROID_VPN_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values | Supported for |
---|---|---|---|---|---|---|
connection_name | Connection Name | String | Required | VPN Configuration | ||
connection_type | Connection Type 19-- L2TP PSK 5-- F5 SSL 9-- Cisco AnyConnect 14-- IPSec XAuth PSK 7-- Pulse Secure 16-- IPSec IKEv2 PSK 1-- PPTP 13-- Palo Alto |
Integer | Requied | 19 | '19', '1', '16', '14', '9', '13', '5', '7' | 19,1,16,14-Applicable only for Samsung devices running Android 6.0 or later
versions. Others-Needs respective app to be installed |
l2tp | L2TP configuration | JSONObject | Required if connection_type is 19 | None | None | |
pptp | PPTP configuration | JSONObject | Required if connection_type is 1 | None | None | |
ipsec | IPSEC configuration | JSONObject | Required if connection_type is 16,14 | None | None | |
juniperssl | juniperssl configuration | JSONObject | Required if connection_type is 7 | None | None | |
f5ssl | F5SSL configuration | JSONObject | Required if connection_type is 5 | None | None | |
ciscoanyconnect | Cisco anyconnect configuration | JSONObject | Required if connection_type is 9 | None | None | |
paloalto | Palo alto configuration | JSONObject | Required if connection_type is 13 | None | None |
l2tp
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server Name/IP Address | string | Required | ||
account | Username Specifying %username% fetches the user name, mapped to the device |
string | No | ||
password | Password | string | No | ||
shared_secret | Shared Secret | string | Required | ||
is_l2tp_secret_enabled | Enable/disable Secret Key | boolean | Required | false | true,false |
l2tp_secret | L2TP secret key | string | No | None | |
ipsec_identifier | IPSec Identifier | String | No |
pptp
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server Name/IP Address | String | Required | ||
account | Username Specifying %username% fetches the user name, mapped to the device. |
string | No | ||
password | Password | string | No |
ipsec
field name | description | type | required | default value | allowed values |
---|---|---|---|---|---|
server_name | Server Name/IP Address | String | Required | ||
account | Username Specifying %username% fetches the user name, mapped to the device. |
String | No | ||
password | Password | string | No | ||
shared_secret | Shared Secret | string | Required | ||
ipsec_identifier | IPSec Identifier | String | No |
juniperssl
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server Name/IP Address | String | Required | ||
auth_type | Authentication Type 2-- Account based authentication 3-- Dual authentication 1-- Certificate based authentication |
Integer | False | 3 | 1,2,3 |
account | Username Specifying %username% fetches the user name, mapped to the device. Opens if auth_type is 3,2 |
String | No | ||
password | Password Opens if auth_type is 3,2 |
string | No | ||
certificate_id | Identity Certificate Pre-requisites -The device must be passcode-protected for the certificate to be associated to the device. Opens if auth_type is 3,1 |
long | No | -1 | |
realm | Realm | String | False | ||
role | Role | String | False | ||
is_deafault_vpn | Make this VPN Configuration default | Boolean | Required | false | true,false |
route_type | Route type. 0-Device 1-Application |
integer | Required | 0 | 0,1 |
uiless_auth | UI-less auth | boolean | Required | False | true,false |
keychain_cert_alias | Key chain certificate alias - Hidden | string | None |
f5ssl
field name | description | type | required | default value | allowed values |
---|---|---|---|---|---|
server_name | Server Name/IP Address | String | Required | ||
account | Username | String | No | ||
password | Password | string | No | ||
certificate_id | Identity Certificate Pre-requisites - The device must be passcode-protected for the certificate to be associated to the device. |
long | No | -1 | |
fips_mode | FIPS Mode | boolean | Required | false | true,false |
web_logon_mode | Web logon | boolean | Required | false | true,false |
disallow_user_config | Allow user to configure VPN | boolean | Required | false | true,false |
user_message | Restriction Message to be displayed | string | None | ||
keychain_cert_alias | Key chain certificate alias - Hidden | string | None |
ciscoanyconnect
field name | description | type | required | default value | allowed values |
---|---|---|---|---|---|
server_name | Server Name/IP Address | String | Required | ||
vpn_connection_protocol | Connection Protocol vpn_connection_protocol_ipsec-- IPsec vpn_connection_protocol_ssl-- SSL |
string | Required | vpn_connection_protocol_ssl | vpn_connection_protocol_ssl,vpn_connection_protocol_ipsec |
ipsec_auth_type | Authentication Type EAP-MD5-- EAP-MD5 EAP-GTC-- EAP-GTC EAP-MSCHAPv2-- EAP-MSCHAPv2 IKE-RSA-- IKE-RSA EAP-AnyConnect-- EAP-AnyConnect |
string | Required | EAP-AnyConnect | EAP-AnyConnect,EAP-GTC,EAP-MD5,EAP-MSCHAPv2,IKE-RSA |
ike_identity | IKE Identity | string | No | ||
certificate_id | Identity Certificate | long | No | -1 | |
cert_revocation | Certificate Revocation | boolean | Required | false | true,false |
fips_mode | FIPS Mode | boolean | Required | false | true,false |
strict_mode | Strict Mode | boolean | Required | false | true,false |
keychain_cert_alias | Key chain certificate alias - Hidden | string | None |
paloalto
field name | description | type | required | default value | allowed values |
---|---|---|---|---|---|
server_name | Server Name/IP Address | String | Required | ||
account | Username Specifying %username% fetches the user name, mapped to the device. |
string | No | ||
password | Password | string | No | ||
certificate_id | Identity Certificate | long | No | -1 | |
keychain_cert_alias | Key chain certificate alias - Hidden | string | None |
ANDROID_EFRP_POLICY
payload_id : 565
payload_name : ANDROID_EFRP_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
efrp_details | Account details for the accounts added | String | Required | None | JSONArray string of JSONObject of format efrp_detail. See below for format |
efrp_detail
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
email_user_id | Email user ID got from steps /help/profile_management/android/android_enterprise_factory_reset_protection.html?mdmpi#google_link | String | Required | -- | |
email_id | Email ID | String | Required | -- |
efrp_details- Sample JSON format
[
{
"EMAIL_USER_ID": "358797364893708434",
"EMAIL_ID": "user@zylker.com"
}
{
"EMAIL_USER_ID": "3587897364893708434",
"EMAIL_ID": "mdm@gmail.com"
}
]
Android Knox profiles
ANDROID_PASSCODE_POLICY - KNOX
payload_id : 185
payload_name : ANDROID_PASSCODE_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
Integer | Required | 0 | 0,1 | ||
passcode_type | Minimum Passcode Type Reuired -1 - None 1 - Simple Value(Pattern) 2 - Numbers 3 - Alphabets 4 - AlphaNumeric 5 - Complex Value |
Integer | Required | -1 | -1,1,2,3,4,5 |
min_passcode_length | Minimum Passcode Length to be set -1 - None (Applicable for passcode_type 2,3,4,5) |
Integer | None | -1 | -1, 4-16 |
max_failed_attempts | Maximum number of failed attempts -1 - None (Note : Device will be completely wiped if the number of failed attempts exceeds the limit defined) |
Integer | None | -1 | -1, 4-16 |
auto_lock_idle_for | Maximum idle time allowed before auto-lock, (seconds) | Integer | None | 0 | 5 - 1800 |
no_of_passcode_maintained | Number of passcodes to be maintained in history | Integer | None | 0 | 0 - 100 |
max_passcode_age | Maximum passcode age in days after which password will get expired and prompt for new | Integer | None | 0 | 0 - 1000 |
grace_period | Minutes after which passcode policy will get enforced (Minutes) | Integer | None | 60 | 1 - 1000 |
max_chars | Maximum Repetition of Characters (Applicable for passcode_type 5 ) |
Integer | None | 0 | 1 - 16 |
max_numeric_sequence | Maximum Numeric Sequence (Applicable for passcode_type 5) |
Integer | None | 0 | 1 - 16 |
min_upper_case_length | Minimum Uppercase length -1 - None (Applicable for passcode_type 5) |
Integer | None | -1 | -1, 1 - 5 |
min_lower_case_length | Minimum lowercase letter length -1 - None (Applicable for passcode_type 5) |
Integer | None | -1 | -1, 1 - 5 |
min_letter_length | Minimum letter length -1 - None (Applicable for passcode_type 5) |
Integer | None | -1 | -1, 1 - 5 |
min_non_letter_length | Minimum Non-Alphabetic Characters -1 - None (Applicable for passcode_type 5) |
Integer | None | -1 | -1, 1 - 5 |
min_numeric_length | Minimum numeric length -1 - None (Applicable for passcode_type 5) |
Integer | None | -1 | -1, 1 - 5 |
min_symbol_length | Minimum symbol length -1 - None (Applicable for passcode_type 5) |
Integer | None | -1 | -1, 1 - 5 |
allow_one_lock | Prevent usage of same passcode for both device and work profile false - Yes true - No |
Boolean | None | true | true, false |
allow_fingerprint | Unlock Device using Fingerprint 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
ANDROID_RESTRICTIONS_POLICY - KNOX
payload_id : 186
payload_name : ANDROID_RESTRICTIONS_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
allow_camera | Camera 1 - Allow 2 - Restrict |
Integer | None | 1 | 1, 2 |
allow_video_record | Video Recording 1 - Allow 2 - Restrict |
Integer | None | 1 | 1, 2 |
allow_microphone | Microphone 1 - Allow 0 - Restrict Microphone If this is disabled, users can use the microphone only for receiving and making calls. All other voice applications which requires microphone usage will be restricted. |
Integer | None | 1 | 0, 1 |
allow_audio_record | Audio Recording 1 - Allow 2 - Restrict |
Integer | None | 1 | 1, 2 |
allow_s_voice | S Voice 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
allow_install_app | Installing Apps 1 - Allow 0 - Restrict Installing Apps Disabling this option will restrict the end user from installing Apps. However Apps can still be distributed via MDM App Repository. |
Integer | None | 1 | 0, 1 |
allow_uninstall_app | Uninstalling Apps 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
allow_stop_system_app | Stop System App 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
allow_android_market | Play Store 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
allow_knox_app_store | KNOX app store 1 - Allow 2 - Restrict |
Integer | None | 1 | 1, 2 |
allow_you_tube | You Tube 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
allow_app_notification_mode | Application Notification Mode 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
allow_screen_capture | Screen Capture 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
allow_android_browser | Android Browser 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
browser_allow_fraud_warning | 1 - Allow 0 - Restrict Fraud Warning Setting |
Integer | None | 1 | 0, 1 |
browser_allow_popups | Pop-ups 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
browser_allow_javascript | JavaScript 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
browser_allow_autofill | Autofill 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
browser_allow_cookies | Cookies 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
allow_voice_dialer | Google Voice search 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
allow_clipboard | Clip Board 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
allow_clipboard_share | Clipboard Share 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
allow_non_secure_keypad | Third Party Keypad 1 - Allow 2 - Restrict |
Integer | None | 1 | 1, 2 |
allow_contact_to_device | Share "Contacts" with the device 1 - Allow 2 - Restrict |
Integer | None | 1 | 1, 2 |
allow_share_list | Share List 1 - Allow 0 - Restrict Share List A list of Apps that can be used to share photos, videos etc. |
Integer | None | 1 | 0, 1 |
allow_google_account_auto_sync | Google Account Auto Sync 1 - Allow 0 - Restrict |
Integer | None | 1 | 0, 1 |
allow_google_crash_report | Report Crash to Google 1 - Allow 0 - Restrict Report Crash to Google By enabling this option Google crash reports will be notified. |
Integer | None | 1 | 0, 1 |
allow_sdcard_move | Move Apps to SD Card 1 - Allow 0 - Restrict Move Apps to SD Card Move applications installed in device memory to SD card. |
Integer | None | 1 | 0, 1 |
ANDROID_VPN_POLICY -- KNOX
payload_id : 564
payload_name : ANDROID_VPN_POLICY
Same as ANDROID_VPN_POLICY
ANDROID_EMAIL_POLICY -- KNOX
payload_id : 553
payload_name : ANDROID_EMAIL_POLICY
Same as ANDROID_EMAIL_POLICY
ANDROID_VPN_POLICY -- KNOX
payload_id : 564
payload_name : ANDROID_VPN_POLICY
Same as ANDROID_VPN_POLICY
Chrome device profiles
CHROME_RESTRICTIONS_POLICY
payload_id : 706
payload_name : CHROME_RESTRICTIONS_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
guest_mode | Guest Mode 1 -Disable 2 - Enable 0 - Unspecifed - Hidden value |
Integer | Required | 2 | 0, 1, 2 |
epheremal_mode | Ephemeral Mode 1 - Disable 2- Enable 0 - Unspecified - Hidden value |
Integer | Required | 2 | 0, 1, 2 |
forced_reenrollment | Forced Re-Enrollment 1 - Disable 2- Enable 0 - Unspecified - Hidden value |
Integer | Required | 2 | 0, 1, 2 |
redirect_to_saml | Redirect to SAML 1 - Disable 2- Enable 0 - Unspecified - Hidden value |
Integer | Required | 2 | 0, 1, 2 |
transfer_saml_cookies | Transfer SAML Cookies 1 - Disable 2- Enable 0 - Unspecified - Hidden value |
Integer | Required | 2 | 0, 1, 2 |
allowed_users_to_signin | Users permitted to sign in | String | No | ||
autocomplete_domain_name | Auto-complete domain name when logging in | String | No | ||
time_zone_mode | Mode of setting timezone 0--Select timezone manually 1--Automatic timezone detection |
Integer | Required | 1 | 0,1 |
time_zone | Timezone to set in device manually. Opens only if time_zone_mode is 0 | String | Required if time_zone_mode is 0 | Greenwich | All timezones. Refer time zone values for available zones |
time_zone_detection | Automatic detection of timezone 1--User Controlled 2--Automatic Detection disabled 3--Automatic Detection using IP only 4--Automatic Detection by using visible APNs 5--Automatic detection by using all location info Opens only if time_zone_mode is 1 |
Integer | Required if time_zone_mode is 1 | 1 | 1,2,3,4,5 |
CHROME_WIFI_POLICY
payload_id : 701
payload_name : CHROME_WIFI_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
service_set_identifier | Wireless Network Identification | String | Required | ||
auto_join | Connect to this Wi-Fi automatically false - No true - Yes |
Boolean | No | true | false, true |
hidden_network | Hidden Network (SSID is broadcast or not) false - No true - Yes |
Boolean | No | false | false, true |
security_type | Security Type 5 - WPA/WPA2 Enterprise 4 - Dynamic WEP 0 - None 2 - WPA/WPA2 1 - WEP |
Integer | No | 3 | 0, 1, 2, 4, 5 |
wifi_non_enterprise | Wifi non enterprise configuration | JSONObject | Required if security_type is 1 or 2 | ||
wifi_enterprise | Wifi enterprise configuration | JSONObject | Required if security_type is 4 or 5 | ||
proxy_settings | Proxy configuration | JSONObject | Required |
CHROME_ETHERNET_POLICY
payload_id : 702
payload_name : CHROME_ETHERNET_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
type | Authentication Type 4 - Enterpise(802.1X) 0 - None |
Integer | False | 0 | 0, 4 |
ethernet_enterprise | Ethernet enterprise configuration | JSONObject | Required if type is 4 | ||
proxy_settings | Proxy configuration | JSONObject | Required |
ethernet_enterprise
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
peap | Protocol supported PEAP. Any one and only one of peap, tls, ttls, leap must be true |
boolean | Required | true | true,false |
tls | Protocol supported TLS Any one and only one of peap, tls, ttls, leap must be true |
boolean | Required | false | true,false |
ttls | Protocol supported TTLS Any one and only one of peap, tls, ttls, leap must be true |
boolean | Required | false | true,false |
leap | Protocol supported LEAP Any one and only one of peap, tls, ttls, leap must be true |
boolean | Required | false | true,false |
inner_identity | Inner Protocol 3 - MSCHAP2 4 - Automatic 2 - MSCHAP 5 - MD5 6 - GTC 0 - PAP Opens if ttls is true or peap is true |
Integer | Required if ttls is true or peap is true | 3 | 0, 2, 3, 4, 5, 6 |
user_name | User Name Specifying %username% fetches the user name, mapped to the device |
String | No | ||
password | Password Opens if tls is false |
String | No | ||
certificate_id | CA certificate Opens if either ttls is true or peap is true |
Long | None | -1 | |
outer_identity | Externally Visible identification Opens if either ttls is true or peap is true |
String | No |
CHROME_KIOSK_POLICY
payload_id : 705
payload_name : CHROME_KIOSK_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
kiosk_mode | Kiosk Mode 1 - Multi App 0 - Single App |
Integer | Required | 0 | 0, 1 |
allowed_apps | Allowed Apps | String | Required | JSONObject string. Format mentioned below | |
bailout_enabled | Bailout false - Disable true - Enable Opens only if kiosk_mode is 0 Allow/Restrict users from preventing auto-provisioning of Kiosk by using the key combination(Ctrl+Alt+S) within 3 seconds |
Boolean | False | true | false, true |
prompt_network | Prompt Network false - Restrict true - Allow Opens only if kiosk_mode is 0 |
Boolean | False | true | false, true |
health_monitor_enabled | Health Monitor false - Disable true - Enable Opens only if kiosk_mode is 0 |
Boolean | False | true | false, true |
log_upload_enabled | Log Upload false - Disable true - Enable Opens only if kiosk_mode is 0 |
Boolean | False | false | false, true |
allow_os_update | Update OS false - No true - Yes Opens only if kiosk_mode is 0 |
Boolean | False | true | false, true |
status_alert_email | E-mail address(es) for notifying Admin Opens only if kiosk_mode is 0 |
String | False | ||
status_alert_phno | Contact number(s) for notifying Admin Opens only if kiosk_mode is 0 |
String | False |
allowed_apps Sample JSON format
One and only app if kiosk_mode is 0.
Atleast one app if kiosk_mode is 1
{
"9007199254741039": {
"SHOW_APP_ICON": false,
"APP_GROUP_ID": "9007199254741039",
"GROUP_DISPLAY_NAME": "MyProfile2",
"IDENTIFIER": "com.facebook.katana",
"APP_TYPE": 1,
"DISPLAY_IMAGE_LOC": ""
}
}
CHROME_CERTIFICATE_POLICY
payload_id : 703
payload_name : CHROME_CERTIFICATE_POLICY
CHROME_VERIFY_ACCESS_API
payload_id : 711
payload_name : CHROME_VERIFY_ACCESS_API
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
verified_access_mode | Skip boot mode check for verified access - Hidden | Boolean | Required | true | true,false |
verified_access_for_extensions | Verified Access for Enterprise Extensions - Hidden | Boolean | Required | true | true,false |
verified_access_for_content | Verified Access for content protection Applicable only for device profile |
Boolean | Required | true | true,false |
allowed_service_accounts | Service accounts which can verify devices but do not receive device ID Multiple patterns must be comma separated |
String | No | ||
allowed_service_accounts_with_data | Service accounts which are allowed to receive device ID Multiple patterns must be comma separated |
String | No |
Chrome user profiles
CHROME_USER_RESTRICTIONS
payload_id : 710
payload_name : CHROME_USER_RESTRICTIONS
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
allow_incognito | Incognito mode true-Allow false-Restrict |
Boolean | Required | true | false, true |
show_home_button | Show home button true-Show false-Hide |
Boolean | Required | true | false, true |
allow_end_process | Terminate processes using Task Manager true-Allow false-Restrict |
Boolean | Required | false | false, true |
allow_printing | Allow printing true-Allow false-Restrict |
Boolean | Required | true | false, true |
external_storage_accessibility | Mount external storage device 1-Disabled 2-Read only 3-Read-Write |
Integer | Required | 3 | 1,2,3 |
CHROME_WIFI_POLICY
payload_id : 701
payload_name : CHROME_WIFI_POLICY
Same as CHROME_WIFI_POLICY in device profiles
CHROME_ETHERNET_POLICY
payload_id : 702
payload_name : CHROME_ETHERNET_POLICY
Same as CHROME_ETHERNET_POLICY in device profiles
CHROME_VPN_POLICY
payload_id : 704
payload_name : CHROME_VPN_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
connection_name | Connection Name | String | False | ||
connection_type | Type of the VPN. 0 - L2TP 13 - Open VPN |
Integer | False | 0 | 0, 13 |
l2tp | L2TP configuration | JSONObject | Required if connection_type is 0 | ||
open_vpn_policy | Open VPN configuration | JSONObject | Required if connection_type is 1 | ||
proxy_settings | Proxy settings | JSONObject | Required |
l2tp
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server Name/IP Address (Host) Host name or IP address of server to connect to. |
String | Required | ||
account | Username | String | False | ||
password | Password | String | False |
open_vpn_policy
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
remote_host | Remote host | String | No | ||
remote_host_port | Remote host port | Integer | No | ||
username | Username | String | No | ||
password | Password | String | No | ||
protocol | Protocol 0 - TCP 1 - UDP |
Integer | False | 0 | 0, 1 |
certificate_id | Certificate | Long | False | -1 | -1, -3 |
CHROME_CERTIFICATE_POLICY
payload_id : 703
payload_name : CHROME_CERTIFICATE_POLICY
CHROME_POWER_SETTINGS
payload_id : 708
payload_name : CHROME_POWER_SETTINGS
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
idle_action_ac | Action for timeout for General timeout settings (in seconds) (AC) 3 - Do nothing 1 - Logout 0 - Suspend 2 - Shutdown |
Integer | False | 0 | 0, 1, 2, 3 |
idle_action_dc | Action for timeout for Timeout settings when connected to a power source (in seconds)(DC) 3 - Do nothing 1 - Logout 0 - Suspend 2 - Shutdown |
Integer | False | 0 | 0, 1, 2, 3 |
idle_warning_timeout_ac | Timeout for idle warning for General timeout settings (in seconds) (AC) -1--User controlled 0--No timeout Any other speficied timeout as integer in seconds |
Integer | required | 0 | 0,-1,Any positive integer |
screenoff_timeout_ac | Screen dim timeout for General timeout settings (in seconds) (AC) -1--User controlled 0--No timeout Any other speficied timeout as integer in seconds |
Integer | required | 0 | 0,-1,Any positive integer |
idle_timeout_ac | Timeout for idle for General timeout settings (in seconds) (AC) -1--User controlled 0--No timeout Any other speficied timeout as integer in seconds |
Integer | required | 0 | 0,-1,Any positive integer |
screen_dim_timeout_ac | Timeout for screenoff for General timeout settings (in seconds) (AC) -1--User controlled 0--No timeout Any other speficied timeout as integer in seconds |
Integer | required | 0 | 0,-1,Any positive integer |
idle_warning_timeout_dc | Timeout for idle warning for Timeout settings when connected to a power source (in
seconds)(DC) -1--User controlled 0--No timeout Any other speficied timeout as integer in seconds |
Integer | required | 0 | 0,-1,Any positive integer |
screenoff_timeout_dc | Screen dim timeout for Timeout settings when connected to a power source (in
seconds)(DC) -1--User controlled 0--No timeout Any other speficied timeout as integer in seconds |
Integer | required | 0 | 0,-1,Any positive integer |
idle_timeout_dc | Timeout for idle for Timeout settings when connected to a power source (in seconds)(DC) -1--User controlled 0--No timeout Any other speficied timeout as integer in seconds |
Integer | required | 0 | 0,-1,Any positive integer |
screen_dim_timeout_dc | Timeout for screenofffor Timeout settings when connected to a power source (in
seconds)(DC) -1--User controlled 0--No timeout Any other speficied timeout as integer in seconds |
Integer | required | 0 | 0,-1,Any positive integer |
CHROME_BROWSER_MANAGEMENT
payload_id : 712
payload_name : CHROME_BROWSER_MANAGEMENT
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
incognito_mode | Incognito mode 1--Allow 2--Restrict 0--User controlled(Hidden) |
Integer | Required | 1 | 0,1,2 |
popup_settings | Popups 1--Allow 2--Restrict 0--User controlled(Hidden) |
Integer | Required | 1 | 0,1,2 |
popup_block_url | URLs for which the pop-ups must be blocked Multiple URLs must be comma separated |
String | No | ||
popup_allow_url | URLs for which the pop-ups must be permitted Multiple URLs must be comma separated |
String | No | ||
safe_browsing | Safe Browsing 1--Allow 2--Restrict 0--User controlled(Hidden) |
Integer | Required | 1 | 0,1,2 |
prevent_malicious_sites | Malicious site | Boolean | Required | false | true,false |
saving_history | Saving history allowed | Boolean | Required | false | true,false |
deleting_history | Deleting history allowed | Boolean | Required | false | true,false |
bookmarks_enabled | Bookmarks enabled 1--Allow 2--Restrict 0--User controlled(Hidden) |
Integer | Required | 1 | 0,1,2 |
bookmarks_editable | Can edit bookmarks 1--Allow 2--Restrict 0--User controlled(Hidden) |
Integer | Required | 1 | 0,1,2 |
home_page_settings | Browser home page 0--User Control 1--Show a blank page 2--Show specific URL |
Integer | Required | 1 | 0,1,2 |
home_page_url | Home page URL should be proper URL Opens if home_page_settings is 2 |
String | Required if home_page_settings is 2 | ||
startup_urls | URLs to open on startup. Multiple URLs should be comma separated | String | No |
CHROME_WEB_CONTENT_FILTER
payload_id : 707
payload_name : CHROME_WEB_CONTENT_FILTER
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
url_filter_type | Filter type true - Whitelist false - Blacklist |
Boolean | Required | true | false, true |
create_bookmarks | Create bookmarks for whitelisted URL Opens if url_filter_type is true |
Boolean | Required if url_filter_type is true | false | true,false |
url_details | URL details | String | Required | JSONArray String of mentioned format |
url_details
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
url | Url for whtelist or blacklist | String | Requried | None | None |
bookmark_path | Bookmark path- Hidden | String | None | None | None |
bookmark_titile | Title of the bookmark Opens is url_filter_type is true and create_bookmarks is true |
String | None | None | None |
CHROME_MANAGED_BOOKMARKS
payload_id : 709
payload_name : CHROME_MANAGED_BOOKMARKS
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
folder_name | Folder name If folder name is not specified, the domain name will be used as bookmark folder name |
String | No | ||
url_details | URL details | String | Required | JSONArray String of mentioned format | |
is_bookmark_editable | Allow modify bookmarks | Boolean | Required | true | true,false |
bookmarks_bar | Should show bookmarks bar or not-Hidden 0-User control 1-Allow 2-Restrict |
Integer | Required | 0 | 0,1,2 |
url_details
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
url | Url for whtelist or blacklist | String | Requried | None | None |
bookmark_path | Bookmark path- Hidden | String | None | None | None |
bookmark_titile | Title of the bookmark | String | None | None | None |
CHROME_APPLICATION_POLICY
payload_id : 713
payload_name : CHROME_APPLICATION_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
url_details | URL details | String | Required | JSONArray String of mentioned format |
url_details
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
url | Url for whtelist or blacklist | String | Requried | None | None |
bookmark_path | Bookmark path- Hidden | String | None | None | None |
bookmark_titile | Title of the bookmark - Hidden | String | None | None | None |
CHROME_VERIFY_ACCESS_API
payload_id : 711
payload_name : CHROME_VERIFY_ACCESS_API
Same as CHROME_VERIFY_ACCESS_API in device profile
proxy_settings
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
proxy_type | Proxy Settings 0 - Direct connection to internet (No proxy) 2 - Automatic 1 - Manual |
Integer | Required | 0 | 0, 1, 2 |
proxy_server | Server Opens if proxy_type is 1 |
String | Required if proxy_type is 1 | ||
proxy_server_port | Port Opens if proxy_type is 1 |
Integer | Required if proxy_type is 1 | ||
https_proxy_server | Secure HTTP Proxy server Opens if proxy_type is 1 |
String | Required if proxy_type is 1 | Same as proxy_server | |
https_proxy_port | Secure HTTP Proxy port Opens if proxy_type is 1 |
Integer | Required if proxy_type is 1 | Same as proxy_server_port | |
ftp_proxy_server | Secure FTP Proxy server Opens if proxy_type is 1 |
String | Required if proxy_type is 1 | Same as proxy_server | |
ftp_proxy_port | Secure FTP Proxy port Opens if proxy_type is 1 |
Integer | Required if proxy_type is 1 | Same as proxy_server_port | |
socks_proxy_server | Secure SOCKS Proxy server Opens if proxy_type is 1 |
String | Required if proxy_type is 1 | Same as proxy_serverSame as proxy_server | |
socks_proxy_port | Secure SOCKS Proxy port Opens if proxy_type is 1 |
Integer | Required if proxy_type is 1 | Same as proxy_server_port | |
proxy_pac_url | Autoconfiguration URL (leave blank for WPAD protocol) Opens if proxy_type is 2 |
String |
time_zone
value | description |
---|---|
Africa/Abidjan | ( GMT+0:0 ) Greenwich Mean Time( Africa/Abidjan ) |
Africa/Accra | ( GMT+0:0 ) Ghana Mean Time( Africa/Accra ) |
Africa/Addis_Ababa | ( GMT+3:0 ) Eastern African Time( Africa/Addis_Ababa ) |
Africa/Algiers | ( GMT+1:0 ) Central European Time( Africa/Algiers ) |
Africa/Asmara | ( GMT+3:0 ) Eastern African Time( Africa/Asmara ) |
Africa/Asmera | ( GMT+3:0 ) Eastern African Time( Africa/Asmera ) |
Africa/Bamako | ( GMT+0:0 ) Greenwich Mean Time( Africa/Bamako ) |
Africa/Bangui | ( GMT+1:0 ) Western African Time( Africa/Bangui ) |
Africa/Banjul | ( GMT+0:0 ) Greenwich Mean Time( Africa/Banjul ) |
Africa/Bissau | ( GMT+0:0 ) Greenwich Mean Time( Africa/Bissau ) |
Africa/Blantyre | ( GMT+2:0 ) Central African Time( Africa/Blantyre ) |
Africa/Brazzaville | ( GMT+1:0 ) Western African Time( Africa/Brazzaville ) |
Africa/Bujumbura | ( GMT+2:0 ) Central African Time( Africa/Bujumbura ) |
Africa/Cairo | ( GMT+2:0 ) Eastern European Time( Africa/Cairo ) |
Africa/Casablanca | ( GMT+0:0 ) Western European Time( Africa/Casablanca ) |
Africa/Ceuta | ( GMT+1:0 ) Central European Time( Africa/Ceuta ) |
Africa/Conakry | ( GMT+0:0 ) Greenwich Mean Time( Africa/Conakry ) |
Africa/Dakar | ( GMT+0:0 ) Greenwich Mean Time( Africa/Dakar ) |
Africa/Dar_es_Salaam | ( GMT+3:0 ) Eastern African Time( Africa/Dar_es_Salaam ) |
Africa/Djibouti | ( GMT+3:0 ) Eastern African Time( Africa/Djibouti ) |
Africa/Douala | ( GMT+1:0 ) Western African Time( Africa/Douala ) |
Africa/El_Aaiun | ( GMT+0:0 ) Western European Time( Africa/El_Aaiun ) |
Africa/Freetown | ( GMT+0:0 ) Greenwich Mean Time( Africa/Freetown ) |
Africa/Gaborone | ( GMT+2:0 ) Central African Time( Africa/Gaborone ) |
Africa/Harare | ( GMT+2:0 ) Central African Time( Africa/Harare ) |
Africa/Johannesburg | ( GMT+2:0 ) South Africa Standard Time( Africa/Johannesburg ) |
Africa/Juba | ( GMT+3:0 ) Eastern African Time( Africa/Juba ) |
Africa/Kampala | ( GMT+3:0 ) Eastern African Time( Africa/Kampala ) |
Africa/Khartoum | ( GMT+3:0 ) Eastern African Time( Africa/Khartoum ) |
Africa/Kigali | ( GMT+2:0 ) Central African Time( Africa/Kigali ) |
Africa/Kinshasa | ( GMT+1:0 ) Western African Time( Africa/Kinshasa ) |
Africa/Lagos | ( GMT+1:0 ) Western African Time( Africa/Lagos ) |
Africa/Libreville | ( GMT+1:0 ) Western African Time( Africa/Libreville ) |
Africa/Lome | ( GMT+0:0 ) Greenwich Mean Time( Africa/Lome ) |
Africa/Luanda | ( GMT+1:0 ) Western African Time( Africa/Luanda ) |
Africa/Lubumbashi | ( GMT+2:0 ) Central African Time( Africa/Lubumbashi ) |
Africa/Lusaka | ( GMT+2:0 ) Central African Time( Africa/Lusaka ) |
Africa/Malabo | ( GMT+1:0 ) Western African Time( Africa/Malabo ) |
Africa/Maputo | ( GMT+2:0 ) Central African Time( Africa/Maputo ) |
Africa/Maseru | ( GMT+2:0 ) South Africa Standard Time( Africa/Maseru ) |
Africa/Mbabane | ( GMT+2:0 ) South Africa Standard Time( Africa/Mbabane ) |
Africa/Mogadishu | ( GMT+3:0 ) Eastern African Time( Africa/Mogadishu ) |
Africa/Monrovia | ( GMT+0:0 ) Greenwich Mean Time( Africa/Monrovia ) |
Africa/Nairobi | ( GMT+3:0 ) Eastern African Time( Africa/Nairobi ) |
Africa/Ndjamena | ( GMT+1:0 ) Western African Time( Africa/Ndjamena ) |
Africa/Niamey | ( GMT+1:0 ) Western African Time( Africa/Niamey ) |
Africa/Nouakchott | ( GMT+0:0 ) Greenwich Mean Time( Africa/Nouakchott ) |
Africa/Ouagadougou | ( GMT+0:0 ) Greenwich Mean Time( Africa/Ouagadougou ) |
Africa/Porto-Novo | ( GMT+1:0 ) Western African Time( Africa/Porto-Novo ) |
Africa/Sao_Tome | ( GMT+0:0 ) Greenwich Mean Time( Africa/Sao_Tome ) |
Africa/Timbuktu | ( GMT+0:0 ) Greenwich Mean Time( Africa/Timbuktu ) |
Africa/Tripoli | ( GMT+2:0 ) Eastern European Time( Africa/Tripoli ) |
Africa/Tunis | ( GMT+1:0 ) Central European Time( Africa/Tunis ) |
Africa/Windhoek | ( GMT+1:0 ) Western African Summer Time( Africa/Windhoek ) |
America/Adak | ( GMT-10:0 ) Hawaii Standard Time( America/Adak ) |
America/Anchorage | ( GMT-9:0 ) Alaska Standard Time( America/Anchorage ) |
America/Anguilla | ( GMT-4:0 ) Atlantic Standard Time( America/Anguilla ) |
America/Antigua | ( GMT-4:0 ) Atlantic Standard Time( America/Antigua ) |
America/Araguaina | ( GMT-3:0 ) Brasilia Time( America/Araguaina ) |
America/Argentina/Buenos_Aires | ( GMT-3:0 ) Argentine Time( America/Argentina/Buenos_Aires ) |
America/Argentina/Catamarca | ( GMT-3:0 ) Argentine Time( America/Argentina/Catamarca ) |
America/Argentina/ComodRivadavia | ( GMT-3:0 ) Argentine Time( America/Argentina/ComodRivadavia ) |
America/Argentina/Cordoba | ( GMT-3:0 ) Argentine Time( America/Argentina/Cordoba ) |
America/Argentina/Jujuy | ( GMT-3:0 ) Argentine Time( America/Argentina/Jujuy ) |
America/Argentina/La_Rioja | ( GMT-3:0 ) Argentine Time( America/Argentina/La_Rioja ) |
America/Argentina/Mendoza | ( GMT-3:0 ) Argentine Time( America/Argentina/Mendoza ) |
America/Argentina/Rio_Gallegos | ( GMT-3:0 ) Argentine Time( America/Argentina/Rio_Gallegos ) |
America/Argentina/Salta | ( GMT-3:0 ) Argentine Time( America/Argentina/Salta ) |
America/Argentina/San_Juan | ( GMT-3:0 ) Argentine Time( America/Argentina/San_Juan ) |
America/Argentina/San_Luis | ( GMT-3:0 ) Argentine Time( America/Argentina/San_Luis ) |
America/Argentina/Tucuman | ( GMT-3:0 ) Argentine Time( America/Argentina/Tucuman ) |
America/Argentina/Ushuaia | ( GMT-3:0 ) Argentine Time( America/Argentina/Ushuaia ) |
America/Aruba | ( GMT-4:0 ) Atlantic Standard Time( America/Aruba ) |
America/Asuncion | ( GMT-4:0 ) Paraguay Summer Time( America/Asuncion ) |
America/Atikokan | ( GMT-5:0 ) Eastern Standard Time( America/Atikokan ) |
America/Atka | ( GMT-10:0 ) Hawaii Standard Time( America/Atka ) |
America/Bahia | ( GMT-3:0 ) Brasilia Time( America/Bahia ) |
America/Bahia_Banderas | ( GMT-6:0 ) Central Standard Time( America/Bahia_Banderas ) |
America/Barbados | ( GMT-4:0 ) Atlantic Standard Time( America/Barbados ) |
America/Belem | ( GMT-3:0 ) Brasilia Time( America/Belem ) |
America/Belize | ( GMT-6:0 ) Central Standard Time( America/Belize ) |
America/Blanc-Sablon | ( GMT-4:0 ) Atlantic Standard Time( America/Blanc-Sablon ) |
America/Boa_Vista | ( GMT-4:0 ) Amazon Time( America/Boa_Vista ) |
America/Bogota | ( GMT-5:0 ) Colombia Time( America/Bogota ) |
America/Boise | ( GMT-7:0 ) Mountain Standard Time( America/Boise ) |
America/Buenos_Aires | ( GMT-3:0 ) Argentine Time( America/Buenos_Aires ) |
America/Cambridge_Bay | ( GMT-7:0 ) Mountain Standard Time( America/Cambridge_Bay ) |
America/Campo_Grande | ( GMT-4:0 ) Amazon Summer Time( America/Campo_Grande ) |
America/Cancun | ( GMT-5:0 ) Eastern Standard Time( America/Cancun ) |
America/Caracas | ( GMT-4:30 ) Venezuela Time( America/Caracas ) |
America/Catamarca | ( GMT-3:0 ) Argentine Time( America/Catamarca ) |
America/Cayenne | ( GMT-3:0 ) French Guiana Time( America/Cayenne ) |
America/Cayman | ( GMT-5:0 ) Eastern Standard Time( America/Cayman ) |
America/Chicago | ( GMT-6:0 ) Central Standard Time( America/Chicago ) |
America/Chihuahua | ( GMT-7:0 ) Mountain Standard Time( America/Chihuahua ) |
America/Coral_Harbour | ( GMT-5:0 ) Eastern Standard Time( America/Coral_Harbour ) |
America/Cordoba | ( GMT-3:0 ) Argentine Time( America/Cordoba ) |
America/Costa_Rica | ( GMT-6:0 ) Central Standard Time( America/Costa_Rica ) |
America/Creston | ( GMT-7:0 ) Mountain Standard Time( America/Creston ) |
America/Cuiaba | ( GMT-4:0 ) Amazon Summer Time( America/Cuiaba ) |
America/Curacao | ( GMT-4:0 ) Atlantic Standard Time( America/Curacao ) |
America/Danmarkshavn | ( GMT+0:0 ) Greenwich Mean Time( America/Danmarkshavn ) |
America/Dawson | ( GMT-8:0 ) Pacific Standard Time( America/Dawson ) |
America/Dawson_Creek | ( GMT-7:0 ) Mountain Standard Time( America/Dawson_Creek ) |
America/Denver | ( GMT-7:0 ) Mountain Standard Time( America/Denver ) |
America/Detroit | ( GMT-5:0 ) Eastern Standard Time( America/Detroit ) |
America/Dominica | ( GMT-4:0 ) Atlantic Standard Time( America/Dominica ) |
America/Edmonton | ( GMT-7:0 ) Mountain Standard Time( America/Edmonton ) |
America/Eirunepe | ( GMT-5:0 ) Acre Time( America/Eirunepe ) |
America/El_Salvador | ( GMT-6:0 ) Central Standard Time( America/El_Salvador ) |
America/Ensenada | ( GMT-8:0 ) Pacific Standard Time( America/Ensenada ) |
America/Fort_Wayne | ( GMT-5:0 ) Eastern Standard Time( America/Fort_Wayne ) |
America/Fortaleza | ( GMT-3:0 ) Brasilia Time( America/Fortaleza ) |
America/Glace_Bay | ( GMT-4:0 ) Atlantic Standard Time( America/Glace_Bay ) |
America/Godthab | ( GMT-3:0 ) Western Greenland Time( America/Godthab ) |
America/Goose_Bay | ( GMT-4:0 ) Atlantic Standard Time( America/Goose_Bay ) |
America/Grand_Turk | ( GMT-4:0 ) Atlantic Standard Time( America/Grand_Turk ) |
America/Grenada | ( GMT-4:0 ) Atlantic Standard Time( America/Grenada ) |
America/Guadeloupe | ( GMT-4:0 ) Atlantic Standard Time( America/Guadeloupe ) |
America/Guatemala | ( GMT-6:0 ) Central Standard Time( America/Guatemala ) |
America/Guayaquil | ( GMT-5:0 ) Ecuador Time( America/Guayaquil ) |
America/Guyana | ( GMT-4:0 ) Guyana Time( America/Guyana ) |
America/Halifax | ( GMT-4:0 ) Atlantic Standard Time( America/Halifax ) |
America/Havana | ( GMT-5:0 ) Cuba Standard Time( America/Havana ) |
America/Hermosillo | ( GMT-7:0 ) Mountain Standard Time( America/Hermosillo ) |
America/Indiana/Indianapolis | ( GMT-5:0 ) Eastern Standard Time( America/Indiana/Indianapolis ) |
America/Indiana/Knox | ( GMT-6:0 ) Central Standard Time( America/Indiana/Knox ) |
America/Indiana/Marengo | ( GMT-5:0 ) Eastern Standard Time( America/Indiana/Marengo ) |
America/Indiana/Petersburg | ( GMT-5:0 ) Eastern Standard Time( America/Indiana/Petersburg ) |
America/Indiana/Tell_City | ( GMT-6:0 ) Central Standard Time( America/Indiana/Tell_City ) |
America/Indiana/Vevay | ( GMT-5:0 ) Eastern Standard Time( America/Indiana/Vevay ) |
America/Indiana/Vincennes | ( GMT-5:0 ) Eastern Standard Time( America/Indiana/Vincennes ) |
America/Indiana/Winamac | ( GMT-5:0 ) Eastern Standard Time( America/Indiana/Winamac ) |
America/Indianapolis | ( GMT-5:0 ) Eastern Standard Time( America/Indianapolis ) |
America/Inuvik | ( GMT-7:0 ) Mountain Standard Time( America/Inuvik ) |
America/Iqaluit | ( GMT-5:0 ) Eastern Standard Time( America/Iqaluit ) |
America/Jamaica | ( GMT-5:0 ) Eastern Standard Time( America/Jamaica ) |
America/Jujuy | ( GMT-3:0 ) Argentine Time( America/Jujuy ) |
America/Juneau | ( GMT-9:0 ) Alaska Standard Time( America/Juneau ) |
America/Kentucky/Louisville | ( GMT-5:0 ) Eastern Standard Time( America/Kentucky/Louisville ) |
America/Kentucky/Monticello | ( GMT-5:0 ) Eastern Standard Time( America/Kentucky/Monticello ) |
America/Knox_IN | ( GMT-6:0 ) Central Standard Time( America/Knox_IN ) |
America/Kralendijk | ( GMT-4:0 ) Atlantic Standard Time( America/Kralendijk ) |
America/La_Paz | ( GMT-4:0 ) Bolivia Time( America/La_Paz ) |
America/Lima | ( GMT-5:0 ) Peru Time( America/Lima ) |
America/Los_Angeles | ( GMT-8:0 ) Pacific Standard Time( America/Los_Angeles ) |
America/Louisville | ( GMT-5:0 ) Eastern Standard Time( America/Louisville ) |
America/Lower_Princes | ( GMT-4:0 ) Atlantic Standard Time( America/Lower_Princes ) |
America/Maceio | ( GMT-3:0 ) Brasilia Time( America/Maceio ) |
America/Managua | ( GMT-6:0 ) Central Standard Time( America/Managua ) |
America/Manaus | ( GMT-4:0 ) Amazon Time( America/Manaus ) |
America/Marigot | ( GMT-4:0 ) Atlantic Standard Time( America/Marigot ) |
America/Martinique | ( GMT-4:0 ) Atlantic Standard Time( America/Martinique ) |
America/Matamoros | ( GMT-6:0 ) Central Standard Time( America/Matamoros ) |
America/Mazatlan | ( GMT-7:0 ) Mountain Standard Time( America/Mazatlan ) |
America/Mendoza | ( GMT-3:0 ) Argentine Time( America/Mendoza ) |
America/Menominee | ( GMT-6:0 ) Central Standard Time( America/Menominee ) |
America/Merida | ( GMT-6:0 ) Central Standard Time( America/Merida ) |
America/Metlakatla | ( GMT-8:0 ) Pacific Standard Time( America/Metlakatla ) |
America/Mexico_City | ( GMT-6:0 ) Central Standard Time( America/Mexico_City ) |
America/Miquelon | ( GMT-3:0 ) Pierre & Miquelon Standard Time( America/Miquelon ) |
America/Moncton | ( GMT-4:0 ) Atlantic Standard Time( America/Moncton ) |
America/Monterrey | ( GMT-6:0 ) Central Standard Time( America/Monterrey ) |
America/Montevideo | ( GMT-3:0 ) Uruguay Summer Time( America/Montevideo ) |
America/Montreal | ( GMT-5:0 ) Eastern Standard Time( America/Montreal ) |
America/Montserrat | ( GMT-4:0 ) Atlantic Standard Time( America/Montserrat ) |
America/Nassau | ( GMT-5:0 ) Eastern Standard Time( America/Nassau ) |
America/New_York | ( GMT-5:0 ) Eastern Standard Time( America/New_York ) |
America/Nipigon | ( GMT-5:0 ) Eastern Standard Time( America/Nipigon ) |
America/Nome | ( GMT-9:0 ) Alaska Standard Time( America/Nome ) |
America/Noronha | ( GMT-2:0 ) Fernando de Noronha Time( America/Noronha ) |
America/North_Dakota/Beulah | ( GMT-6:0 ) Central Standard Time( America/North_Dakota/Beulah ) |
America/North_Dakota/Center | ( GMT-6:0 ) Central Standard Time( America/North_Dakota/Center ) |
America/North_Dakota/New_Salem | ( GMT-6:0 ) Central Standard Time( America/North_Dakota/New_Salem ) |
America/Ojinaga | ( GMT-7:0 ) Mountain Standard Time( America/Ojinaga ) |
America/Panama | ( GMT-5:0 ) Eastern Standard Time( America/Panama ) |
America/Pangnirtung | ( GMT-5:0 ) Eastern Standard Time( America/Pangnirtung ) |
America/Paramaribo | ( GMT-3:0 ) Suriname Time( America/Paramaribo ) |
America/Phoenix | ( GMT-7:0 ) Mountain Standard Time( America/Phoenix ) |
America/Port-au-Prince | ( GMT-5:0 ) Eastern Standard Time( America/Port-au-Prince ) |
America/Port_of_Spain | ( GMT-4:0 ) Atlantic Standard Time( America/Port_of_Spain ) |
America/Porto_Acre | ( GMT-5:0 ) Acre Time( America/Porto_Acre ) |
America/Porto_Velho | ( GMT-4:0 ) Amazon Time( America/Porto_Velho ) |
America/Puerto_Rico | ( GMT-4:0 ) Atlantic Standard Time( America/Puerto_Rico ) |
America/Rainy_River | ( GMT-6:0 ) Central Standard Time( America/Rainy_River ) |
America/Rankin_Inlet | ( GMT-6:0 ) Central Standard Time( America/Rankin_Inlet ) |
America/Recife | ( GMT-3:0 ) Brasilia Time( America/Recife ) |
America/Regina | ( GMT-6:0 ) Central Standard Time( America/Regina ) |
America/Resolute | ( GMT-6:0 ) Central Standard Time( America/Resolute ) |
America/Rio_Branco | ( GMT-5:0 ) Acre Time( America/Rio_Branco ) |
America/Rosario | ( GMT-3:0 ) Argentine Time( America/Rosario ) |
America/Santa_Isabel | ( GMT-8:0 ) Pacific Standard Time( America/Santa_Isabel ) |
America/Santarem | ( GMT-3:0 ) Brasilia Time( America/Santarem ) |
America/Santiago | ( GMT-3:0 ) Chile Time( America/Santiago ) |
America/Santo_Domingo | ( GMT-4:0 ) Atlantic Standard Time( America/Santo_Domingo ) |
America/Sao_Paulo | ( GMT-3:0 ) Brasilia Summer Time( America/Sao_Paulo ) |
America/Scoresbysund | ( GMT-1:0 ) Eastern Greenland Time( America/Scoresbysund ) |
America/Shiprock | ( GMT-7:0 ) Mountain Standard Time( America/Shiprock ) |
America/Sitka | ( GMT-9:0 ) Alaska Standard Time( America/Sitka ) |
America/St_Barthelemy | ( GMT-4:0 ) Atlantic Standard Time( America/St_Barthelemy ) |
America/St_Johns | ( GMT-3:30 ) Newfoundland Standard Time( America/St_Johns ) |
America/St_Kitts | ( GMT-4:0 ) Atlantic Standard Time( America/St_Kitts ) |
America/St_Lucia | ( GMT-4:0 ) Atlantic Standard Time( America/St_Lucia ) |
America/St_Thomas | ( GMT-4:0 ) Atlantic Standard Time( America/St_Thomas ) |
America/St_Vincent | ( GMT-4:0 ) Atlantic Standard Time( America/St_Vincent ) |
America/Swift_Current | ( GMT-6:0 ) Central Standard Time( America/Swift_Current ) |
America/Tegucigalpa | ( GMT-6:0 ) Central Standard Time( America/Tegucigalpa ) |
America/Thule | ( GMT-4:0 ) Atlantic Standard Time( America/Thule ) |
America/Thunder_Bay | ( GMT-5:0 ) Eastern Standard Time( America/Thunder_Bay ) |
America/Tijuana | ( GMT-8:0 ) Pacific Standard Time( America/Tijuana ) |
America/Toronto | ( GMT-5:0 ) Eastern Standard Time( America/Toronto ) |
America/Tortola | ( GMT-4:0 ) Atlantic Standard Time( America/Tortola ) |
America/Vancouver | ( GMT-8:0 ) Pacific Standard Time( America/Vancouver ) |
America/Virgin | ( GMT-4:0 ) Atlantic Standard Time( America/Virgin ) |
America/Whitehorse | ( GMT-8:0 ) Pacific Standard Time( America/Whitehorse ) |
America/Winnipeg | ( GMT-6:0 ) Central Standard Time( America/Winnipeg ) |
America/Yakutat | ( GMT-9:0 ) Alaska Standard Time( America/Yakutat ) |
America/Yellowknife | ( GMT-7:0 ) Mountain Standard Time( America/Yellowknife ) |
Antarctica/Casey | ( GMT+8:0 ) Australian Western Standard Time( Antarctica/Casey ) |
Antarctica/Davis | ( GMT+7:0 ) Davis Time( Antarctica/Davis ) |
Antarctica/DumontDUrville | ( GMT+10:0 ) Dumont-d'Urville Time( Antarctica/DumontDUrville ) |
Antarctica/Macquarie | ( GMT+11:0 ) Macquarie Island Standard Time( Antarctica/Macquarie ) |
Antarctica/Mawson | ( GMT+5:0 ) Mawson Time( Antarctica/Mawson ) |
Antarctica/McMurdo | ( GMT+12:0 ) New Zealand Daylight Time( Antarctica/McMurdo ) |
Antarctica/Palmer | ( GMT-3:0 ) Chile Time( Antarctica/Palmer ) |
Antarctica/Rothera | ( GMT-3:0 ) Rothera Time( Antarctica/Rothera ) |
Antarctica/South_Pole | ( GMT+12:0 ) New Zealand Daylight Time( Antarctica/South_Pole ) |
Antarctica/Syowa | ( GMT+3:0 ) Syowa Time( Antarctica/Syowa ) |
Antarctica/Troll | ( GMT+0:0 ) Coordinated Universal Time( Antarctica/Troll ) |
Antarctica/Vostok | ( GMT+6:0 ) Vostok Time( Antarctica/Vostok ) |
Arctic/Longyearbyen | ( GMT+1:0 ) Central European Time( Arctic/Longyearbyen ) |
Asia/Aden | ( GMT+3:0 ) Arabia Standard Time( Asia/Aden ) |
Asia/Almaty | ( GMT+6:0 ) Alma-Ata Time( Asia/Almaty ) |
Asia/Amman | ( GMT+2:0 ) Eastern European Time( Asia/Amman ) |
Asia/Anadyr | ( GMT+12:0 ) Anadyr Time( Asia/Anadyr ) |
Asia/Aqtau | ( GMT+5:0 ) Aqtau Time( Asia/Aqtau ) |
Asia/Aqtobe | ( GMT+5:0 ) Aqtobe Time( Asia/Aqtobe ) |
Asia/Ashgabat | ( GMT+5:0 ) Turkmenistan Time( Asia/Ashgabat ) |
Asia/Ashkhabad | ( GMT+5:0 ) Turkmenistan Time( Asia/Ashkhabad ) |
Asia/Baghdad | ( GMT+3:0 ) Arabia Standard Time( Asia/Baghdad ) |
Asia/Bahrain | ( GMT+3:0 ) Arabia Standard Time( Asia/Bahrain ) |
Asia/Baku | ( GMT+4:0 ) Azerbaijan Time( Asia/Baku ) |
Asia/Bangkok | ( GMT+7:0 ) Indochina Time( Asia/Bangkok ) |
Asia/Beirut | ( GMT+2:0 ) Eastern European Time( Asia/Beirut ) |
Asia/Bishkek | ( GMT+6:0 ) Kirgizstan Time( Asia/Bishkek ) |
Asia/Brunei | ( GMT+8:0 ) Brunei Time( Asia/Brunei ) |
Asia/Calcutta | ( GMT+5:30 ) India Standard Time( Asia/Calcutta ) |
Asia/Chita | ( GMT+8:0 ) Irkutsk Time( Asia/Chita ) |
Asia/Choibalsan | ( GMT+8:0 ) Choibalsan Time( Asia/Choibalsan ) |
Asia/Chongqing | ( GMT+8:0 ) China Standard Time( Asia/Chongqing ) |
Asia/Chungking | ( GMT+8:0 ) China Standard Time( Asia/Chungking ) |
Asia/Colombo | ( GMT+5:30 ) India Standard Time( Asia/Colombo ) |
Asia/Dacca | ( GMT+6:0 ) Bangladesh Time( Asia/Dacca ) |
Asia/Damascus | ( GMT+2:0 ) Eastern European Time( Asia/Damascus ) |
Asia/Dhaka | ( GMT+6:0 ) Bangladesh Time( Asia/Dhaka ) |
Asia/Dili | ( GMT+9:0 ) Timor-Leste Time( Asia/Dili ) |
Asia/Dubai | ( GMT+4:0 ) Gulf Standard Time( Asia/Dubai ) |
Asia/Dushanbe | ( GMT+5:0 ) Tajikistan Time( Asia/Dushanbe ) |
Asia/Gaza | ( GMT+2:0 ) Eastern European Time( Asia/Gaza ) |
Asia/Harbin | ( GMT+8:0 ) China Standard Time( Asia/Harbin ) |
Asia/Hebron | ( GMT+2:0 ) Eastern European Time( Asia/Hebron ) |
Asia/Ho_Chi_Minh | ( GMT+7:0 ) Indochina Time( Asia/Ho_Chi_Minh ) |
Asia/Hong_Kong | ( GMT+8:0 ) Hong Kong Time( Asia/Hong_Kong ) |
Asia/Hovd | ( GMT+7:0 ) Hovd Time( Asia/Hovd ) |
Asia/Irkutsk | ( GMT+8:0 ) Irkutsk Time( Asia/Irkutsk ) |
Asia/Istanbul | ( GMT+2:0 ) Eastern European Time( Asia/Istanbul ) |
Asia/Jakarta | ( GMT+7:0 ) West Indonesia Time( Asia/Jakarta ) |
Asia/Jayapura | ( GMT+9:0 ) East Indonesia Time( Asia/Jayapura ) |
Asia/Jerusalem | ( GMT+2:0 ) Israel Standard Time( Asia/Jerusalem ) |
Asia/Kabul | ( GMT+4:30 ) Afghanistan Time( Asia/Kabul ) |
Asia/Kamchatka | ( GMT+12:0 ) Petropavlovsk-Kamchatski Time( Asia/Kamchatka ) |
Asia/Karachi | ( GMT+5:0 ) Pakistan Time( Asia/Karachi ) |
Asia/Kashgar | ( GMT+6:0 ) Xinjiang Standard Time( Asia/Kashgar ) |
Asia/Kathmandu | ( GMT+5:45 ) Nepal Time( Asia/Kathmandu ) |
Asia/Katmandu | ( GMT+5:45 ) Nepal Time( Asia/Katmandu ) |
Asia/Khandyga | ( GMT+9:0 ) Khandyga Time( Asia/Khandyga ) |
Asia/Kolkata | ( GMT+5:30 ) India Standard Time( Asia/Kolkata ) |
Asia/Krasnoyarsk | ( GMT+7:0 ) Krasnoyarsk Time( Asia/Krasnoyarsk ) |
Asia/Kuala_Lumpur | ( GMT+8:0 ) Malaysia Time( Asia/Kuala_Lumpur ) |
Asia/Kuching | ( GMT+8:0 ) Malaysia Time( Asia/Kuching ) |
Asia/Kuwait | ( GMT+3:0 ) Arabia Standard Time( Asia/Kuwait ) |
Asia/Macao | ( GMT+8:0 ) China Standard Time( Asia/Macao ) |
Asia/Macau | ( GMT+8:0 ) China Standard Time( Asia/Macau ) |
Asia/Magadan | ( GMT+10:0 ) Magadan Time( Asia/Magadan ) |
Asia/Makassar | ( GMT+8:0 ) Central Indonesia Time( Asia/Makassar ) |
Asia/Manila | ( GMT+8:0 ) Philippines Time( Asia/Manila ) |
Asia/Muscat | ( GMT+4:0 ) Gulf Standard Time( Asia/Muscat ) |
Asia/Nicosia | ( GMT+2:0 ) Eastern European Time( Asia/Nicosia ) |
Asia/Novokuznetsk | ( GMT+7:0 ) Krasnoyarsk Time( Asia/Novokuznetsk ) |
Asia/Novosibirsk | ( GMT+6:0 ) Novosibirsk Time( Asia/Novosibirsk ) |
Asia/Omsk | ( GMT+6:0 ) Omsk Time( Asia/Omsk ) |
Asia/Oral | ( GMT+5:0 ) Oral Time( Asia/Oral ) |
Asia/Phnom_Penh | ( GMT+7:0 ) Indochina Time( Asia/Phnom_Penh ) |
Asia/Pontianak | ( GMT+7:0 ) West Indonesia Time( Asia/Pontianak ) |
Asia/Pyongyang | ( GMT+9:0 ) Korea Standard Time( Asia/Pyongyang ) |
Asia/Qatar | ( GMT+3:0 ) Arabia Standard Time( Asia/Qatar ) |
Asia/Qyzylorda | ( GMT+6:0 ) Qyzylorda Time( Asia/Qyzylorda ) |
Asia/Rangoon | ( GMT+6:30 ) Myanmar Time( Asia/Rangoon ) |
Asia/Riyadh | ( GMT+3:0 ) Arabia Standard Time( Asia/Riyadh ) |
Asia/Saigon | ( GMT+7:0 ) Indochina Time( Asia/Saigon ) |
Asia/Sakhalin | ( GMT+10:0 ) Sakhalin Time( Asia/Sakhalin ) |
Asia/Samarkand | ( GMT+5:0 ) Uzbekistan Time( Asia/Samarkand ) |
Asia/Seoul | ( GMT+9:0 ) Korea Standard Time( Asia/Seoul ) |
Asia/Shanghai | ( GMT+8:0 ) China Standard Time( Asia/Shanghai ) |
Asia/Singapore | ( GMT+8:0 ) Singapore Time( Asia/Singapore ) |
Asia/Srednekolymsk | ( GMT+11:0 ) Srednekolymsk Time( Asia/Srednekolymsk ) |
Asia/Taipei | ( GMT+8:0 ) China Standard Time( Asia/Taipei ) |
Asia/Tashkent | ( GMT+5:0 ) Uzbekistan Time( Asia/Tashkent ) |
Asia/Tbilisi | ( GMT+4:0 ) Georgia Time( Asia/Tbilisi ) |
Asia/Tehran | ( GMT+3:30 ) Iran Standard Time( Asia/Tehran ) |
Asia/Tel_Aviv | ( GMT+2:0 ) Israel Standard Time( Asia/Tel_Aviv ) |
Asia/Thimbu | ( GMT+6:0 ) Bhutan Time( Asia/Thimbu ) |
Asia/Thimphu | ( GMT+6:0 ) Bhutan Time( Asia/Thimphu ) |
Asia/Tokyo | ( GMT+9:0 ) Japan Standard Time( Asia/Tokyo ) |
Asia/Ujung_Pandang | ( GMT+8:0 ) Central Indonesia Time( Asia/Ujung_Pandang ) |
Asia/Ulaanbaatar | ( GMT+8:0 ) Ulaanbaatar Time( Asia/Ulaanbaatar ) |
Asia/Ulan_Bator | ( GMT+8:0 ) Ulaanbaatar Time( Asia/Ulan_Bator ) |
Asia/Urumqi | ( GMT+6:0 ) Xinjiang Standard Time( Asia/Urumqi ) |
Asia/Ust-Nera | ( GMT+10:0 ) Ust-Nera Time( Asia/Ust-Nera ) |
Asia/Vientiane | ( GMT+7:0 ) Indochina Time( Asia/Vientiane ) |
Asia/Vladivostok | ( GMT+10:0 ) Vladivostok Time( Asia/Vladivostok ) |
Asia/Yakutsk | ( GMT+9:0 ) Yakutsk Time( Asia/Yakutsk ) |
Asia/Yekaterinburg | ( GMT+5:0 ) Yekaterinburg Time( Asia/Yekaterinburg ) |
Asia/Yerevan | ( GMT+4:0 ) Armenia Time( Asia/Yerevan ) |
Atlantic/Azores | ( GMT-1:0 ) Azores Time( Atlantic/Azores ) |
Atlantic/Bermuda | ( GMT-4:0 ) Atlantic Standard Time( Atlantic/Bermuda ) |
Atlantic/Canary | ( GMT+0:0 ) Western European Time( Atlantic/Canary ) |
Atlantic/Cape_Verde | ( GMT-1:0 ) Cape Verde Time( Atlantic/Cape_Verde ) |
Atlantic/Faeroe | ( GMT+0:0 ) Western European Time( Atlantic/Faeroe ) |
Atlantic/Faroe | ( GMT+0:0 ) Western European Time( Atlantic/Faroe ) |
Atlantic/Jan_Mayen | ( GMT+1:0 ) Central European Time( Atlantic/Jan_Mayen ) |
Atlantic/Madeira | ( GMT+0:0 ) Western European Time( Atlantic/Madeira ) |
Atlantic/Reykjavik | ( GMT+0:0 ) Greenwich Mean Time( Atlantic/Reykjavik ) |
Atlantic/South_Georgia | ( GMT-2:0 ) South Georgia Standard Time( Atlantic/South_Georgia ) |
Atlantic/St_Helena | ( GMT+0:0 ) Greenwich Mean Time( Atlantic/St_Helena ) |
Atlantic/Stanley | ( GMT-3:0 ) Falkland Is. Time( Atlantic/Stanley ) |
Australia/ACT | ( GMT+10:0 ) Australian Eastern Daylight Time (New South Wales)( Australia/ACT ) |
Australia/Adelaide | ( GMT+9:30 ) Australian Central Daylight Time (South Australia)( Australia/Adelaide ) |
Australia/Brisbane | ( GMT+10:0 ) Australian Eastern Standard Time (Queensland)( Australia/Brisbane ) |
Australia/Broken_Hill | ( GMT+9:30 ) Australian Central Daylight Time (South Australia/New South Wales)( Australia/Broken_Hill ) |
Australia/Canberra | ( GMT+10:0 ) Australian Eastern Daylight Time (New South Wales)( Australia/Canberra ) |
Australia/Currie | ( GMT+10:0 ) Australian Eastern Daylight Time (New South Wales)( Australia/Currie ) |
Australia/Darwin | ( GMT+9:30 ) Australian Central Standard Time (Northern Territory)( Australia/Darwin ) |
Australia/Eucla | ( GMT+8:45 ) Australian Central Western Standard Time( Australia/Eucla ) |
Australia/Hobart | ( GMT+10:0 ) Australian Eastern Daylight Time (Tasmania)( Australia/Hobart ) |
Australia/LHI | ( GMT+10:30 ) Lord Howe Daylight Time( Australia/LHI ) |
Australia/Lindeman | ( GMT+10:0 ) Australian Eastern Standard Time (Queensland)( Australia/Lindeman ) |
Australia/Lord_Howe | ( GMT+10:30 ) Lord Howe Daylight Time( Australia/Lord_Howe ) |
Australia/Melbourne | ( GMT+10:0 ) Australian Eastern Daylight Time (Victoria)( Australia/Melbourne ) |
Australia/NSW | ( GMT+10:0 ) Australian Eastern Daylight Time (New South Wales)( Australia/NSW ) |
Australia/North | ( GMT+9:30 ) Australian Central Standard Time (Northern Territory)( Australia/North ) |
Australia/Perth | ( GMT+8:0 ) Australian Western Standard Time( Australia/Perth ) |
Australia/Queensland | ( GMT+10:0 ) Australian Eastern Standard Time (Queensland)( Australia/Queensland ) |
Australia/South | ( GMT+9:30 ) Australian Central Daylight Time (South Australia)( Australia/South ) |
Australia/Sydney | ( GMT+10:0 ) Australian Eastern Daylight Time (New South Wales)( Australia/Sydney ) |
Australia/Tasmania | ( GMT+10:0 ) Australian Eastern Daylight Time (Tasmania)( Australia/Tasmania ) |
Australia/Victoria | ( GMT+10:0 ) Australian Eastern Daylight Time (Victoria)( Australia/Victoria ) |
Australia/West | ( GMT+8:0 ) Australian Western Standard Time( Australia/West ) |
Australia/Yancowinna | ( GMT+9:30 ) Australian Central Daylight Time (South Australia/New South Wales)( Australia/Yancowinna ) |
Brazil/Acre | ( GMT-5:0 ) Acre Time( Brazil/Acre ) |
Brazil/DeNoronha | ( GMT-2:0 ) Fernando de Noronha Time( Brazil/DeNoronha ) |
Brazil/East | ( GMT-3:0 ) Brasilia Summer Time( Brazil/East ) |
Brazil/West | ( GMT-4:0 ) Amazon Time( Brazil/West ) |
CET | ( GMT+1:0 ) Central European Time( CET ) |
CST6CDT | ( GMT-6:0 ) Central Standard Time( CST6CDT ) |
Canada/Atlantic | ( GMT-4:0 ) Atlantic Standard Time( Canada/Atlantic ) |
Canada/Central | ( GMT-6:0 ) Central Standard Time( Canada/Central ) |
Canada/East-Saskatchewan | ( GMT-6:0 ) Central Standard Time( Canada/East-Saskatchewan ) |
Canada/Eastern | ( GMT-5:0 ) Eastern Standard Time( Canada/Eastern ) |
Canada/Mountain | ( GMT-7:0 ) Mountain Standard Time( Canada/Mountain ) |
Canada/Newfoundland | ( GMT-3:30 ) Newfoundland Standard Time( Canada/Newfoundland ) |
Canada/Pacific | ( GMT-8:0 ) Pacific Standard Time( Canada/Pacific ) |
Canada/Saskatchewan | ( GMT-6:0 ) Central Standard Time( Canada/Saskatchewan ) |
Canada/Yukon | ( GMT-8:0 ) Pacific Standard Time( Canada/Yukon ) |
Chile/Continental | ( GMT-3:0 ) Chile Time( Chile/Continental ) |
Chile/EasterIsland | ( GMT-5:0 ) Easter Is. Time( Chile/EasterIsland ) |
Cuba | ( GMT-5:0 ) Cuba Standard Time( Cuba ) |
EET | ( GMT+2:0 ) Eastern European Time( EET ) |
EST5EDT | ( GMT-5:0 ) Eastern Standard Time( EST5EDT ) |
Egypt | ( GMT+2:0 ) Eastern European Time( Egypt ) |
Eire | ( GMT+0:0 ) Greenwich Mean Time( Eire ) |
Etc/GMT | ( GMT+0:0 ) Greenwich Mean Time( Etc/GMT ) |
Etc/GMT+0 | ( GMT+0:0 ) Greenwich Mean Time( Etc/GMT+0 ) |
Etc/GMT+1 | ( GMT-1:0 ) GMT-01:00( Etc/GMT+1 ) |
Etc/GMT+10 | ( GMT-10:0 ) GMT-10:00( Etc/GMT+10 ) |
Etc/GMT+11 | ( GMT-11:0 ) GMT-11:00( Etc/GMT+11 ) |
Etc/GMT+12 | ( GMT-12:0 ) GMT-12:00( Etc/GMT+12 ) |
Etc/GMT+2 | ( GMT-2:0 ) GMT-02:00( Etc/GMT+2 ) |
Etc/GMT+3 | ( GMT-3:0 ) GMT-03:00( Etc/GMT+3 ) |
Etc/GMT+4 | ( GMT-4:0 ) GMT-04:00( Etc/GMT+4 ) |
Etc/GMT+5 | ( GMT-5:0 ) GMT-05:00( Etc/GMT+5 ) |
Etc/GMT+6 | ( GMT-6:0 ) GMT-06:00( Etc/GMT+6 ) |
Etc/GMT+7 | ( GMT-7:0 ) GMT-07:00( Etc/GMT+7 ) |
Etc/GMT+8 | ( GMT-8:0 ) GMT-08:00( Etc/GMT+8 ) |
Etc/GMT+9 | ( GMT-9:0 ) GMT-09:00( Etc/GMT+9 ) |
Etc/GMT-0 | ( GMT+0:0 ) Greenwich Mean Time( Etc/GMT-0 ) |
Etc/GMT-1 | ( GMT+1:0 ) GMT+01:00( Etc/GMT-1 ) |
Etc/GMT-10 | ( GMT+10:0 ) GMT+10:00( Etc/GMT-10 ) |
Etc/GMT-11 | ( GMT+11:0 ) GMT+11:00( Etc/GMT-11 ) |
Etc/GMT-12 | ( GMT+12:0 ) GMT+12:00( Etc/GMT-12 ) |
Etc/GMT-13 | ( GMT+13:0 ) GMT+13:00( Etc/GMT-13 ) |
Etc/GMT-14 | ( GMT+14:0 ) GMT+14:00( Etc/GMT-14 ) |
Etc/GMT-2 | ( GMT+2:0 ) GMT+02:00( Etc/GMT-2 ) |
Etc/GMT-3 | ( GMT+3:0 ) GMT+03:00( Etc/GMT-3 ) |
Etc/GMT-4 | ( GMT+4:0 ) GMT+04:00( Etc/GMT-4 ) |
Etc/GMT-5 | ( GMT+5:0 ) GMT+05:00( Etc/GMT-5 ) |
Etc/GMT-6 | ( GMT+6:0 ) GMT+06:00( Etc/GMT-6 ) |
Etc/GMT-7 | ( GMT+7:0 ) GMT+07:00( Etc/GMT-7 ) |
Etc/GMT-8 | ( GMT+8:0 ) GMT+08:00( Etc/GMT-8 ) |
Etc/GMT-9 | ( GMT+9:0 ) GMT+09:00( Etc/GMT-9 ) |
Etc/GMT0 | ( GMT+0:0 ) Greenwich Mean Time( Etc/GMT0 ) |
Etc/Greenwich | ( GMT+0:0 ) Greenwich Mean Time( Etc/Greenwich ) |
Etc/UCT | ( GMT+0:0 ) Coordinated Universal Time( Etc/UCT ) |
Etc/UTC | ( GMT+0:0 ) Coordinated Universal Time( Etc/UTC ) |
Etc/Universal | ( GMT+0:0 ) Coordinated Universal Time( Etc/Universal ) |
Etc/Zulu | ( GMT+0:0 ) Coordinated Universal Time( Etc/Zulu ) |
Europe/Amsterdam | ( GMT+1:0 ) Central European Time( Europe/Amsterdam ) |
Europe/Andorra | ( GMT+1:0 ) Central European Time( Europe/Andorra ) |
Europe/Athens | ( GMT+2:0 ) Eastern European Time( Europe/Athens ) |
Europe/Belfast | ( GMT+0:0 ) Greenwich Mean Time( Europe/Belfast ) |
Europe/Belgrade | ( GMT+1:0 ) Central European Time( Europe/Belgrade ) |
Europe/Berlin | ( GMT+1:0 ) Central European Time( Europe/Berlin ) |
Europe/Bratislava | ( GMT+1:0 ) Central European Time( Europe/Bratislava ) |
Europe/Brussels | ( GMT+1:0 ) Central European Time( Europe/Brussels ) |
Europe/Bucharest | ( GMT+2:0 ) Eastern European Time( Europe/Bucharest ) |
Europe/Budapest | ( GMT+1:0 ) Central European Time( Europe/Budapest ) |
Europe/Busingen | ( GMT+1:0 ) Central European Time( Europe/Busingen ) |
Europe/Chisinau | ( GMT+2:0 ) Eastern European Time( Europe/Chisinau ) |
Europe/Copenhagen | ( GMT+1:0 ) Central European Time( Europe/Copenhagen ) |
Europe/Dublin | ( GMT+0:0 ) Greenwich Mean Time( Europe/Dublin ) |
Europe/Gibraltar | ( GMT+1:0 ) Central European Time( Europe/Gibraltar ) |
Europe/Guernsey | ( GMT+0:0 ) Greenwich Mean Time( Europe/Guernsey ) |
Europe/Helsinki | ( GMT+2:0 ) Eastern European Time( Europe/Helsinki ) |
Europe/Isle_of_Man | ( GMT+0:0 ) Greenwich Mean Time( Europe/Isle_of_Man ) |
Europe/Istanbul | ( GMT+2:0 ) Eastern European Time( Europe/Istanbul ) |
Europe/Jersey | ( GMT+0:0 ) Greenwich Mean Time( Europe/Jersey ) |
Europe/Kaliningrad | ( GMT+2:0 ) Eastern European Time( Europe/Kaliningrad ) |
Europe/Kiev | ( GMT+2:0 ) Eastern European Time( Europe/Kiev ) |
Europe/Lisbon | ( GMT+0:0 ) Western European Time( Europe/Lisbon ) |
Europe/Ljubljana | ( GMT+1:0 ) Central European Time( Europe/Ljubljana ) |
Europe/London | ( GMT+0:0 ) Greenwich Mean Time( Europe/London ) |
Europe/Luxembourg | ( GMT+1:0 ) Central European Time( Europe/Luxembourg ) |
Europe/Madrid | ( GMT+1:0 ) Central European Time( Europe/Madrid ) |
Europe/Malta | ( GMT+1:0 ) Central European Time( Europe/Malta ) |
Europe/Mariehamn | ( GMT+2:0 ) Eastern European Time( Europe/Mariehamn ) |
Europe/Minsk | ( GMT+3:0 ) Moscow Standard Time( Europe/Minsk ) |
Europe/Monaco | ( GMT+1:0 ) Central European Time( Europe/Monaco ) |
Europe/Moscow | ( GMT+3:0 ) Moscow Standard Time( Europe/Moscow ) |
Europe/Nicosia | ( GMT+2:0 ) Eastern European Time( Europe/Nicosia ) |
Europe/Oslo | ( GMT+1:0 ) Central European Time( Europe/Oslo ) |
Europe/Paris | ( GMT+1:0 ) Central European Time( Europe/Paris ) |
Europe/Podgorica | ( GMT+1:0 ) Central European Time( Europe/Podgorica ) |
Europe/Prague | ( GMT+1:0 ) Central European Time( Europe/Prague ) |
Europe/Riga | ( GMT+2:0 ) Eastern European Time( Europe/Riga ) |
Europe/Rome | ( GMT+1:0 ) Central European Time( Europe/Rome ) |
Europe/Samara | ( GMT+4:0 ) Samara Time( Europe/Samara ) |
Europe/San_Marino | ( GMT+1:0 ) Central European Time( Europe/San_Marino ) |
Europe/Sarajevo | ( GMT+1:0 ) Central European Time( Europe/Sarajevo ) |
Europe/Simferopol | ( GMT+3:0 ) Moscow Standard Time( Europe/Simferopol ) |
Europe/Skopje | ( GMT+1:0 ) Central European Time( Europe/Skopje ) |
Europe/Sofia | ( GMT+2:0 ) Eastern European Time( Europe/Sofia ) |
Europe/Stockholm | ( GMT+1:0 ) Central European Time( Europe/Stockholm ) |
Europe/Tallinn | ( GMT+2:0 ) Eastern European Time( Europe/Tallinn ) |
Europe/Tirane | ( GMT+1:0 ) Central European Time( Europe/Tirane ) |
Europe/Tiraspol | ( GMT+2:0 ) Eastern European Time( Europe/Tiraspol ) |
Europe/Uzhgorod | ( GMT+2:0 ) Eastern European Time( Europe/Uzhgorod ) |
Europe/Vaduz | ( GMT+1:0 ) Central European Time( Europe/Vaduz ) |
Europe/Vatican | ( GMT+1:0 ) Central European Time( Europe/Vatican ) |
Europe/Vienna | ( GMT+1:0 ) Central European Time( Europe/Vienna ) |
Europe/Vilnius | ( GMT+2:0 ) Eastern European Time( Europe/Vilnius ) |
Europe/Volgograd | ( GMT+3:0 ) Moscow Standard Time( Europe/Volgograd ) |
Europe/Warsaw | ( GMT+1:0 ) Central European Time( Europe/Warsaw ) |
Europe/Zagreb | ( GMT+1:0 ) Central European Time( Europe/Zagreb ) |
Europe/Zaporozhye | ( GMT+2:0 ) Eastern European Time( Europe/Zaporozhye ) |
Europe/Zurich | ( GMT+1:0 ) Central European Time( Europe/Zurich ) |
GB | ( GMT+0:0 ) Greenwich Mean Time( GB ) |
GB-Eire | ( GMT+0:0 ) Greenwich Mean Time( GB-Eire ) |
GMT | ( GMT+0:0 ) Greenwich Mean Time( GMT ) |
GMT0 | ( GMT+0:0 ) Greenwich Mean Time( GMT0 ) |
Greenwich | ( GMT+0:0 ) Greenwich Mean Time( Greenwich ) |
Hongkong | ( GMT+8:0 ) Hong Kong Time( Hongkong ) |
Iceland | ( GMT+0:0 ) Greenwich Mean Time( Iceland ) |
Indian/Antananarivo | ( GMT+3:0 ) Eastern African Time( Indian/Antananarivo ) |
Indian/Chagos | ( GMT+6:0 ) Indian Ocean Territory Time( Indian/Chagos ) |
Indian/Christmas | ( GMT+7:0 ) Christmas Island Time( Indian/Christmas ) |
Indian/Cocos | ( GMT+6:30 ) Cocos Islands Time( Indian/Cocos ) |
Indian/Comoro | ( GMT+3:0 ) Eastern African Time( Indian/Comoro ) |
Indian/Kerguelen | ( GMT+5:0 ) French Southern & Antarctic Lands Time( Indian/Kerguelen ) |
Indian/Mahe | ( GMT+4:0 ) Seychelles Time( Indian/Mahe ) |
Indian/Maldives | ( GMT+5:0 ) Maldives Time( Indian/Maldives ) |
Indian/Mauritius | ( GMT+4:0 ) Mauritius Time( Indian/Mauritius ) |
Indian/Mayotte | ( GMT+3:0 ) Eastern African Time( Indian/Mayotte ) |
Indian/Reunion | ( GMT+4:0 ) Reunion Time( Indian/Reunion ) |
Iran | ( GMT+3:30 ) Iran Standard Time( Iran ) |
Israel | ( GMT+2:0 ) Israel Standard Time( Israel ) |
Jamaica | ( GMT-5:0 ) Eastern Standard Time( Jamaica ) |
Japan | ( GMT+9:0 ) Japan Standard Time( Japan ) |
Kwajalein | ( GMT+12:0 ) Marshall Islands Time( Kwajalein ) |
Libya | ( GMT+2:0 ) Eastern European Time( Libya ) |
MET | ( GMT+1:0 ) Middle Europe Time( MET ) |
MST7MDT | ( GMT-7:0 ) Mountain Standard Time( MST7MDT ) |
Mexico/BajaNorte | ( GMT-8:0 ) Pacific Standard Time( Mexico/BajaNorte ) |
Mexico/BajaSur | ( GMT-7:0 ) Mountain Standard Time( Mexico/BajaSur ) |
Mexico/General | ( GMT-6:0 ) Central Standard Time( Mexico/General ) |
NZ | ( GMT+12:0 ) New Zealand Daylight Time( NZ ) |
NZ-CHAT | ( GMT+12:45 ) Chatham Daylight Time( NZ-CHAT ) |
Navajo | ( GMT-7:0 ) Mountain Standard Time( Navajo ) |
PRC | ( GMT+8:0 ) China Standard Time( PRC ) |
PST8PDT | ( GMT-8:0 ) Pacific Standard Time( PST8PDT ) |
Pacific/Apia | ( GMT+13:0 ) West Samoa Daylight Time( Pacific/Apia ) |
Pacific/Auckland | ( GMT+12:0 ) New Zealand Daylight Time( Pacific/Auckland ) |
Pacific/Bougainville | ( GMT+11:0 ) Bougainville Standard Time( Pacific/Bougainville ) |
Pacific/Chatham | ( GMT+12:45 ) Chatham Daylight Time( Pacific/Chatham ) |
Pacific/Chuuk | ( GMT+10:0 ) Chuuk Time( Pacific/Chuuk ) |
Pacific/Easter | ( GMT-5:0 ) Easter Is. Time( Pacific/Easter ) |
Pacific/Efate | ( GMT+11:0 ) Vanuatu Time( Pacific/Efate ) |
Pacific/Enderbury | ( GMT+13:0 ) Phoenix Is. Time( Pacific/Enderbury ) |
Pacific/Fakaofo | ( GMT+13:0 ) Tokelau Time( Pacific/Fakaofo ) |
Pacific/Fiji | ( GMT+12:0 ) Fiji Summer Time( Pacific/Fiji ) |
Pacific/Funafuti | ( GMT+12:0 ) Tuvalu Time( Pacific/Funafuti ) |
Pacific/Galapagos | ( GMT-6:0 ) Galapagos Time( Pacific/Galapagos ) |
Pacific/Gambier | ( GMT-9:0 ) Gambier Time( Pacific/Gambier ) |
Pacific/Guadalcanal | ( GMT+11:0 ) Solomon Is. Time( Pacific/Guadalcanal ) |
Pacific/Guam | ( GMT+10:0 ) Chamorro Standard Time( Pacific/Guam ) |
Pacific/Honolulu | ( GMT-10:0 ) Hawaii Standard Time( Pacific/Honolulu ) |
Pacific/Johnston | ( GMT-10:0 ) Hawaii Standard Time( Pacific/Johnston ) |
Pacific/Kiritimati | ( GMT+14:0 ) Line Is. Time( Pacific/Kiritimati ) |
Pacific/Kosrae | ( GMT+11:0 ) Kosrae Time( Pacific/Kosrae ) |
Pacific/Kwajalein | ( GMT+12:0 ) Marshall Islands Time( Pacific/Kwajalein ) |
Pacific/Majuro | ( GMT+12:0 ) Marshall Islands Time( Pacific/Majuro ) |
Pacific/Marquesas | ( GMT-9:30 ) Marquesas Time( Pacific/Marquesas ) |
Pacific/Midway | ( GMT-11:0 ) Samoa Standard Time( Pacific/Midway ) |
Pacific/Nauru | ( GMT+12:0 ) Nauru Time( Pacific/Nauru ) |
Pacific/Niue | ( GMT-11:0 ) Niue Time( Pacific/Niue ) |
Pacific/Norfolk | ( GMT+11:30 ) Norfolk Time( Pacific/Norfolk ) |
Pacific/Noumea | ( GMT+11:0 ) New Caledonia Time( Pacific/Noumea ) |
Pacific/Pago_Pago | ( GMT-11:0 ) Samoa Standard Time( Pacific/Pago_Pago ) |
Pacific/Palau | ( GMT+9:0 ) Palau Time( Pacific/Palau ) |
Pacific/Pitcairn | ( GMT-8:0 ) Pitcairn Standard Time( Pacific/Pitcairn ) |
Pacific/Pohnpei | ( GMT+11:0 ) Pohnpei Time( Pacific/Pohnpei ) |
Pacific/Ponape | ( GMT+11:0 ) Pohnpei Time( Pacific/Ponape ) |
Pacific/Port_Moresby | ( GMT+10:0 ) Papua New Guinea Time( Pacific/Port_Moresby ) |
Pacific/Rarotonga | ( GMT-10:0 ) Cook Is. Time( Pacific/Rarotonga ) |
Pacific/Saipan | ( GMT+10:0 ) Chamorro Standard Time( Pacific/Saipan ) |
Pacific/Samoa | ( GMT-11:0 ) Samoa Standard Time( Pacific/Samoa ) |
Pacific/Tahiti | ( GMT-10:0 ) Tahiti Time( Pacific/Tahiti ) |
Pacific/Tarawa | ( GMT+12:0 ) Gilbert Is. Time( Pacific/Tarawa ) |
Pacific/Tongatapu | ( GMT+13:0 ) Tonga Time( Pacific/Tongatapu ) |
Pacific/Truk | ( GMT+10:0 ) Chuuk Time( Pacific/Truk ) |
Pacific/Wake | ( GMT+12:0 ) Wake Time( Pacific/Wake ) |
Pacific/Wallis | ( GMT+12:0 ) Wallis & Futuna Time( Pacific/Wallis ) |
Pacific/Yap | ( GMT+10:0 ) Chuuk Time( Pacific/Yap ) |
Poland | ( GMT+1:0 ) Central European Time( Poland ) |
Portugal | ( GMT+0:0 ) Western European Time( Portugal ) |
ROK | ( GMT+9:0 ) Korea Standard Time( ROK ) |
Singapore | ( GMT+8:0 ) Singapore Time( Singapore ) |
SystemV/AST4 | ( GMT-4:0 ) Atlantic Standard Time( SystemV/AST4 ) |
SystemV/AST4ADT | ( GMT-4:0 ) Atlantic Standard Time( SystemV/AST4ADT ) |
SystemV/CST6 | ( GMT-6:0 ) Central Standard Time( SystemV/CST6 ) |
SystemV/CST6CDT | ( GMT-6:0 ) Central Standard Time( SystemV/CST6CDT ) |
SystemV/EST5 | ( GMT-5:0 ) Eastern Standard Time( SystemV/EST5 ) |
SystemV/EST5EDT | ( GMT-5:0 ) Eastern Standard Time( SystemV/EST5EDT ) |
SystemV/HST10 | ( GMT-10:0 ) Hawaii Standard Time( SystemV/HST10 ) |
SystemV/MST7 | ( GMT-7:0 ) Mountain Standard Time( SystemV/MST7 ) |
SystemV/MST7MDT | ( GMT-7:0 ) Mountain Standard Time( SystemV/MST7MDT ) |
SystemV/PST8 | ( GMT-8:0 ) Pacific Standard Time( SystemV/PST8 ) |
SystemV/PST8PDT | ( GMT-8:0 ) Pacific Standard Time( SystemV/PST8PDT ) |
SystemV/YST9 | ( GMT-9:0 ) Alaska Standard Time( SystemV/YST9 ) |
SystemV/YST9YDT | ( GMT-9:0 ) Alaska Standard Time( SystemV/YST9YDT ) |
Turkey | ( GMT+2:0 ) Eastern European Time( Turkey ) |
UCT | ( GMT+0:0 ) Coordinated Universal Time( UCT ) |
US/Alaska | ( GMT-9:0 ) Alaska Standard Time( US/Alaska ) |
US/Aleutian | ( GMT-10:0 ) Hawaii Standard Time( US/Aleutian ) |
US/Arizona | ( GMT-7:0 ) Mountain Standard Time( US/Arizona ) |
US/Central | ( GMT-6:0 ) Central Standard Time( US/Central ) |
US/East-Indiana | ( GMT-5:0 ) Eastern Standard Time( US/East-Indiana ) |
US/Eastern | ( GMT-5:0 ) Eastern Standard Time( US/Eastern ) |
US/Hawaii | ( GMT-10:0 ) Hawaii Standard Time( US/Hawaii ) |
US/Indiana-Starke | ( GMT-6:0 ) Central Standard Time( US/Indiana-Starke ) |
US/Michigan | ( GMT-5:0 ) Eastern Standard Time( US/Michigan ) |
US/Mountain | ( GMT-7:0 ) Mountain Standard Time( US/Mountain ) |
US/Pacific | ( GMT-8:0 ) Pacific Standard Time( US/Pacific ) |
US/Pacific-New | ( GMT-8:0 ) Pacific Standard Time( US/Pacific-New ) |
US/Samoa | ( GMT-11:0 ) Samoa Standard Time( US/Samoa ) |
UTC | ( GMT+0:0 ) Coordinated Universal Time( UTC ) |
Universal | ( GMT+0:0 ) Coordinated Universal Time( Universal ) |
W-SU | ( GMT+3:0 ) Moscow Standard Time( W-SU ) |
WET | ( GMT+0:0 ) Western European Time( WET ) |
Zulu | ( GMT+0:0 ) Coordinated Universal Time( Zulu ) |
EST | ( GMT-5:0 ) Eastern Standard Time( EST ) |
HST | ( GMT-10:0 ) Hawaii Standard Time( HST ) |
MST | ( GMT-7:0 ) Mountain Standard Time( MST ) |
ACT | ( GMT+9:30 ) Australian Central Standard Time (Northern Territory)( ACT ) |
AET | ( GMT+10:0 ) Australian Eastern Daylight Time (New South Wales)( AET ) |
AGT | ( GMT-3:0 ) Argentine Time( AGT ) |
ART | ( GMT+2:0 ) Eastern European Time( ART ) |
AST | ( GMT-9:0 ) Alaska Standard Time( AST ) |
BET | ( GMT-3:0 ) Brasilia Summer Time( BET ) |
BST | ( GMT+6:0 ) Bangladesh Time( BST ) |
CAT | ( GMT+2:0 ) Central African Time( CAT ) |
CNT | ( GMT-3:30 ) Newfoundland Standard Time( CNT ) |
CST | ( GMT-6:0 ) Central Standard Time( CST ) |
CTT | ( GMT+8:0 ) China Standard Time( CTT ) |
EAT | ( GMT+3:0 ) Eastern African Time( EAT ) |
ECT | ( GMT+1:0 ) Central European Time( ECT ) |
IET | ( GMT-5:0 ) Eastern Standard Time( IET ) |
IST | ( GMT+5:30 ) India Standard Time( IST ) |
JST | ( GMT+9:0 ) Japan Standard Time( JST ) |
MIT | ( GMT+13:0 ) West Samoa Daylight Time( MIT ) |
NET | ( GMT+4:0 ) Armenia Time( NET ) |
NST | ( GMT+12:0 ) New Zealand Daylight Time( NST ) |
PLT | ( GMT+5:0 ) Pakistan Time( PLT ) |
PNT | ( GMT-7:0 ) Mountain Standard Time( PNT ) |
PRT | ( GMT-4:0 ) Atlantic Standard Time( PRT ) |
PST | ( GMT-8:0 ) Pacific Standard Time( PST ) |
SST | ( GMT+11:0 ) Solomon Is. Time( SST ) |
VST | ( GMT+7:0 ) Indochina Time( VST ) |
MAC_DIRECTORY_BIND_POLICY
payload_id : 524
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
bind_policy_id | Bind policy template ID used for Mac binding. | Long | true | ||
object_name | Client ID of the device that will be shown in the Active Directory | String | false | [Host Name of the device] | |
adbindou | OU available in the Active Directory to which the device must be added. | String | true | ||
adminprivilegeadgroup | Security groups, whose members should have administrator privilege on the device. | Array of Strings | false |
WINDOWS PROFILES
PASSCODE_POLICY
payload_id : 172
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
max_inactivity_time_devlock | Maximum idle time allowed before auto-lock (in minutes). The user can choose any value less than the one specified here. | Integer | None | None | 1-999 |
alphanumeric_pwd_required | Mandates the use of alphanumeric values in the passcode. | Integer | None | false | 0-Alphanumeric, 1 - Numbers |
min_pwd_length | The minimum length of the passcode to be configured on the device. | Integer | None | None | 4-18 |
min_pwd_complex_char | Specifies the minimum number of special characters that must be present in the passcode. | Integer | None | None | 2, 3, 4 |
pwd_expiration | The number of days after which the user must change the passcode. | Integer | None | None | 1-730 |
pwd_history | Number of passcodes to be maintained in the history. The user cannot reuse the passcode stored in history. | Integer | None | None | 1-50 |
max_pwd_failed_attempts | Maximum Number of failed attempts. The device will be reset after the user exceeds the specified value. | Integer | None | None | 1-999 |
WINDOWS_RESTRICTION_POLICY
payload_id : 172
Field Name | Description | Type | Required | Default Value | **Allowed Values ** |
---|---|---|---|---|---|
enforce_device_encription | Enforce Device Encryption. 'true'-- 'Yes', 'false'-- ' No ' | java.lang.Boolean | False | false | ['true', 'false'] |
disable_sd_card | Disable SD Card.'true'-- 'Yes', 'false'-- ' No ' | java.lang.Boolean | False | false | ['true', 'false'] |
allow_use_of_camera | Restrict the use of Camera on the device.'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_screen_capture | Restrict Screen Capture on the device.'true'-- 'Allow', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_storage_card | Allow data to be stored on the Storage Card. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_telemetry | Allow sending data to Windows for fixing issues on devices.'1'-- 'Partial data', '0'-- 'Do not allow', '2'-- 'All data' | java.lang.Integer | False | 2 | ['2', '1', '0'] |
allow_store | Restrict the use of Microsoft Windows App Store on devices.'true'-- 'Allow', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_usb | Allow device connections using USB. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
ms_feedback_notif | Restrict feedback notifications from Microsoft.'0'-- 'User Control', '1'-- 'Disabled' | java.lang.Integer | False | 0 | ['0', '1'] |
allow_date_time | Prevent users from modifying the device date & time 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_edit_device_name | Prevent users from modifying device name. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_internet_sharing | Restrict managed devices from sharing Internet with unmanaged devices.'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_vpn_setting | Allow users to configure VPN on the device.'true'-- 'Allow', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_vpn_over_data | Allow users to configure VPN over cellular data. 'true'-- 'Allow', 'userConfig'-- 'User Control', 'false'-- ' ' | java.lang.String | False | userConfig | ['true', 'false', 'userConfig'] |
allow_vpn_over_data_roaming | Allow VPN Roaming while using cellular data. 'true'-- 'Allow', 'userConfig'-- 'User Control', 'false'-- ' ' | java.lang.String | False | userConfig | ['true', 'false', 'userConfig'] |
allow_cellular_data | Configure cellular network on devices.'1'-- 'Turn On', '0'-- 'Turn Off', '2'-- 'Force On' | java.lang.Integer | False | 1 | ['1', '0', '2'] |
allow_data_roaming | Allow the use of cellular data while Roaming 'true'-- 'Allow ', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_wifi | Allow the use of Wi-Fi on devices.'true'-- 'Allow ', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_manual_wifi_config | Allow users to add Wi-Fi configurations manually to devices. 'true'-- 'Yes', 'false'-- ' No' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_auto_wifi_hotspot | Automatically connect devices to Wi-Fi Sense Hotspots. 'true'-- 'Yes ', 'false'-- ' No ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_copy_paste | Allow the use of Clipboard Share to copy/paste.'true'-- 'Allow ', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_location | Enable Location Services on devices.'true'-- 'Allow ', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_microsoft_account | Restrict users from adding Microsoft accounts on devices.'true'-- 'Allow', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_adding_non_microsoft | Restrict users from manually adding non-Microsoft accounts on devices. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_root_certificate_install | Install root certificates on devices'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_developer_unlock_new | Prevent users from performing Developer Unlock on devices for additional control.'true'-- 'Allow', 'userConfig'-- 'User Control', 'false'-- ' ' | java.lang.String | False | userConfig | ['true', 'false', 'userConfig'] |
allow_user_reset_phone | Prevent users resetting the device to factory settings. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_action_notification | Prevent Action Center Notifications on devices. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_toast | Restrict Toast notifications on devices. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_fips_policy | Allow FIPS Algorithm to secure device communication. 'true'-- 'Yes', 'false'-- ' No ' | java.lang.Boolean | False | false | ['true', 'false'] |
allow_add_prov_package | Allow users to add provisioning package on devices. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_remove_prov_package | Remove existing provisioning package from devices. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
enable_anti_theft_mode | Allow users to enable Anti-theft mode on devices. '1'-- 'Allow', '0'-- ' Restrict ' | java.lang.Integer | False | 1 | ['1', '0'] |
allow_cortana | Allow users to use Cortana on devices. 'true'-- 'Allow ', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_voice_recording | Allow Voice Recording on devices. 'true'-- 'Allow ', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_save_as_office_files | Allow users to save "Office Files" on the device. 'true'-- 'Allow', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_sharing_office_files | Allow users to share "Office Files" from the device. 'true'-- 'Allow ', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_sync_my_settings | Allow users to sync settings across all devices. 'true'-- 'Allow ', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_storing_image_search | Allow users to store Image from "Vision Search" on devices. 'true'-- 'Allow ', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
safe_search_permissions | Safe Search Permissions '1'-- 'Moderate', '0'-- 'Strict', '-1'-- 'None' | java.lang.Integer | False | -1 | ['1', '0', '-1'] |
allow_search_use_location | Allow "Search" to use Location Services 'true'-- 'Yes ', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_all_trusted_apps | Restrict users from installing Non-Store apps on devices.'1'-- 'Allow', '0'-- ' Deny ', '65535'-- ' User Control ' | java.lang.Integer | False | 65535 | ['1', '0', '65535'] |
limit_appinstall_to_sys_vol | Allow users to install apps only on the device memory. 'true'-- 'Yes', 'false'-- ' No ' | java.lang.Boolean | False | false | ['true', 'false'] |
limit_appdata_to_sys_vol | Allow users to store app data only on device memory. 'true'-- 'Yes', 'false'-- ' No ' | java.lang.Boolean | False | false | ['true', 'false'] |
allow_appstore_auto_update | Allow users to auto-update store apps. '1'-- 'Yes', '0'-- ' No ', '-999'-- ' User Control ' | java.lang.Integer | False | -999 | ['1', '0', '-999'] |
require_private_store_only | Restrict users from downloading apps from Private Store. 'true'-- 'Yes', 'false'-- ' No ' | java.lang.Boolean | False | false | ['true', 'false'] |
allow_browser | Restrict Internet Explorer/ Edge Browser on devices. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
browser_allow_cookies | Allow the use of Cookies on devices.'1'-- 'Block only third-party cookies', '0'-- 'Block all cookies', 'userConfig'-- 'User Control', '2'-- 'Allow all cookies' | java.lang.String | False | userConfig | ['userConfig', '2', '1', '0'] |
browser_allow_inprivate | Allow In-Private Browsing on devices.'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
browser_allow_passmgr | Restrict users from saving passwords locally on devices. 'true'-- 'Allow', 'userConfig'-- ' User Control ', 'false'-- ' Restrict ' | java.lang.String | False | userConfig | ['true', 'false', 'userConfig'] |
browser_allow_searchsuggest | Restrict search suggestions in the browser address bar. 'true'-- 'Allow', 'userConfig'-- ' User Control ', 'false'-- ' Restrict ' | java.lang.String | False | userConfig | ['true', 'false', 'userConfig'] |
browser_allow_smartscreen | Force fraudulent website warning on devices. 'true'-- 'Yes', 'userConfig'-- ' User Control ', 'false'-- ' No ' | java.lang.String | False | userConfig | ['true', 'false', 'userConfig'] |
browser_smartscreen_prompt | Override fraudulent website warning on devices. 'true'-- 'Allow', 'userConfig'-- ' User Control ', 'false'-- ' Restrict ' | java.lang.String | False | userConfig | ['true', 'false', 'userConfig'] |
browser_smartscreen_files | Override malicious file warning on devices. 'true'-- 'Allow', 'userConfig'-- ' User Control ', 'false'-- ' Restrict ' | java.lang.String | False | userConfig | ['true', 'false', 'userConfig'] |
browser_allow_donot_track | Allow "Do not track" request on devices. 'true'-- 'Yes', 'userConfig'-- ' User Control ', 'false'-- ' No ' | java.lang.String | False | userConfig | ['true', 'false', 'userConfig'] |
browser_allow_address_bar_dropdown | Restrict website suggestions in the address bar dropdown. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
browser_allow_extensions | Restrict Browser extensions on devices. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
browser_clear_browsing_data_exit | Restrict automatic deletion of browsing history on exiting browser. '1'-- 'Allow', '0'-- ' Restrict ', '-999'-- ' User Control ' | java.lang.Integer | False | -999 | ['1', '0', '-999'] |
browser_about_flags_access | Allow access to "about:flags" page on the browser. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
browser_allow_flash | Allow Flash to run on the browser. '1'-- 'Yes', '0'-- ' No ', '-999'-- ' User Control ' | java.lang.Integer | False | -999 | ['1', '0', '-999'] |
browser_run_flash_automatically | Run Flash without user intervention on devices. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | false | ['true', 'false'] |
browser_allow_autofill | Allow automatic pre-filling of websites on the browser.'1'-- 'Allow', '0'-- ' Restrict ', '-999'-- ' User Control ' | java.lang.Integer | False | -999 | ['1', '0', '-999'] |
browser_allow_popups | Allow display of browser popups. '1'-- 'Allow', '0'-- ' Restrict ', '-999'-- ' User Control ' | java.lang.Integer | False | -999 | ['1', '0', '-999'] |
browser_allow_developer_tools | Restrict access to Developer Tools. 'true'-- 'Allow', 'false'-- ' Restrict ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_nfc | Restrict NFC on devices. 'true'-- 'Allow', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_bluetooth | Restrict Bluetooth on devices. 'true'-- 'Allow', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_bluetooth_discoverable | Restrict Bluetooth discovery on devices'true'-- 'Allow', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_bluetooth_prepairing | Restrict Bluetooth pre-pairing on devices. 'true'-- 'Allow', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
allow_bluetooth_advertising | Restrict advertising Bluetooth services 'true'-- 'Allow', 'false'-- ' ' | java.lang.Boolean | False | true | ['true', 'false'] |
WINDOWS_EMAIL_POLICY
payload_id : 603
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
account_type | Type of the Account to be configured. | String | Email, VVM | ||
smtp_alt_password | User must specify an alternate password. Applicable only for smtp_alt_enabled , | String | FALSE | None | |
auth_secret | User password for the configured accoutn. | String | FALSE | None | |
smtp_alt_auth_name | Alternate name for SMTP. Applicable only for smtp_alt_enabled , | String | FALSE | None | |
out_server | SMTP out server details. | String | TRUE | None | |
auth_name | user name of the account to be configured. | String | TRUE | None | |
account_icon_path | Details about the account path to be configured. | FormFile | FALSE | None | |
in_server | in server URL /IP. | String | TRUE | None | |
in_server_port | Port details for the in server. | Integer | TRUE | None | |
reply_addr | Specify the email address to which the reply mails to be sent. | String | FALSE | None | |
out_server_port | Port for the outgoing mail server. | Integer | TRUE | None | |
payload_id | Long | FALSE | None | ||
dwn_day | Specify the number of days for which the mails need to be downloaded. | Integer | FALSE | -1 | 7,14,30 |
auth_req | Specify the authentication to send mails. | Integer | TRUE | FALSE | |
linger | Frequency to sync mails(in minutes) | Integer | FALSE | 15 | 153060120 |
service_name | Account Display Name. | String | TRUE | None | |
use_ssl_in | use SSL to secure inbound mails | Boolean | FALSE | false | |
service_type | Type of mail service to be used. | String | TRUE | imap4 | imap4,pop3 |
smtp_alt_enabled | Specify if SMPT alternative is to be used. | Boolean | TRUE | false | |
domain | Domain of the email account to be configured. | String | FALSE | None | |
smtp_alt_domain | Alternate domain name for SMTP. Applicable if smtp_alt_enabled. | String | FALSE | None | |
name | Dispaly name of the account to be configured. | String | FALSE | None | |
use_ssl_out | Mandates the use of SSL to secure outgoing mail. | Boolean | TRUE | false | |
guid | Auto generated ID. | String | FALSE | None |
WINDOWS_EXCHANGE_ACTIVE_SYNC_POLICY
payload_id : 604
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Exchange Server to be configured. | String | TRUE | None | None |
payload_id | Long | TRUE | None | None | |
account_type | Account Type to be configured. | String | TRUE | Exchange | None |
is_con_type_task_enabled | Enable syncing of tasks from the configured account. | Boolean | FALSE | false | None |
user_name | User Name of the account to be configured. | String | TRUE | %upn% | None |
use_ssl | Mandates the use of SSL to secure communication. | Boolean | FALSE | true | None |
content_type_contact_name | Enable syncing of contacts from the configured account. | String | FALSE | Contacts | None |
domin_name | Domain Name. (Applicable only if Exchange on-premises is selected) | String | TRUE | %domainname% | None |
is_con_type_email_enabled | Enable syncing of emails from the configured account. | Boolean | FALSE | true | None |
is_con_type_cal_enabled | Enable syncing of calendar from the configured account. | Boolean | FALSE | false | None |
mail_age_filter | Specify the number of days the mails need to be synced for. | Integer | FALSE | 3 | 0-AllMails, 2-lat 3 days, 3-last 1 week , 4- last two weeks, 5 - last 1 month |
schedule | Specify the schedule to sync Calendar/Contacts/Tasks/Notes. | Integer | FALSE | -1 | -1,15,0- manually,30,60,120 |
password | Specify the account password. (Applicable if Exchange on-premises is selected) | String | TRUE | None | None |
email_address | Specify the e-mail sddress. (Applicable if Exchange on-premises is selected) | String | TRUE | %email% | None |
account_name | Account dispaly name | String | TRUE | None | None |
is_con_type_contact_enabled | Enable syncing of contacts from the configured account. | Boolean | FALSE | false | None |
logging | Enable advanced login for the account configured. | Integer | FALSE | 0 | 2,0 |
host_type | Exchange Host type for the account to be configured. | Boolean | TRUE | FALSE | - true , Exchange On-Premise - false |
WINDOWS_WIFI_POLICY
payload_id : 609
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
payload_id | Long | TRUE | None | None | |
proxy_server | Proxy server URL. (Applicable only if manual proxy is configured.) | String | TRUE | None | None |
auto_join | Mandates whether the devices must connect to the configured Wi-Fi automatically. | Boolean | FALSE | true | None |
proxy_server_port | Proxy server port. (Applicable only if manual proxy is configured.) | Integer | None | ||
service_set_identifier | Wi-Fi identifier | String | TRUE | None | None |
security_type | Security type configured on the selected Wi-Fi. | Integer | TRUE | 0 | 0-None , 1- WPA2 PSK, 2 - 802.1x EAP |
proxy_type | Proxy configuration type. | Integer | TRUE | 0 | 1- Automatic, 2-Manual |
wifi_enterprise | Wifi enterprise configuration | JSONObject | Required if security_type is 4,5,6 | None | None |
wifi_non_enterprise | Wifi non-enterprise configuration | JSONObject | Required if security_type is 1,2,3 | None | None |
wifi_enterprise
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
peap | Specifies whether the wifi supports PEAP protocol. | Boolean | Required | true | true,false |
tls | Whether the Wi-FI supports TLS protocol. | Boolean | Required | true | true,false |
certificate_id | Server certificate ID configured for authentication using the Certificates endpoint. | Long | None | None | None |
inner_identity | Applicable only for PEAP. | Long | True | 3 | 3-MSCHAP V2 |
wifi_non_enterprise
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
password | Specify the password for non-enterprise. | String | None | None | None |
WINDOWS_LOCKDOWN_POLICY
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
payload_id | Long | TRUE | None | None | |
allowed_apps | Specify the app to be configured in Kiosk. | JSONArray | - | - | - |
user | Specify the user for whom Kiosk must be enabled. | String | TRUE | %username% | None |
kiosk_mode | Type of kiosk to be enabled on the device. (Currently only single app is supported) | Integer | TRUE | 0 | 0,1 |
allowed_apps
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
app_id | App ID of the app. | Long | Required | None | None |
is_system_app | Whether the selected app is a system app. | Boolean | Required | false | true,false |
group_display_name | Display name of the app. | String | Required | None | None |
aumid | Manually enter the Aumid if necessary. | String | TRUE | None | None |
storeId | Manually enter the Store ID if necessary. (This value is required if phone product ID is not present) | String | TRUE | None | None |
productID | Product ID that is available in the list. | String | TRUE | None | None |
WINDOWS_VPN_POLICY
payload_id : 609
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
connection_name | Name of the connection | String | Required | None | None |
vpn_type | Type of the VPN. By default it is set to 1. | Integer | Required | None | None |
connection_type | Type of VPN connection. 1-L2TP,2-PPTP or IPSec,6-Plugin SSL,8-IKEv2 | Intger | Required | 1 | None |
sub_config | Current subconfiguration. | String | Required | None | L2TP, PPTP, CUSTOMSSL, IKEV2 |
proxy_type | Type of the proxy. 0-None, 1-Manual,2-Auto | Integer | None | None | 0,1,2 |
proxy_server | Server address of the proxy to be configured. | String | Required if proxy type is 1 | None | None |
proxy_server_port | Sever port of the proxy to be configured. | String | Required if proxy type is 1 | None | None |
proxy_pac_url | Proxy PAC URL. Applicable only if proxy type is set to 2 | String | None | None | None |
l2tp | L2TP configuration | JSONObject | None | None | None |
pptp | PPTP configuration. | JSONObject | None | None | None |
ikev2 | IKEv2 configuration | JSONObject | None | None | None |
customssl | CustomSSL configuration | JSONObject | None | None | None |
custom_data | Custom data of the vendors. (Applicable if customSLL is used. JSON should contain key value pairs.) | JSONObject | None | None | None |
l2tp
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name / host IP address to be configured. | String | Required | None | None |
user_authentication | Type of authentication. 0- Password 1-shared secret, 2 - EAP | Integer | Required | 0 | 0,1 |
shared_secret | Shared secret for account to be configured. | String | None | None | None |
ca_certificate_id | Applicable for EAP type. CA cert of the issuing authority. | String | false | None | None |
pptp
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name / host IP address to be configured. | String | Required | None | None |
user_authentication | Type of authentication. 0- Password , 2 - EAP | Integer | Required | 0 | 0,2 |
ca_certificate_id | Applicable for EAP type. CA cert of the issuing authority. | String | false | None | None |
pptp
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
server_name | Server name / host IP address to be configured. | String | Required | None | None |
user_authentication | Type of authentication. 0- Password , 2 - EAP | Integer | Required | 0 | 0,2 |
ca_certificate_id | Applicable for EAP type. CA cert of the issuing authority. | String | false | None | None |
customssl
Field Name | Description | Type | Required | Default Value | Allowed Values |
---|---|---|---|---|---|
identifier | Package family name of the plug-in profile. | string | true | - | Any VPN PFN |
server_name | Server name / host IP address. | String | Required | None | None |