ContextQMD
Back to Aws Doc Sdk Examples

Amazon Cognito Identity Provider code examples for the SDK for Python

python/example_code/cognito/README.md

latest5.3 KB
Original Source

Amazon Cognito Identity Provider code examples for the SDK for Python

Overview

Shows how to use the AWS SDK for Python (Boto3) to work with Amazon Cognito Identity Provider.

<!--custom.overview.start--> <!--custom.overview.end-->

Amazon Cognito Identity Provider handles user authentication and authorization for your web and mobile apps.

⚠ Important

  • 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.
<!--custom.important.start--> <!--custom.important.end-->

Code examples

Prerequisites

For prerequisites, see the README in the python folder.

Install the packages required by these examples by running the following in a virtual environment:

python -m pip install -r requirements.txt
<!--custom.prerequisites.start--> <!--custom.prerequisites.end-->

Get started

Single actions

Code excerpts that show you how to call individual service functions.

Scenarios

Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

<!--custom.examples.start--> <!--custom.examples.end-->

Run the examples

Instructions

<!--custom.instructions.start--> <!--custom.instructions.end-->

Hello Amazon Cognito Identity Provider

This example shows you how to get started using Amazon Cognito Identity Provider.

python hello/hello_cognito.py

Sign up a user with a user pool that requires MFA

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.
<!--custom.scenario_prereqs.cognito-identity-provider_Scenario_SignUpUserWithMfa.start-->

This scenario requires the following resources:

  • An existing Amazon Cognito user pool that is configured to allow self sign-up.
  • A client ID to use for authenticating with Amazon Cognito.

To create these resources, run the AWS CloudFormation script in the resources/cdk/cognito_scenario_user_pool_with_mfa folder. This script outputs a user pool ID and a client ID that you can use to run the scenario.

<!--custom.scenario_prereqs.cognito-identity-provider_Scenario_SignUpUserWithMfa.end-->

Start the example by running the following at a command prompt:

python cognito_idp_actions.py
<!--custom.scenarios.cognito-identity-provider_Scenario_SignUpUserWithMfa.start--> <!--custom.scenarios.cognito-identity-provider_Scenario_SignUpUserWithMfa.end-->

Use Amazon Cognito identity pools

This example shows you how to create a web-based demo application that demonstrates identity pools authentication flows.

<!--custom.scenario_prereqs.cross_CognitoFlows.start--> <!--custom.scenario_prereqs.cross_CognitoFlows.end--> <!--custom.scenarios.cross_CognitoFlows.start--> <!--custom.scenarios.cross_CognitoFlows.end-->

Tests

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the python folder.

<!--custom.tests.start--> <!--custom.tests.end-->

Additional resources

<!--custom.resources.start--> <!--custom.resources.end-->

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0