Package odata.msgraph.client.beta.entity

Class WindowsIdentityProtectionConfiguration

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType
    public class WindowsIdentityProtectionConfiguration
extends DeviceConfiguration
implements com.github.davidmoten.odata.client.ODataEntityType
    “This entity provides descriptions of the declared methods, properties and relationships exposed by Windows Hello for Business.”

    • Field Detail

      • enhancedAntiSpoofingForFacialFeaturesEnabled

        protected Boolean enhancedAntiSpoofingForFacialFeaturesEnabled

      • pinExpirationInDays

        protected Integer pinExpirationInDays

      • pinMaximumLength

        protected Integer pinMaximumLength

      • pinMinimumLength

        protected Integer pinMinimumLength

      • pinPreviousBlockCount

        protected Integer pinPreviousBlockCount

      • pinRecoveryEnabled

        protected Boolean pinRecoveryEnabled

      • securityDeviceRequired

        protected Boolean securityDeviceRequired

      • unlockWithBiometricsEnabled

        protected Boolean unlockWithBiometricsEnabled

      • useCertificatesForOnPremisesAuthEnabled

        protected Boolean useCertificatesForOnPremisesAuthEnabled

      • useSecurityKeyForSignin

        protected Boolean useSecurityKeyForSignin

      • windowsHelloForBusinessBlocked

        protected Boolean windowsHelloForBusinessBlocked

    • Constructor Detail

      • WindowsIdentityProtectionConfiguration

        protected WindowsIdentityProtectionConfiguration()

    • Method Detail

      • odataTypeName

        public String odataTypeName()
        Specified by:
        odataTypeName in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        odataTypeName in class DeviceConfiguration

      • builderWindowsIdentityProtectionConfiguration

        public static WindowsIdentityProtectionConfiguration.Builder builderWindowsIdentityProtectionConfiguration()
        Returns a builder which is used to create a new instance of this class (given that this class is immutable).
        Returns:
        a new Builder for this class

      • getChangedFields

        public com.github.davidmoten.odata.client.internal.ChangedFields getChangedFields()
        Specified by:
        getChangedFields in interface com.github.davidmoten.odata.client.ODataEntityType
        Overrides:
        getChangedFields in class DeviceConfiguration

      • postInject

        public void postInject​(boolean addKeysToContextPath)
        Specified by:
        postInject in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        postInject in class DeviceConfiguration

      • getEnhancedAntiSpoofingForFacialFeaturesEnabled

        public Optional<Boolean> getEnhancedAntiSpoofingForFacialFeaturesEnabled()
        “Boolean value used to enable enhanced anti-spoofing for facial feature recognition on Windows Hello face authentication.”
        Returns:
        property enhancedAntiSpoofingForFacialFeaturesEnabled

      • withEnhancedAntiSpoofingForFacialFeaturesEnabled

        public WindowsIdentityProtectionConfiguration withEnhancedAntiSpoofingForFacialFeaturesEnabled​(Boolean enhancedAntiSpoofingForFacialFeaturesEnabled)
        Returns an immutable copy of this with just the enhancedAntiSpoofingForFacialFeaturesEnabled field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Boolean value used to enable enhanced anti-spoofing for facial feature recognition on Windows Hello face authentication.”

        Parameters:
        enhancedAntiSpoofingForFacialFeaturesEnabled - new value of enhancedAntiSpoofingForFacialFeaturesEnabled field (as defined in service metadata)
        Returns:
        immutable copy of this with just the enhancedAntiSpoofingForFacialFeaturesEnabled field changed

      • getPinExpirationInDays

        public Optional<Integer> getPinExpirationInDays()
        “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”
        Returns:
        property pinExpirationInDays

      • withPinExpirationInDays

        public WindowsIdentityProtectionConfiguration withPinExpirationInDays​(Integer pinExpirationInDays)
        Returns an immutable copy of this with just the pinExpirationInDays field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “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”

        Parameters:
        pinExpirationInDays - new value of pinExpirationInDays field (as defined in service metadata)
        Returns:
        immutable copy of this with just the pinExpirationInDays field changed

      • getPinLowercaseCharactersUsage

        public Optional<ConfigurationUsage> getPinLowercaseCharactersUsage()
        “This value configures the use of lowercase characters in the Windows Hello for Business PIN.”
        Returns:
        property pinLowercaseCharactersUsage

      • withPinLowercaseCharactersUsage

        public WindowsIdentityProtectionConfiguration withPinLowercaseCharactersUsage​(ConfigurationUsage pinLowercaseCharactersUsage)
        Returns an immutable copy of this with just the pinLowercaseCharactersUsage field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “This value configures the use of lowercase characters in the Windows Hello for Business PIN.”

        Parameters:
        pinLowercaseCharactersUsage - new value of pinLowercaseCharactersUsage field (as defined in service metadata)
        Returns:
        immutable copy of this with just the pinLowercaseCharactersUsage field changed

      • getPinMaximumLength

        public Optional<Integer> getPinMaximumLength()
        “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”
        Returns:
        property pinMaximumLength

      • withPinMaximumLength

        public WindowsIdentityProtectionConfiguration withPinMaximumLength​(Integer pinMaximumLength)
        Returns an immutable copy of this with just the pinMaximumLength field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “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”

        Parameters:
        pinMaximumLength - new value of pinMaximumLength field (as defined in service metadata)
        Returns:
        immutable copy of this with just the pinMaximumLength field changed

      • getPinMinimumLength

        public Optional<Integer> getPinMinimumLength()
        “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”
        Returns:
        property pinMinimumLength

      • withPinMinimumLength

        public WindowsIdentityProtectionConfiguration withPinMinimumLength​(Integer pinMinimumLength)
        Returns an immutable copy of this with just the pinMinimumLength field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “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”

        Parameters:
        pinMinimumLength - new value of pinMinimumLength field (as defined in service metadata)
        Returns:
        immutable copy of this with just the pinMinimumLength field changed

      • getPinPreviousBlockCount

        public Optional<Integer> getPinPreviousBlockCount()
        “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”
        Returns:
        property pinPreviousBlockCount

      • withPinPreviousBlockCount

        public WindowsIdentityProtectionConfiguration withPinPreviousBlockCount​(Integer pinPreviousBlockCount)
        Returns an immutable copy of this with just the pinPreviousBlockCount field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “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”

        Parameters:
        pinPreviousBlockCount - new value of pinPreviousBlockCount field (as defined in service metadata)
        Returns:
        immutable copy of this with just the pinPreviousBlockCount field changed

      • getPinRecoveryEnabled

        public Optional<Boolean> getPinRecoveryEnabled()
        “Boolean value that enables a user to change their PIN by using the Windows Hello for Business PIN recovery service.”
        Returns:
        property pinRecoveryEnabled

      • withPinRecoveryEnabled

        public WindowsIdentityProtectionConfiguration withPinRecoveryEnabled​(Boolean pinRecoveryEnabled)
        Returns an immutable copy of this with just the pinRecoveryEnabled field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Boolean value that enables a user to change their PIN by using the Windows Hello for Business PIN recovery service.”

        Parameters:
        pinRecoveryEnabled - new value of pinRecoveryEnabled field (as defined in service metadata)
        Returns:
        immutable copy of this with just the pinRecoveryEnabled field changed

      • getPinSpecialCharactersUsage

        public Optional<ConfigurationUsage> getPinSpecialCharactersUsage()
        “Controls the ability to use special characters in the Windows Hello for Business PIN.”
        Returns:
        property pinSpecialCharactersUsage

      • withPinSpecialCharactersUsage

        public WindowsIdentityProtectionConfiguration withPinSpecialCharactersUsage​(ConfigurationUsage pinSpecialCharactersUsage)
        Returns an immutable copy of this with just the pinSpecialCharactersUsage field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Controls the ability to use special characters in the Windows Hello for Business PIN.”

        Parameters:
        pinSpecialCharactersUsage - new value of pinSpecialCharactersUsage field (as defined in service metadata)
        Returns:
        immutable copy of this with just the pinSpecialCharactersUsage field changed

      • getPinUppercaseCharactersUsage

        public Optional<ConfigurationUsage> getPinUppercaseCharactersUsage()
        “This value configures the use of uppercase characters in the Windows Hello for Business PIN.”
        Returns:
        property pinUppercaseCharactersUsage

      • withPinUppercaseCharactersUsage

        public WindowsIdentityProtectionConfiguration withPinUppercaseCharactersUsage​(ConfigurationUsage pinUppercaseCharactersUsage)
        Returns an immutable copy of this with just the pinUppercaseCharactersUsage field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “This value configures the use of uppercase characters in the Windows Hello for Business PIN.”

        Parameters:
        pinUppercaseCharactersUsage - new value of pinUppercaseCharactersUsage field (as defined in service metadata)
        Returns:
        immutable copy of this with just the pinUppercaseCharactersUsage field changed

      • getSecurityDeviceRequired

        public Optional<Boolean> getSecurityDeviceRequired()
        “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.”
        Returns:
        property securityDeviceRequired

      • withSecurityDeviceRequired

        public WindowsIdentityProtectionConfiguration withSecurityDeviceRequired​(Boolean securityDeviceRequired)
        Returns an immutable copy of this with just the securityDeviceRequired field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “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.”

        Parameters:
        securityDeviceRequired - new value of securityDeviceRequired field (as defined in service metadata)
        Returns:
        immutable copy of this with just the securityDeviceRequired field changed

      • getUnlockWithBiometricsEnabled

        public Optional<Boolean> getUnlockWithBiometricsEnabled()
        “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.”
        Returns:
        property unlockWithBiometricsEnabled

      • withUnlockWithBiometricsEnabled

        public WindowsIdentityProtectionConfiguration withUnlockWithBiometricsEnabled​(Boolean unlockWithBiometricsEnabled)
        Returns an immutable copy of this with just the unlockWithBiometricsEnabled field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “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.”

        Parameters:
        unlockWithBiometricsEnabled - new value of unlockWithBiometricsEnabled field (as defined in service metadata)
        Returns:
        immutable copy of this with just the unlockWithBiometricsEnabled field changed

      • getUseCertificatesForOnPremisesAuthEnabled

        public Optional<Boolean> getUseCertificatesForOnPremisesAuthEnabled()
        “Boolean value that enables Windows Hello for Business to use certificates to authenticate on-premise resources.”
        Returns:
        property useCertificatesForOnPremisesAuthEnabled

      • withUseCertificatesForOnPremisesAuthEnabled

        public WindowsIdentityProtectionConfiguration withUseCertificatesForOnPremisesAuthEnabled​(Boolean useCertificatesForOnPremisesAuthEnabled)
        Returns an immutable copy of this with just the useCertificatesForOnPremisesAuthEnabled field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Boolean value that enables Windows Hello for Business to use certificates to authenticate on-premise resources.”

        Parameters:
        useCertificatesForOnPremisesAuthEnabled - new value of useCertificatesForOnPremisesAuthEnabled field (as defined in service metadata)
        Returns:
        immutable copy of this with just the useCertificatesForOnPremisesAuthEnabled field changed

      • getUseSecurityKeyForSignin

        public Optional<Boolean> getUseSecurityKeyForSignin()
        “Boolean value used to enable the Windows Hello security key as a logon credential.”
        Returns:
        property useSecurityKeyForSignin

      • withUseSecurityKeyForSignin

        public WindowsIdentityProtectionConfiguration withUseSecurityKeyForSignin​(Boolean useSecurityKeyForSignin)
        Returns an immutable copy of this with just the useSecurityKeyForSignin field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Boolean value used to enable the Windows Hello security key as a logon credential.”

        Parameters:
        useSecurityKeyForSignin - new value of useSecurityKeyForSignin field (as defined in service metadata)
        Returns:
        immutable copy of this with just the useSecurityKeyForSignin field changed

      • getWindowsHelloForBusinessBlocked

        public Optional<Boolean> getWindowsHelloForBusinessBlocked()
        “Boolean value that blocks Windows Hello for Business as a method for signing into Windows.”
        Returns:
        property windowsHelloForBusinessBlocked

      • withWindowsHelloForBusinessBlocked

        public WindowsIdentityProtectionConfiguration withWindowsHelloForBusinessBlocked​(Boolean windowsHelloForBusinessBlocked)
        Returns an immutable copy of this with just the windowsHelloForBusinessBlocked field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Boolean value that blocks Windows Hello for Business as a method for signing into Windows.”

        Parameters:
        windowsHelloForBusinessBlocked - new value of windowsHelloForBusinessBlocked field (as defined in service metadata)
        Returns:
        immutable copy of this with just the windowsHelloForBusinessBlocked field changed

      • getUnmappedFields

        public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
        Specified by:
        getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        getUnmappedFields in class DeviceConfiguration

      • patch

        public WindowsIdentityProtectionConfiguration patch()
        Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
        Overrides:
        patch in class DeviceConfiguration
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected

      • put

        public WindowsIdentityProtectionConfiguration put()
        Submits all fields for update and returns an immutable copy of this with changed fields reset (they were ignored anyway).
        Overrides:
        put in class DeviceConfiguration
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected