Shows how to use the AWS SDK for JavaScript (v3) to work with Amazon Cognito Identity Provider.
Amazon Cognito Identity Provider handles user authentication and authorization for your web and mobile apps.
- Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
- Running the tests might result in charges to your AWS account.
- We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
- This code is not tested in every AWS Region. For more information, see AWS Regional Services.
For prerequisites, see the README in the javascriptv3
folder.
- Hello Amazon Cognito Identity Provider (
ListUserPools
)
Code excerpts that show you how to call individual service functions.
- AdminGetUser
- AdminInitiateAuth
- AdminRespondToAuthChallenge
- AssociateSoftwareToken
- ConfirmDevice
- ConfirmSignUp
- DeleteUser
- InitiateAuth
- ListUsers
- ResendConfirmationCode
- RespondToAuthChallenge
- SignUp
- UpdateUserPool
- VerifySoftwareToken
Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.
- Automatically confirm known users with a Lambda function
- Sign up a user with a user pool that requires MFA
Note: All code examples are written in ECMAscript 6 (ES6). For guidelines on converting to CommonJS, see JavaScript ES6/CommonJS syntax.
Run a single action
node ./actions/<fileName>
Run a scenario
Most scenarios can be run with the following command:
node ./scenarios/<fileName>
Run with options
Some actions and scenarios can be run with options from the command line:
node ./scenarios/<fileName> --option1 --option2
util.parseArgs is used to configure
these options. For the specific options available to each script, see the parseArgs
usage
for that file.
This example shows you how to get started using Amazon Cognito Identity Provider.
node ./hello.js
This example shows you how to automatically confirm known Amazon Cognito users with a Lambda function.
- Configure a user pool to call a Lambda function for the
PreSignUp
trigger. - Sign up a user with Amazon Cognito.
- The Lambda function scans a DynamoDB table and automatically confirms known users.
- Sign in as the new user, then clean up resources.
This example shows you how to do the following:
- Sign up and confirm a user with a username, password, and email address.
- Set up multi-factor authentication by associating an MFA application with the user.
- Sign in by using a password and an MFA code.
⚠ Running tests might result in charges to your AWS account.
To find instructions for running these tests, see the README
in the javascriptv3
folder.
- Amazon Cognito Identity Provider Developer Guide
- Amazon Cognito Identity Provider API Reference
- SDK for JavaScript (v3) Amazon Cognito Identity Provider reference
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0