Metadata-Version: 2.1
Name: Flask-Cognito
Version: 1.0
Summary: Authenticate users to Cognito user pool via JWT.
Home-page: https://github.com/jetbridge/flask-cognito
Author: Mischa Spiegelmock
Author-email: mischa@mvstg.biz
License: ABRMS
Description: Flask-Cognito
        -------------
        
        Authenticate users based on AWS Cognito JWT.
        
        
        # Initialization
        ```python3
        
        app.config.extend({
            'COGNITO_REGION': 'eu-central-1',
            'COGNITO_USERPOOL_ID': 'eu-central-1c3fea2',
            'COGNITO_APP_CLIENT_ID': 'abcdef123456',  # client ID you wish to verify user is authenticated against
        
            # optional
            'COGNITO_JWT_HEADER_NAME': 'X-MyApp-Authentication',
            'COGNITO_CHECK_TOKEN_EXPIRATION': False,  # disable token expiration checking for testing purposes
            'COGNITO_JWT_HEADER_NAME': 'Authorization',
            'COGNITO_JWT_HEADER_PREFIX': 'JWT',
        })
        
        CognitoAuth(app)
        ```
        
        # Check Authentication
        ```python3
        from flask_cognito import cognito_auth_required, cognito_user
        
        @route('/api/private')
        @cognito_auth_required
        def api_private():
            # user must have valid cognito auth token in header
            return jsonify({
                'COGNITO_USERNAME': cognito_user['cognito:username'],   # from cognito pool
            })
        ```
        
        
        ### Acknowledgements
        * Uses [cognitojwt](https://github.com/borisrozumnuk/cognitojwt) at its core.
        * Based on [flask-jwt](https://github.com/mattupstate/flask-jwt/).
        
Keywords: flask aws cognito jwt authentication auth serverless
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
