Save enrollment settings for on-premises

Save enrollment settings On premise

Endpoints

post /api/v1/mdm/enrollmentsettings

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/enrollmentsettings

Scope

MDMAdmin.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Request Body

application/json

JSON Object

Hide Sub-Attributes

show_owned_by_optionbooleanOptional

Whether owned-by option is shown during invite enrollment

is_auto_deprovisionbooleanOptional

Whether to auto-deprovision when users are disabled in directory. Applicable for Okta Directory only.

is_user_signoutbooleanOptional

Whether to sign out Google Workspace users on deprovision

notify_device_unmanagedbooleanMandatory

Whether to send mail notification when devices are unmanaged

android_dpc_typestringOptional

Android DPC agent type used in android enrollment. 1 = ME MDM, 2 = Android Device Policy

block_afterstringOptional

Days after which a non-compliant device is blocked. 0 = no blocking. Applicable when Android Device Policy is enabled

wipe_afterintegerOptional

Days after which a non-compliant device is wiped. Applicable when Android Device Policy is enabled

block_personal_profilebooleanOptional

Whether personal profile is blocked on company-owned devices. Applicable when Android Device Policy is enabled

preserve_frpbooleanOptional

Whether Factory Reset Protection is preserved on wipe. Applicable when Android Device Policy is enabled

reminder_settingsJSON ObjectOptional

Enrollment reminder notification settings

Show Sub-Attributes

disabledbooleanOptional

Whether reminders are disabled. When true, no reminders are sent

start_afterstringOptional

Days after invite to start sending reminders

intervalstringOptional

Days between consecutive reminders

time_of_daystringOptional

Hour of day (0-23) to send reminders

total_remindersstringOptional

Total number of reminders to send

notification_typeintegerOptional

Notification type. 1 = Email

auth_modestringMandatory

Invite enrollment auth mode. 0 = No Auth, 1 = OTP, 2 = AD Authentication, 3 = Both OTP and AD

rule_typestringOptional

Authentication rule type. Values: zoho_authentication, authenticated_user, saml_authentication, legacy_authentication

deprovision_from_agentarrayOptional

Deprovisioning allowed from agent for enrollment modes. Values: invite, self.

email_unmanaged_alertsstringOptional

Email addresses notified when a device gets unmanaged

expiry_duration_in_millisstringOptional

Invite expiry duration in milliseconds. Example: 604800000 (7 days)

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/enrollmentsettings \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"deprovision_from_agent":[],"expiry_duration_in_millis":"604800000","auth_mode":"0","notify_device_unmanaged":false,"block_after":"0","preserve_frp":true,"reminder_settings":{"disabled":true},"android_dpc_type":"1","show_owned_by_option":false,"is_user_signout":false,"wipe_after":0,"block_personal_profile":false,"is_auto_deprovision":false,"email_unmanaged_alerts":""}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/enrollmentsettings"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"deprovision_from_agent\":[],\"expiry_duration_in_millis\":\"604800000\",\"auth_mode\":\"0\",\"notify_device_unmanaged\":false,\"block_after\":\"0\",\"preserve_frp\":true,\"reminder_settings\":{\"disabled\":true},\"android_dpc_type\":\"1\",\"show_owned_by_option\":false,\"is_user_signout\":false,\"wipe_after\":0,\"block_personal_profile\":false,\"is_auto_deprovision\":false,\"email_unmanaged_alerts\":\"\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"deprovision_from_agent\":[],\"expiry_duration_in_millis\":\"604800000\",\"auth_mode\":\"0\",\"notify_device_unmanaged\":false,\"block_after\":\"0\",\"preserve_frp\":true,\"reminder_settings\":{\"disabled\":true},\"android_dpc_type\":\"1\",\"show_owned_by_option\":false,\"is_user_signout\":false,\"wipe_after\":0,\"block_personal_profile\":false,\"is_auto_deprovision\":false,\"email_unmanaged_alerts\":\"\"}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/api/v1/mdm/enrollmentsettings", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("show_owned_by_option",true);
    data.put("is_auto_deprovision",true);
    data.put("is_user_signout",true);
    data.put("notify_device_unmanaged",true);
    data.put("android_dpc_type","value");
    data.put("block_after","value");
    data.put("wipe_after","1");
    data.put("block_personal_profile",true);
    data.put("preserve_frp",true);
    data_reminder_settings=Map();
    data_reminder_settings.put("disabled",true);
    data_reminder_settings.put("start_after","value");
    data_reminder_settings.put("interval","value");
    data_reminder_settings.put("time_of_day","value");
    data_reminder_settings.put("total_reminders","value");
    data_reminder_settings.put("notification_type","1");
    data.put("reminder_settings",data_reminder_settings);
    data.put("auth_mode","value");
    data.put("rule_type","value");
    data_deprovision_from_agent=List();
    data.put("deprovision_from_agent",data_deprovision_from_agent);
    data.put("email_unmanaged_alerts","value");
    data.put("expiry_duration_in_millis","value");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/enrollmentsettings"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/enrollmentsettings' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"deprovision_from_agent":[],"expiry_duration_in_millis":"604800000","auth_mode":"0","notify_device_unmanaged":false,"block_after":"0","preserve_frp":true,"reminder_settings":{"disabled":true},"android_dpc_type":"1","show_owned_by_option":false,"is_user_signout":false,"wipe_after":0,"block_personal_profile":false,"is_auto_deprovision":false,"email_unmanaged_alerts":""}'

