Create windows10EnrollmentCompletionPageConfiguration

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Create a new windows10EnrollmentCompletionPageConfiguration object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All

HTTP Request

POST /deviceManagement/deviceEnrollmentConfigurations

Request headers

Header	Value
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Accept	application/json

Request body

In the request body, supply a JSON representation for the windows10EnrollmentCompletionPageConfiguration object.

The following table shows the properties that are required when you create the windows10EnrollmentCompletionPageConfiguration.

Property	Type	Description
id	String	Unique Identifier for the account Inherited from deviceEnrollmentConfiguration
displayName	String	The display name of the device enrollment configuration Inherited from deviceEnrollmentConfiguration
description	String	The description of the device enrollment configuration Inherited from deviceEnrollmentConfiguration
priority	Int32	Priority is used when a user exists in multiple groups that are assigned enrollment configuration. Users are subject only to the configuration with the lowest priority value. Inherited from deviceEnrollmentConfiguration
createdDateTime	DateTimeOffset	Created date time in UTC of the device enrollment configuration Inherited from deviceEnrollmentConfiguration
lastModifiedDateTime	DateTimeOffset	Last modified date time in UTC of the device enrollment configuration Inherited from deviceEnrollmentConfiguration
version	Int32	The version of the device enrollment configuration Inherited from deviceEnrollmentConfiguration
roleScopeTagIds	String collection	Optional role scope tags for the enrollment restrictions. Inherited from deviceEnrollmentConfiguration
deviceEnrollmentConfigurationType	deviceEnrollmentConfigurationType	Support for Enrollment Configuration Type Inherited from deviceEnrollmentConfiguration. Possible values are: unknown, limit, platformRestrictions, windowsHelloForBusiness, defaultLimit, defaultPlatformRestrictions, defaultWindowsHelloForBusiness, defaultWindows10EnrollmentCompletionPageConfiguration, windows10EnrollmentCompletionPageConfiguration, deviceComanagementAuthorityConfiguration, singlePlatformRestriction, unknownFutureValue, enrollmentNotificationsConfiguration.
showInstallationProgress	Boolean	When TRUE, shows installation progress to user. When false, hides installation progress. The default is false.
blockDeviceSetupRetryByUser	Boolean	When TRUE, blocks user from retrying the setup on installation failure. When false, user is allowed to retry. The default is false.
allowDeviceResetOnInstallFailure	Boolean	When TRUE, allows device reset on installation failure. When false, reset is blocked. The default is false.
allowLogCollectionOnInstallFailure	Boolean	When TRUE, allows log collection on installation failure. When false, log collection is not allowed. The default is false.
customErrorMessage	String	The custom error message to show upon installation failure. Max length is 10000. example: "Setup could not be completed. Please try again or contact your support person for help."
installProgressTimeoutInMinutes	Int32	The installation progress timeout in minutes. Default is 60 minutes.
allowDeviceUseOnInstallFailure	Boolean	When TRUE, allows the user to continue using the device on installation failure. When false, blocks the user on installation failure. The default is false.
selectedMobileAppIds	String collection	Selected applications to track the installation status. It is in the form of an array of GUIDs.
allowNonBlockingAppInstallation	Boolean	When TRUE, ESP (Enrollment Status Page) installs all required apps targeted during technician phase and ignores any failures for non-blocking apps. When FALSE, ESP fails on any error during app install. The default is false.
installQualityUpdates	Boolean	Allows quality updates installation during OOBE
trackInstallProgressForAutopilotOnly	Boolean	When TRUE, installation progress is tracked for only Autopilot enrollment scenarios. When false, other scenarios are tracked as well. The default is false.
disableUserStatusTrackingAfterFirstUser	Boolean	When TRUE, disables showing installation progress for first user post enrollment. When false, enables showing progress. The default is false.

Response

If successful, this method returns a 201 Created response code and a windows10EnrollmentCompletionPageConfiguration object in the response body.

Example

Request

Here is an example of the request.

POST https://graph.microsoft.com/beta/deviceManagement/deviceEnrollmentConfigurations
Content-type: application/json
Content-length: 873

{
  "@odata.type": "#microsoft.graph.windows10EnrollmentCompletionPageConfiguration",
  "displayName": "Display Name value",
  "description": "Description value",
  "priority": 8,
  "version": 7,
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "deviceEnrollmentConfigurationType": "limit",
  "showInstallationProgress": true,
  "blockDeviceSetupRetryByUser": true,
  "allowDeviceResetOnInstallFailure": true,
  "allowLogCollectionOnInstallFailure": true,
  "customErrorMessage": "Custom Error Message value",
  "installProgressTimeoutInMinutes": 15,
  "allowDeviceUseOnInstallFailure": true,
  "selectedMobileAppIds": [
    "Selected Mobile App Ids value"
  ],
  "allowNonBlockingAppInstallation": true,
  "installQualityUpdates": true,
  "trackInstallProgressForAutopilotOnly": true,
  "disableUserStatusTrackingAfterFirstUser": true
}

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 1045

{
  "@odata.type": "#microsoft.graph.windows10EnrollmentCompletionPageConfiguration",
  "id": "77bf8248-8248-77bf-4882-bf774882bf77",
  "displayName": "Display Name value",
  "description": "Description value",
  "priority": 8,
  "createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "version": 7,
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "deviceEnrollmentConfigurationType": "limit",
  "showInstallationProgress": true,
  "blockDeviceSetupRetryByUser": true,
  "allowDeviceResetOnInstallFailure": true,
  "allowLogCollectionOnInstallFailure": true,
  "customErrorMessage": "Custom Error Message value",
  "installProgressTimeoutInMinutes": 15,
  "allowDeviceUseOnInstallFailure": true,
  "selectedMobileAppIds": [
    "Selected Mobile App Ids value"
  ],
  "allowNonBlockingAppInstallation": true,
  "installQualityUpdates": true,
  "trackInstallProgressForAutopilotOnly": true,
  "disableUserStatusTrackingAfterFirstUser": true
}