Skip to content

Create a DEP profile
Stable

Request

Creates a new DEP profile for the tenant.

Creates a Device Enrollment Program profile controlling which setup screens are shown to the user during initial iOS device setup, and whether setup advances automatically.

About DEP Profiles A DEP profile controls the out-of-box setup experience for iOS devices enrolled via Apple Business Manager. Different profiles can be created for different deployment scenarios (e.g., single-purpose kiosk devices versus general-use devices).

Key Fields / Query Parameters

  • show_setup_items — List of setup items to show during device enrollment; if omitted or empty, all items are skipped
  • auto_advance_setup — Whether to automatically advance through setup screens; defaults to true if not specified, and only applies when applicable setup items are shown

Common Use Cases

  • Creating a streamlined, hands-off setup profile for single-purpose kiosk devices
  • Defining a setup experience that shows specific configuration screens for general-use devices
  • Building distinct profiles for different device cohorts (e.g., retail vs. warehouse)

Best Practices

  • Set show_setup_items deliberately — leaving it empty skips all setup screens, which is appropriate for kiosk-style zero-touch deployments but not general-use devices
  • Test a new profile on a single device before assigning it to a large DEP device order
  • Keep auto_advance_setup aligned with whether an unattended setup experience is desired

Workflow

  1. Decide which setup screens (if any) end users should see
  2. POST the show_setup_items and auto_advance_setup configuration to this endpoint
  3. Assign the resulting profile to devices via Apple Business Manager / Esper's DEP enrollment flow
Security
tenant_apiKey
Bodyapplication/json
show_setup_itemsArray of strings, unique

List of setup items to show during device enrollment. If not provided or empty, all items will be skipped (default behavior).

Items Enum:"AccessibilityAppearance""ActionButton""Android""Appearance""AppleID""AppStore""Biometric""CameraButton""DeviceToDeviceMigration""Diagnostics"
auto_advance_setupboolean

Whether to automatically advance through setup screens. Defaults to true if not specified. Only applicable to TvOS devices.

Default:true
cURL
curl -i -X POST \
  https://develop-api.esper.io/_mock/openapi/tenant/v0/depprofiles/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "show_setup_items": [
      "AccessibilityAppearance"
    ],
    "auto_advance_setup": true
  }'

Responses

Updated the DEP profile for the tenant

Bodyapplication/json
codeinteger
messagestring
contentobject(tenant_DEPProfile)
Response
{ "code": 0, "message": "string", "content": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "profile_uuid": "string", "show_setup_items": [ … ], "auto_advance_setup": true, "created_by": "string", "updated_by": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } }