# Retrieve current enrollment settings

Fetches enrollment settings.

## Endpoints

**GET** `/api/v1/mdm/enrollmentsettings`

## Request URL

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

## Scope

`MDMAdmin.READ`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Accept** (`string`, Mandatory): `application/json`

## Sample Request

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

## Response Parameters

### HTTP code 200

Response Body — `application/json`

- `available_domain_list` (`JSON Array`): List of authentication domains integrated with the MDM server, used to configure AD Authentication.
- `deprovision_from_agent` (`array`): Deprovisioning allowed from agent for enrollment modes. Values: invite, self.
- `expiry_duration_in_millis` (`string`): Invite expiry duration in milliseconds. Example: 604800000 (7 days)
- `auth_mode` (`string`): Invite enrollment auth mode. 0 = No Auth, 1 = OTP, 2 = AD Authentication, 3 = Both OTP and AD
- `reminder_settings` (`JSON Object`): Enrollment reminder notification settings.
- `enrollment_settings_id` (`string`): Unique identifier for the enrollment settings.
- `android_dpc_type` (`string`): Android DPC agent type used in android enrollment. 1 = ME MDM, 2 = Android Device Policy
- `block_after` (`string`): Days after which a non-compliant device is blocked. 0 = no blocking. Applicable when Android Device Policy is enabled
- `wipe_after` (`string`): Days after which a non-compliant device is wiped. Applicable when Android Device Policy is enabled
- `block_personal_profile` (`boolean`): Whether personal profile is blocked on company-owned devices. Applicable when Android Device Policy is enabled
- `preserve_frp` (`boolean`): Whether Factory Reset Protection is preserved on wipe. Applicable when Android Device Policy is enabled
- `configured_domain_details` (`JSON Object`): Directory details configured for AD authentication.
- `show_owned_by_option` (`boolean`): Whether owned-by option is shown during invite enrollment request creation
- `is_user_signout` (`boolean`): Whether to sign out Google Workspace users on deprovision
- `is_auto_deprovision` (`boolean`): Whether to auto-deprovision when users are disabled in directory. Applicable for Okta Directory only.
- `notify_device_unmanaged` (`boolean`): Whether to send mail notification when devices are unmanaged
- `email_unmanaged_alerts` (`string`): Email addresses notified when a device gets unmanaged

## Possible Response Codes

- **200** — HTTP code

## Sample Response: HTTP 200

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

```json
{
  "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": ""
}
```

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

```json
{
  "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"
}
```

## Rate Limit

**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.