windowsIdentityProtectionConfiguration resource type
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.
This entity provides descriptions of the declared methods, properties and relationships exposed by Windows Hello for Business.
Inherits from deviceConfiguration
Methods
| Method | Return Type | Description |
|---|---|---|
| List windowsIdentityProtectionConfigurations | windowsIdentityProtectionConfiguration collection | List properties and relationships of the windowsIdentityProtectionConfiguration objects. |
| Get windowsIdentityProtectionConfiguration | windowsIdentityProtectionConfiguration | Read properties and relationships of the windowsIdentityProtectionConfiguration object. |
| Create windowsIdentityProtectionConfiguration | windowsIdentityProtectionConfiguration | Create a new windowsIdentityProtectionConfiguration object. |
| Delete windowsIdentityProtectionConfiguration | None | Deletes a windowsIdentityProtectionConfiguration. |
| Update windowsIdentityProtectionConfiguration | windowsIdentityProtectionConfiguration | Update the properties of a windowsIdentityProtectionConfiguration object. |
Properties
| Property | Type | Description |
|---|---|---|
| id | String | Key of the entity. Inherited from deviceConfiguration |
| lastModifiedDateTime | DateTimeOffset | DateTime the object was last modified. Inherited from deviceConfiguration |
| roleScopeTagIds | String collection | List of Scope Tags for this Entity instance. Inherited from deviceConfiguration |
| supportsScopeTags | Boolean | Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from deviceConfiguration |
| deviceManagementApplicabilityRuleOsEdition | deviceManagementApplicabilityRuleOsEdition | The OS edition applicability for this Policy. Inherited from deviceConfiguration |
| deviceManagementApplicabilityRuleOsVersion | deviceManagementApplicabilityRuleOsVersion | The OS version applicability rule for this Policy. Inherited from deviceConfiguration |
| deviceManagementApplicabilityRuleDeviceMode | deviceManagementApplicabilityRuleDeviceMode | The device mode applicability rule for this Policy. Inherited from deviceConfiguration |
| createdDateTime | DateTimeOffset | DateTime the object was created. Inherited from deviceConfiguration |
| description | String | Admin provided description of the Device Configuration. Inherited from deviceConfiguration |
| displayName | String | Admin provided name of the device configuration. Inherited from deviceConfiguration |
| version | Int32 | Version of the device configuration. Inherited from deviceConfiguration |
| useSecurityKeyForSignin | Boolean | Boolean value used to enable the Windows Hello security key as a logon credential. |
| enhancedAntiSpoofingForFacialFeaturesEnabled | Boolean | Boolean value used to enable enhanced anti-spoofing for facial feature recognition on Windows Hello face authentication. |
| pinMinimumLength | Int32 | Integer value that sets the minimum number of characters required for the Windows Hello for Business PIN. Valid values are 4 to 127 inclusive and less than or equal to the value set for the maximum PIN. Valid values 4 to 127 |
| pinMaximumLength | Int32 | Integer value that sets the maximum number of characters allowed for the work PIN. Valid values are 4 to 127 inclusive and greater than or equal to the value set for the minimum PIN. Valid values 4 to 127 |
| pinUppercaseCharactersUsage | configurationUsage | This value configures the use of uppercase characters in the Windows Hello for Business PIN. Possible values are: blocked, required, allowed, notConfigured. |
| pinLowercaseCharactersUsage | configurationUsage | This value configures the use of lowercase characters in the Windows Hello for Business PIN. Possible values are: blocked, required, allowed, notConfigured. |
| pinSpecialCharactersUsage | configurationUsage | Controls the ability to use special characters in the Windows Hello for Business PIN. Possible values are: blocked, required, allowed, notConfigured. |
| pinExpirationInDays | Int32 | Integer value specifies the period (in days) that a PIN can be used before the system requires the user to change it. Valid values are 0 to 730 inclusive. Valid values 0 to 730 |
| 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. Valid values 0 to 50 |
| pinRecoveryEnabled | Boolean | Boolean value that enables a user to change their PIN by using the Windows Hello for Business PIN recovery service. |
| 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. |
| useCertificatesForOnPremisesAuthEnabled | Boolean | Boolean value that enables Windows Hello for Business to use certificates to authenticate on-premise resources. |
| windowsHelloForBusinessBlocked | Boolean | Boolean value that blocks Windows Hello for Business as a method for signing into Windows. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| groupAssignments | deviceConfigurationGroupAssignment collection | The list of group assignments for the device configuration profile. Inherited from deviceConfiguration |
| assignments | deviceConfigurationAssignment collection | The list of assignments for the device configuration profile. Inherited from deviceConfiguration |
| deviceStatuses | deviceConfigurationDeviceStatus collection | Device configuration installation status by device. Inherited from deviceConfiguration |
| userStatuses | deviceConfigurationUserStatus collection | Device configuration installation status by user. Inherited from deviceConfiguration |
| deviceStatusOverview | deviceConfigurationDeviceOverview | Device Configuration devices status overview Inherited from deviceConfiguration |
| userStatusOverview | deviceConfigurationUserOverview | Device Configuration users status overview Inherited from deviceConfiguration |
| deviceSettingStateSummaries | settingStateDeviceSummary collection | Device Configuration Setting State Device Summary Inherited from deviceConfiguration |
JSON Representation
Here is a JSON representation of the resource.
{
"@odata.type": "#microsoft.graph.windowsIdentityProtectionConfiguration",
"id": "String (identifier)",
"lastModifiedDateTime": "String (timestamp)",
"roleScopeTagIds": [
"String"
],
"supportsScopeTags": true,
"deviceManagementApplicabilityRuleOsEdition": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
"osEditionTypes": [
"String"
],
"name": "String",
"ruleType": "String"
},
"deviceManagementApplicabilityRuleOsVersion": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
"minOSVersion": "String",
"maxOSVersion": "String",
"name": "String",
"ruleType": "String"
},
"deviceManagementApplicabilityRuleDeviceMode": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
"deviceMode": "String",
"name": "String",
"ruleType": "String"
},
"createdDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"version": 1024,
"useSecurityKeyForSignin": true,
"enhancedAntiSpoofingForFacialFeaturesEnabled": true,
"pinMinimumLength": 1024,
"pinMaximumLength": 1024,
"pinUppercaseCharactersUsage": "String",
"pinLowercaseCharactersUsage": "String",
"pinSpecialCharactersUsage": "String",
"pinExpirationInDays": 1024,
"pinPreviousBlockCount": 1024,
"pinRecoveryEnabled": true,
"securityDeviceRequired": true,
"unlockWithBiometricsEnabled": true,
"useCertificatesForOnPremisesAuthEnabled": true,
"windowsHelloForBusinessBlocked": true
}