# Save enrollment settings for on-premises

Save enrollment settings On premise

## Endpoint

**POST** `/api/v1/mdm/enrollmentsettings`

## Request URL

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

## Scope

`MDMAdmin.CREATE`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Content-Type** `string` **Mandatory**: `application/json`
- **Accept** `string` **Mandatory**: `application/json`

### Request Body

`application/json`

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

## Sample Request

```curl
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":""}'
```

## Sample Request Body

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

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

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

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

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

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

## Response Parameters

### HTTP code 200

Response Body — `application/json`

- `status` `string`: Current status. Set to `acknowledged` if enrollment settings were successfully saved

## Possible Response Codes

- **200** HTTP code

## Sample Response: HTTP 200

Enrollment settings saved successfully

```json
{
  "status": "acknowledged"
}
```

## API Rate Limits

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