Retrieve enrollment template details

GET

https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/enrollment-templates/{admEnrollmentTemplateId}

curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/enrollment-templates/{admEnrollmentTemplateId}" \
  -H "Authorization: Bearer <YOUR_API_KEY>"

const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/enrollment-templates/{admEnrollmentTemplateId}", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();

import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/enrollment-templates/{admEnrollmentTemplateId}",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

admEnrollmentTemplateId string

required

Unique identifier for Apple enrollment template configuration within organizational MDM deployment.

Match pattern: ^[a-fA-F0-9]{24}$

Responses

200 Response application/json

status boolean optional

data object optional

id string optional

Unique identifier for Apple enrollment template configuration within organizational MDM deployment.

Match pattern: ^[a-fA-F0-9]{24}$

name string optional

Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.

≤ 128 characters

description string optional

Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.

≤ 256 characters

rules array [object] optional

Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.

name string optional

Rule name identifying specific device configuration policy within enrollment template workflow.

≤ 256 characters

displayNamePattern string optional

Device naming pattern template using placeholders for automatic device name generation during enrollment.

≤ 256 characters

setDeviceName boolean optional

Flag enabling automatic device naming based on displayNamePattern during enrollment process.

tags array [string] optional

Classification tags applied to devices enrolled with this rule for organization and policy targeting.

conditions array [object] optional

Conditional criteria array determining when specific enrollment rule applies during device onboarding workflow.

admPolicyId string optional

Apple Device Management policy identifier linking enrollment rule to device configuration and restriction settings.

Match pattern: ^[a-fA-F0-9]{24}$

admPolicyAssignments array [object] optional

Array of policy assignments with priority ordering for devices enrolled under this enrollment rule.

commands array [object] optional

Array of MDM commands automatically executed on devices during enrollment rule application process.

admVppLocationId string optional

Volume Purchase Program location identifier for automatic app assignment during device enrollment.

Match pattern: ^[a-fA-F0-9]{24}$

admVppLocationInfo object optional

Volume Purchase Program location metadata containing app distribution and purchasing configuration details.

allowActivationLock boolean optional

Flag permitting iOS Activation Lock feature enabling device theft protection during enrollment.

setupAssistantEnable boolean optional

Flag enabling Setup Assistant presentation during device enrollment for user configuration guidance.

setupAssistantSkippable boolean optional

Flag allowing users to skip Setup Assistant steps during enrollment for faster device activation.

skipPersonalInfo boolean optional

Flag bypassing personal information collection in Setup Assistant during corporate device enrollment.

segmentId integer optional

Optional segment identifier for targeting enrollment device to a specific segment.

≥ 0

auxiliaryFields array [object] optional

Array of custom input fields collected from users during enrollment for conditional policy application.

type string optional

Input field type determining validation and presentation format for custom user data collection.

select text

key string required

Unique field identifier key used for storing and referencing custom user data in enrollment workflow.

≤ 128 characters

title string optional

Human-readable field label displayed to users during enrollment data collection process.

≤ 128 characters

description string optional

Explanatory field description providing guidance to users during custom data input.

≤ 256 characters

options array [string] optional

Array of selectable values presented to users when auxiliary field type is select.

loginProviderTypes array [string] optional

Array of authentication provider types permitted for user verification during device enrollment workflow.

allowAutoContinue boolean optional

Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.

version string optional

Sequential version string tracking enrollment template configuration changes and synchronization state.

≤ 128 characters

updatedAt string optional

Timestamp indicating when enrollment template configuration was last modified or synchronized.

Format: date-time

createdAt string optional

Timestamp indicating when enrollment template configuration was initially created in system.

Format: date-time

devicesCount integer optional

Total number of Apple devices currently enrolled and managed using this enrollment template.

≥ 0

segmentId integer optional

Segment identifier for scoping smart enrollment into an specific segment

≥ 0

