Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class GetUserAuthFactorsResponse

    • Method Detail

      • username

        public final String username()

        The username of the currently sign-in user.

        Returns:
        The username of the currently sign-in user.

      • preferredMfaSetting

        public final String preferredMfaSetting()

        The user's preferred MFA setting.

        Returns:
        The user's preferred MFA setting.

      • hasUserMFASettingList

        public final boolean hasUserMFASettingList()
        For responses, this returns true if the service returned a value for the UserMFASettingList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • userMFASettingList

        public final List<String> userMFASettingList()

        The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserMFASettingList() method.

        Returns:
        The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

      • configuredUserAuthFactors

        public final List<AuthFactorType> configuredUserAuthFactors()

        The authentication types that are available to the user with USER_AUTH sign-in.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConfiguredUserAuthFactors() method.

        Returns:
        The authentication types that are available to the user with USER_AUTH sign-in.

      • hasConfiguredUserAuthFactors

        public final boolean hasConfiguredUserAuthFactors()
        For responses, this returns true if the service returned a value for the ConfiguredUserAuthFactors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • configuredUserAuthFactorsAsStrings

        public final List<String> configuredUserAuthFactorsAsStrings()

        The authentication types that are available to the user with USER_AUTH sign-in.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConfiguredUserAuthFactors() method.

        Returns:
        The authentication types that are available to the user with USER_AUTH sign-in.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object