Logo for jsDocs.io

@aws-amplify/auth

  • Version 5.2.0
  • Published
  • 716 kB
  • 3 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

Interfaces

Enums

Variables

variable Auth

const Auth: AuthClass;

    Interfaces

    interface SignUpParams

    interface SignUpParams {}

    • Parameters for user sign up

    property attributes

    attributes?: object;

      property autoSignIn

      autoSignIn?: AutoSignInOptions;

        property clientMetadata

        clientMetadata?: {
            [key: string]: string;
        };

          property password

          password: string;

            property username

            username: string;

              property validationData

              validationData?: {
                  [key: string]: any;
              };

                Enums

                enum AuthErrorStrings

                enum AuthErrorStrings {
                    DEFAULT_MSG = 'Authentication Error',
                    EMPTY_EMAIL = 'Email cannot be empty',
                    EMPTY_PHONE = 'Phone number cannot be empty',
                    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',
                    NETWORK_ERROR = 'Network Error',
                    DEVICE_CONFIG = 'Device tracking has not been configured in this User Pool',
                    AUTOSIGNIN_ERROR = 'Please use your credentials to sign in',
                }

                  member AUTOSIGNIN_ERROR

                  AUTOSIGNIN_ERROR = 'Please use your credentials to sign in'

                    member DEFAULT_MSG

                    DEFAULT_MSG = 'Authentication Error'

                      member DEVICE_CONFIG

                      DEVICE_CONFIG = 'Device tracking has not been configured in this User Pool'

                        member EMPTY_CHALLENGE

                        EMPTY_CHALLENGE = 'Challenge response cannot be empty'

                          member EMPTY_CODE

                          EMPTY_CODE = 'Confirmation code cannot be empty'

                            member EMPTY_EMAIL

                            EMPTY_EMAIL = 'Email cannot be empty'

                              member EMPTY_PASSWORD

                              EMPTY_PASSWORD = 'Password cannot be empty'

                                member EMPTY_PHONE

                                EMPTY_PHONE = 'Phone number 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 NETWORK_ERROR

                                        NETWORK_ERROR = 'Network Error'

                                          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'

                                                            enum GRAPHQL_AUTH_MODE

                                                            enum GRAPHQL_AUTH_MODE {
                                                                API_KEY = 'API_KEY',
                                                                AWS_IAM = 'AWS_IAM',
                                                                OPENID_CONNECT = 'OPENID_CONNECT',
                                                                AMAZON_COGNITO_USER_POOLS = 'AMAZON_COGNITO_USER_POOLS',
                                                                AWS_LAMBDA = 'AWS_LAMBDA',
                                                            }

                                                              member AMAZON_COGNITO_USER_POOLS

                                                              AMAZON_COGNITO_USER_POOLS = 'AMAZON_COGNITO_USER_POOLS'

                                                                member API_KEY

                                                                API_KEY = 'API_KEY'

                                                                  member AWS_IAM

                                                                  AWS_IAM = 'AWS_IAM'

                                                                    member AWS_LAMBDA

                                                                    AWS_LAMBDA = 'AWS_LAMBDA'

                                                                      member OPENID_CONNECT

                                                                      OPENID_CONNECT = 'OPENID_CONNECT'

                                                                        Package Files (4)

                                                                        Dependencies (3)

                                                                        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>