Interface AdminGetUserAuthFactorsResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CognitoIdentityProviderResponse.Builder, CopyableBuilder<AdminGetUserAuthFactorsResponse.Builder,AdminGetUserAuthFactorsResponse>, SdkBuilder<AdminGetUserAuthFactorsResponse.Builder,AdminGetUserAuthFactorsResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
AdminGetUserAuthFactorsResponse
@Mutable @NotThreadSafe public static interface AdminGetUserAuthFactorsResponse.Builder extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<AdminGetUserAuthFactorsResponse.Builder,AdminGetUserAuthFactorsResponse>

  • Method Details

    • username

      AdminGetUserAuthFactorsResponse.Builder username(String username)

      The name of the user who is eligible for the authentication factors in the response.

      Parameters:
      username - The name of the user who is eligible for the authentication factors in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preferredMfaSetting

      AdminGetUserAuthFactorsResponse.Builder preferredMfaSetting(String preferredMfaSetting)

      The challenge method that Amazon Cognito returns to the user in response to sign-in requests. Users can prefer SMS message, email message, or TOTP MFA.

      Parameters:
      preferredMfaSetting - The challenge method that Amazon Cognito returns to the user in response to sign-in requests. Users can prefer SMS message, email message, or TOTP MFA.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userMFASettingList

      AdminGetUserAuthFactorsResponse.Builder userMFASettingList(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userMFASettingList

      AdminGetUserAuthFactorsResponse.Builder userMFASettingList(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuredUserAuthFactorsWithStrings

      AdminGetUserAuthFactorsResponse.Builder configuredUserAuthFactorsWithStrings(Collection<String> configuredUserAuthFactors)

      The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

      PASSWORD can only be used as a first authentication factor. SOFTWARE_TOKEN can only be used as an MFA factor. EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be used as either a first authentication factor or an MFA factor. WEB_AUTHN is available as an MFA factor only when passkey MFA is enabled at the user pool level.

      Parameters:
      configuredUserAuthFactors - The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

      PASSWORD can only be used as a first authentication factor. SOFTWARE_TOKEN can only be used as an MFA factor. EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be used as either a first authentication factor or an MFA factor. WEB_AUTHN is available as an MFA factor only when passkey MFA is enabled at the user pool level.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuredUserAuthFactorsWithStrings

      AdminGetUserAuthFactorsResponse.Builder configuredUserAuthFactorsWithStrings(String... configuredUserAuthFactors)

      The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

      PASSWORD can only be used as a first authentication factor. SOFTWARE_TOKEN can only be used as an MFA factor. EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be used as either a first authentication factor or an MFA factor. WEB_AUTHN is available as an MFA factor only when passkey MFA is enabled at the user pool level.

      Parameters:
      configuredUserAuthFactors - The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

      PASSWORD can only be used as a first authentication factor. SOFTWARE_TOKEN can only be used as an MFA factor. EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be used as either a first authentication factor or an MFA factor. WEB_AUTHN is available as an MFA factor only when passkey MFA is enabled at the user pool level.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuredUserAuthFactors

      AdminGetUserAuthFactorsResponse.Builder configuredUserAuthFactors(Collection<AuthFactorType> configuredUserAuthFactors)

      The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

      PASSWORD can only be used as a first authentication factor. SOFTWARE_TOKEN can only be used as an MFA factor. EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be used as either a first authentication factor or an MFA factor. WEB_AUTHN is available as an MFA factor only when passkey MFA is enabled at the user pool level.

      Parameters:
      configuredUserAuthFactors - The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

      PASSWORD can only be used as a first authentication factor. SOFTWARE_TOKEN can only be used as an MFA factor. EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be used as either a first authentication factor or an MFA factor. WEB_AUTHN is available as an MFA factor only when passkey MFA is enabled at the user pool level.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuredUserAuthFactors

      AdminGetUserAuthFactorsResponse.Builder configuredUserAuthFactors(AuthFactorType... configuredUserAuthFactors)

      The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

      PASSWORD can only be used as a first authentication factor. SOFTWARE_TOKEN can only be used as an MFA factor. EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be used as either a first authentication factor or an MFA factor. WEB_AUTHN is available as an MFA factor only when passkey MFA is enabled at the user pool level.

      Parameters:
      configuredUserAuthFactors - The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

      PASSWORD can only be used as a first authentication factor. SOFTWARE_TOKEN can only be used as an MFA factor. EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be used as either a first authentication factor or an MFA factor. WEB_AUTHN is available as an MFA factor only when passkey MFA is enabled at the user pool level.

      Returns:
      Returns a reference to this object so that method calls can be chained together.