AuthClass | amplify-js

Provide authentication steps

Hierarchy

AuthClass

Index

Constructors

constructor

Properties

Credentials

Methods

Constructors

constructor

new AuthClass(config: AuthOptions): AuthClass

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

Parameters
- config: AuthOptions
  
  Configuration of the Auth
Returns AuthClass

Properties

Credentials

Credentials: CredentialsClass = Credentials

Methods

changePassword

changePassword(user: CognitoUser | any, oldPassword: string, newPassword: string, clientMetadata?: ClientMetaData): Promise<"SUCCESS">

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

Parameters
- user: CognitoUser | any
  
  The CognitoUser object
- oldPassword: string
  
  the current password
- newPassword: string
  
  the requested new password
- Default value clientMetadata: ClientMetaData = this._config.clientMetadata
Returns Promise<"SUCCESS">
- A promise resolves if success

completeNewPassword

completeNewPassword(user: CognitoUser | any, password: string, requiredAttributes?: any, clientMetadata?: ClientMetaData): Promise<CognitoUser | any>

- Defined in packages/auth/src/Auth.ts:1236
Parameters
- user: CognitoUser | any
- password: string
- Default value requiredAttributes: any = {}
- Default value clientMetadata: ClientMetaData = this._config.clientMetadata
Returns Promise<CognitoUser | any>

configure

configure(config?: any): AuthOptions

- Defined in packages/auth/src/Auth.ts:151
Parameters
- Optional config: any
Returns AuthOptions

confirmSignIn

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

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

Parameters
- user: CognitoUser | any
  
  The CognitoUser object
- code: string
  
  The confirmation code
- Optional mfaType: "SMS_MFA" | "SOFTWARE_TOKEN_MFA" | null
- Default value clientMetadata: ClientMetaData = this._config.clientMetadata
Returns Promise<CognitoUser | any>

confirmSignUp

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

- Defined in packages/auth/src/Auth.ts:536
Send the verification 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(params?: CurrentUserOpts): Promise<CognitoUser | any>

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

Parameters
- Optional params: CurrentUserOpts
Returns Promise<CognitoUser | any>
- A promise resolves to current authenticated CognitoUser if success

currentCredentials

currentCredentials(): Promise<ICredentials>

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

currentSession

currentSession(): Promise<CognitoUserSession>

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

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

currentUserCredentials

currentUserCredentials(): Promise<ICredentials>

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

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

currentUserInfo

currentUserInfo(): Promise<any>

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

async

Returns Promise<any>
- current User's information

currentUserPoolUser

currentUserPoolUser(params?: CurrentUserOpts): Promise<CognitoUser | any>

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

Parameters
- Optional params: CurrentUserOpts
Returns Promise<CognitoUser | any>
- A promise resolves to current authenticated CognitoUser if success

deleteUser

deleteUser(): Promise<string | void>

- Defined in packages/auth/src/Auth.ts:1358
Delete the current authenticated user

Returns Promise<string | void>

deleteUserAttributes

deleteUserAttributes(user: CognitoUser | any, attributeNames: string[]): Promise<unknown>

- Defined in packages/auth/src/Auth.ts:1335
Delete an authenticated users' attributes

Parameters
- user: CognitoUser | any
- attributeNames: string[]
Returns Promise<unknown>

disableSMS

disableSMS(user: CognitoUser): Promise<string>

- Defined in packages/auth/src/Auth.ts:1077
disable SMS

deprecated

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

enableSMS

enableSMS(user: CognitoUser): Promise<string>

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

deprecated

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

essentialCredentials

essentialCredentials(credentials: any): ICredentials

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

Parameters
- credentials: any
Returns ICredentials
- Credentials

federatedSignIn

federatedSignIn(options?: FederatedSignInOptions): Promise<ICredentials>
federatedSignIn(provider: LegacyProvider, response: FederatedResponse, user: FederatedUser): Promise<ICredentials>
federatedSignIn(options?: FederatedSignInOptionsCustom): Promise<ICredentials>

- Defined in packages/auth/src/Auth.ts:2374
Parameters
- Optional options: FederatedSignInOptions
Returns Promise<ICredentials>
- Defined in packages/auth/src/Auth.ts:2377
Parameters
- provider: LegacyProvider
- response: FederatedResponse
- user: FederatedUser
Returns Promise<ICredentials>
- Defined in packages/auth/src/Auth.ts:2382
Parameters
- Optional options: FederatedSignInOptionsCustom
Returns Promise<ICredentials>

fetchDevices

fetchDevices(): Promise<IAuthDevice[]>

- Defined in packages/auth/src/Auth.ts:2761
Returns Promise<IAuthDevice[]>

forgetDevice

forgetDevice(): Promise<void>

- Defined in packages/auth/src/Auth.ts:2732
Returns Promise<void>

forgotPassword

forgotPassword(username: string, clientMetadata?: ClientMetaData): Promise<any>

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

