Create deviceEnrollmentWindowsHelloForBusinessConfiguration

Article
01/27/2024

Namespace: microsoft.graph

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

Create a new deviceEnrollmentWindowsHelloForBusinessConfiguration 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 deviceEnrollmentWindowsHelloForBusinessConfiguration object.

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

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
pinMinimumLength	Int32	Controls the minimum number of characters required for the Windows Hello for Business PIN. This value must be between 4 and 127, inclusive, and less than or equal to the value set for the maximum PIN.
pinMaximumLength	Int32	Controls the maximum number of characters allowed for the Windows Hello for Business PIN. This value must be between 4 and 127, inclusive. This value must be greater than or equal to the value set for the minimum PIN.
pinUppercaseCharactersUsage	windowsHelloForBusinessPinUsage	Controls the ability to use uppercase letters in the Windows Hello for Business PIN. Allowed permits the use of uppercase letter(s), whereas Required ensures they are present. If set to Not Allowed, uppercase letters will not be permitted. Possible values are: `allowed`, `required`, `disallowed`.
pinLowercaseCharactersUsage	windowsHelloForBusinessPinUsage	Controls the ability to use lowercase letters in the Windows Hello for Business PIN. Allowed permits the use of lowercase letter(s), whereas Required ensures they are present. If set to Not Allowed, lowercase letters will not be permitted. Possible values are: `allowed`, `required`, `disallowed`.
pinSpecialCharactersUsage	windowsHelloForBusinessPinUsage	Controls the ability to use special characters in the Windows Hello for Business PIN. Allowed permits the use of special character(s), whereas Required ensures they are present. If set to Not Allowed, special character(s) will not be permitted. Possible values are: `allowed`, `required`, `disallowed`.
state	enablement	Controls whether to allow the device to be configured for Windows Hello for Business. If set to disabled, the user cannot provision Windows Hello for Business except on Azure Active Directory joined mobile phones if otherwise required. If set to Not Configured, Intune will not override client defaults. Possible values are: `notConfigured`, `enabled`, `disabled`.
securityDeviceRequired	Boolean	Controls whether to require a Trusted Platform Module (TPM) for provisioning Windows Hello for Business. A TPM provides an additional security benefit in that data stored on it cannot be used on other devices. If set to False, all devices can provision Windows Hello for Business even if there is not a usable TPM.
unlockWithBiometricsEnabled	Boolean	Controls the use of biometric gestures, such as face and fingerprint, as an alternative to the Windows Hello for Business PIN. If set to False, biometric gestures are not allowed. Users must still configure a PIN as a backup in case of failures.
remotePassportEnabled	Boolean	Controls the use of Remote Windows Hello for Business. Remote Windows Hello for Business provides the ability for a portable, registered device to be usable as a companion for desktop authentication. The desktop must be Azure AD joined and the companion device must have a Windows Hello for Business PIN.
pinPreviousBlockCount	Int32	Controls the ability to prevent users from using past PINs. This must be set between 0 and 50, inclusive, and the current PIN of the user is included in that count. If set to 0, previous PINs are not stored. PIN history is not preserved through a PIN reset.
pinExpirationInDays	Int32	Controls the period of time (in days) that a PIN can be used before the system requires the user to change it. This must be set between 0 and 730, inclusive. If set to 0, the user's PIN will never expire
enhancedBiometricsState	enablement	Controls the ability to use the anti-spoofing features for facial recognition on devices which support it. If set to disabled, anti-spoofing features are not allowed. If set to Not Configured, the user can choose whether they want to use anti-spoofing. Possible values are: `notConfigured`, `enabled`, `disabled`.

Response

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

Example

Request

Here is an example of the request.

POST https://graph.microsoft.com/v1.0/deviceManagement/deviceEnrollmentConfigurations
Content-type: application/json
Content-length: 629

