Newton's Principia Mathematica

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

    1.0.9 • Public • Published

    Human Authentication using Cognito

    This module provides Authentication and Authorization mechanisms for Human Stakeholders that use the System. It uses Amazon Cognito to enable you to store your own user base within your deployment, and allows you to define RBAC policies for individual Users and/or Groups.

    This module provides an Human Authentication System using Cognito User Pools and Identity Pools.

    • Cognito User Pools lets you add User Sign-Up and Sign-In capabilities to your Web and Mobile Apps quickly and easily.
    • Cognito Identity Pools are used to provide AWS credentials via IAM roles to End-User Applications. Since we’ll be integrating our Cognito deployment and users with other AWS services, such as API-Gateway/Lambda & ElasticSearch

    Module components

    This module comprehends all resources needed for an authentication system, including default configuration for being instantly ready to use. These are the resources this module includes:

    • Cognito User Pool: Stores your users and groups and provides a built-in customizable login experience for web and mobile apps. This user pool is built with a default app client, that you can use to leverage authentication capabilities right out of the box. You can add multiple other clients for the different consumers of the module.
    • Cognito Identity Pool: Enables federated access to AWS resources for users within the User Pool. Configured already for the default User Pool client, this Identity Pool provides AWS credentials for users of the User Pool.
    • Identity Pool default roles: The IdP is configured with two IAM roles, used by default for both authenticated and unauthenticated users.

    Default configuration

    The setup configuration by default allows users to login with both a unique username and an email address, and email addresses are required, and autommatically verified - i.e. no code verification is needed. Minimum password length is 8, and it requires both lower and upper case characters, numbers and symbols.

    Getting started

    Running in one click

    I'm working on preparing automated builds of the modules that could be installed in one click. Stay tuned!

    Installing from code

    Install the dependency: npm i cognito-identity or clone this repository. If you just want to install this module standalone, follow this process

    cd cdk/constructs/cognito-identity/
    npm i
    npm run build
    cdk deploy

    And a new stack will appear in your account containing this module's resources.

    Integrating it into your app

    If you already have a larger CDK app going - or plan to have it - you can use this module to provide your app with the authecation mechanism you'd need. Just install the deependency into your project, and follow this example:

    import { CognitoIdentity } from 'cognito-identity'
    
    
    const auth = new CognitoIdentity(this, 'CognitoAuth', {
      userPoolName: 'MyUserPool',
    })

    Once you have integrated the auth module into your project, you could edit any of its entities - i.e. User Pool and Identity Pool, or the associated default roles - and associate them with any other resource allowed by the CDK or CloudFormation.

    Install

    npm i cognito-identity

    DownloadsWeekly Downloads

    18

    Version

    1.0.9

    License

    MIT

    Unpacked Size

    326 kB

    Total Files

    14

    Last publish

    Collaborators

    • nnthanh101