OpenG2P FastAPI Auth

Introduction

This is a Python package that provides additional support, particularly Authentication and Authorization, to the OpenG2P FastAPI Common Library. This page describes different concepts within the library and instructions on how to use it.

Technical concepts

This package/library contains API Authentication and Authorization helpers for Rest API Services that are bootstrapped by the OpenG2P FastAPI Common Library. Details:

Name	Description
Login Provider	LoginProvider is an object that helps the user login in the current web app using an external Authorization System. LoginProviders is a database table where different types of login providers can be configured. This module also exposes APIs to query the LoginProviders configured on DB. The type column of LoginProviders can be set to one of the following values. oauth2_auth_code - If the type is set to this, then the LoginProvider is an OIDC Provider, that supports the basic auth_code flow. (With PKCE being optional) The authorization_parameters are the parameters required by this LoginProvider
AuthController	TODO
OauthController	TODO
JwtBearerAuth	TODO
ApiAuthSettings	TODO

Installation

This section describes instructions for installing the package. Primarily intended for developers using this module.

• Install python3 for your environment.

• Set up a virtualenv in your project directory. Using:

  python3 -n venv .venv
  source .venv/bin/activate

• Clone openg2p-fastapi-common.

• Then Install the common package using pip:

  pip install -e <path-to-cloned-common-repo>/openg2p-fastapi-auth

Usage guide

This section describes instructions for using the package/library. Primarily intended for developers using this module to build their own projects.

TODO

Configuration

TODO

Source code

• OpenG2P FastAPI Common Module Source Code - https://github.com/OpenG2P/openg2p-fastapi-common/tree/develop/openg2p-fastapi-auth