layla/cognito-oauthtools
1
0
Fork 0
mirror of https://github.com/yeslayla/cognito-oauthtools.git synced 2025-01-14 04:53:24 +01:00
Code Issues Packages Projects Releases Wiki Activity
Simple AWS Cognito client to simplify implementing oauth into python applications
3 Commits 1 Branch 1 Tag 49 KiB
Python 100%
130ae3f76e
Go to file
Joseph Manley 130ae3f76e Push additional files 
Update Workflow

Update Workflow

Update Workflow

Update Workflow

Update Workflow
2020-01-25 01:42:15 -05:00
.github/workflows Push additional files 2020-01-25 01:42:15 -05:00
cognito_oauthtools Push additional files 2020-01-25 01:42:15 -05:00
.bumpversion.cfg Push additional files 2020-01-25 01:42:15 -05:00
.gitignore Initial commit 2020-01-25 00:07:36 -05:00
LICENSE Initial commit 2020-01-25 00:07:36 -05:00
README.md Working Cognito Tool 2020-01-25 01:21:06 -05:00
requirements.txt Push additional files 2020-01-25 01:42:15 -05:00
setup.py Push additional files 2020-01-25 01:42:15 -05:00

README.md

Version Build Status Supported Versions

cognito-oauthtools

Simple AWS Cognito client to simplify project implementation.

Getting Started

Installation

cognito-oauthtools can easily be install using pip:

pip install cognito-oauthtools

Objects

Client

cognito_oauthtools.Client

Intializing

To intialize a cognito_oauthtools.Client, you must pass it:

  • endpoint

    The dns name of the Cognito endpoint

  • client_id

    The id of your Cognito authorizer clinet

  • client_secret

    The secret for your Cognito client

  • host_domain

    The domain name of the server that cognito will hit with oauth redirects

  • logout_path = "/"

    Path on the host to return to after logging out

  • redirect_path = "/oauth"

    Path on the host to return to after logging in

oauth = cognito_oauthtools.Client('ENDPOINT.amazoncognito.com', 'CLIENT_ID', 'CLIENT_SECRET', 'myapp.example')

Properties

  • loginUrl

    Cognito URL to authorize

  • registerUrl

    Cognito URL to register a new user

  • logoutUrl

    Cognito URL to logout

Methods

  • get_token(code)

    Method that gets cognito token from the oauth return code

User

cognito_oauthtools.User

Intializing

To intialize a cognito_oauthtools.User, you must pass it:

  • client

    cognito_oauthtools.Client object for the user to use

  • token

    The user's authorization token

user = cognito_oauthtools.User(client, "xxxxTOKENxxxx")