cognito-authentication
v1.0.12
Published
This is a package for AWS cognito OTP based authentication
Downloads
17
Readme
imobi-backend-authentication
This is a package for authentication
#To implement the package in yor project
import package
const authentication = require('cognito-authentication')
#Testing module with REPL
Start the Node.js REPL in the same folder as the index.js file:
When REPL has started you will see the > prompt. This means you can enter javascript code.
First enter the following
> authentication = require('./index')
you will get an output as
{ authentication: [Function: Authentication] }
then enter
> let auth= new authentication.authentication({awsCognito:{clientId:'aws-cognito-client-id',userPoolId:'aws-cognito-userpool',region: 'us-east-1'})
finally
#To register with cognito
> auth.register('your-phone-number-with-country-code','your-password',['atributeList'],{'app_opt_hashcode':''})
To login
> auth.login('your-phone-number-with-country-code','your-password');
To verify OTP
> auth.verifyOTP('your-phone-number-with-country-code','otp-received');
To resend OTP
auth.reSendOtp('your-phone-number-with-country-code',{'app_opt_hashcode':''});
#To validate Token
auth.validateToken('your-jwt-token');
#Reset password
auth.forgotPassword('your-phone-number-with-country-code',{'app_opt_hashcode':''});
You will get an otp on your phone
auth.confirmReset('your-phone-number-with-country-code','otp-recieved','new-password');
#To delete an user (Not recomended)
auth.deleteUser('access_key','secret_key',username);
Note: An user with cognito-idp:AdminDeleteUser permission can only delete a user.
Access key and secret key not saving anywhere in the code.
To exit REPL
> .exit
To use in an external project
npm install --save ../path-to-imobi-backend-authentication