cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/SoftwareTokenMfaSettingsType

SoftwareTokenMfaSettingsType

A user's preference for using time-based one-time password (TOTP) multi-factor authentication (MFA). Turns TOTP MFA on and off, and can set TOTP as preferred when other MFA options are available. You can't turn off TOTP MFA for any of your users when MFA is required in your user pool; you can only set the type that your user prefers.

Types

Builder

class Builder

Companion

object Companion

Properties

enabled

val enabled: Boolean

Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.

preferredMfa

val preferredMfa: Boolean

Specifies whether software token MFA is the preferred MFA method.

Functions

copy

inline fun copy(block: SoftwareTokenMfaSettingsType.Builder.() -> Unit = {}): SoftwareTokenMfaSettingsType

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String