Parameters
- username: string
  
  the username to change password
- Default value clientMetadata: ClientMetaData = this._config.clientMetadata
Returns Promise<any>
- A promise resolves if success

forgotPasswordSubmit

forgotPasswordSubmit(username: string, code: string, password: string, clientMetadata?: ClientMetaData): Promise<string>

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

Parameters
- username: string
  
  The username
- code: string
  
  The confirmation code
- password: string
  
  The new password
- Default value clientMetadata: ClientMetaData = this._config.clientMetadata
Returns Promise<string>
- A promise that resolves if success

getMFAOptions

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

- Defined in packages/auth/src/Auth.ts:832
This was previously used by an authenticated user to get MFAOptions, but no longer returns a meaningful response. Refer to the documentation for how to setup and use MFA: https://docs.amplify.aws/lib/auth/mfa/q/platform/js

deprecated

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

getModuleName

getModuleName(): string

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

getPreferredMFA

getPreferredMFA(user: CognitoUser | any, params?: GetPreferredMFAOpts): Promise<string>

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

Parameters
- user: CognitoUser | any
  
  the current cognito user
- Optional params: GetPreferredMFAOpts
  
  options for getting the current user preferred MFA
Returns Promise<string>

rememberDevice

rememberDevice(): Promise<string | AuthError>

- Defined in packages/auth/src/Auth.ts:2703
Returns Promise<string | AuthError>

resendSignUp

resendSignUp(username: string, clientMetadata?: ClientMetaData): Promise<any>

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

Parameters
- username: string
  
  The username to be confirmed
- Default value clientMetadata: ClientMetaData = this._config.clientMetadata
  
  Metadata to be passed to Cognito Lambda triggers
Returns Promise<any>
- A promise resolves code delivery details if successful

sendCustomChallengeAnswer

sendCustomChallengeAnswer(user: CognitoUser | any, challengeResponses: string, clientMetadata?: ClientMetaData): Promise<CognitoUser | any>

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

Parameters
- user: CognitoUser | any
  
  The CognitoUser object
- challengeResponses: string
  
  The confirmation code
- Default value clientMetadata: ClientMetaData = this._config.clientMetadata
Returns Promise<CognitoUser | any>

setPreferredMFA

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

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

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

setupTOTP

setupTOTP(user: CognitoUser | any): Promise<string>

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

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

signIn

signIn(usernameOrSignInOpts: string | SignInOpts, pw?: string, clientMetadata?: ClientMetaData): Promise<CognitoUser | any>

- Defined in packages/auth/src/Auth.ts:634
Sign in

Parameters
- usernameOrSignInOpts: string | SignInOpts
  
  The username to be signed in or the sign in options
- Optional pw: string
  
  The password of the username
- Default value clientMetadata: ClientMetaData = this._config.clientMetadata
  
  Client metadata for custom workflows
Returns Promise<CognitoUser | any>
- A promise resolves the CognitoUser

signOut

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

- Defined in packages/auth/src/Auth.ts:2157
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 packages/auth/src/Auth.ts:314
Sign up with username, password and other attributes like phone, email

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

updateUserAttributes

updateUserAttributes(user: CognitoUser | any, attributes: object, clientMetadata?: ClientMetaData): Promise<string>

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

Parameters
- user: CognitoUser | any
- attributes: object
- Default value clientMetadata: ClientMetaData = this._config.clientMetadata
Returns Promise<string>

userAttributes

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

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

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

userSession

userSession(user: any): Promise<CognitoUserSession>

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

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

verifiedContact

verifiedContact(user: CognitoUser | any): Promise<object>

- Defined in packages/auth/src/Auth.ts:1528
Parameters
- user: CognitoUser | any
Returns Promise<object>

verifyCurrentUserAttribute

verifyCurrentUserAttribute(attr: string): Promise<void>

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

verifyCurrentUserAttributeSubmit

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

- Defined in packages/auth/src/Auth.ts:2047
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 | any, challengeAnswer: string): Promise<CognitoUserSession>

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

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

verifyUserAttribute

verifyUserAttribute(user: CognitoUser | any, attr: string, clientMetadata?: ClientMetaData): Promise<void>

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

Parameters
- user: CognitoUser | any
  
  The CognitoUser
- attr: string
  
  The attributes to be verified
- Default value clientMetadata: ClientMetaData = this._config.clientMetadata
Returns Promise<void>
- A promise resolves to callback data if success

verifyUserAttributeSubmit

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

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

Parameters
- user: CognitoUser | any
  
  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

wrapRefreshSessionCallback

wrapRefreshSessionCallback(callback: NodeCallback.Any): function

- Defined in packages/auth/src/Auth.ts:292
Parameters
- callback: NodeCallback.Any
Returns function
- - (err?: E, result?: T): void
  - Parameters
    - Optional err: E
    - Optional result: T
    Returns void