{
    "status": true,
    "data": {
        "id": "698f2b1c18f11470ce02da32",
        "name": "Sales Team iPad Enrollment",
        "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
        "rules": [
            {
                "name": "Executive Device Setup",
                "displayNamePattern": "{firstName}-{lastName}-iPad",
                "setDeviceName": true,
                "tags": [
                    "executive",
                    "high-security"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "executive"
                            ],
                            [
                                "manager",
                                "director"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "department:sales"
                            ],
                            [
                                "location:hq"
                            ]
                        ],
                        "patterns": [
                            "^iPad.*",
                            ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
          name
          string
          
          optional
          
        
        Rule name identifying specific device configuration policy within enrollment template workflow.
≤ 256 characters
      

        
          displayNamePattern
          string
          
          optional
          
        
        Device naming pattern template using placeholders for automatic device name generation during enrollment.
≤ 256 characters
      

        
          setDeviceName
          boolean
          
          optional
          
        
        Flag enabling automatic device naming based on displayNamePattern during enrollment process.
      

        
          tags
          array [string]
          
          optional
          
        
        Classification tags applied to devices enrolled with this rule for organization and policy targeting.
      

        
          
          conditions
          array [object]
          
          optional
          
        
        Conditional criteria array determining when specific enrollment rule applies during device onboarding workflow.
        
          
        
      

        
          admPolicyId
          string
          
          optional
          
        
        Apple Device Management policy identifier linking enrollment rule to device configuration and restriction settings.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admPolicyAssignments
          array [object]
          
          optional
          
        
        Array of policy assignments with priority ordering for devices enrolled under this enrollment rule.
        
          
        
      

        
          
          commands
          array [object]
          
          optional
          
        
        Array of MDM commands automatically executed on devices during enrollment rule application process.
        
          
        
      

        
          admVppLocationId
          string
          
          optional
          
        
        Volume Purchase Program location identifier for automatic app assignment during device enrollment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admVppLocationInfo
          object
          
          optional
          
        
        Volume Purchase Program location metadata containing app distribution and purchasing configuration details.
        
          
        
      

        
          allowActivationLock
          boolean
          
          optional
          
        
        Flag permitting iOS Activation Lock feature enabling device theft protection during enrollment.
      

        
          setupAssistantEnable
          boolean
          
          optional
          
        
        Flag enabling Setup Assistant presentation during device enrollment for user configuration guidance.
      

        
          setupAssistantSkippable
          boolean
          
          optional
          
        
        Flag allowing users to skip Setup Assistant steps during enrollment for faster device activation.
      

        
          skipPersonalInfo
          boolean
          
          optional
          
        
        Flag bypassing personal information collection in Setup Assistant during corporate device enrollment.
      

        
          segmentId
          integer
          
          optional
          
        
        Optional segment identifier for targeting enrollment device to a specific segment.
≥ 0
      
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
          type
          string
          
          optional
          
        
        Input field type determining validation and presentation format for custom user data collection.
select text
      

        
          key
          string
          
          required
          
        
        Unique field identifier key used for storing and referencing custom user data in enrollment workflow.
≤ 128 characters
      

        
          title
          string
          
          optional
          
        
        Human-readable field label displayed to users during enrollment data collection process.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Explanatory field description providing guidance to users during custom data input.
≤ 256 characters
      

        
          options
          array [string]
          
          optional
          
        
        Array of selectable values presented to users when auxiliary field type is select.
      
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          version
          string
          
          optional
          
        
        Sequential version string tracking enrollment template configuration changes and synchronization state.
≤ 128 characters
      

        
          updatedAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was last modified or synchronized.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment into an specific segment
≥ 0
      
        
      
        
        
          
            
            {
    "status": true,
    "data": {
        "id": "698f2b1c18f11470ce02da32",
        "name": "Sales Team iPad Enrollment",
        "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
        "rules": [
            {
                "name": "Executive Device Setup",
                "displayNamePattern": "{firstName}-{lastName}-iPad",
                "setDeviceName": true,
                "tags": [
                    "executive",
                    "high-security"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "executive"
                            ],
                            [
                                "manager",
                                "director"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "department:sales"
                            ],
                            [
                                "location:hq"
                            ]
                        ],
                        "patterns": [
                            "^iPad.*",
                            ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
          name
          string
          
          optional
          
        
        Rule name identifying specific device configuration policy within enrollment template workflow.
≤ 256 characters
      

        
          displayNamePattern
          string
          
          optional
          
        
        Device naming pattern template using placeholders for automatic device name generation during enrollment.
≤ 256 characters
      

        
          setDeviceName
          boolean
          
          optional
          
        
        Flag enabling automatic device naming based on displayNamePattern during enrollment process.
      

        
          tags
          array [string]
          
          optional
          
        
        Classification tags applied to devices enrolled with this rule for organization and policy targeting.
      

        
          
          conditions
          array [object]
          
          optional
          
        
        Conditional criteria array determining when specific enrollment rule applies during device onboarding workflow.
        
          
        
      

        
          admPolicyId
          string
          
          optional
          
        
        Apple Device Management policy identifier linking enrollment rule to device configuration and restriction settings.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admPolicyAssignments
          array [object]
          
          optional
          
        
        Array of policy assignments with priority ordering for devices enrolled under this enrollment rule.
        
          
        
      

        
          
          commands
          array [object]
          
          optional
          
        
        Array of MDM commands automatically executed on devices during enrollment rule application process.
        
          
        
      

        
          admVppLocationId
          string
          
          optional
          
        
        Volume Purchase Program location identifier for automatic app assignment during device enrollment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admVppLocationInfo
          object
          
          optional
          
        
        Volume Purchase Program location metadata containing app distribution and purchasing configuration details.
        
          
        
      

        
          allowActivationLock
          boolean
          
          optional
          
        
        Flag permitting iOS Activation Lock feature enabling device theft protection during enrollment.
      

        
          setupAssistantEnable
          boolean
          
          optional
          
        
        Flag enabling Setup Assistant presentation during device enrollment for user configuration guidance.
      

        
          setupAssistantSkippable
          boolean
          
          optional
          
        
        Flag allowing users to skip Setup Assistant steps during enrollment for faster device activation.
      

        
          skipPersonalInfo
          boolean
          
          optional
          
        
        Flag bypassing personal information collection in Setup Assistant during corporate device enrollment.
      

        
          segmentId
          integer
          
          optional
          
        
        Optional segment identifier for targeting enrollment device to a specific segment.
≥ 0
      
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
          type
          string
          
          optional
          
        
        Input field type determining validation and presentation format for custom user data collection.
select text
      

        
          key
          string
          
          required
          
        
        Unique field identifier key used for storing and referencing custom user data in enrollment workflow.
≤ 128 characters
      

        
          title
          string
          
          optional
          
        
        Human-readable field label displayed to users during enrollment data collection process.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Explanatory field description providing guidance to users during custom data input.
≤ 256 characters
      

        
          options
          array [string]
          
          optional
          
        
        Array of selectable values presented to users when auxiliary field type is select.
      
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          version
          string
          
          optional
          
        
        Sequential version string tracking enrollment template configuration changes and synchronization state.
≤ 128 characters
      

        
          updatedAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was last modified or synchronized.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment into an specific segment
≥ 0
      
        
      
        
        
          
            
            {
    "status": true,
    "data": {
        "id": "698f2b1c18f11470ce02da32",
        "name": "Sales Team iPad Enrollment",
        "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
        "rules": [
            {
                "name": "Executive Device Setup",
                "displayNamePattern": "{firstName}-{lastName}-iPad",
                "setDeviceName": true,
                "tags": [
                    "executive",
                    "high-security"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "executive"
                            ],
                            [
                                "manager",
                                "director"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "department:sales"
                            ],
                            [
                                "location:hq"
                            ]
                        ],
                        "patterns": [
                            "^iPad.*",
                            ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
          name
          string
          
          optional
          
        
        Rule name identifying specific device configuration policy within enrollment template workflow.
≤ 256 characters
      

        
          displayNamePattern
          string
          
          optional
          
        
        Device naming pattern template using placeholders for automatic device name generation during enrollment.
≤ 256 characters
      

        
          setDeviceName
          boolean
          
          optional
          
        
        Flag enabling automatic device naming based on displayNamePattern during enrollment process.
      

        
          tags
          array [string]
          
          optional
          
        
        Classification tags applied to devices enrolled with this rule for organization and policy targeting.
      

        
          
          conditions
          array [object]
          
          optional
          
        
        Conditional criteria array determining when specific enrollment rule applies during device onboarding workflow.
        
          
        
      

        
          admPolicyId
          string
          
          optional
          
        
        Apple Device Management policy identifier linking enrollment rule to device configuration and restriction settings.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admPolicyAssignments
          array [object]
          
          optional
          
        
        Array of policy assignments with priority ordering for devices enrolled under this enrollment rule.
        
          
        
      

        
          
          commands
          array [object]
          
          optional
          
        
        Array of MDM commands automatically executed on devices during enrollment rule application process.
        
          
        
      

        
          admVppLocationId
          string
          
          optional
          
        
        Volume Purchase Program location identifier for automatic app assignment during device enrollment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admVppLocationInfo
          object
          
          optional
          
        
        Volume Purchase Program location metadata containing app distribution and purchasing configuration details.
        
          
        
      

        
          allowActivationLock
          boolean
          
          optional
          
        
        Flag permitting iOS Activation Lock feature enabling device theft protection during enrollment.
      

        
          setupAssistantEnable
          boolean
          
          optional
          
        
        Flag enabling Setup Assistant presentation during device enrollment for user configuration guidance.
      

        
          setupAssistantSkippable
          boolean
          
          optional
          
        
        Flag allowing users to skip Setup Assistant steps during enrollment for faster device activation.
      

        
          skipPersonalInfo
          boolean
          
          optional
          
        
        Flag bypassing personal information collection in Setup Assistant during corporate device enrollment.
      

        
          segmentId
          integer
          
          optional
          
        
        Optional segment identifier for targeting enrollment device to a specific segment.
≥ 0
      
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
          type
          string
          
          optional
          
        
        Input field type determining validation and presentation format for custom user data collection.
select text
      

        
          key
          string
          
          required
          
        
        Unique field identifier key used for storing and referencing custom user data in enrollment workflow.
≤ 128 characters
      

        
          title
          string
          
          optional
          
        
        Human-readable field label displayed to users during enrollment data collection process.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Explanatory field description providing guidance to users during custom data input.
≤ 256 characters
      

        
          options
          array [string]
          
          optional
          
        
        Array of selectable values presented to users when auxiliary field type is select.
      
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          version
          string
          
          optional
          
        
        Sequential version string tracking enrollment template configuration changes and synchronization state.
≤ 128 characters
      

        
          updatedAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was last modified or synchronized.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment into an specific segment
≥ 0
      
        
      
        
        
          
            
            {
    "status": true,
    "data": {
        "id": "698f2b1c18f11470ce02da32",
        "name": "Sales Team iPad Enrollment",
        "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
        "rules": [
            {
                "name": "Executive Device Setup",
                "displayNamePattern": "{firstName}-{lastName}-iPad",
                "setDeviceName": true,
                "tags": [
                    "executive",
                    "high-security"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "executive"
                            ],
                            [
                                "manager",
                                "director"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "department:sales"
                            ],
                            [
                                "location:hq"
                            ]
                        ],
                        "patterns": [
                            "^iPad.*",
                            ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
          name
          string
          
          optional
          
        
        Rule name identifying specific device configuration policy within enrollment template workflow.
≤ 256 characters
      

        
          displayNamePattern
          string
          
          optional
          
        
        Device naming pattern template using placeholders for automatic device name generation during enrollment.
≤ 256 characters
      

        
          setDeviceName
          boolean
          
          optional
          
        
        Flag enabling automatic device naming based on displayNamePattern during enrollment process.
      

        
          tags
          array [string]
          
          optional
          
        
        Classification tags applied to devices enrolled with this rule for organization and policy targeting.
      

        
          
          conditions
          array [object]
          
          optional
          
        
        Conditional criteria array determining when specific enrollment rule applies during device onboarding workflow.
        
          
        
      

        
          admPolicyId
          string
          
          optional
          
        
        Apple Device Management policy identifier linking enrollment rule to device configuration and restriction settings.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admPolicyAssignments
          array [object]
          
          optional
          
        
        Array of policy assignments with priority ordering for devices enrolled under this enrollment rule.
        
          
        
      

        
          
          commands
          array [object]
          
          optional
          
        
        Array of MDM commands automatically executed on devices during enrollment rule application process.
        
          
        
      

        
          admVppLocationId
          string
          
          optional
          
        
        Volume Purchase Program location identifier for automatic app assignment during device enrollment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admVppLocationInfo
          object
          
          optional
          
        
        Volume Purchase Program location metadata containing app distribution and purchasing configuration details.
        
          
        
      

        
          allowActivationLock
          boolean
          
          optional
          
        
        Flag permitting iOS Activation Lock feature enabling device theft protection during enrollment.
      

        
          setupAssistantEnable
          boolean
          
          optional
          
        
        Flag enabling Setup Assistant presentation during device enrollment for user configuration guidance.
      

        
          setupAssistantSkippable
          boolean
          
          optional
          
        
        Flag allowing users to skip Setup Assistant steps during enrollment for faster device activation.
      

        
          skipPersonalInfo
          boolean
          
          optional
          
        
        Flag bypassing personal information collection in Setup Assistant during corporate device enrollment.
      

        
          segmentId
          integer
          
          optional
          
        
        Optional segment identifier for targeting enrollment device to a specific segment.
≥ 0
      
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
          type
          string
          
          optional
          
        
        Input field type determining validation and presentation format for custom user data collection.
select text
      

        
          key
          string
          
          required
          
        
        Unique field identifier key used for storing and referencing custom user data in enrollment workflow.
≤ 128 characters
      

        
          title
          string
          
          optional
          
        
        Human-readable field label displayed to users during enrollment data collection process.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Explanatory field description providing guidance to users during custom data input.
≤ 256 characters
      

        
          options
          array [string]
          
          optional
          
        
        Array of selectable values presented to users when auxiliary field type is select.
      
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          version
          string
          
          optional
          
        
        Sequential version string tracking enrollment template configuration changes and synchronization state.
≤ 128 characters
      

        
          updatedAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was last modified or synchronized.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment into an specific segment
≥ 0
      
        
      
        
        
          
            
            {
    "status": true,
    "data": {
        "id": "698f2b1c18f11470ce02da32",
        "name": "Sales Team iPad Enrollment",
        "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
        "rules": [
            {
                "name": "Executive Device Setup",
                "displayNamePattern": "{firstName}-{lastName}-iPad",
                "setDeviceName": true,
                "tags": [
                    "executive",
                    "high-security"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "executive"
                            ],
                            [
                                "manager",
                                "director"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "department:sales"
                            ],
                            [
                                "location:hq"
                            ]
                        ],
                        "patterns": [
                            "^iPad.*",
                            ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
          name
          string
          
          optional
          
        
        Rule name identifying specific device configuration policy within enrollment template workflow.
≤ 256 characters
      

        
          displayNamePattern
          string
          
          optional
          
        
        Device naming pattern template using placeholders for automatic device name generation during enrollment.
≤ 256 characters
      

        
          setDeviceName
          boolean
          
          optional
          
        
        Flag enabling automatic device naming based on displayNamePattern during enrollment process.
      

        
          tags
          array [string]
          
          optional
          
        
        Classification tags applied to devices enrolled with this rule for organization and policy targeting.
      

        
          
          conditions
          array [object]
          
          optional
          
        
        Conditional criteria array determining when specific enrollment rule applies during device onboarding workflow.
        
          
        
      

        
          admPolicyId
          string
          
          optional
          
        
        Apple Device Management policy identifier linking enrollment rule to device configuration and restriction settings.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admPolicyAssignments
          array [object]
          
          optional
          
        
        Array of policy assignments with priority ordering for devices enrolled under this enrollment rule.
        
          
        
      

        
          
          commands
          array [object]
          
          optional
          
        
        Array of MDM commands automatically executed on devices during enrollment rule application process.
        
          
        
      

        
          admVppLocationId
          string
          
          optional
          
        
        Volume Purchase Program location identifier for automatic app assignment during device enrollment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admVppLocationInfo
          object
          
          optional
          
        
        Volume Purchase Program location metadata containing app distribution and purchasing configuration details.
        
          
        
      

        
          allowActivationLock
          boolean
          
          optional
          
        
        Flag permitting iOS Activation Lock feature enabling device theft protection during enrollment.
      

        
          setupAssistantEnable
          boolean
          
          optional
          
        
        Flag enabling Setup Assistant presentation during device enrollment for user configuration guidance.
      

        
          setupAssistantSkippable
          boolean
          
          optional
          
        
        Flag allowing users to skip Setup Assistant steps during enrollment for faster device activation.
      

        
          skipPersonalInfo
          boolean
          
          optional
          
        
        Flag bypassing personal information collection in Setup Assistant during corporate device enrollment.
      

        
          segmentId
          integer
          
          optional
          
        
        Optional segment identifier for targeting enrollment device to a specific segment.
≥ 0
      
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
          type
          string
          
          optional
          
        
        Input field type determining validation and presentation format for custom user data collection.
select text
      

        
          key
          string
          
          required
          
        
        Unique field identifier key used for storing and referencing custom user data in enrollment workflow.
≤ 128 characters
      

        
          title
          string
          
          optional
          
        
        Human-readable field label displayed to users during enrollment data collection process.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Explanatory field description providing guidance to users during custom data input.
≤ 256 characters
      

        
          options
          array [string]
          
          optional
          
        
        Array of selectable values presented to users when auxiliary field type is select.
      
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          version
          string
          
          optional
          
        
        Sequential version string tracking enrollment template configuration changes and synchronization state.
≤ 128 characters
      

        
          updatedAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was last modified or synchronized.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment into an specific segment
≥ 0
      
        
      
        
        
          
            
            {
    "status": true,
    "data": {
        "id": "698f2b1c18f11470ce02da32",
        "name": "Sales Team iPad Enrollment",
        "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
        "rules": [
            {
                "name": "Executive Device Setup",
                "displayNamePattern": "{firstName}-{lastName}-iPad",
                "setDeviceName": true,
                "tags": [
                    "executive",
                    "high-security"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "executive"
                            ],
                            [
                                "manager",
                                "director"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "department:sales"
                            ],
                            [
                                "location:hq"
                            ]
                        ],
                        "patterns": [
                            "^iPad.*",
                            ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
          name
          string
          
          optional
          
        
        Rule name identifying specific device configuration policy within enrollment template workflow.
≤ 256 characters
      

        
          displayNamePattern
          string
          
          optional
          
        
        Device naming pattern template using placeholders for automatic device name generation during enrollment.
≤ 256 characters
      

        
          setDeviceName
          boolean
          
          optional
          
        
        Flag enabling automatic device naming based on displayNamePattern during enrollment process.
      

        
          tags
          array [string]
          
          optional
          
        
        Classification tags applied to devices enrolled with this rule for organization and policy targeting.
      

        
          
          conditions
          array [object]
          
          optional
          
        
        Conditional criteria array determining when specific enrollment rule applies during device onboarding workflow.
        
          
        
      

        
          admPolicyId
          string
          
          optional
          
        
        Apple Device Management policy identifier linking enrollment rule to device configuration and restriction settings.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admPolicyAssignments
          array [object]
          
          optional
          
        
        Array of policy assignments with priority ordering for devices enrolled under this enrollment rule.
        
          
        
      

        
          
          commands
          array [object]
          
          optional
          
        
        Array of MDM commands automatically executed on devices during enrollment rule application process.
        
          
        
      

        
          admVppLocationId
          string
          
          optional
          
        
        Volume Purchase Program location identifier for automatic app assignment during device enrollment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admVppLocationInfo
          object
          
          optional
          
        
        Volume Purchase Program location metadata containing app distribution and purchasing configuration details.
        
          
        
      

        
          allowActivationLock
          boolean
          
          optional
          
        
        Flag permitting iOS Activation Lock feature enabling device theft protection during enrollment.
      

        
          setupAssistantEnable
          boolean
          
          optional
          
        
        Flag enabling Setup Assistant presentation during device enrollment for user configuration guidance.
      

        
          setupAssistantSkippable
          boolean
          
          optional
          
        
        Flag allowing users to skip Setup Assistant steps during enrollment for faster device activation.
      

        
          skipPersonalInfo
          boolean
          
          optional
          
        
        Flag bypassing personal information collection in Setup Assistant during corporate device enrollment.
      

        
          segmentId
          integer
          
          optional
          
        
        Optional segment identifier for targeting enrollment device to a specific segment.
≥ 0
      
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
          type
          string
          
          optional
          
        
        Input field type determining validation and presentation format for custom user data collection.
select text
      

        
          key
          string
          
          required
          
        
        Unique field identifier key used for storing and referencing custom user data in enrollment workflow.
≤ 128 characters
      

        
          title
          string
          
          optional
          
        
        Human-readable field label displayed to users during enrollment data collection process.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Explanatory field description providing guidance to users during custom data input.
≤ 256 characters
      

        
          options
          array [string]
          
          optional
          
        
        Array of selectable values presented to users when auxiliary field type is select.
      
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          version
          string
          
          optional
          
        
        Sequential version string tracking enrollment template configuration changes and synchronization state.
≤ 128 characters
      

        
          updatedAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was last modified or synchronized.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment into an specific segment
≥ 0
      
        
      
        
        
          
            
            {
    "status": true,
    "data": {
        "id": "698f2b1c18f11470ce02da32",
        "name": "Sales Team iPad Enrollment",
        "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
        "rules": [
            {
                "name": "Executive Device Setup",
                "displayNamePattern": "{firstName}-{lastName}-iPad",
                "setDeviceName": true,
                "tags": [
                    "executive",
                    "high-security"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "executive"
                            ],
                            [
                                "manager",
                                "director"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "department:sales"
                            ],
                            [
                                "location:hq"
                            ]
                        ],
                        "patterns": [
                            "^iPad.*",
                            ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
          name
          string
          
          optional
          
        
        Rule name identifying specific device configuration policy within enrollment template workflow.
≤ 256 characters
      

        
          displayNamePattern
          string
          
          optional
          
        
        Device naming pattern template using placeholders for automatic device name generation during enrollment.
≤ 256 characters
      

        
          setDeviceName
          boolean
          
          optional
          
        
        Flag enabling automatic device naming based on displayNamePattern during enrollment process.
      

        
          tags
          array [string]
          
          optional
          
        
        Classification tags applied to devices enrolled with this rule for organization and policy targeting.
      

        
          
          conditions
          array [object]
          
          optional
          
        
        Conditional criteria array determining when specific enrollment rule applies during device onboarding workflow.
        
          
        
      

        
          admPolicyId
          string
          
          optional
          
        
        Apple Device Management policy identifier linking enrollment rule to device configuration and restriction settings.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admPolicyAssignments
          array [object]
          
          optional
          
        
        Array of policy assignments with priority ordering for devices enrolled under this enrollment rule.
        
          
        
      

        
          
          commands
          array [object]
          
          optional
          
        
        Array of MDM commands automatically executed on devices during enrollment rule application process.
        
          
        
      

        
          admVppLocationId
          string
          
          optional
          
        
        Volume Purchase Program location identifier for automatic app assignment during device enrollment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admVppLocationInfo
          object
          
          optional
          
        
        Volume Purchase Program location metadata containing app distribution and purchasing configuration details.
        
          
        
      

        
          allowActivationLock
          boolean
          
          optional
          
        
        Flag permitting iOS Activation Lock feature enabling device theft protection during enrollment.
      

        
          setupAssistantEnable
          boolean
          
          optional
          
        
        Flag enabling Setup Assistant presentation during device enrollment for user configuration guidance.
      

        
          setupAssistantSkippable
          boolean
          
          optional
          
        
        Flag allowing users to skip Setup Assistant steps during enrollment for faster device activation.
      

        
          skipPersonalInfo
          boolean
          
          optional
          
        
        Flag bypassing personal information collection in Setup Assistant during corporate device enrollment.
      

        
          segmentId
          integer
          
          optional
          
        
        Optional segment identifier for targeting enrollment device to a specific segment.
≥ 0
      
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
          type
          string
          
          optional
          
        
        Input field type determining validation and presentation format for custom user data collection.
select text
      

        
          key
          string
          
          required
          
        
        Unique field identifier key used for storing and referencing custom user data in enrollment workflow.
≤ 128 characters
      

        
          title
          string
          
          optional
          
        
        Human-readable field label displayed to users during enrollment data collection process.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Explanatory field description providing guidance to users during custom data input.
≤ 256 characters
      

        
          options
          array [string]
          
          optional
          
        
        Array of selectable values presented to users when auxiliary field type is select.
      
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          version
          string
          
          optional
          
        
        Sequential version string tracking enrollment template configuration changes and synchronization state.
≤ 128 characters
      

        
          updatedAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was last modified or synchronized.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment into an specific segment
≥ 0
      
        
      
        
        
          
            
            {
    "status": true,
    "data": {
        "id": "698f2b1c18f11470ce02da32",
        "name": "Sales Team iPad Enrollment",
        "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
        "rules": [
            {
                "name": "Executive Device Setup",
                "displayNamePattern": "{firstName}-{lastName}-iPad",
                "setDeviceName": true,
                "tags": [
                    "executive",
                    "high-security"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "executive"
                            ],
                            [
                                "manager",
                                "director"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "department:sales"
                            ],
                            [
                                "location:hq"
                            ]
                        ],
                        "patterns": [
                            "^iPad.*",
                            ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
          name
          string
          
          optional
          
        
        Rule name identifying specific device configuration policy within enrollment template workflow.
≤ 256 characters
      

        
          displayNamePattern
          string
          
          optional
          
        
        Device naming pattern template using placeholders for automatic device name generation during enrollment.
≤ 256 characters
      

        
          setDeviceName
          boolean
          
          optional
          
        
        Flag enabling automatic device naming based on displayNamePattern during enrollment process.
      

        
          tags
          array [string]
          
          optional
          
        
        Classification tags applied to devices enrolled with this rule for organization and policy targeting.
      

        
          
          conditions
          array [object]
          
          optional
          
        
        Conditional criteria array determining when specific enrollment rule applies during device onboarding workflow.
        
          
        
      

        
          admPolicyId
          string
          
          optional
          
        
        Apple Device Management policy identifier linking enrollment rule to device configuration and restriction settings.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admPolicyAssignments
          array [object]
          
          optional
          
        
        Array of policy assignments with priority ordering for devices enrolled under this enrollment rule.
        
          
        
      

        
          
          commands
          array [object]
          
          optional
          
        
        Array of MDM commands automatically executed on devices during enrollment rule application process.
        
          
        
      

        
          admVppLocationId
          string
          
          optional
          
        
        Volume Purchase Program location identifier for automatic app assignment during device enrollment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admVppLocationInfo
          object
          
          optional
          
        
        Volume Purchase Program location metadata containing app distribution and purchasing configuration details.
        
          
        
      

        
          allowActivationLock
          boolean
          
          optional
          
        
        Flag permitting iOS Activation Lock feature enabling device theft protection during enrollment.
      

        
          setupAssistantEnable
          boolean
          
          optional
          
        
        Flag enabling Setup Assistant presentation during device enrollment for user configuration guidance.
      

        
          setupAssistantSkippable
          boolean
          
          optional
          
        
        Flag allowing users to skip Setup Assistant steps during enrollment for faster device activation.
      

        
          skipPersonalInfo
          boolean
          
          optional
          
        
        Flag bypassing personal information collection in Setup Assistant during corporate device enrollment.
      

        
          segmentId
          integer
          
          optional
          
        
        Optional segment identifier for targeting enrollment device to a specific segment.
≥ 0
      
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
          type
          string
          
          optional
          
        
        Input field type determining validation and presentation format for custom user data collection.
select text
      

        
          key
          string
          
          required
          
        
        Unique field identifier key used for storing and referencing custom user data in enrollment workflow.
≤ 128 characters
      

        
          title
          string
          
          optional
          
        
        Human-readable field label displayed to users during enrollment data collection process.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Explanatory field description providing guidance to users during custom data input.
≤ 256 characters
      

        
          options
          array [string]
          
          optional
          
        
        Array of selectable values presented to users when auxiliary field type is select.
      
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          version
          string
          
          optional
          
        
        Sequential version string tracking enrollment template configuration changes and synchronization state.
≤ 128 characters
      

        
          updatedAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was last modified or synchronized.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment into an specific segment
≥ 0
      
        
      
        
        
          
            
            {
    "status": true,
    "data": {
        "id": "698f2b1c18f11470ce02da32",
        "name": "Sales Team iPad Enrollment",
        "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
        "rules": [
            {
                "name": "Executive Device Setup",
                "displayNamePattern": "{firstName}-{lastName}-iPad",
                "setDeviceName": true,
                "tags": [
                    "executive",
                    "high-security"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "executive"
                            ],
                            [
                                "manager",
                                "director"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "department:sales"
                            ],
                            [
                                "location:hq"
                            ]
                        ],
                        "patterns": [
                            "^iPad.*",
                            ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
          name
          string
          
          optional
          
        
        Rule name identifying specific device configuration policy within enrollment template workflow.
≤ 256 characters
      

        
          displayNamePattern
          string
          
          optional
          
        
        Device naming pattern template using placeholders for automatic device name generation during enrollment.
≤ 256 characters
      

        
          setDeviceName
          boolean
          
          optional
          
        
        Flag enabling automatic device naming based on displayNamePattern during enrollment process.
      

        
          tags
          array [string]
          
          optional
          
        
        Classification tags applied to devices enrolled with this rule for organization and policy targeting.
      

        
          
          conditions
          array [object]
          
          optional
          
        
        Conditional criteria array determining when specific enrollment rule applies during device onboarding workflow.
        
          
        
      

        
          admPolicyId
          string
          
          optional
          
        
        Apple Device Management policy identifier linking enrollment rule to device configuration and restriction settings.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admPolicyAssignments
          array [object]
          
          optional
          
        
        Array of policy assignments with priority ordering for devices enrolled under this enrollment rule.
        
          
        
      

        
          
          commands
          array [object]
          
          optional
          
        
        Array of MDM commands automatically executed on devices during enrollment rule application process.
        
          
        
      

        
          admVppLocationId
          string
          
          optional
          
        
        Volume Purchase Program location identifier for automatic app assignment during device enrollment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          
          admVppLocationInfo
          object
          
          optional
          
        
        Volume Purchase Program location metadata containing app distribution and purchasing configuration details.
        
          
        
      

        
          allowActivationLock
          boolean
          
          optional
          
        
        Flag permitting iOS Activation Lock feature enabling device theft protection during enrollment.
      

        
          setupAssistantEnable
          boolean
          
          optional
          
        
        Flag enabling Setup Assistant presentation during device enrollment for user configuration guidance.
      

        
          setupAssistantSkippable
          boolean
          
          optional
          
        
        Flag allowing users to skip Setup Assistant steps during enrollment for faster device activation.
      

        
          skipPersonalInfo
          boolean
          
          optional
          
        
        Flag bypassing personal information collection in Setup Assistant during corporate device enrollment.
      

        
          segmentId
          integer
          
          optional
          
        
        Optional segment identifier for targeting enrollment device to a specific segment.
≥ 0
      
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
          type
          string
          
          optional
          
        
        Input field type determining validation and presentation format for custom user data collection.
select text
      

        
          key
          string
          
          required
          
        
        Unique field identifier key used for storing and referencing custom user data in enrollment workflow.
≤ 128 characters
      

        
          title
          string
          
          optional
          
        
        Human-readable field label displayed to users during enrollment data collection process.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Explanatory field description providing guidance to users during custom data input.
≤ 256 characters
      

        
          options
          array [string]
          
          optional
          
        
        Array of selectable values presented to users when auxiliary field type is select.
      
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          version
          string
          
          optional
          
        
        Sequential version string tracking enrollment template configuration changes and synchronization state.
≤ 128 characters
      

        
          updatedAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was last modified or synchronized.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment into an specific segment
≥ 0
      
        
      
        
        
          
            
            {
    "status": true,
    "data": {
        "id": "698f2b1c18f11470ce02da32",
        "name": "Sales Team iPad Enrollment",
        "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
        "rules": [
            {
                "name": "Executive Device Setup",
                "displayNamePattern": "{firstName}-{lastName}-iPad",
                "setDeviceName": true,
                "tags": [
                    "executive",
                    "high-security"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "executive"
                            ],
                            [
                                "manager",
                                "director"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "department:sales"
                            ],
                            [
                                "location:hq"
                            ]
                        ],
                        "patterns": [
                            "^iPad.*",
                            ".*Proquot;
                        ],
                        "identifiers": [
                            "[email protected]",
                            "A1B2C3D4E5F6"
                        ]
                    }
                ],
                "admPolicyId": "698f2b1c18f11470ce02da32",
                "admPolicyAssignments": [
                    {
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicy": {},
                        "priority": 10
                    }
                ],
                "commands": [
                    {
                        "type": "InstallProfile",
                        "profileId": "698f2b1c18f11470ce02da32"
                    }
                ],
                "admVppLocationId": "698f2b1c18f11470ce02da32",
                "admVppLocationInfo": {
                    "id": "698f2b1c18f11470ce02da32",
                    "name": "US Corporate VPP",
                    "config": {
                        "countryISO2ACode": "US",
                        "defaultPlatform": "ios",
                        "locationName": "US Corporate Location"
                    }
                },
                "allowActivationLock": false,
                "setupAssistantEnable": true,
                "setupAssistantSkippable": false,
                "skipPersonalInfo": true,
                "segmentId": 1
            }
        ],
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "department",
                "title": "Department",
                "description": "Select your organizational department for policy assignment.",
                "options": [
                    "Sales",
                    "Engineering",
                    "Marketing",
                    "Operations"
                ]
            }
        ],
        "loginProviderTypes": [
            "ldap",
            "saml",
            "google"
        ],
        "allowAutoContinue": true,
        "version": "3.2.1",
        "updatedAt": "2026-02-10T14: 22:00Z",
        "createdAt": "2026-01-15T10: 30:00Z",
        "devicesCount": 45,
        "segmentId": 1
    }
}
          
        
      
    
    

      
      
      
        
          401 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        4004
      

        
          message
          string
          
          optional
          
        
        Invalid Token
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
          
        
      
    
    

      
      
      
        
          404 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        3001
      

        
          message
          string
          
          optional
          
        
        Entity not found
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}
          
        
      
    
    
  quot;
                        ],
                        "identifiers": [
                            "[email protected]",
                            "A1B2C3D4E5F6"
                        ]
                    }
                ],
                "admPolicyId": "698f2b1c18f11470ce02da32",
                "admPolicyAssignments": [
                    {
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicy": {},
                        "priority": 10
                    }
                ],
                "commands": [
                    {
                        "type": "InstallProfile",
                        "profileId": "698f2b1c18f11470ce02da32"
                    }
                ],
                "admVppLocationId": "698f2b1c18f11470ce02da32",
                "admVppLocationInfo": {
                    "id": "698f2b1c18f11470ce02da32",
                    "name": "US Corporate VPP",
                    "config": {
                        "countryISO2ACode": "US",
                        "defaultPlatform": "ios",
                        "locationName": "US Corporate Location"
                    }
                },
                "allowActivationLock": false,
                "setupAssistantEnable": true,
                "setupAssistantSkippable": false,
                "skipPersonalInfo": true,
                "segmentId": 1
            }
        ],
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "department",
                "title": "Department",
                "description": "Select your organizational department for policy assignment.",
                "options": [
                    "Sales",
                    "Engineering",
                    "Marketing",
                    "Operations"
                ]
            }
        ],
        "loginProviderTypes": [
            "ldap",
            "saml",
            "google"
        ],
        "allowAutoContinue": true,
        "version": "3.2.1",
        "updatedAt": "2026-02-10T14: 22:00Z",
        "createdAt": "2026-01-15T10: 30:00Z",
        "devicesCount": 45,
        "segmentId": 1
    }
}
          
        
      
    
    

      
      
      
        
          401 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        4004
      

        
          message
          string
          
          optional
          
        
        Invalid Token
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
          
        
      
    
    

      
      
      
        
          404 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        3001
      

        
          message
          string
          
          optional
          
        
        Entity not found
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}
          
        
      
    
    
  quot;
                        ],
                        "identifiers": [
                            "[email protected]",
                            "A1B2C3D4E5F6"
                        ]
                    }
                ],
                "admPolicyId": "698f2b1c18f11470ce02da32",
                "admPolicyAssignments": [
                    {
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicy": {},
                        "priority": 10
                    }
                ],
                "commands": [
                    {
                        "type": "InstallProfile",
                        "profileId": "698f2b1c18f11470ce02da32"
                    }
                ],
                "admVppLocationId": "698f2b1c18f11470ce02da32",
                "admVppLocationInfo": {
                    "id": "698f2b1c18f11470ce02da32",
                    "name": "US Corporate VPP",
                    "config": {
                        "countryISO2ACode": "US",
                        "defaultPlatform": "ios",
                        "locationName": "US Corporate Location"
                    }
                },
                "allowActivationLock": false,
                "setupAssistantEnable": true,
                "setupAssistantSkippable": false,
                "skipPersonalInfo": true,
                "segmentId": 1
            }
        ],
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "department",
                "title": "Department",
                "description": "Select your organizational department for policy assignment.",
                "options": [
                    "Sales",
                    "Engineering",
                    "Marketing",
                    "Operations"
                ]
            }
        ],
        "loginProviderTypes": [
            "ldap",
            "saml",
            "google"
        ],
        "allowAutoContinue": true,
        "version": "3.2.1",
        "updatedAt": "2026-02-10T14: 22:00Z",
        "createdAt": "2026-01-15T10: 30:00Z",
        "devicesCount": 45,
        "segmentId": 1
    }
}
          
        
      
    
    

      
      
      
        
          401 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        4004
      

        
          message
          string
          
          optional
          
        
        Invalid Token
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
          
        
      
    
    

      
      
      
        
          404 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        3001
      

        
          message
          string
          
          optional
          
        
        Entity not found
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}
          
        
      
    
    
  quot;
                        ],
                        "identifiers": [
                            "[email protected]",
                            "A1B2C3D4E5F6"
                        ]
                    }
                ],
                "admPolicyId": "698f2b1c18f11470ce02da32",
                "admPolicyAssignments": [
                    {
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicy": {},
                        "priority": 10
                    }
                ],
                "commands": [
                    {
                        "type": "InstallProfile",
                        "profileId": "698f2b1c18f11470ce02da32"
                    }
                ],
                "admVppLocationId": "698f2b1c18f11470ce02da32",
                "admVppLocationInfo": {
                    "id": "698f2b1c18f11470ce02da32",
                    "name": "US Corporate VPP",
                    "config": {
                        "countryISO2ACode": "US",
                        "defaultPlatform": "ios",
                        "locationName": "US Corporate Location"
                    }
                },
                "allowActivationLock": false,
                "setupAssistantEnable": true,
                "setupAssistantSkippable": false,
                "skipPersonalInfo": true,
                "segmentId": 1
            }
        ],
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "department",
                "title": "Department",
                "description": "Select your organizational department for policy assignment.",
                "options": [
                    "Sales",
                    "Engineering",
                    "Marketing",
                    "Operations"
                ]
            }
        ],
        "loginProviderTypes": [
            "ldap",
            "saml",
            "google"
        ],
        "allowAutoContinue": true,
        "version": "3.2.1",
        "updatedAt": "2026-02-10T14: 22:00Z",
        "createdAt": "2026-01-15T10: 30:00Z",
        "devicesCount": 45,
        "segmentId": 1
    }
}
          
        
      
    
    

      
      
      
        
          401 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        4004
      

        
          message
          string
          
          optional
          
        
        Invalid Token
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
          
        
      
    
    

      
      
      
        
          404 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        3001
      

        
          message
          string
          
          optional
          
        
        Entity not found
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}
          
        
      
    
    
  quot;
                        ],
                        "identifiers": [
                            "[email protected]",
                            "A1B2C3D4E5F6"
                        ]
                    }
                ],
                "admPolicyId": "698f2b1c18f11470ce02da32",
                "admPolicyAssignments": [
                    {
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicy": {},
                        "priority": 10
                    }
                ],
                "commands": [
                    {
                        "type": "InstallProfile",
                        "profileId": "698f2b1c18f11470ce02da32"
                    }
                ],
                "admVppLocationId": "698f2b1c18f11470ce02da32",
                "admVppLocationInfo": {
                    "id": "698f2b1c18f11470ce02da32",
                    "name": "US Corporate VPP",
                    "config": {
                        "countryISO2ACode": "US",
                        "defaultPlatform": "ios",
                        "locationName": "US Corporate Location"
                    }
                },
                "allowActivationLock": false,
                "setupAssistantEnable": true,
                "setupAssistantSkippable": false,
                "skipPersonalInfo": true,
                "segmentId": 1
            }
        ],
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "department",
                "title": "Department",
                "description": "Select your organizational department for policy assignment.",
                "options": [
                    "Sales",
                    "Engineering",
                    "Marketing",
                    "Operations"
                ]
            }
        ],
        "loginProviderTypes": [
            "ldap",
            "saml",
            "google"
        ],
        "allowAutoContinue": true,
        "version": "3.2.1",
        "updatedAt": "2026-02-10T14: 22:00Z",
        "createdAt": "2026-01-15T10: 30:00Z",
        "devicesCount": 45,
        "segmentId": 1
    }
}
          
        
      
    
    

      
      
      
        
          401 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        4004
      

        
          message
          string
          
          optional
          
        
        Invalid Token
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
          
        
      
    
    

      
      
      
        
          404 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        3001
      

        
          message
          string
          
          optional
          
        
        Entity not found
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}
          
        
      
    
    
  quot;
                        ],
                        "identifiers": [
                            "[email protected]",
                            "A1B2C3D4E5F6"
                        ]
                    }
                ],
                "admPolicyId": "698f2b1c18f11470ce02da32",
                "admPolicyAssignments": [
                    {
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicy": {},
                        "priority": 10
                    }
                ],
                "commands": [
                    {
                        "type": "InstallProfile",
                        "profileId": "698f2b1c18f11470ce02da32"
                    }
                ],
                "admVppLocationId": "698f2b1c18f11470ce02da32",
                "admVppLocationInfo": {
                    "id": "698f2b1c18f11470ce02da32",
                    "name": "US Corporate VPP",
                    "config": {
                        "countryISO2ACode": "US",
                        "defaultPlatform": "ios",
                        "locationName": "US Corporate Location"
                    }
                },
                "allowActivationLock": false,
                "setupAssistantEnable": true,
                "setupAssistantSkippable": false,
                "skipPersonalInfo": true,
                "segmentId": 1
            }
        ],
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "department",
                "title": "Department",
                "description": "Select your organizational department for policy assignment.",
                "options": [
                    "Sales",
                    "Engineering",
                    "Marketing",
                    "Operations"
                ]
            }
        ],
        "loginProviderTypes": [
            "ldap",
            "saml",
            "google"
        ],
        "allowAutoContinue": true,
        "version": "3.2.1",
        "updatedAt": "2026-02-10T14: 22:00Z",
        "createdAt": "2026-01-15T10: 30:00Z",
        "devicesCount": 45,
        "segmentId": 1
    }
}
          
        
      
    
    

      
      
      
        
          401 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        4004
      

        
          message
          string
          
          optional
          
        
        Invalid Token
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
          
        
      
    
    

      
      
      
        
          404 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        3001
      

        
          message
          string
          
          optional
          
        
        Entity not found
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}
          
        
      
    
    
  quot;
                        ],
                        "identifiers": [
                            "[email protected]",
                            "A1B2C3D4E5F6"
                        ]
                    }
                ],
                "admPolicyId": "698f2b1c18f11470ce02da32",
                "admPolicyAssignments": [
                    {
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicy": {},
                        "priority": 10
                    }
                ],
                "commands": [
                    {
                        "type": "InstallProfile",
                        "profileId": "698f2b1c18f11470ce02da32"
                    }
                ],
                "admVppLocationId": "698f2b1c18f11470ce02da32",
                "admVppLocationInfo": {
                    "id": "698f2b1c18f11470ce02da32",
                    "name": "US Corporate VPP",
                    "config": {
                        "countryISO2ACode": "US",
                        "defaultPlatform": "ios",
                        "locationName": "US Corporate Location"
                    }
                },
                "allowActivationLock": false,
                "setupAssistantEnable": true,
                "setupAssistantSkippable": false,
                "skipPersonalInfo": true,
                "segmentId": 1
            }
        ],
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "department",
                "title": "Department",
                "description": "Select your organizational department for policy assignment.",
                "options": [
                    "Sales",
                    "Engineering",
                    "Marketing",
                    "Operations"
                ]
            }
        ],
        "loginProviderTypes": [
            "ldap",
            "saml",
            "google"
        ],
        "allowAutoContinue": true,
        "version": "3.2.1",
        "updatedAt": "2026-02-10T14: 22:00Z",
        "createdAt": "2026-01-15T10: 30:00Z",
        "devicesCount": 45,
        "segmentId": 1
    }
}
          
        
      
    
    

      
      
      
        
          401 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        4004
      

        
          message
          string
          
          optional
          
        
        Invalid Token
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
          
        
      
    
    

      
      
      
        
          404 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        3001
      

        
          message
          string
          
          optional
          
        
        Entity not found
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}
          
        
      
    
    
  quot;
                        ],
                        "identifiers": [
                            "[email protected]",
                            "A1B2C3D4E5F6"
                        ]
                    }
                ],
                "admPolicyId": "698f2b1c18f11470ce02da32",
                "admPolicyAssignments": [
                    {
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicy": {},
                        "priority": 10
                    }
                ],
                "commands": [
                    {
                        "type": "InstallProfile",
                        "profileId": "698f2b1c18f11470ce02da32"
                    }
                ],
                "admVppLocationId": "698f2b1c18f11470ce02da32",
                "admVppLocationInfo": {
                    "id": "698f2b1c18f11470ce02da32",
                    "name": "US Corporate VPP",
                    "config": {
                        "countryISO2ACode": "US",
                        "defaultPlatform": "ios",
                        "locationName": "US Corporate Location"
                    }
                },
                "allowActivationLock": false,
                "setupAssistantEnable": true,
                "setupAssistantSkippable": false,
                "skipPersonalInfo": true,
                "segmentId": 1
            }
        ],
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "department",
                "title": "Department",
                "description": "Select your organizational department for policy assignment.",
                "options": [
                    "Sales",
                    "Engineering",
                    "Marketing",
                    "Operations"
                ]
            }
        ],
        "loginProviderTypes": [
            "ldap",
            "saml",
            "google"
        ],
        "allowAutoContinue": true,
        "version": "3.2.1",
        "updatedAt": "2026-02-10T14: 22:00Z",
        "createdAt": "2026-01-15T10: 30:00Z",
        "devicesCount": 45,
        "segmentId": 1
    }
}
          
        
      
    
    

      
      
      
        
          401 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        4004
      

        
          message
          string
          
          optional
          
        
        Invalid Token
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
          
        
      
    
    

      
      
      
        
          404 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        3001
      

        
          message
          string
          
          optional
          
        
        Entity not found
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}
          
        
      
    
    
  quot;
                        ],
                        "identifiers": [
                            "[email protected]",
                            "A1B2C3D4E5F6"
                        ]
                    }
                ],
                "admPolicyId": "698f2b1c18f11470ce02da32",
                "admPolicyAssignments": [
                    {
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicy": {},
                        "priority": 10
                    }
                ],
                "commands": [
                    {
                        "type": "InstallProfile",
                        "profileId": "698f2b1c18f11470ce02da32"
                    }
                ],
                "admVppLocationId": "698f2b1c18f11470ce02da32",
                "admVppLocationInfo": {
                    "id": "698f2b1c18f11470ce02da32",
                    "name": "US Corporate VPP",
                    "config": {
                        "countryISO2ACode": "US",
                        "defaultPlatform": "ios",
                        "locationName": "US Corporate Location"
                    }
                },
                "allowActivationLock": false,
                "setupAssistantEnable": true,
                "setupAssistantSkippable": false,
                "skipPersonalInfo": true,
                "segmentId": 1
            }
        ],
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "department",
                "title": "Department",
                "description": "Select your organizational department for policy assignment.",
                "options": [
                    "Sales",
                    "Engineering",
                    "Marketing",
                    "Operations"
                ]
            }
        ],
        "loginProviderTypes": [
            "ldap",
            "saml",
            "google"
        ],
        "allowAutoContinue": true,
        "version": "3.2.1",
        "updatedAt": "2026-02-10T14: 22:00Z",
        "createdAt": "2026-01-15T10: 30:00Z",
        "devicesCount": 45,
        "segmentId": 1
    }
}
          
        
      
    
    

      
      
      
        
          401 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        4004
      

        
          message
          string
          
          optional
          
        
        Invalid Token
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
          
        
      
    
    

      
      
      
        
          404 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        false
      

        
          
          error
          object
          
          optional
          
        
        
        
          
        
          code
          number
          
          optional
          
        
        3001
      

        
          message
          string
          
          optional
          
        
        Entity not found
      
        
      
        
        
          
            
            {
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}
          
        
      
    
    
  quot;
                        ],
                        "identifiers": [
                            "[email protected]",
                            "A1B2C3D4E5F6"
                        ]
                    }
                ],
                "admPolicyId": "698f2b1c18f11470ce02da32",
                "admPolicyAssignments": [
                    {
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicy": {},
                        "priority": 10
                    }
                ],
                "commands": [
                    {
                        "type": "InstallProfile",
                        "profileId": "698f2b1c18f11470ce02da32"
                    }
                ],
                "admVppLocationId": "698f2b1c18f11470ce02da32",
                "admVppLocationInfo": {
                    "id": "698f2b1c18f11470ce02da32",
                    "name": "US Corporate VPP",
                    "config": {
                        "countryISO2ACode": "US",
                        "defaultPlatform": "ios",
                        "locationName": "US Corporate Location"
                    }
                },
                "allowActivationLock": false,
                "setupAssistantEnable": true,
                "setupAssistantSkippable": false,
                "skipPersonalInfo": true,
                "segmentId": 1
            }
        ],
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "department",
                "title": "Department",
                "description": "Select your organizational department for policy assignment.",
                "options": [
                    "Sales",
                    "Engineering",
                    "Marketing",
                    "Operations"
                ]
            }
        ],
        "loginProviderTypes": [
            "ldap",
            "saml",
            "google"
        ],
        "allowAutoContinue": true,
        "version": "3.2.1",
        "updatedAt": "2026-02-10T14: 22:00Z",
        "createdAt": "2026-01-15T10: 30:00Z",
        "devicesCount": 45,
        "segmentId": 1
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}

Request

Authorization

Path Params2

Responses

Responses

Responses

Responses

Responses

Responses

Responses

Responses

Responses

Responses