amazon-cognito-srp
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

amazon-cognito-srp

Amazon Cognito SRP allows you to authenticate into Amazon Cognito by Username and Password through SRP based authentication (the USER_SRP_AUTH authentication flow).

Amazon Cognito SRP allows you to get the JWT access token, id token, refresh token by Username and Password through SRP authentication.

Keywords: AWS, Amazon, Cognito, Sign-in, Authentication, SRP, Secure, Remote, Password, Protocol, Access, Control, JWT

Example

const authResult: AuthResult = await amazonCognitoSrp.authenticate();

authResult output:

{
    accessToken: string;
    idToken: string;
    refreshToken: string;
}

JavaScript Examples

const { AmazonCognitoSrp } = require('amazon-cognito-srp');
    
const amazonCognitoSrp = new AmazonCognitoSrp({
    userPoolId: 'us-east-1_Gmmqbdhdd',
    clientId: '70681titoqu1dq7ho24j8h197o',
    username: 'test.email@gmail.com',
    password: 'test_password'
});
    
// If you run code in a sync function
amazonCognitoSrp.authenticate().then(result => {
    console.log(result)
});
    
// If you run code in a async function
(async () => {
    const result = await amazonCognitoSrp.authenticate();
    console.log(result)
})();

TypeScript Examples

import { AmazonCognitoSrp } from 'amazon-cognito-srp';
import { AuthResult, Options } from 'amazon-cognito-srp/lib/types';

const options: Options = {
    clientId: '70681titoqu1dq7ho24j8h197o',
    password: 'test_password',
    username: 'test.email@gmail.com',
    userPoolId: 'us-east-1_Gmmqbdhdd'
}

const amazonCognitoSrp = new AmazonCognitoSrp(options);

// If you run code in a sync function
amazonCognitoSrp.authenticate().then((authResult: AuthResult) => {
    console.log(authResult)
});

// If you run code in a async function
const authResult: AuthResult = await amazonCognitoSrp.authenticate();
console.log(authResult);

Package Sidebar

Install

npm i amazon-cognito-srp

Weekly Downloads

549

Version

1.0.1

License

ISC

Unpacked Size

29.6 kB

Total Files

17

Last publish

Collaborators

  • aliaksei.kankou