{
  "@odata.type": "#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration",
  "displayName": "Display Name value",
  "description": "Description value",
  "priority": 8,
  "version": 7,
  "pinMinimumLength": 0,
  "pinMaximumLength": 0,
  "pinUppercaseCharactersUsage": "required",
  "pinLowercaseCharactersUsage": "required",
  "pinSpecialCharactersUsage": "required",
  "state": "enabled",
  "securityDeviceRequired": true,
  "unlockWithBiometricsEnabled": true,
  "remotePassportEnabled": true,
  "pinPreviousBlockCount": 5,
  "pinExpirationInDays": 3,
  "enhancedBiometricsState": "enabled"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new DeviceEnrollmentWindowsHelloForBusinessConfiguration
{
	OdataType = "#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration",
	DisplayName = "Display Name value",
	Description = "Description value",
	Priority = 8,
	Version = 7,
	PinMinimumLength = 0,
	PinMaximumLength = 0,
	PinUppercaseCharactersUsage = WindowsHelloForBusinessPinUsage.Required,
	PinLowercaseCharactersUsage = WindowsHelloForBusinessPinUsage.Required,
	PinSpecialCharactersUsage = WindowsHelloForBusinessPinUsage.Required,
	State = Enablement.Enabled,
	SecurityDeviceRequired = true,
	UnlockWithBiometricsEnabled = true,
	RemotePassportEnabled = true,
	PinPreviousBlockCount = 5,
	PinExpirationInDays = 3,
	EnhancedBiometricsState = Enablement.Enabled,
};

// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceManagement.DeviceEnrollmentConfigurations.PostAsync(requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



mgc device-management device-enrollment-configurations create --body '{\
  "@odata.type": "#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration",\
  "displayName": "Display Name value",\
  "description": "Description value",\
  "priority": 8,\
  "version": 7,\
  "pinMinimumLength": 0,\
  "pinMaximumLength": 0,\
  "pinUppercaseCharactersUsage": "required",\
  "pinLowercaseCharactersUsage": "required",\
  "pinSpecialCharactersUsage": "required",\
  "state": "enabled",\
  "securityDeviceRequired": true,\
  "unlockWithBiometricsEnabled": true,\
  "remotePassportEnabled": true,\
  "pinPreviousBlockCount": 5,\
  "pinExpirationInDays": 3,\
  "enhancedBiometricsState": "enabled"\
}\
'

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewDeviceEnrollmentConfiguration()
displayName := "Display Name value"
requestBody.SetDisplayName(&displayName) 
description := "Description value"
requestBody.SetDescription(&description) 
priority := int32(8)
requestBody.SetPriority(&priority) 
version := int32(7)
requestBody.SetVersion(&version) 
pinMinimumLength := int32(0)
requestBody.SetPinMinimumLength(&pinMinimumLength) 
pinMaximumLength := int32(0)
requestBody.SetPinMaximumLength(&pinMaximumLength) 
pinUppercaseCharactersUsage := graphmodels.REQUIRED_WINDOWSHELLOFORBUSINESSPINUSAGE 
requestBody.SetPinUppercaseCharactersUsage(&pinUppercaseCharactersUsage) 
pinLowercaseCharactersUsage := graphmodels.REQUIRED_WINDOWSHELLOFORBUSINESSPINUSAGE 
requestBody.SetPinLowercaseCharactersUsage(&pinLowercaseCharactersUsage) 
pinSpecialCharactersUsage := graphmodels.REQUIRED_WINDOWSHELLOFORBUSINESSPINUSAGE 
requestBody.SetPinSpecialCharactersUsage(&pinSpecialCharactersUsage) 
state := graphmodels.ENABLED_ENABLEMENT 
requestBody.SetState(&state) 
securityDeviceRequired := true
requestBody.SetSecurityDeviceRequired(&securityDeviceRequired) 
unlockWithBiometricsEnabled := true
requestBody.SetUnlockWithBiometricsEnabled(&unlockWithBiometricsEnabled) 
remotePassportEnabled := true
requestBody.SetRemotePassportEnabled(&remotePassportEnabled) 
pinPreviousBlockCount := int32(5)
requestBody.SetPinPreviousBlockCount(&pinPreviousBlockCount) 
pinExpirationInDays := int32(3)
requestBody.SetPinExpirationInDays(&pinExpirationInDays) 
enhancedBiometricsState := graphmodels.ENABLED_ENABLEMENT 
requestBody.SetEnhancedBiometricsState(&enhancedBiometricsState) 

// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=go
deviceEnrollmentConfigurations, err := graphClient.DeviceManagement().DeviceEnrollmentConfigurations().Post(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DeviceEnrollmentWindowsHelloForBusinessConfiguration deviceEnrollmentConfiguration = new DeviceEnrollmentWindowsHelloForBusinessConfiguration();
deviceEnrollmentConfiguration.setOdataType("#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration");
deviceEnrollmentConfiguration.setDisplayName("Display Name value");
deviceEnrollmentConfiguration.setDescription("Description value");
deviceEnrollmentConfiguration.setPriority(8);
deviceEnrollmentConfiguration.setVersion(7);
deviceEnrollmentConfiguration.setPinMinimumLength(0);
deviceEnrollmentConfiguration.setPinMaximumLength(0);
deviceEnrollmentConfiguration.setPinUppercaseCharactersUsage(WindowsHelloForBusinessPinUsage.Required);
deviceEnrollmentConfiguration.setPinLowercaseCharactersUsage(WindowsHelloForBusinessPinUsage.Required);
deviceEnrollmentConfiguration.setPinSpecialCharactersUsage(WindowsHelloForBusinessPinUsage.Required);
deviceEnrollmentConfiguration.setState(Enablement.Enabled);
deviceEnrollmentConfiguration.setSecurityDeviceRequired(true);
deviceEnrollmentConfiguration.setUnlockWithBiometricsEnabled(true);
deviceEnrollmentConfiguration.setRemotePassportEnabled(true);
deviceEnrollmentConfiguration.setPinPreviousBlockCount(5);
deviceEnrollmentConfiguration.setPinExpirationInDays(3);
deviceEnrollmentConfiguration.setEnhancedBiometricsState(Enablement.Enabled);
DeviceEnrollmentConfiguration result = graphClient.deviceManagement().deviceEnrollmentConfigurations().post(deviceEnrollmentConfiguration);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const deviceEnrollmentConfiguration = {
  '@odata.type': '#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration',
  displayName: 'Display Name value',
  description: 'Description value',
  priority: 8,
  version: 7,
  pinMinimumLength: 0,
  pinMaximumLength: 0,
  pinUppercaseCharactersUsage: 'required',
  pinLowercaseCharactersUsage: 'required',
  pinSpecialCharactersUsage: 'required',
  state: 'enabled',
  securityDeviceRequired: true,
  unlockWithBiometricsEnabled: true,
  remotePassportEnabled: true,
  pinPreviousBlockCount: 5,
  pinExpirationInDays: 3,
  enhancedBiometricsState: 'enabled'
};

await client.api('/deviceManagement/deviceEnrollmentConfigurations')
	.post(deviceEnrollmentConfiguration);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\DeviceEnrollmentWindowsHelloForBusinessConfiguration;
use Microsoft\Graph\Generated\Models\WindowsHelloForBusinessPinUsage;
use Microsoft\Graph\Generated\Models\Enablement;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new DeviceEnrollmentWindowsHelloForBusinessConfiguration();
$requestBody->setOdataType('#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration');
$requestBody->setDisplayName('Display Name value');
$requestBody->setDescription('Description value');
$requestBody->setPriority(8);
$requestBody->setVersion(7);
$requestBody->setPinMinimumLength(0);
$requestBody->setPinMaximumLength(0);
$requestBody->setPinUppercaseCharactersUsage(new WindowsHelloForBusinessPinUsage('required'));
$requestBody->setPinLowercaseCharactersUsage(new WindowsHelloForBusinessPinUsage('required'));
$requestBody->setPinSpecialCharactersUsage(new WindowsHelloForBusinessPinUsage('required'));
$requestBody->setState(new Enablement('enabled'));
$requestBody->setSecurityDeviceRequired(true);
$requestBody->setUnlockWithBiometricsEnabled(true);
$requestBody->setRemotePassportEnabled(true);
$requestBody->setPinPreviousBlockCount(5);
$requestBody->setPinExpirationInDays(3);
$requestBody->setEnhancedBiometricsState(new Enablement('enabled'));

$result = $graphServiceClient->deviceManagement()->deviceEnrollmentConfigurations()->post($requestBody)->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.DeviceManagement.Enrollment

$params = @{
	"@odata.type" = "#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration"
	displayName = "Display Name value"
	description = "Description value"
	priority = 8
	version = 7
	pinMinimumLength = 
	pinMaximumLength = 
	pinUppercaseCharactersUsage = "required"
	pinLowercaseCharactersUsage = "required"
	pinSpecialCharactersUsage = "required"
	state = "enabled"
	securityDeviceRequired = $true
	unlockWithBiometricsEnabled = $true
	remotePassportEnabled = $true
	pinPreviousBlockCount = 
	pinExpirationInDays = 
	enhancedBiometricsState = "enabled"
}

New-MgDeviceManagementDeviceEnrollmentConfiguration -BodyParameter $params

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.device_enrollment_windows_hello_for_business_configuration import DeviceEnrollmentWindowsHelloForBusinessConfiguration
from msgraph.generated.models.windows_hello_for_business_pin_usage import WindowsHelloForBusinessPinUsage
from msgraph.generated.models.enablement import Enablement
# To initialize your graph_client, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = DeviceEnrollmentWindowsHelloForBusinessConfiguration(
	odata_type = "#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration",
	display_name = "Display Name value",
	description = "Description value",
	priority = 8,
	version = 7,
	pin_minimum_length = 0,
	pin_maximum_length = 0,
	pin_uppercase_characters_usage = WindowsHelloForBusinessPinUsage.Required,
	pin_lowercase_characters_usage = WindowsHelloForBusinessPinUsage.Required,
	pin_special_characters_usage = WindowsHelloForBusinessPinUsage.Required,
	state = Enablement.Enabled,
	security_device_required = True,
	unlock_with_biometrics_enabled = True,
	remote_passport_enabled = True,
	pin_previous_block_count = 5,
	pin_expiration_in_days = 3,
	enhanced_biometrics_state = Enablement.Enabled,
)

result = await graph_client.device_management.device_enrollment_configurations.post(request_body)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

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: 801

{
  "@odata.type": "#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration",
  "id": "3068e0cd-e0cd-3068-cde0-6830cde06830",
  "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,
  "pinMinimumLength": 0,
  "pinMaximumLength": 0,
  "pinUppercaseCharactersUsage": "required",
  "pinLowercaseCharactersUsage": "required",
  "pinSpecialCharactersUsage": "required",
  "state": "enabled",
  "securityDeviceRequired": true,
  "unlockWithBiometricsEnabled": true,
  "remotePassportEnabled": true,
  "pinPreviousBlockCount": 5,
  "pinExpirationInDays": 3,
  "enhancedBiometricsState": "enabled"
}

Share via

Create deviceEnrollmentWindowsHelloForBusinessConfiguration

Permissions

HTTP Request

Request headers

Request body

Response

Example

Request

Response

Feedback

Additional resources