Looking for how to use this in your app?See Frontend Libraries →

API Reference

associateWebAuthnCredential

Registers a new passkey for an authenticated user

Throws

PasskeyError:
- Thrown when intermediate state is invalid
AuthError:
- Thrown when user is unauthenticated
StartWebAuthnRegistrationException
- Thrown due to a service error retrieving WebAuthn registration options
CompleteWebAuthnRegistrationException
- Thrown due to a service error when verifying WebAuthn registration result

Returns

Promise<void>

confirmResetPassword

Confirms the new password and verification code to reset the password.

Parameters

Option	Required	Type	Description
`input`	true		The ConfirmResetPasswordInput object.

Throws

ConfirmForgotPasswordException Thrown due to an invalid confirmation code or password.
AuthValidationErrorCode Thrown due to an empty confirmation code, password or username.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<void>

confirmSignIn

Continues or completes the sign in process when required by the initial call to signIn.

Parameters

Option	Required	Type	Description
`input`	true		The ConfirmSignInInput object

Throws

VerifySoftwareTokenException: Thrown due to an invalid MFA token.
RespondToAuthChallengeException: Thrown due to an invalid auth challenge response.
AssociateSoftwareTokenException: Thrown due to a service error during the MFA setup process.
AuthValidationErrorCode: Thrown when challengeResponse is not defined.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<>

Output type for Cognito confirmSignIn API.

confirmSignUp

Confirms a new user account.

Parameters

Option	Required	Type	Description
`input`	true		The ConfirmSignUpInput object.

Throws

ConfirmSignUpException Thrown due to an invalid confirmation code.
AuthValidationErrorCode Thrown due to an empty confirmation code
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<>

Output type for Cognito confirmSignUp API.

confirmUserAttribute

Confirms a user attribute with the confirmation code.

Parameters

Option	Required	Type	Description
`input`	true		The ConfirmUserAttributeInput object

Throws

AuthValidationErrorCode - Thrown when confirmationCode is not defined.
VerifyUserAttributeException - Thrown due to an invalid confirmation code or attribute.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<void>

decodeJWT

Decodes payload of JWT token

Parameters

Option	Required	Type	Description
`token`	true	string	A string representing a token to be decoded

Throws

Error - Throws error when token is invalid or payload malformed.

Returns

deleteUser

Deletes a user from the user pool while authenticated.

Throws

DeleteUserException
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<void>

deleteUserAttributes

Deletes user attributes.

Parameters

Option	Required	Type	Description
`input`	true		The DeleteUserAttributesInput object

Throws

DeleteUserAttributesException - Thrown due to invalid attribute.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<void>

deleteWebAuthnCredential

Delete a registered credential for an authenticated user by credentialId

Parameters

Option	Required	Type	Description
`input`	true		The delete input parameters including the credentialId

Throws

AuthError:
- Thrown when user is unauthenticated
DeleteWebAuthnCredentialException
- Thrown due to a service error when deleting a WebAuthn credential

Returns

Promise<void>

fetchDevices

Fetches devices that have been remembered using rememberDevice for the currently authenticated user.

Throws

ListDevicesException
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<>

Output type for Cognito fetchDevices API.

fetchMFAPreference

Fetches the preferred MFA setting and enabled MFA settings for the user.

Throws

GetUserException : error thrown when the service fails to fetch MFA preference and settings.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<>

forgetDevice

Forget a remembered device while authenticated.

Parameters

Option	Required	Type	Description
`input`	false	AuthForgetDeviceInput	The ForgetDeviceInput object.

Throws

ForgetDeviceException - Cognito service errors thrown when forgetting device with invalid device key
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<void>

listWebAuthnCredentials

Lists registered credentials for an authenticated user

Parameters

Option	Required	Type	Description
`input`	false		The list input parameters including page size and next token.

Throws

AuthError:
- Thrown when user is unauthenticated
ListWebAuthnCredentialsException
- Thrown due to a service error when listing WebAuthn credentials

Returns

Promise<>

Output type for Cognito listWebAuthnCredentials API.

rememberDevice

Marks device as remembered while authenticated.

Throws

UpdateDeviceStatusException - Cognito service errors thrown when setting device status to remembered using an invalid device key.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<void>

resendSignUpCode

Resend the confirmation code while signing up

Parameters

Option	Required	Type	Description
`input`	true		The ResendSignUpCodeInput object

Throws

service:ResendConfirmationException - Cognito service errors thrown when resending the code.
validation:AuthValidationErrorCode - Validation errors thrown either username are not defined.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<>

Output type for Cognito resendSignUpCode API.

resetPassword

Resets a user's password.

Parameters

Option	Required	Type	Description
`input`	true		The ResetPasswordInput object.

Throws

ForgotPasswordException Thrown due to an invalid confirmation code or password.
AuthValidationErrorCode Thrown due to an empty username.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<>

Output type for Cognito resetPassword API.

setUpTOTP

Sets up TOTP for the user.

Throws

AssociateSoftwareTokenException Thrown if a service occurs while setting up TOTP.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<AuthTOTPSetupDetails>

Signs a user in

Option	Required	Type	Description
`input`	true		The SignInInput object

service:InitiateAuthException, RespondToAuthChallengeException - Cognito service errors thrown during the sign-in process.
validation:AuthValidationErrorCode - Validation errors thrown when either username or password are not defined.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Promise<>

Output type for Cognito signIn API.

signInWithRedirect

Signs in a user with OAuth. Redirects the application to an Identity Provider.

Parameters

Option	Required	Type	Description
`input`	false	AuthSignInWithRedirectInput	The SignInWithRedirectInput object, if empty it will redirect to Cognito HostedUI

Throws

AuthTokenConfigException- Thrown when the user pool config is invalid.
OAuthNotConfigureException- Thrown when the oauth config is invalid.

Returns

Promise<void>

signOut

Signs a user out

Parameters

Option	Required	Type	Description
`input`	false	AuthSignOutInput	The SignOutInput object

Throws

AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<void>

Creates a user

Option	Required	Type	Description
`input`	true		The SignUpInput object

service:SignUpException - Cognito service errors thrown during the sign-up process.
validation:AuthValidationErrorCode - Validation errors thrown either username or password are not defined.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Promise<>

Output type for Cognito signUp API.

updateMFAPreference

Updates the MFA preference of the user.

Parameters

Option	Required	Type	Description
`input`	true		The UpdateMFAPreferenceInput object.

Throws

SetUserMFAPreferenceException - Service error thrown when the MFA preference cannot be updated.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<void>

updatePassword

Updates user's password while authenticated.

Parameters

Option	Required	Type	Description
`input`	true	AuthUpdatePasswordInput	The UpdatePasswordInput object.

Throws

ChangePasswordException - Cognito service errors thrown when updating a password.
AuthValidationErrorCode - Validation errors thrown when oldPassword or newPassword are empty.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<void>

verifyTOTPSetup

Verifies an OTP code retrieved from an associated authentication app.

Parameters

Option	Required	Type	Description
`input`	true		The VerifyTOTPSetupInput

Throws

VerifySoftwareTokenException: Thrown due to an invalid MFA token.
AuthValidationErrorCode: Thrown when code is not defined.
AuthTokenConfigException- Thrown when the token provider config is invalid.

Returns

Promise<void>

Link Color Legend

Interface

Reference

Other