Package odata.msgraph.client.entity

Class DeviceEnrollmentWindowsHelloForBusinessConfiguration

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType
    public class DeviceEnrollmentWindowsHelloForBusinessConfiguration
extends DeviceEnrollmentConfiguration
implements com.github.davidmoten.odata.client.ODataEntityType
    “Windows Hello for Business settings lets users access their devices using a gesture, such as biometric authentication, or a PIN. Configure settings for enrolled Windows 10, Windows 10 Mobile and later.”

    • Constructor Detail

      • DeviceEnrollmentWindowsHelloForBusinessConfiguration

        protected DeviceEnrollmentWindowsHelloForBusinessConfiguration()

    • Method Detail

      • builderDeviceEnrollmentWindowsHelloForBusinessConfiguration

        public static DeviceEnrollmentWindowsHelloForBusinessConfiguration.Builder builderDeviceEnrollmentWindowsHelloForBusinessConfiguration()
        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 DeviceEnrollmentConfiguration

      • postInject

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

      • getEnhancedBiometricsState

        public Optional<Enablement> getEnhancedBiometricsState()
        “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.”
        Returns:
        property enhancedBiometricsState

      • withEnhancedBiometricsState

        public DeviceEnrollmentWindowsHelloForBusinessConfiguration withEnhancedBiometricsState​(Enablement enhancedBiometricsState)
        Returns an immutable copy of this with just the enhancedBiometricsState 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 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.”

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

      • getPinExpirationInDays

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

      • withPinExpirationInDays

        public DeviceEnrollmentWindowsHelloForBusinessConfiguration 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.

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

        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<WindowsHelloForBusinessPinUsage> getPinLowercaseCharactersUsage()
        “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 .”
        Returns:
        property pinLowercaseCharactersUsage

      • withPinLowercaseCharactersUsage

        public DeviceEnrollmentWindowsHelloForBusinessConfiguration withPinLowercaseCharactersUsage​(WindowsHelloForBusinessPinUsage 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.

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

        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()
        “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.”
        Returns:
        property pinMaximumLength

      • withPinMaximumLength

        public DeviceEnrollmentWindowsHelloForBusinessConfiguration 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.

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

        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()
        “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.”
        Returns:
        property pinMinimumLength

      • withPinMinimumLength

        public DeviceEnrollmentWindowsHelloForBusinessConfiguration 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.

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

        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.”
        Returns:
        property pinPreviousBlockCount

      • withPinPreviousBlockCount

        public DeviceEnrollmentWindowsHelloForBusinessConfiguration 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.”

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

      • getPinSpecialCharactersUsage

        public Optional<WindowsHelloForBusinessPinUsage> getPinSpecialCharactersUsage()
        “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.”
        Returns:
        property pinSpecialCharactersUsage

      • withPinSpecialCharactersUsage

        public DeviceEnrollmentWindowsHelloForBusinessConfiguration withPinSpecialCharactersUsage​(WindowsHelloForBusinessPinUsage 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. 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.”

        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<WindowsHelloForBusinessPinUsage> getPinUppercaseCharactersUsage()
        “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 .”
        Returns:
        property pinUppercaseCharactersUsage

      • withPinUppercaseCharactersUsage

        public DeviceEnrollmentWindowsHelloForBusinessConfiguration withPinUppercaseCharactersUsage​(WindowsHelloForBusinessPinUsage 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.

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

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

      • getRemotePassportEnabled

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

      • withRemotePassportEnabled

        public DeviceEnrollmentWindowsHelloForBusinessConfiguration withRemotePassportEnabled​(Boolean remotePassportEnabled)
        Returns an immutable copy of this with just the remotePassportEnabled 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 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.”

        Parameters:
        remotePassportEnabled - new value of remotePassportEnabled field (as defined in service metadata)
        Returns:
        immutable copy of this with just the remotePassportEnabled 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 DeviceEnrollmentWindowsHelloForBusinessConfiguration 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

      • getState

        public Optional<Enablement> getState()
        “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.”
        Returns:
        property state

      • withState

        public DeviceEnrollmentWindowsHelloForBusinessConfiguration withState​(Enablement state)
        Returns an immutable copy of this with just the state 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 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.”

        Parameters:
        state - new value of state field (as defined in service metadata)
        Returns:
        immutable copy of this with just the state 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 DeviceEnrollmentWindowsHelloForBusinessConfiguration 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

      • getUnmappedFields

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