AuthenticatorStep enum

The current step of the authentication flow.

Inheritance

Constructors

AuthenticatorStep()
const

Values

loading → const AuthenticatorStep

The authenticator is in a loading state.

Either Amplify.configure() or the current authentication status is pending.

onboarding → const AuthenticatorStep

The user is on the Onboarding step.

This step can be used to create an onboarding view that will be displayed to users prior to showing sign in / sign up.

See Onboarding guidelines from Material and Human Interface Guidelines

This step is only relevant if a custom builder is provided to the Authenticator. The prebuilt authenticator takes users directly to sign in by default.

signUp → const AuthenticatorStep

The user is on the Sign Up step.

signIn → const AuthenticatorStep

The user is on the Sign In step.

confirmSignUp → const AuthenticatorStep

The user is on the Confirm Sign Up step.

The user has signed up, but their account is currently in an unconfirmed state.

confirmSignInCustomAuth → const AuthenticatorStep

The user is on the Confirm Sign In (Custom Auth) step.

The user has performed the initial step of the sign in process, and should be presented with a form to enter a response to a custom auth challenge.

confirmSignInMfa → const AuthenticatorStep

The user is on the Confirm Sign In with MFA (Multi-factor Authentication) step.

The user has performed the initial step of the sign in process, and should be presented with a form to enter their confirmation code.

confirmSignInNewPassword → const AuthenticatorStep

The user is on the Confirm Sign In with New Password step.

The user has performed the initial step of the sign in process, and is required to change their password in order to complete the sign in process.

continueSignInWithMfaSelection → const AuthenticatorStep

The user is on the Continue Sign In with MFA Selection step.

The sign-in is not complete and the user must select and set up an MFA method.

continueSignInWithTotpSetup → const AuthenticatorStep

The user is on the Continue Sign In with TOTP setup step.

The sign-in is not complete and a TOTP authenticator app must be registered before continuing.

confirmSignInWithTotpMfaCode → const AuthenticatorStep

The user is on the Confirm Sign In with TOTP MFA step.

The sign-in is not complete and must be confirmed with a TOTP code from a registered authenticator app.

resetPassword → const AuthenticatorStep

The user is on the Reset Password step.

confirmResetPassword → const AuthenticatorStep

The user is on the Confirm Reset Password step.

verifyUser → const AuthenticatorStep

The user is on the Verify User step.

The user has successfully signed in and their account is confirmed, however they do not have any means of account recovery (email, phone) that is confirmed.

confirmVerifyUser → const AuthenticatorStep

The user is on the Confirm Verify User step.

The user has initiated verification of an account recovery means (email, phone), and needs to provide a verification code.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<AuthenticatorStep>
A constant List of the values in this enum, in order of their declaration.