{"id":20114347,"url":"https://github.com/jetbridge/flask_cognito","last_synced_at":"2025-04-05T18:06:48.772Z","repository":{"id":49115914,"uuid":"164308251","full_name":"jetbridge/flask_cognito","owner":"jetbridge","description":"Flask authentication with JWT against AWS Cognito","archived":false,"fork":false,"pushed_at":"2024-05-05T20:35:48.000Z","size":59,"stargazers_count":96,"open_issues_count":5,"forks_count":32,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-09-01T09:55:56.205Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jetbridge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-06T13:10:59.000Z","updated_at":"2024-08-30T12:10:27.000Z","dependencies_parsed_at":"2024-04-13T20:29:35.014Z","dependency_job_id":"971d2e94-df96-453a-bffb-f5597426ca2b","html_url":"https://github.com/jetbridge/flask_cognito","commit_stats":{"total_commits":34,"total_committers":16,"mean_commits":2.125,"dds":0.7647058823529411,"last_synced_commit":"a2b973b1582cc734c2eff142f473ecc1f8cb9884"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jetbridge%2Fflask_cognito","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jetbridge%2Fflask_cognito/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jetbridge%2Fflask_cognito/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jetbridge%2Fflask_cognito/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jetbridge","download_url":"https://codeload.github.com/jetbridge/flask_cognito/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247378141,"owners_count":20929296,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T18:29:26.024Z","updated_at":"2025-04-05T18:06:48.751Z","avatar_url":"https://github.com/jetbridge.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Flask-Cognito\n-------------\n\nAuthenticate users based on AWS Cognito JWT.\n\n\n# Initialization\n```python3\n# configuration\napp.config.update({\n    'COGNITO_REGION': 'eu-central-1',\n    'COGNITO_USERPOOL_ID': 'eu-central-1c3fea2',\n\n    # optional\n    'COGNITO_APP_CLIENT_ID': 'abcdef123456',  # client ID you wish to verify user is authenticated against\n    'COGNITO_CHECK_TOKEN_EXPIRATION': False,  # disable token expiration checking for testing purposes\n    'COGNITO_JWT_HEADER_NAME': 'X-MyApp-Authorization',\n    'COGNITO_JWT_HEADER_PREFIX': 'Bearer',\n})\n\n\n# initialize extension\nfrom flask_cognito import CognitoAuth\ncogauth = CognitoAuth(app)\n\n@cogauth.identity_handler\ndef lookup_cognito_user(payload):\n    \"\"\"Look up user in our database from Cognito JWT payload.\"\"\"\n    return User.query.filter(User.cognito_username == payload['username']).one_or_none()\n```\n\n# Check Authentication\n```python3\nfrom flask_cognito import cognito_auth_required, current_user, current_cognito_jwt\n\n@route('/api/private')\n@cognito_auth_required\ndef api_private():\n    # user must have valid cognito access or ID token in header\n    # (accessToken is recommended - not as much personal information contained inside as with idToken)\n    return jsonify({\n        'cognito_username': current_cognito_jwt['username'],   # from cognito pool\n        'user_id': current_user.id,   # from your database\n    })\n```\n\n# Restrict access by Cognito Group\n```python3\nfrom flask_cognito import cognito_auth_required, current_user, current_cognito_jwt\n\n@route('/api/foo')\n@cognito_auth_required\n@cognito_group_permissions(['admin','developer'])\ndef api_private():\n    # user must belongs to \"admin\" or \"developer\" groups\n    return jsonify({\n        'foo': \"bar\"\n    })\n```\n\n### Acknowledgements\n* Uses [cognitojwt](https://github.com/borisrozumnuk/cognitojwt) at its core.\n* Based on [flask-jwt](https://github.com/mattupstate/flask-jwt/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjetbridge%2Fflask_cognito","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjetbridge%2Fflask_cognito","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjetbridge%2Fflask_cognito/lists"}