README.md

aws-cognito-public-keys

Module for retrieving public keys for AWS Cognito user pools

Features

• Does not require AWS credentials
• Synchronous and asynchronous methods
• Node.js 12.x compatible, works in AWS Lambda environments

Installation

Install via npm.

npm install aws-cognito-public-keys --save

Getting Started

const { getKeysSync } = require( 'aws-cognito-public-keys' );

const userPoolId = 'us-east-1_ZLPZ8Z7yS'; // your user pool id

const awsRegion = 'us-east1';             // valid AWS Region

const key = getKeysSync( userPoolId, awsRegion );

// keys =
// {
//    "<key id 1>": { ...key1 ... }
//    "<key id 2>": { ...key2 ... }
//    ..
// }

API

async getKeys( userPoolId, region )

Gets the Cognito public keys asynchronously. Returns a promise that resolves to an object that contains the keys.

getKeysSync( userPoolId, region )

Gets the Cognito public keys synchronously and blocks until resolved. Returns an object that contains the keys.

Feedback

We'd love to get feedback on how to make this tool better. Feel free to contact us at [email protected]

License

BSD-3-Clause