Skip to content

Commit

Permalink
minor updates to table
Browse files Browse the repository at this point in the history
  • Loading branch information
@haverchuck
haverchuck committed Mar 5, 2024
1 parent 18ce488 commit 7cbb585
Showing 1 changed file with 34 additions and 23 deletions.
57 changes: 34 additions & 23 deletions packages/amazon-cognito-identity-js/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,40 @@ We recommend using the Amplify JavaScript library's Auth features in place of th

The following table provides the Amplify Auth APIs that can be used to satisfy Amazon Cognito Identity SDK use cases.

| Amazon Cognito Identity SDK Use Case | Amplify JS Auth |
| ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| Registering a user with the application. | [Sign Up](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.signUp.html) |
| Confirming a registered, unauthenticated user using a confirmation code. | [Confirm Sign Up](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.confirmSignUp.html) |
| Resending a confirmation code form registration of an unauthenticated user. | [Resend Sign Up Code](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.resendSignUpCode.html) |
| Authenticating a user and establishing a user session (with your choice of authentication flow type). | [Sign In](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.signIn.html) |
| Retrieving user attributes for an authenticated user. | [Fetch User Attributes](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.fetchUserAttributes.html) |
| Verifying user attribute for an authenticated user. | [Confirm User Attribute](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.confirmUserAttribute.html) |
| Deleting user attributes for an authenticated user. | [Delete User Attributes](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.deleteUserAttributes.html) |
| Updating user attributes for an authenticated user. | [Update User Attributes](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.updateUserAttributes.html) |
| Updating MFA settings for a user on a User Pool that allows MFA. | [Update MFA Preference](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.updateMFAPreference.html) |
| Getting MFA preferences for an authenticated user. | [Fetch MFA Preference](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.fetchMFAPreference.html) |
| Getting the setup URI for configuring TOTP MFA in an authenticator app. | [TOTP Setup Details](https://aws-amplify.github.io/amplify-js/api/types/aws_amplify.auth._Reference_Types_.AuthTOTPSetupDetails.html) |
| Completing TOTP MFA setup. | [Verify TOTP Setup](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.verifyTOTPSetup.html) |
| Changing the current password for an authenticated user. | [Update Password](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.updatePassword.html) |
| Initiating password recovery for an unauthenticated user. | [Reset Password](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.resetPassword.html) |
| Completing password recovery for an unauthenticated user. | [Confirm Reset Password](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.confirmResetPassword.html) |
| Deleting an authenticated user. | [Delete User](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.deleteUser.html) |
| Signing out from the application (including global sign out). | [Sign Out](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.signOut.html) |
| Retrieving the authenticated user's session information. | [Fetch Auth Session](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.fetchAuthSession.html) |
| Fetching all remembered devices for an authenticated user as a limited, paginated list. | [Fetch Devices](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.fetchDevices.html) |
| Remembering the current device. | [Remember Device](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.rememberDevice.html) |
| Forgetting a device. | [Forget Device](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.forgetDevice.html) |
# Developer Note: Please Update to Amplify v6

We recommend using the Amplify JavaScript library's Auth features in place of the Amazon Cognito Identity SDK. The Amplify JavaScript library offers a modern, fully-typed and performant experience for Auth use cases.

## Amazon Cognito Identity SDK and Amplify JavaScript API Mappings

The following table provides the Amplify Auth APIs that can be used in place of Amazon Cognito Identity SDK APIs.

| Amazon Cognito Identity SDK Use Case | Amplify JS Auth |
| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| Registering a user with the application. | [Sign Up](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.signUp.html) |
| Confirming a registered, unauthenticated user using a confirmation code. | [Confirm Sign Up](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.confirmSignUp.html) |
| Resending a confirmation code form registration of an unauthenticated user. | [Resend Sign Up Code](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.resendSignUpCode.html) |
| Authenticating a user and establishing a user session. | [Sign In](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.signIn.html) |
| Configuring an authentication flow type. | [Auth Flows](https://docs.amplify.aws/react/build-a-backend/auth/switch-auth/) |
| Configuring persistence of auth data. | [Token Saving Mechanism](https://docs.amplify.aws/react/build-a-backend/auth/manage-user-session/#update-your-token-saving-mechanism) |
| Handling token expiration. | [Token Expiration](https://docs.amplify.aws/react/build-a-backend/auth/manage-user-session/#refreshing-sessions) |
| Retrieving user attributes for an authenticated user. | [Fetch User Attributes](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.fetchUserAttributes.html) |
| Verifying user attribute for an authenticated user. | [Confirm User Attribute](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.confirmUserAttribute.html) |
| Deleting user attributes for an authenticated user. | [Delete User Attributes](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.deleteUserAttributes.html) |
| Updating user attributes for an authenticated user. | [Update User Attributes](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.updateUserAttributes.html) |
| Updating MFA settings for a user on a User Pool that allows MFA. | [Update MFA Preference](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.updateMFAPreference.html) |
| Getting MFA preferences for an authenticated user. | [Fetch MFA Preference](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.fetchMFAPreference.html) |
| Getting the setup URI for configuring TOTP MFA in an authenticator app. | [TOTP Setup Details](https://aws-amplify.github.io/amplify-js/api/types/aws_amplify.auth._Reference_Types_.AuthTOTPSetupDetails.html) |
| Completing TOTP MFA setup. | [Verify TOTP Setup](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.verifyTOTPSetup.html) |
| Changing the current password for an authenticated user. | [Update Password](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.updatePassword.html) |
| Initiating password recovery for an unauthenticated user. | [Reset Password](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.resetPassword.html) |
| Completing password recovery for an unauthenticated user. | [Confirm Reset Password](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.confirmResetPassword.html) |
| Deleting an authenticated user. | [Delete User](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.deleteUser.html) |
| Signing out from the application (including global sign out). | [Sign Out](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.signOut.html) |
| Retrieving the authenticated user's session information. | [Fetch Auth Session](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.fetchAuthSession.html) |
| Fetching all remembered devices for an authenticated user as a limited, paginated list. | [Fetch Devices](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.fetchDevices.html) |
| Remembering the current device. | [Remember Device](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.rememberDevice.html) |
| Forgetting a device. | [Forget Device](https://aws-amplify.github.io/amplify-js/api/functions/aws_amplify.auth.forgetDevice.html) |

# Amazon Cognito Identity SDK for JavaScript

Expand Down

0 comments on commit 7cbb585

Please sign in to comment.