Class IosKerberosSingleSignOnExtension

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataType

    public class IosKerberosSingleSignOnExtension
    extends IosSingleSignOnExtension
    implements com.github.davidmoten.odata.client.ODataType
    “Represents a Kerberos-type Single Sign-On extension profile for iOS devices.”
    • Field Detail

      • activeDirectorySiteCode

        protected String activeDirectorySiteCode
      • blockActiveDirectorySiteAutoDiscovery

        protected Boolean blockActiveDirectorySiteAutoDiscovery
      • blockAutomaticLogin

        protected Boolean blockAutomaticLogin
      • cacheName

        protected String cacheName
      • credentialBundleIdAccessControlList

        protected List<String> credentialBundleIdAccessControlList
      • credentialBundleIdAccessControlListNextLink

        protected String credentialBundleIdAccessControlListNextLink
      • domainRealms

        protected List<String> domainRealms
      • domainRealmsNextLink

        protected String domainRealmsNextLink
      • domainsNextLink

        protected String domainsNextLink
      • isDefaultRealm

        protected Boolean isDefaultRealm
      • managedAppsInBundleIdACLIncluded

        protected Boolean managedAppsInBundleIdACLIncluded
      • passwordBlockModification

        protected Boolean passwordBlockModification
      • passwordChangeUrl

        protected String passwordChangeUrl
      • passwordEnableLocalSync

        protected Boolean passwordEnableLocalSync
      • passwordExpirationDays

        protected Integer passwordExpirationDays
      • passwordExpirationNotificationDays

        protected Integer passwordExpirationNotificationDays
      • passwordMinimumAgeDays

        protected Integer passwordMinimumAgeDays
      • passwordMinimumLength

        protected Integer passwordMinimumLength
      • passwordPreviousPasswordBlockCount

        protected Integer passwordPreviousPasswordBlockCount
      • passwordRequireActiveDirectoryComplexity

        protected Boolean passwordRequireActiveDirectoryComplexity
      • passwordRequirementsDescription

        protected String passwordRequirementsDescription
      • realm

        protected String realm
      • requireUserPresence

        protected Boolean requireUserPresence
      • signInHelpText

        protected String signInHelpText
      • userPrincipalName

        protected String userPrincipalName
    • Constructor Detail

      • IosKerberosSingleSignOnExtension

        protected IosKerberosSingleSignOnExtension()
    • Method Detail

      • getActiveDirectorySiteCode

        public Optional<String> getActiveDirectorySiteCode()
        “Gets or sets the Active Directory site.”
        Returns:
        property activeDirectorySiteCode
      • withActiveDirectorySiteCode

        public IosKerberosSingleSignOnExtension withActiveDirectorySiteCode​(String activeDirectorySiteCode)
        Returns an immutable copy of this with just the activeDirectorySiteCode 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.

        “Gets or sets the Active Directory site.”

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

        public Optional<Boolean> getBlockActiveDirectorySiteAutoDiscovery()
        “Enables or disables whether the Kerberos extension can automatically determine its site name.”
        Returns:
        property blockActiveDirectorySiteAutoDiscovery
      • withBlockActiveDirectorySiteAutoDiscovery

        public IosKerberosSingleSignOnExtension withBlockActiveDirectorySiteAutoDiscovery​(Boolean blockActiveDirectorySiteAutoDiscovery)
        Returns an immutable copy of this with just the blockActiveDirectorySiteAutoDiscovery 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.

        “Enables or disables whether the Kerberos extension can automatically determine its site name.”

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

        public Optional<Boolean> getBlockAutomaticLogin()
        “Enables or disables Keychain usage.”
        Returns:
        property blockAutomaticLogin
      • withBlockAutomaticLogin

        public IosKerberosSingleSignOnExtension withBlockAutomaticLogin​(Boolean blockAutomaticLogin)
        Returns an immutable copy of this with just the blockAutomaticLogin 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.

        “Enables or disables Keychain usage.”

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

        public Optional<String> getCacheName()
        “Gets or sets the Generic Security Services name of the Kerberos cache to use for this profile.”
        Returns:
        property cacheName
      • withCacheName

        public IosKerberosSingleSignOnExtension withCacheName​(String cacheName)
        Returns an immutable copy of this with just the cacheName 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.

        “Gets or sets the Generic Security Services name of the Kerberos cache to use for this profile.”

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

        public com.github.davidmoten.odata.client.CollectionPage<String> getCredentialBundleIdAccessControlList()
        “Gets or sets a list of app Bundle IDs allowed to access the Kerberos Ticket Granting Ticket.”
        Returns:
        property credentialBundleIdAccessControlList
      • getCredentialBundleIdAccessControlList

        public com.github.davidmoten.odata.client.CollectionPage<String> getCredentialBundleIdAccessControlList​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Gets or sets a list of app Bundle IDs allowed to access the Kerberos Ticket Granting Ticket.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property credentialBundleIdAccessControlList
      • getDomainRealms

        public com.github.davidmoten.odata.client.CollectionPage<String> getDomainRealms()
        “Gets or sets a list of realms for custom domain-realm mapping. Realms are case sensitive.”
        Returns:
        property domainRealms
      • getDomainRealms

        public com.github.davidmoten.odata.client.CollectionPage<String> getDomainRealms​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Gets or sets a list of realms for custom domain-realm mapping. Realms are case sensitive.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property domainRealms
      • getDomains

        public com.github.davidmoten.odata.client.CollectionPage<String> getDomains()
        “Gets or sets a list of hosts or domain names for which the app extension performs SSO.”
        Returns:
        property domains
      • getDomains

        public com.github.davidmoten.odata.client.CollectionPage<String> getDomains​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Gets or sets a list of hosts or domain names for which the app extension performs SSO.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property domains
      • getIsDefaultRealm

        public Optional<Boolean> getIsDefaultRealm()
        “When true, this profile's realm will be selected as the default. Necessary if multiple Kerberos-type profiles are configured.”
        Returns:
        property isDefaultRealm
      • withIsDefaultRealm

        public IosKerberosSingleSignOnExtension withIsDefaultRealm​(Boolean isDefaultRealm)
        Returns an immutable copy of this with just the isDefaultRealm 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.

        “When true, this profile's realm will be selected as the default. Necessary if multiple Kerberos-type profiles are configured.”

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

        public Optional<Boolean> getManagedAppsInBundleIdACLIncluded()
        “When set to True, the Kerberos extension allows managed apps, and any apps entered with the app bundle ID to access the credential. When set to False, the Kerberos extension allows all apps to access the credential. Available for devices running iOS and iPadOS versions 14 and later.”
        Returns:
        property managedAppsInBundleIdACLIncluded
      • withManagedAppsInBundleIdACLIncluded

        public IosKerberosSingleSignOnExtension withManagedAppsInBundleIdACLIncluded​(Boolean managedAppsInBundleIdACLIncluded)
        Returns an immutable copy of this with just the managedAppsInBundleIdACLIncluded 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.

        “When set to True, the Kerberos extension allows managed apps, and any apps entered with the app bundle ID to access the credential. When set to False, the Kerberos extension allows all apps to access the credential. Available for devices running iOS and iPadOS versions 14 and later.”

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

        public Optional<Boolean> getPasswordBlockModification()
        “Enables or disables password changes.”
        Returns:
        property passwordBlockModification
      • withPasswordBlockModification

        public IosKerberosSingleSignOnExtension withPasswordBlockModification​(Boolean passwordBlockModification)
        Returns an immutable copy of this with just the passwordBlockModification 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.

        “Enables or disables password changes.”

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

        public Optional<String> getPasswordChangeUrl()
        “Gets or sets the URL that the user will be sent to when they initiate a password change.”
        Returns:
        property passwordChangeUrl
      • withPasswordChangeUrl

        public IosKerberosSingleSignOnExtension withPasswordChangeUrl​(String passwordChangeUrl)
        Returns an immutable copy of this with just the passwordChangeUrl 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.

        “Gets or sets the URL that the user will be sent to when they initiate a password change.”

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

        public Optional<Boolean> getPasswordEnableLocalSync()
        “Enables or disables password syncing. This won't affect users logged in with a mobile account on macOS.”
        Returns:
        property passwordEnableLocalSync
      • withPasswordEnableLocalSync

        public IosKerberosSingleSignOnExtension withPasswordEnableLocalSync​(Boolean passwordEnableLocalSync)
        Returns an immutable copy of this with just the passwordEnableLocalSync 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.

        “Enables or disables password syncing. This won't affect users logged in with a mobile account on macOS.”

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

        public Optional<Integer> getPasswordExpirationDays()
        “Overrides the default password expiration in days. For most domains, this value is calculated automatically.”
        Returns:
        property passwordExpirationDays
      • withPasswordExpirationDays

        public IosKerberosSingleSignOnExtension withPasswordExpirationDays​(Integer passwordExpirationDays)
        Returns an immutable copy of this with just the passwordExpirationDays 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.

        “Overrides the default password expiration in days. For most domains, this value is calculated automatically.”

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

        public Optional<Integer> getPasswordExpirationNotificationDays()
        “Gets or sets the number of days until the user is notified that their password will expire (default is 15).”
        Returns:
        property passwordExpirationNotificationDays
      • withPasswordExpirationNotificationDays

        public IosKerberosSingleSignOnExtension withPasswordExpirationNotificationDays​(Integer passwordExpirationNotificationDays)
        Returns an immutable copy of this with just the passwordExpirationNotificationDays 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.

        “Gets or sets the number of days until the user is notified that their password will expire (default is 15).”

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

        public Optional<Integer> getPasswordMinimumAgeDays()
        “Gets or sets the minimum number of days until a user can change their password again.”
        Returns:
        property passwordMinimumAgeDays
      • withPasswordMinimumAgeDays

        public IosKerberosSingleSignOnExtension withPasswordMinimumAgeDays​(Integer passwordMinimumAgeDays)
        Returns an immutable copy of this with just the passwordMinimumAgeDays 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.

        “Gets or sets the minimum number of days until a user can change their password again.”

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

        public Optional<Integer> getPasswordMinimumLength()
        “Gets or sets the minimum length of a password.”
        Returns:
        property passwordMinimumLength
      • withPasswordMinimumLength

        public IosKerberosSingleSignOnExtension withPasswordMinimumLength​(Integer passwordMinimumLength)
        Returns an immutable copy of this with just the passwordMinimumLength 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.

        “Gets or sets the minimum length of a password.”

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

        public Optional<Integer> getPasswordPreviousPasswordBlockCount()
        “Gets or sets the number of previous passwords to block.”
        Returns:
        property passwordPreviousPasswordBlockCount
      • withPasswordPreviousPasswordBlockCount

        public IosKerberosSingleSignOnExtension withPasswordPreviousPasswordBlockCount​(Integer passwordPreviousPasswordBlockCount)
        Returns an immutable copy of this with just the passwordPreviousPasswordBlockCount 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.

        “Gets or sets the number of previous passwords to block.”

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

        public Optional<Boolean> getPasswordRequireActiveDirectoryComplexity()
        “Enables or disables whether passwords must meet Active Directory's complexity requirements.”
        Returns:
        property passwordRequireActiveDirectoryComplexity
      • withPasswordRequireActiveDirectoryComplexity

        public IosKerberosSingleSignOnExtension withPasswordRequireActiveDirectoryComplexity​(Boolean passwordRequireActiveDirectoryComplexity)
        Returns an immutable copy of this with just the passwordRequireActiveDirectoryComplexity 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.

        “Enables or disables whether passwords must meet Active Directory's complexity requirements.”

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

        public Optional<String> getPasswordRequirementsDescription()
        “Gets or sets a description of the password complexity requirements.”
        Returns:
        property passwordRequirementsDescription
      • withPasswordRequirementsDescription

        public IosKerberosSingleSignOnExtension withPasswordRequirementsDescription​(String passwordRequirementsDescription)
        Returns an immutable copy of this with just the passwordRequirementsDescription 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.

        “Gets or sets a description of the password complexity requirements.”

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

        public Optional<String> getRealm()
        “Gets or sets the case-sensitive realm name for this profile.”
        Returns:
        property realm
      • withRealm

        public IosKerberosSingleSignOnExtension withRealm​(String realm)
        Returns an immutable copy of this with just the realm 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.

        “Gets or sets the case-sensitive realm name for this profile.”

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

        public Optional<Boolean> getRequireUserPresence()
        “Gets or sets whether to require authentication via Touch ID, Face ID, or a passcode to access the keychain entry.”
        Returns:
        property requireUserPresence
      • withRequireUserPresence

        public IosKerberosSingleSignOnExtension withRequireUserPresence​(Boolean requireUserPresence)
        Returns an immutable copy of this with just the requireUserPresence 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.

        “Gets or sets whether to require authentication via Touch ID, Face ID, or a passcode to access the keychain entry.”

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

        public Optional<String> getSignInHelpText()
        “Text displayed to the user at the Kerberos sign in window. Available for devices running iOS and iPadOS versions 14 and later.”
        Returns:
        property signInHelpText
      • withSignInHelpText

        public IosKerberosSingleSignOnExtension withSignInHelpText​(String signInHelpText)
        Returns an immutable copy of this with just the signInHelpText 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.

        “Text displayed to the user at the Kerberos sign in window. Available for devices running iOS and iPadOS versions 14 and later.”

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

        public Optional<String> getUserPrincipalName()
        “Gets or sets the principle user name to use for this profile. The realm name does not need to be included.”
        Returns:
        property userPrincipalName
      • withUserPrincipalName

        public IosKerberosSingleSignOnExtension withUserPrincipalName​(String userPrincipalName)
        Returns an immutable copy of this with just the userPrincipalName 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.

        “Gets or sets the principle user name to use for this profile. The realm name does not need to be included.”

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

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

        public static IosKerberosSingleSignOnExtension.Builder builderIosKerberosSingleSignOnExtension()
        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