CIPP icon

CIPP

CIPP-API is an Azure Function App providing the logic layer for the CIPP platform. This spec is auto-generated via static analysis of both the API (PowerShell) and frontend (React/Next.js) repositories. Last generated: 2026-03-02.

Actions75

EndpointAutopilot → AddEnrollment

AI-generated

Overview

The EndpointAutopilot AddEnrollment operation allows users to add enrollment configurations to the Autopilot endpoint. This operation is useful for managing device enrollment settings in an automated and customizable way, such as allowing or blocking device enrollment, enabling logs, setting error messages, and controlling update installations. It supports additional options like tenant selection and progress display, making it suitable for IT administrators managing device enrollments across multiple tenants.

Use Case Examples

  1. An IT administrator wants to enroll devices with specific settings such as allowing reset, enabling logs, and blocking certain devices.
  2. A company needs to automate the enrollment process for Windows devices, including installing updates and showing progress to users.

Properties

Name Meaning
Allow Fail Indicates whether to allow failure during enrollment.
Allow Reset Indicates whether to allow device reset during enrollment.
Block Device Indicates whether to block the device from enrollment.
Enable Log Indicates whether to enable logging during enrollment.
Error Message Custom error message to display if enrollment fails.
Install Windows Updates Indicates whether to install Windows updates during enrollment.
OBEEOnly Indicates whether the enrollment is for OBEE only.
Selected Tenants Specifies the tenants selected for enrollment.
Show Progress Indicates whether to show progress during enrollment.
Time Out In Minutes Specifies the timeout duration in minutes for the enrollment process.

Output

JSON

  • response - The response from the AddEnrollment API call
  • debug - Debug information including URL, query parameters, headers, and body sent for the API request (if debug option is enabled)

Dependencies

  • An API key credential for authentication to the CIPP API

Troubleshooting

  • Ensure all required fields are provided and correctly formatted.
  • Check API authentication credentials and permissions.
  • Enable debug option to get detailed request and response information for troubleshooting.
  • Handle API rate limits by configuring batching options if processing multiple items.

Discussion