Class ExtensionMfaUser.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • preferredAuthenticationFactor

        public ExtensionMfaUser.Builder preferredAuthenticationFactor​(ExtensionMfaUser.PreferredAuthenticationFactor preferredAuthenticationFactor)
        The preferred authentication factor type.

        *Added In:** 18.3.6

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        preferredAuthenticationFactor - the value to set
        Returns:
        this builder
      • mfaStatus

        public ExtensionMfaUser.Builder mfaStatus​(ExtensionMfaUser.MfaStatus mfaStatus)
        The user opted for MFA.

        *Added In:** 18.3.6

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readOnly - idcsRequiresWriteForAccessFlows: true - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        mfaStatus - the value to set
        Returns:
        this builder
      • preferredThirdPartyVendor

        public ExtensionMfaUser.Builder preferredThirdPartyVendor​(String preferredThirdPartyVendor)
        The preferred third-party vendor name.

        *Added In:** 19.2.1

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        preferredThirdPartyVendor - the value to set
        Returns:
        this builder
      • preferredAuthenticationMethod

        public ExtensionMfaUser.Builder preferredAuthenticationMethod​(String preferredAuthenticationMethod)
        The preferred authentication method.

        *Added In:** 2009232244

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        preferredAuthenticationMethod - the value to set
        Returns:
        this builder
      • loginAttempts

        public ExtensionMfaUser.Builder loginAttempts​(Integer loginAttempts)
        The number of incorrect multi factor authentication sign in attempts made by this user.

        The user is locked if this reaches the threshold specified in the maxIncorrectAttempts attribute in AuthenticationFactorSettings.

        *Added In:** 18.3.6

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readOnly - idcsRequiresWriteForAccessFlows: true - idcsRequiresImmediateReadAfterWriteForAccessFlows: true - required: false - returned: default - type: integer - uniqueness: none

        Parameters:
        loginAttempts - the value to set
        Returns:
        this builder
      • mfaEnabledOn

        public ExtensionMfaUser.Builder mfaEnabledOn​(String mfaEnabledOn)
        The date when the user enrolled in multi factor authentication.

        This will be set to null, when the user resets their factors.

        *Added In:** 18.3.6

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: request - type: dateTime - uniqueness: none

        Parameters:
        mfaEnabledOn - the value to set
        Returns:
        this builder
      • mfaIgnoredApps

        public ExtensionMfaUser.Builder mfaIgnoredApps​(List<String> mfaIgnoredApps)
        User MFA Ignored Apps Identifiers

        *Added In:** 19.2.1

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        mfaIgnoredApps - the value to set
        Returns:
        this builder
      • devices

        public ExtensionMfaUser.Builder devices​(List<UserExtDevices> devices)
        A list of devices enrolled by the user.

        *Added In:** 18.3.6

        *SCIM++ Properties:** - idcsCompositeKey: [value] - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

        Parameters:
        devices - the value to set
        Returns:
        this builder
      • bypassCodes

        public ExtensionMfaUser.Builder bypassCodes​(List<UserExtBypassCodes> bypassCodes)
        A list of bypass codes that belongs to the user.

        *Added In:** 18.3.6

        *SCIM++ Properties:** - idcsCompositeKey: [value] - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

        Parameters:
        bypassCodes - the value to set
        Returns:
        this builder
      • trustedUserAgents

        public ExtensionMfaUser.Builder trustedUserAgents​(List<UserExtTrustedUserAgents> trustedUserAgents)
        A list of trusted User Agents owned by this user.

        Multi-Factored Authentication uses Trusted User Agents to authenticate users. A User Agent is software application that a user uses to issue requests. For example, a User Agent could be a particular browser (possibly one of several executing on a desktop or laptop) or a particular mobile application (again, oneof several executing on a particular mobile device). A User Agent is trusted once the Multi-Factor Authentication has verified it in some way.

        *Added In:** 18.3.6

        *SCIM++ Properties:** - idcsCompositeKey: [value] - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none

        Parameters:
        trustedUserAgents - the value to set
        Returns:
        this builder