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
ConfirmForgotPasswordExceptionThrown due to an invalid confirmation code or password.AuthValidationErrorCodeThrown due to an empty confirmation code, password or username.AuthTokenConfigException- Thrown when the token provider config is invalid.
Returns
Promise<void>confirmSignIn
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true | ||
input | true |
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 whenchallengeResponseis not defined.AuthTokenConfigException- Thrown when the token provider config is invalid.
confirmSignUp
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true | ||
input | true |
confirmSignUp
Confirms a new user account.
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | The ConfirmSignUpInput object. |
Throws
ConfirmSignUpExceptionThrown due to an invalid confirmation code.AuthValidationErrorCodeThrown due to an empty confirmation codeAuthTokenConfigException- Thrown when the token provider config is invalid.
confirmUserAttribute
Confirms a user attribute with the confirmation code.
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | The ConfirmUserAttributeInput object |
Throws
AuthValidationErrorCode- Thrown whenconfirmationCodeis 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.
deleteUser
Deletes a user from the user pool while authenticated.
Throws
DeleteUserExceptionAuthTokenConfigException- 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>fetchAuthSession
Fetch the auth session of the given AmplifyContext — e.g. the
per-request context handed to an SSR
runWithAmplifyServerContext
operation — instead of the global context. This restores the pre-context
v6 SSR calling pattern fetchAuthSession(contextSpec) (the deprecated
ContextSpec type is an alias of AmplifyContext, so existing SSR code
compiles unchanged).Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true | The explicit AmplifyContext whose auth providers are used. | |
options | false | Options configuring the fetch behavior. |
Throws
AuthError- Throws error when session information cannot be refreshed.
Returns
Promise<>fetchAuthSession
Fetch the auth session including the tokens and credentials if they are available. By default it
will automatically refresh expired auth tokens if a valid refresh token is present. You can force a refresh
of non-expired tokens with
{ forceRefresh: true } input.Parameters
| Option | Required | Type | Description |
|---|---|---|---|
options | false | Options configuring the fetch behavior. |
Throws
AuthError- Throws error when session information cannot be refreshed.
Returns
Promise<>fetchDevices
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true |
fetchDevices
Fetches devices that have been remembered using rememberDevice
for the currently authenticated user.
Throws
ListDevicesExceptionAuthTokenConfigException- Thrown when the token provider config is invalid.
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<>fetchUserAttributes
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true |
Returns
Promise<Partial<Record<, string>>>fetchUserAttributes
Fetches the current user attributes while authenticated.
Throws
GetUserException- Cognito service errors thrown when the service is not able to get the user.AuthTokenConfigException- Thrown when the token provider config is invalid.
Returns
Promise<Partial<Record<, string>>>forgetDevice
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true | ||
input | false | AuthForgetDeviceInput |
Returns
Promise<void>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 keyAuthTokenConfigException- Thrown when the token provider config is invalid.
Returns
Promise<void>getCurrentUser
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true |
getCurrentUser
Gets the current user from the idToken.
Throws
InitiateAuthException- Thrown when the service fails to refresh the tokens.AuthTokenConfigException- Thrown when the token provider config is invalid.
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
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
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true | ||
input | true |
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.
resetPassword
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true | ||
input | true |
resetPassword
Resets a user's password.
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | The ResetPasswordInput object. |
Throws
ForgotPasswordExceptionThrown due to an invalid confirmation code or password.AuthValidationErrorCodeThrown due to an empty username.AuthTokenConfigException- Thrown when the token provider config is invalid.
sendUserAttributeVerificationCode
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true | ||
input | true |
sendUserAttributeVerificationCode
Resends user's confirmation code when updating attributes while authenticated.
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | The SendUserAttributeVerificationCodeInput object |
Throws
GetUserAttributeVerificationExceptionAuthTokenConfigException- Thrown when the token provider config is invalid.
signIn
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true | ||
input | true |
signIn
Signs a user in
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | The SignInInput object |
Throws
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.
signInWithRedirect
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true | ||
input | false | AuthSignInWithRedirectInput |
Returns
Promise<void>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>signUp
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true | ||
input | true |
signUp
Creates a user
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | The SignUpInput object |
Throws
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.
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
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true | ||
input | true | AuthUpdatePasswordInput |
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>updateUserAttributes
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true | ||
input | true |
updateUserAttributes
Updates user's attributes while authenticated.
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | The UpdateUserAttributesInput object |
Throws
UpdateUserAttributesExceptionAuthTokenConfigException- Thrown when the token provider config is invalid.
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 whencodeis not defined.AuthTokenConfigException- Thrown when the token provider config is invalid.
Returns
Promise<void>Link Color Legend
Interface
Reference
Other