amplify_authenticator library
A prebuilt sign in/sign up experience for Amplify Auth.
See Authenticator for an overview on getting started.
Classes
- AuthenticatedView
- A widget for wrapping portions of the application (typically routes) that are intended to be protected by authentication.
- Authenticator
- Amplify Authenticator
- AuthenticatorForm
- Base class for Authenticator forms and ancestor of all Authenticator form fields.
- AuthenticatorState
- State of the Amplify Authenticator.
- AuthProvider Auth
- AuthStringResolver
- The class that is accepted by the Authenticator to override strings
- BackToSignInButton
- A prebuilt button for navigating back to the Sign In step.
- ButtonResolver
- The resolver class for shared button Widgets
- ButtonResolverKey
- ConfirmResetPasswordButton
- A prebuilt button for completing the reset password flow.
- ConfirmResetPasswordForm
- A prebuilt form for completing the reset password flow.
- ConfirmSignInCustomAuthForm
- A prebuilt form for completing the sign in process with a Custom Auth Flow.
- ConfirmSignInCustomButton
- A prebuilt button for completing Sign In with a custom challenge.
-
ConfirmSignInFormField<
FieldValue extends Object> - A prebuilt form field widget for use on the Confirm Sign In step.
- ConfirmSignInMFAButton
- A prebuilt button for completing Sign In with and MFA code.
- ConfirmSignInMFAForm
- A prebuilt form for completing the sign in process with an MFA code, from either SMS or TOTP.
- ConfirmSignInNewPasswordButton
- A prebuilt button for completing the force reset password flow.
- ConfirmSignInNewPasswordForm
- A prebuilt form for completing the force new password flow.
- ConfirmSignUpButton
- A prebuilt button for completing the sign up flow with a confirmation code.
- ConfirmSignUpForm
- A prebuilt form for completing the sign up flow with a confirmation code.
-
ConfirmSignUpFormField<
FieldValue extends Object> - A prebuilt form field widget for use on the Confirm Sign Up step.
- ConfirmVerifyUserButton
- A prebuilt button for completing the account recovery attribute verification process.
- ConfirmVerifyUserForm
- A prebuilt form for completing the account recovery attribute verification process.
- ContinueSignInWithMfaSelectionForm
- A prebuilt form for selecting MFA preference.
- ContinueSignInWithTotpSetupForm
- A prebuilt form for completing the totp setup process.
- DialCodeOptions
- The options for displaying dial codes in popup modals.
- DialCodeResolver
- ForgotPasswordButton
- A prebuilt button for changing the current step to AuthenticatorStep.resetPassword.
- InputResolver
- The resolver class for input widgets.
- InputResolverKey
- LostCodeButton
- A prebuilt button for resending a confirmation code during the sign up process.
- MessageResolver
- The resolver class for messages
- MessageResolverKey
- ResetPasswordButton
- A prebuilt button for initiating the reset password flow.
- ResetPasswordForm
- A prebuilt form for initiating the reset password flow.
- ResetPasswordFormField
- A prebuilt form field widget for use on the Confirm Sign Up step.
- SignInButton
- A prebuilt button for signing in a user.
- SignInForm
- A prebuilt form for signing in a user.
-
SignInFormField<
FieldValue extends Object> - A prebuilt form field widget for the Sign In step.
- SignOutButton
- A prebuilt button for Signing Out.
- SignUpButton
- A prebuilt button for registering a new user.
- SignUpForm
- A prebuilt form for registering a new user.
-
SignUpFormField<
FieldValue extends Object> - A prebuilt form field widget for use on the Sign Up step.
- SkipVerifyUserButton
- A prebuilt button for completing the account recovery attribute verification process.
- TitleResolver
- The resolver class for step titles
- TotpOptions
- Options for configuring the TOTP MFA Experience
-
TotpSetupFormField<
FieldValue extends Object> - Prebuilt form field widgets for setting up TOTP.
- UsernameInput
- A value emitted from username form fields when a user has updated their input.
- VerifyUserButton
- A prebuilt button for initiating the account recovery attribute verification process.
- VerifyUserForm
- A prebuilt form for initiating the account recovery attribute verification process.
-
VerifyUserFormField<
FieldValue extends Object> - A prebuilt Radio widget for use on the Verify User step.
Enums
- AuthenticatorStep
- The current step of the authentication flow.
- DialCode
- A list of ISO 3166-1 dial codes.
- DialCodeResolverKey
- ExceptionBannerLocation
- The location on the screen to show error banners.
- Gender
- InputField
- InputResolverKeyType
- MessageResolverKeyType
- UsernameSelection
- The username type to use during sign up and sign in for configurations that allow email OR phone number.
- UsernameType
- The type of username input field presented to the user.
Typedefs
- BlocEventPredicate = bool Function(AuthState state)
- CountryResolver = DialCodeResolver
- CountryResolverKey = DialCodeResolverKey
- ExceptionHandler = void Function(AuthenticatorException)
- A user-specified exception handler for errors originating within the Authenticator.
Exceptions / Errors
- AuthenticatorException
- An exception originating within the Authenticator as part of the sign up/ sign in flow.