1.0.1 • Published 10 months ago

@icancode/identity-cognito v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

icancode-identity-cognito

An identity module based on @icancode/express to integrate with AWS Cognito.

How to use

  • Add package as dependency
yarn add @icancode/identity-cognito
  • Register the module
import { ModuleLoader } from '@icancode/express';
import IdentityCognito from '@icancode/identity-cognito';

const loader = new ModuleLoader(app);
loader.register(IdentityCognito);

Environment variables

Mandatory

NameDescription
COGNITO_ADMIN_CLIENT_IDCognito admin client id
COGNITO_ADMIN_CLIENT_SECRETCognito admin client secret
COGNITO_POOL_IDCognito Pool id

Use self-managed JWT

NameDescription
COGNITO_USE_JWTDefault is false. Enable self managed JWT token
JWT_RSA_KEYPath to RSA private key (use for self-managed JWT token)
JWT_RSA_PUBLICPath to RSA public key (use for self-managed JWT token)
JWT_EXPIRES_INExpiration of token in seconds (use for self-managed JWT token)

Enable social integration

NameDescription
COGNITO_USE_PROVIDERDefault is false. Enable social and custom provider
COGNITO_CLIENT_IDCognito client id (use for exchanging token)
COGNITO_CLIENT_SECRETCognito client secret (use for exchanging token)
COGNITO_DOMAINCognito domain (use for exchanging token)
COGNITO_REDIRECT_URICognito redirect uri (use for exchanging token)