Sample Request Body

Save enrollment settings with no authentication, ME MDM agent, reminders disabled, and default settings

Copied!

  {
    "deprovision_from_agent": [],
    "expiry_duration_in_millis": "604800000",
    "auth_mode": "0",
    "notify_device_unmanaged": false,
    "block_after": "0",
    "preserve_frp": true,
    "reminder_settings": {
      "disabled": true
    },
    "android_dpc_type": "1",
    "show_owned_by_option": false,
    "is_user_signout": false,
    "wipe_after": 0,
    "block_personal_profile": false,
    "is_auto_deprovision": false,
    "email_unmanaged_alerts": ""
  }

▼ Show full

Enrollment settings are saved with AD authentication configured for a specific Active Directory.

Copied!

  {
    "deprovision_from_agent": [],
    "expiry_duration_in_millis": "604800000",
    "auth_mode": "2",
    "notify_device_unmanaged": false,
    "block_after": "0",
    "preserve_frp": true,
    "reminder_settings": {
      "disabled": true
    },
    "android_dpc_type": "1",
    "domain_id": "9007199254741297",
    "rule_type": "authenticated_user",
    "show_owned_by_option": false,
    "is_user_signout": false,
    "wipe_after": 0,
    "block_personal_profile": false,
    "is_auto_deprovision": false,
    "email_unmanaged_alerts": ""
  }

▼ Show full

Save enrollment settings with combined OTP and Legacy authentication, Android Device Policy agent, auto deprovision, user signout, block personal profile, and reminder notifications enabled

Copied!

  {
    "deprovision_from_agent": [],
    "expiry_duration_in_millis": "604800000",
    "auth_mode": "3",
    "notify_device_unmanaged": false,
    "block_after": "5",
    "preserve_frp": true,
    "reminder_settings": {
      "notification_type": 1,
      "start_after": "2",
      "total_reminders": "2",
      "time_of_day": "9",
      "interval": "1"
    },
    "android_dpc_type": "2",
    "rule_type": "legacy_authentication",
    "show_owned_by_option": true,
    "is_user_signout": true,
    "wipe_after": 10,
    "block_personal_profile": true,
    "is_auto_deprovision": true,
    "email_unmanaged_alerts": ""
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

statusstring

Current status. Set to 'acknowledged' if enrollment settings were successfully saved

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Enrollment settings saved successfully

Copied!

  {
    "status": "acknowledged"
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.