Class AuthClass

Provide authentication steps

Hierarchy

AuthClass

Index

Constructors

constructor

Properties

data

Methods

Constructors

constructor

new AuthClass(config: AuthOptions): AuthClass

- Defined in auth/src/Auth.ts:68
Initialize Auth with AWS configurations

Parameters
- config: AuthOptions
  
  Configuration of the Auth
Returns AuthClass

Properties

data

data: any

Methods

changePassword

changePassword(user: CognitoUser, oldPassword: string, newPassword: string): Promise<"SUCCESS">

- Defined in auth/src/Auth.ts:1175
Change a password for an authenticated user

Parameters
- user: CognitoUser
  
  The CognitoUser object
- oldPassword: string
  
  the current password
- newPassword: string
  
  the requested new password
Returns Promise<"SUCCESS">
- A promise resolves if success

completeNewPassword

completeNewPassword(user: CognitoUser, password: string, requiredAttributes: any): Promise<CognitoUser>

- Defined in auth/src/Auth.ts:726
Parameters
- user: CognitoUser
- password: string
- requiredAttributes: any
Returns Promise<CognitoUser>

configure

configure(config: any): any

- Defined in auth/src/Auth.ts:90
Parameters
- config: any
Returns any

confirmSignIn

confirmSignIn(user: CognitoUser, code: string, mfaType?: "SMS_MFA" | "SOFTWARE_TOKEN_MFA" | null): Promise<CognitoUser>

- Defined in auth/src/Auth.ts:692
Send MFA code to confirm sign in

Parameters
- user: CognitoUser
  
  The CognitoUser object
- code: string
  
  The confirmation code
- Optional mfaType: "SMS_MFA" | "SOFTWARE_TOKEN_MFA" | null
Returns Promise<CognitoUser>

confirmSignUp

confirmSignUp(username: string, code: string, options?: ConfirmSignUpOptions): Promise<any>

- Defined in auth/src/Auth.ts:265
Send the verfication code to confirm sign up

Parameters
- username: string
  
  The username to be confirmed
- code: string
  
  The verification code
- Optional options: ConfirmSignUpOptions
  
  other options for confirm signup
Returns Promise<any>
- A promise resolves callback data if success

currentAuthenticatedUser

currentAuthenticatedUser(): Promise<CognitoUser | any>

- Defined in auth/src/Auth.ts:918
Get current authenticated user

Returns Promise<CognitoUser | any>
- A promise resolves to curret authenticated CognitoUser if success

currentCredentials

currentCredentials(): Promise<ICredentials>

- Defined in auth/src/Auth.ts:1030
Returns Promise<ICredentials>

currentSession

currentSession(): Promise<CognitoUserSession>

- Defined in auth/src/Auth.ts:949
Get current user's session

Returns Promise<CognitoUserSession>
- A promise resolves to session object if success

currentUserCredentials

currentUserCredentials(): Promise<ICredentials>

- Defined in auth/src/Auth.ts:1002
Get authenticated credentials of current user.

Returns Promise<ICredentials>
- A promise resolves to be current user's credentials

currentUserInfo

currentUserInfo(): Promise<any>

- Defined in auth/src/Auth.ts:1256
Get user information

async

Returns Promise<any>
- current User's information

currentUserPoolUser

currentUserPoolUser(): Promise<CognitoUser>

- Defined in auth/src/Auth.ts:859
Get current authenticated user

Returns Promise<CognitoUser>
- A promise resolves to curret authenticated CognitoUser if success

disableSMS

disableSMS(user: CognitoUser): Promise<string>

- Defined in auth/src/Auth.ts:605
diable SMS

deprecated

Parameters
- user: CognitoUser
  
  the current user
Returns Promise<string>
- A promise resolves is success

enableSMS

enableSMS(user: CognitoUser): Promise<string>

- Defined in auth/src/Auth.ts:626
enable SMS

deprecated

Parameters
- user: CognitoUser
  
  the current user
Returns Promise<string>
- A promise resolves is success

essentialCredentials

essentialCredentials(credentials: any): ICredentials

- Defined in auth/src/Auth.ts:1326
Compact version of credentials

Parameters
- credentials: any
Returns ICredentials
- Credentials

federatedSignIn

federatedSignIn(provider: "google" | "facebook" | "amazon" | "developer", response: FederatedResponse, user: FederatedUser): Promise<ICredentials>

- Defined in auth/src/Auth.ts:1301
For federated login

Parameters
- provider: "google" | "facebook" | "amazon" | "developer"
  
  federation login provider
- response: FederatedResponse
  
  response should have the access token the identity id (optional) and the expiration time (the universal time)
- user: FederatedUser
  
  user info
Returns Promise<ICredentials>

forgotPassword

forgotPassword(username: string): Promise<any>

- Defined in auth/src/Auth.ts:1195
Initiate a forgot password request

Parameters
- username: string
  
  the username to change password
Returns Promise<any>
- A promise resolves if success

forgotPasswordSubmit

forgotPasswordSubmit(username: string, code: string, password: string): Promise<void>

- Defined in auth/src/Auth.ts:1226
Confirm a new password using a confirmation Code

Parameters
- username: string
  
  The username
- code: string
  
  The confirmation code
- password: string
  
  The new password
Returns Promise<void>
- A promise that resolves if success

getMFAOptions

getMFAOptions(user: CognitoUser): Promise<MFAOption[]>

- Defined in auth/src/Auth.ts:433
get user current preferred mfa option this method doesn't work with totp, we need to deprecate it.

deprecated

