amplify_auth_cognito_dart library
Amplify Auth Cognito for Dart
Classes
- AmplifyAuthCognitoDart
- The AWS Cognito implementation of the Amplify Auth category.
- ASFContextData
- Context parameters required for advanced security features (ASF).
- ASFContextDataBuilder
- ASFContextDataProvider
- Provides user context data as required for Cognito's advanced security features (ASF) functionality.
- ASFDeviceInfoCollector
- Retrieves context data as required for advanced security features (ASF).
- AuthCodeDeliveryDetails
- Details on where a confirmation code has been delivered.
- AuthDevice
- Common interface for devices tracked by an authentication provider.
- AuthHubEvent
- The base class for hub events of the Auth category.
- AuthNextSignInStep
- AuthNextSignUpStep
- AuthNextStep
- AuthNextUpdateAttributeStep
- This wraps all the details around the next step in the user attribute update process.
- AuthProvider
- AuthSession
- AuthUser
- AuthUserAttribute
- The key and value for a user attribute.
- AuthUserAttributeKey
- A user attribute identifier.
- CognitoAuthSession
- The current Cognito auth session, with AWS credentials and User Pool tokens of the active user.
- CognitoAuthUser
- A Cognito user, including details of how they signed in.
- CognitoCompleteSignOut
-
The result of a call to
Amplify.Auth.signOut. - CognitoConfirmResetPasswordPluginOptions
-
Cognito options for
Amplify.Auth.confirmResetPassword. - CognitoConfirmSignInPluginOptions
-
Cognito options for
Amplify.Auth.confirmSignIn. - CognitoConfirmSignUpPluginOptions
-
Cognito options for
Amplify.Auth.confirmSignUp. - CognitoConfirmUserAttributePluginOptions
-
Cognito options for
Amplify.Auth.confirmUserAttribute. - CognitoDevice
- A device tracked by AWS Cognito.
- CognitoFailedSignOut
- A sign out which did not complete. The user will remain signed in.
- CognitoFetchAuthSessionPluginOptions
-
Cognito options for
Amplify.Auth.fetchAuthSession. - CognitoFetchUserAttributesPluginOptions
-
Cognito options for
Amplify.Auth.fetchUserAttributes. - CognitoGetCurrentUserPluginOptions
-
Cognito options for
Amplify.Auth.getCurrentUser. - CognitoPartialSignOut
- A partial success during sign out where credentials have been cleared from the device.
- CognitoResendSignUpCodePluginOptions
-
Cognito options for
Amplify.Auth.resendSignUpCode. - CognitoResendSignUpCodeResult
- The result of resending a sign up code with Cognito.
- CognitoResetPasswordPluginOptions
-
Cognito options for
Amplify.Auth.resetPassword. - CognitoResetPasswordResult
- The result of performing a password reset.
- CognitoSendUserAttributeVerificationCodePluginOptions
-
Cognito options for
Amplify.Auth.sendUserAttributeVerificationCode. - CognitoSignInDetails
- The details of how a user logged in.
- CognitoSignInDetailsApiBased
- Sign in details for Cognito API-based (e.g. SRP or Custom Auth).
- CognitoSignInDetailsHostedUi
- Sign in details for Cognito Hosted UI.
- CognitoSignInMethod
- The method by which the user logged in and retrieved the accompanying CognitoUserPoolTokens.
- CognitoSignInPluginOptions
-
Cognito options for
Amplify.Auth.signIn. - CognitoSignInResult
- The result of performing a sign in with Cognito.
- CognitoSignInWithWebUIPluginOptions
-
Cognito options for
Amplify.Auth.signIn. - CognitoSignOutPluginOptions
-
Cognito options for
Amplify.Auth.signOut. - CognitoSignOutResult
-
The result of a call to
Amplify.Auth.signOut. - CognitoSignUpPluginOptions
-
Cognito options for
Amplify.Auth.signUp. - CognitoSignUpResult
- The result of performing a sign up with Cognito.
- CognitoUpdatePasswordPluginOptions
-
Cognito options for
Amplify.Auth.updatePassword. - CognitoUpdateUserAttributePluginOptions
-
Cognito options for
Amplify.Auth.updateUserAttribute. - CognitoUpdateUserAttributesPluginOptions
-
Cognito options for
Amplify.Auth.updateUserAttributes. - CognitoUserAttributeKey
-
User attributes available for configuring via
Amplify.Auth.signUp, or updating viaAmplify.Auth.updateUserAttributeandAmplify.Auth.updateUserAttributes. - CognitoUserPoolTokens
- Cognito credentials of the active user.
- CognitoUserPoolTokensBuilder
- CognitoVerifyTotpSetupPluginOptions
-
Cognito options for
Amplify.Auth.verifyTotpSetup. - ConfirmResetPasswordOptions
- The shared confirm reset password options among all Auth plugins.
- ConfirmSignInOptions
-
Options for
Amplify.Auth.confirmSignIn. - ConfirmSignUpOptions
-
Options passed to
Amplify.Auth.confirmSignUp. - ConfirmUserAttributeOptions
-
Options passed to
Amplify.Auth.confirmUserAttribute - ConfirmUserAttributeResult
- Wraps the result of a confirm user attribute operation.
- FederateToIdentityPoolOptions
- Options to AmplifyAuthCognitoDart.federateToIdentityPool.
- FederateToIdentityPoolRequest
- Encapsulates a request to AmplifyAuthCognitoDart.federateToIdentityPool.
- FederateToIdentityPoolResult
- The result of calling AmplifyAuthCognitoDart.federateToIdentityPool.
- FetchAuthSessionOptions
-
Options for
Amplify.Auth.fetchAuthSession. - FetchUserAttributesOptions
- The shared fetch user attributes options among all Auth plugins.
- GetCurrentUserOptions
-
Options for
Amplify.Auth.getCurrentUser. - JsonWebToken
- A JSON Web Token (JWT) is a compact, URL-safe means of representing claims to be transferred between two parties.
- ResendSignUpCodeOptions
- The shared resend sign up code options among all Auth plugins.
- ResendSignUpCodeResult
- ResetPasswordOptions
- The shared reset password options among all Auth plugins.
- ResetPasswordResult
- The result of a password reset request.
- ResetPasswordStep
- The next step required for resetting a user's password.
- SendUserAttributeVerificationCodeOptions
- The shared send user attribute verification code options among all Auth plugins.
- SendUserAttributeVerificationCodeResult
- Wraps the result of a send user verification code operation.
- SignInDetails
- Details about how a user signed in.
- SignInOptions
-
Options for
Amplify.Auth.signIn. - SignInResult
- SignInWithWebUIOptions
-
Options for
Amplify.Auth.signInWithWebUI. - SignOutOptions
- The shared sign out options among all Auth plugins.
- SignOutResult
-
The result of a call to
Amplify.Auth.signOut. - SignUpOptions
-
Options for
Amplify.Auth.signUp. - SignUpResult
- TotpSetupDetails
- The TOTP secret code and QR code, used to set up an authenticator for TOTP MFA.
- TotpSetupOptions
-
Options for
Amplify.Auth.verifyTotpSetup. - TotpSetupPluginOptions
-
Plugin-specific options for
Amplify.Auth.setUpTotp. - UpdatePasswordOptions
- The shared update password options among all Auth plugins.
- UpdatePasswordResult
- The result of an update password request.
- UpdateUserAttributeOptions
- The shared update user attribute options among all Auth plugins.
- UpdateUserAttributeResult
- Wraps the result of an update user attribute operation.
- UpdateUserAttributesOptions
- The shared update user attributes options among all Auth plugins.
- UserMfaPreference
-
The MFA preferences for the user, returned from
Amplify.Auth.fetchMfaPreference. - VerifyTotpSetupOptions
-
Options for
Amplify.Auth.verifyTotpSetup. - VerifyTotpSetupPluginOptions
-
Plugin-specific options for
Amplify.Auth.verifyTotpSetup.
Enums
- AuthHubEventType
- Hub Event types for the Auth category.
- AuthResetPasswordStep
- The current step in the reset password flow.
- AuthSignInStep
- The current step in the sign in flow.
- AuthSignUpStep
- The current step in the sign up flow.
- AuthUpdateAttributeStep
- The current step in the attribute update flow.
- CognitoSignInType
- The type of sign-in initiated by the user.
- DeliveryMedium
- The medium to which an item (e.g., confirmation code) was delivered.
- MfaPreference
- The MFA preference for an MFA type.
Extensions
- AuthDeviceX on AuthDevice
- Helper functions for AuthDevice.
- CognitoAccessToken on JsonWebToken
- Cognito-specific access token claims.
- CognitoIdToken on JsonWebToken
- Standard OIDC and Cognito-specific ID token claims.
- CognitoToken on JsonWebToken
- Cognito-specific claims for access and ID tokens.
Typedefs
-
AuthErrorResult<
T extends Object?> = AWSErrorResult< T, AuthException> - A failed result to an Auth operation.
-
AuthResult<
T extends Object?> = AWSResult< T, AuthException> - The result of an Auth operation.
-
AuthSuccessResult<
T extends Object?> = AWSSuccessResult< T, AuthException> - A successful result to an Auth operation.
Exceptions / Errors
- AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
- AuthException
- The class for Auth category exceptions.
- AuthNotAuthorizedException
- Exception thrown when the current session is not authorized to perform an operation.
- AuthServiceException
- Exception thrown when some error occurs in the underlying service.
- AuthValidationException
- Exception thrown when one of the input fields to an operation is invalid.
- CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.
- CodeMismatchException
- This exception is thrown if the provided code doesn't match what the server was expecting.
- CognitoServiceException
- An core.AuthServiceException thrown by Cognito.
- ConcurrentModificationException
- This exception is thrown if two or more modifications are happening concurrently.
- DeviceNotTrackedException
- Exception thrown when a request is made for a device which is either not currently tracked or previously forgotten.
- EnableSoftwareTokenMfaException
- This exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA).
- ExpiredCodeException
- This exception is thrown if a code has expired.
- ExternalServiceException
- An exception thrown when a dependent service such as Facebook or Twitter is not responding
- ForbiddenException
- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.
- GlobalSignOutException
- Exception thrown trying to sign out the user globally.
- HostedUiException
- Exception thrown trying to sign out of Hosted UI.
- InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.
- InvalidAccountTypeException
- Exception thrown when the configuration of the signed in account does not support the requested operation.
- InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
- InvalidIdentityPoolConfigurationException
- Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.
- InvalidLambdaResponseException
- This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
- InvalidPasswordException
- This exception is thrown when Amazon Cognito encounters an invalid password.
- InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
- InvalidSmsRoleTrustRelationshipException
-
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust
cognito-idp.amazonaws.comor the external ID provided in the role does not match what is provided in the SMS configuration for the user pool. - InvalidStateException
- Exception thrown when the requested operation is not valid in the current Amplity Auth state.
- InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is not valid.
- LambdaException
- Exception thrown when an error from the AWS Lambda service is encountered.
- LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
- MfaMethodNotFoundException
- This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.
- NetworkException
- Exception thrown when the requested operation fails due to a network failure.
- NotAuthorizedServiceException
- This exception is thrown when a user isn't authorized.
- PasswordHistoryPolicyViolationException
- The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.
- PasswordResetRequiredException
- This exception is thrown when a password reset is required.
- ResourceConflictException
- Thrown when a user tries to use a login which is already linked to another account.
- ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service can't find the requested resource.
- RevokeTokenException
- Exception thrown trying to revoke the user's token.
- SessionExpiredException
- Exception thrown when the current session is expired.
- SignedOutException
- Exception thrown when the requested operation can't be performed due to the user being signed out.
- SoftwareTokenMfaNotFoundException
- This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn't activated for the user pool.
- TooManyFailedAttemptsException
- This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.
- TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.
- Exception that is thrown when the request isn't authorized. This can happen due to an invalid access token in the request.
- UnexpectedLambdaException
- This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
- UnknownException
- Exception thrown when an unknown error from an underlying SDK or service is encountered.
- UnknownServiceException
- An unknown exception raised by Cognito.
- UnsupportedOperationException
- Exception that is thrown when you attempt to perform an operation that isn't enabled for the user pool client.
- UnsupportedTokenTypeException
- Exception that is thrown when an unsupported token is passed to an operation.
- UserCancelledException
- Exception thrown when a requested operation could not be completed because it was cancelled by the user.
- UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
- UsernameExistsException
- This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
- UserNotConfirmedException
- This exception is thrown when a user isn't confirmed successfully.
- UserNotFoundException
- This exception is thrown when a user isn't found.