@aws-amplify/auth

  • Version 4.0.1
  • Published
  • 6.65 MB
  • 4 dependencies
  • Apache-2.0 license

Install

npm i @aws-amplify/auth
yarn add @aws-amplify/auth
pnpm add @aws-amplify/auth

Overview

Auth category of aws-amplify

Index

Variables

variable Auth

const Auth: AuthClass;

    Enums

    enum AuthErrorStrings

    enum AuthErrorStrings {
    DEFAULT_MSG = 'Authentication Error',
    EMPTY_USERNAME = 'Username cannot be empty',
    INVALID_USERNAME = 'The username should either be a string or one of the sign in types',
    EMPTY_PASSWORD = 'Password cannot be empty',
    EMPTY_CODE = 'Confirmation code cannot be empty',
    SIGN_UP_ERROR = 'Error creating account',
    NO_MFA = 'No valid MFA method provided',
    INVALID_MFA = 'Invalid MFA type',
    EMPTY_CHALLENGE = 'Challenge response cannot be empty',
    NO_USER_SESSION = 'Failed to get the session because the user is empty',
    }

      member DEFAULT_MSG

      DEFAULT_MSG = 'Authentication Error'

        member EMPTY_CHALLENGE

        EMPTY_CHALLENGE = 'Challenge response cannot be empty'

          member EMPTY_CODE

          EMPTY_CODE = 'Confirmation code cannot be empty'

            member EMPTY_PASSWORD

            EMPTY_PASSWORD = 'Password cannot be empty'

              member EMPTY_USERNAME

              EMPTY_USERNAME = 'Username cannot be empty'

                member INVALID_MFA

                INVALID_MFA = 'Invalid MFA type'

                  member INVALID_USERNAME

                  INVALID_USERNAME = 'The username should either be a string or one of the sign in types'

                    member NO_MFA

                    NO_MFA = 'No valid MFA method provided'

                      member NO_USER_SESSION

                      NO_USER_SESSION = 'Failed to get the session because the user is empty'

                        member SIGN_UP_ERROR

                        SIGN_UP_ERROR = 'Error creating account'

                          enum CognitoHostedUIIdentityProvider

                          enum CognitoHostedUIIdentityProvider {
                          Cognito = 'COGNITO',
                          Google = 'Google',
                          Facebook = 'Facebook',
                          Amazon = 'LoginWithAmazon',
                          Apple = 'SignInWithApple',
                          }

                            member Amazon

                            Amazon = 'LoginWithAmazon'

                              member Apple

                              Apple = 'SignInWithApple'

                                member Cognito

                                Cognito = 'COGNITO'

                                  member Facebook

                                  Facebook = 'Facebook'

                                    member Google

                                    Google = 'Google'

                                      Package Files (4)

                                      Dependencies (4)

                                      Dev Dependencies (1)

                                      Peer Dependencies (0)

                                      No peer dependencies.

                                      Badge

                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-amplify/auth.

                                      • Markdown
                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-amplify/auth)
                                      • HTML
                                        <a href="https://www.jsdocs.io/package/@aws-amplify/auth"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>