Parameters
- user: CognitoUser
  
  the current user
Returns Promise<MFAOption[]>
- A promise resolves the current preferred mfa option if success

getModuleName

getModuleName(): string

- Defined in auth/src/Auth.ts:86
Returns string

getPreferredMFA

getPreferredMFA(user: any): Promise<string>

- Defined in auth/src/Auth.ts:452
get preferred mfa method

Parameters
- user: any
  
  the current cognito user
Returns Promise<string>

resendSignUp

resendSignUp(username: string): Promise<string>

- Defined in auth/src/Auth.ts:286
Resend the verification code

Parameters
- username: string
  
  The username to be confirmed
Returns Promise<string>
- A promise resolves data if success

sendCustomChallengeAnswer

sendCustomChallengeAnswer(user: CognitoUser, challengeResponses: string): Promise<CognitoUser>

- Defined in auth/src/Auth.ts:776
Send the answer to a custom challenge

Parameters
- user: CognitoUser
  
  The CognitoUser object
- challengeResponses: string
  
  The confirmation code
Returns Promise<CognitoUser>

setPreferredMFA

setPreferredMFA(user: CognitoUser, mfaMethod: "TOTP" | "SMS" | "NOMFA"): Promise<string>

- Defined in auth/src/Auth.ts:525
set preferred MFA method

Parameters
- user: CognitoUser
  
  the current Cognito user
- mfaMethod: "TOTP" | "SMS" | "NOMFA"
  
  preferred mfa method
Returns Promise<string>
- A promise resolve if success

setupTOTP

setupTOTP(user: CognitoUser): Promise<string>

- Defined in auth/src/Auth.ts:646
Setup TOTP

Parameters
- user: CognitoUser
  
  the current user
Returns Promise<string>
- A promise resolves with the secret code if success

signIn

signIn(username: string, password?: string): Promise<CognitoUser>

- Defined in auth/src/Auth.ts:304
Sign in

Parameters
- username: string
  
  The username to be signed in
- Optional password: string
  
  The password of the username
Returns Promise<CognitoUser>
- A promise resolves the CognitoUser

signOut

signOut(opts?: SignOutOpts): Promise<any>

- Defined in auth/src/Auth.ts:1133
Sign out method @

Parameters
- Optional opts: SignOutOpts
Returns Promise<any>
- A promise resolved if success

signUp

signUp(params: string | SignUpParams, ...restOfAttrs: string[]): Promise<ISignUpResult>

- Defined in auth/src/Auth.ts:209
Sign up with username, password and other attrbutes like phone, email

Parameters
- params: string | SignUpParams
  
  The user attirbutes used for signin
- Rest ...restOfAttrs: string[]
  
  for the backward compatability
Returns Promise<ISignUpResult>
- A promise resolves callback data if success

updateUserAttributes

updateUserAttributes(user: CognitoUser, attributes: object): Promise<string>

- Defined in auth/src/Auth.ts:791
Update an authenticated users' attributes

Parameters
- user: CognitoUser
- attributes: object
Returns Promise<string>

userAttributes

userAttributes(user: CognitoUser): Promise<CognitoUserAttribute[]>

- Defined in auth/src/Auth.ts:817
Return user attributes

Parameters
- user: CognitoUser
  
  The CognitoUser object
Returns Promise<CognitoUserAttribute[]>
- A promise resolves to user attributes if success

userSession

userSession(user: any): Promise<CognitoUserSession>

- Defined in auth/src/Auth.ts:977
Get the corresponding user session

Parameters
- user: any
  
  The CognitoUser object
Returns Promise<CognitoUserSession>
- A promise resolves to the session

verifiedContact

verifiedContact(user: CognitoUser): Promise<object>

- Defined in auth/src/Auth.ts:827
Parameters
- user: CognitoUser
Returns Promise<object>

verifyCurrentUserAttribute

verifyCurrentUserAttribute(attr: string): Promise<void>

- Defined in auth/src/Auth.ts:1074
Parameters
- attr: string
Returns Promise<void>

verifyCurrentUserAttributeSubmit

verifyCurrentUserAttributeSubmit(attr: string, code: string): Promise<string>

- Defined in auth/src/Auth.ts:1086
Confirm current user's attribute using a confirmation code

Parameters
- attr: string
  
  The attribute to be verified
- code: string
  
  The confirmation code
Returns Promise<string>
- A promise resolves to callback data if success

verifyTotpToken

verifyTotpToken(user: CognitoUser, challengeAnswer: string): Promise<CognitoUserSession>

- Defined in auth/src/Auth.ts:669
verify TOTP setup

Parameters
- user: CognitoUser
  
  the current user
- challengeAnswer: string
  
  challenge answer
Returns Promise<CognitoUserSession>
- A promise resolves is success

verifyUserAttribute

verifyUserAttribute(user: CognitoUser, attr: string): Promise<void>

- Defined in auth/src/Auth.ts:1041
Initiate an attribute confirmation request

Parameters
- user: CognitoUser
  
  The CognitoUser
- attr: string
  
  The attributes to be verified
Returns Promise<void>
- A promise resolves to callback data if success

verifyUserAttributeSubmit

verifyUserAttributeSubmit(user: CognitoUser, attr: string, code: string): Promise<string>

- Defined in auth/src/Auth.ts:1057
Confirm an attribute using a confirmation code

Parameters
- user: CognitoUser
  
  The CognitoUser
- attr: string
  
  The attribute to be verified
- code: string
  
  The confirmation code
Returns Promise<string>
- A promise resolves to callback data if success