@aws-amplify/auth

What is @aws-amplify/auth?

@aws-amplify/auth is a part of the AWS Amplify library that provides authentication functionalities for web and mobile applications. It allows developers to easily integrate authentication and authorization features into their applications using AWS Cognito.

What are @aws-amplify/auth's main functionalities?

Sign Up

This feature allows users to sign up for an account. The code sample demonstrates how to use the signUp method to create a new user with a username, password, and additional attributes like email and phone number.

const { Auth } = require('@aws-amplify/auth');

Auth.signUp({
  username: 'username',
  password: 'password',
  attributes: {
    email: '[e-mail]',
    phone_number: '[phone]'
  }
}).then(data => console.log(data)).catch(err => console.log(err));

Sign In

This feature allows users to sign in to their account. The code sample demonstrates how to use the signIn method to authenticate a user with a username and password.

const { Auth } = require('@aws-amplify/auth');

Auth.signIn('username', 'password')
  .then(user => console.log(user))
  .catch(err => console.log(err));

Sign Out

This feature allows users to sign out of their account. The code sample demonstrates how to use the signOut method to log out the current user.

const { Auth } = require('@aws-amplify/auth');

Auth.signOut()
  .then(data => console.log(data))
  .catch(err => console.log(err));

Password Reset

This feature allows users to reset their password. The code sample demonstrates how to use the forgotPassword method to initiate a password reset and the forgotPasswordSubmit method to complete the password reset process.

const { Auth } = require('@aws-amplify/auth');

Auth.forgotPassword('username')
  .then(data => console.log(data))
  .catch(err => console.log(err));

Auth.forgotPasswordSubmit('username', 'code', 'new_password')
  .then(data => console.log(data))
  .catch(err => console.log(err));

User Attributes

This feature allows users to update their attributes. The code sample demonstrates how to use the currentAuthenticatedUser method to get the current user and the updateUserAttributes method to update the user's attributes.

const { Auth } = require('@aws-amplify/auth');

Auth.currentAuthenticatedUser()
  .then(user => {
    return Auth.updateUserAttributes(user, {
      'custom:attribute': 'value'
    });
  })
  .then(data => console.log(data))
  .catch(err => console.log(err));

Other packages similar to @aws-amplify/auth

firebase

Firebase is a comprehensive app development platform by Google that includes authentication services. It provides similar functionalities to @aws-amplify/auth, such as user sign-up, sign-in, and password management. Firebase Authentication supports various authentication methods, including email/password, phone, and social providers like Google and Facebook.

auth0-js

Auth0 is a flexible, drop-in solution to add authentication and authorization services to your applications. The auth0-js library provides similar functionalities to @aws-amplify/auth, including user sign-up, sign-in, and password management. Auth0 supports a wide range of identity providers and offers extensive customization options.

passport

Passport is a popular authentication middleware for Node.js. It provides a wide range of authentication strategies, including local authentication, OAuth, and OpenID Connect. While it offers similar functionalities to @aws-amplify/auth, Passport requires more configuration and setup compared to the out-of-the-box solutions provided by AWS Amplify.

README

INTERNAL USE ONLY

This package contains the AWS Amplify Auth category and is intended for internal use only. To integrate Amplify into your app, please use aws-amplify.