Retrieve current enrollment settings

Fetches enrollment settings

Endpoints

get /api/v1/mdm/enrollmentsettings

Copy full URL

Request URL

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

Scope

MDMAdmin.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/api/v1/mdm/enrollmentsettings \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

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("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

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

conn.request("GET", "/api/v1/mdm/enrollmentsettings", headers=headers)

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

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


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

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

    info response;

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/enrollmentsettings' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

available_domain_listJSON Array

List of authentication domains integrated with the MDM server, used to configure AD Authentication

Show Sub-Attributes

JSON Object

Show Sub-Attributes

domain_idstring

Unique identifier of the domain

rule_typestring

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

namestring

Display name of the domain

client_idstring

Client identifier for the domain

deprovision_from_agentarray

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

expiry_duration_in_millisstring

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

auth_modestring

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

reminder_settingsJSON Object

Enrollment reminder notification settings

Show Sub-Attributes

disabledboolean

Whether reminders are disabled

notification_typestring

Notification type. 1 = Email

start_afterstring

Days after invite to start sending reminders

total_remindersstring

Total number of reminders to send

time_of_daystring

Hour of day (0-23) to send reminders

intervalstring

Days between consecutive reminders

exact_execute_time_with_minstring

Exact scheduled time in HH:mm format

enrollment_settings_idstring

Unique identifier for the enrollment settings

android_dpc_typestring

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

block_afterstring

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

wipe_afterstring

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

block_personal_profileboolean

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

preserve_frpboolean

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

configured_domain_detailsJSON Object

Directory details configured for AD authentication

Show Sub-Attributes

domain_idstring

Unique identifier of the domain

rule_typestring

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

namestring

Display name of the configured directory

client_idstring

Client identifier for the domain

show_owned_by_optionboolean

Whether owned-by option is shown during invite enrollment request creation

is_user_signoutboolean

Whether to sign out Google Workspace users on deprovision

is_auto_deprovisionboolean

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

notify_device_unmanagedboolean

Whether to send mail notification when devices are unmanaged

email_unmanaged_alertsstring

Email addresses notified when a device gets unmanaged

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Basic enrollment configuration with no authentication, ME MDM agent usage, and reminders disabled.

Copied!

  {
    "available_domain_list": [
      {
        "domain_id": "9007199254741297",
        "rule_type": "authenticated_user",
        "name": "idp.zylker.com",
        "client_id": "9007199254741036"
      },
      {
        "rule_type": "legacy_authentication",
        "name": "Legacy Authentication"
      }
    ],
    "deprovision_from_agent": [],
    "expiry_duration_in_millis": "604800000",
    "auth_mode": "0",
    "block_after": "0",
    "notify_device_unmanaged": false,
    "preserve_frp": true,
    "is_ad_integrated": true,
    "enrollment_settings_id": "9007199254740995",
    "android_dpc_type": "1",
    "is_authentication_handling_available": true,
    "show_owned_by_option": false,
    "wipe_after": "10",
    "block_personal_profile": false,
    "is_user_signout": false,
    "is_auto_deprovision": false,
    "email_unmanaged_alerts": ""
  }

▼ Show full

Enrollment settings configured with both OTP and AD authentication, invite reminders enabled, and Android Device Policy agent.

Copied!

  {
    "available_domain_list": [
      {
        "domain_id": "9007199254741297",
        "rule_type": "authenticated_user",
        "name": "idp.zylker.com",
        "client_id": "9007199254741036"
      },
      {
        "rule_type": "legacy_authentication",
        "name": "Legacy Authentication"
      }
    ],
    "expiry_duration_in_millis": "604800000",
    "auth_mode": "3",
    "block_after": "5",
    "notify_device_unmanaged": true,
    "preserve_frp": true,
    "is_ad_integrated": true,
    "reminder_settings": {
      "notification_type": "1",
      "start_after": "2",
      "total_reminders": "2",
      "time_of_day": "9",
      "interval": "1",
      "exact_execute_time_with_min": "09:47"
    },
    "enrollment_settings_id": "9509000000029375",
    "android_dpc_type": "2",
    "pending_count": "0",
    "is_authentication_handling_available": true,
    "configured_domain_details": {
      "rule_type": "legacy_authentication",
      "name": "Legacy Authentication"
    },
    "show_owned_by_option": true,
    "wipe_after": "10",
    "block_personal_profile": true,
    "is_user_signout": false,
    "is_auto_deprovision": true,
    "email_unmanaged_alerts": "admin@zylker.com"
  }

▼ Show full

Duration: 1 minute | Threshold: 120 | 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.