FastAPI Reference

Installation

pip install propelauth_fastapi

Initialize

init_auth performs a one-time initialization of the library. It will verify your api_key is correct and fetch the metadata needed to verify access tokens in require_user, optional_user, or require_org_member.

from propelauth_fastapi import init_auth

auth = init_auth("YOUR_AUTH_URL", "YOUR_API_KEY")

Protect API Routes

Protecting an API route is as simple as adding a dependency to your route.

require_user

A dependency that will verify the request was made by a valid user. If a valid access token is provided, it will return a User object. If not, the request is rejected with a 401 status code.

from fastapi import FastAPI, Depends
from propelauth_fastapi import init_auth, User

app = FastAPI()
auth = init_auth("AUTH_URL", "API_KEY")

@app.get("/")
async def root(current_user: User = Depends(auth.require_user)):
    return {"message": f"Hello {current_user.user_id}"}

optional_user

Similar to require_user, but will return None if no valid access token is provided.

from typing import Optional

from fastapi import FastAPI, Depends
from propelauth_fastapi import init_auth, User

app = FastAPI()
auth = init_auth("AUTH_URL", "API_KEY")

@app.get("/api/whoami_optional")
async def whoami_optional(current_user: Optional[User] = Depends(auth.optional_user)):
    if current_user:
        return {"user_id": current_user.user_id}
    return {}

Authorization

require_org_member

A function that will verify that the request was made by a valid user and that the user is a member of the specified organization.

This function will return an OrgMemberInfo object if the user is a member of the specified organization, otherwise it will return a 403 status code.

Typically, the organization id is passed in from the frontend as a path or query parameter.

from fastapi import FastAPI, Depends
from propelauth_fastapi import init_auth, User

app = FastAPI()
auth = init_auth("AUTH_URL", "API_KEY")

@app.get("/api/org/{org_id}/check")
async def admin_only(org_id: str, current_user: User = Depends(auth.require_user)):
    org = auth.require_org_member(current_user, org_id)
    return {"message": f"You are in {org.org_name}"}

require_org_member_with_minimum_role

Similar to require_org_member, but will also verify that the user has at least the specified role in the organization.

A user has a Role within an organization. By default, the available roles are Owner, Admin, or Member, but these can be configured. These roles are also hierarchical, so Owner > Admin > Member.

## Assuming a Role structure of Owner => Admin => Member

@app.get("/api/org/{org_id}/admin_or_owner")
async def admin_or_owner(org_id: str, current_user: User = Depends(auth.require_user)):
    org = auth.require_org_member_with_minimum_role(current_user, org_id, "Admin")
    return {"message": f"You are an Admin or Owner of {org.org_name}"}

require_org_member_with_exact_role

Similar to require_org_member, but will also verify that the user has the exact specified role in the organization.

A user has a Role within an organization. By default, the available roles are Owner, Admin, or Member, but these can be configured. These roles are also hierarchical, so Owner > Admin > Member.

## Assuming a Role structure of Owner => Admin => Member

@app.get("/api/org/{org_id}/admin_only")
async def admin_only(org_id: str, current_user: User = Depends(auth.require_user)):
    org = auth.require_org_member_with_exact_role(current_user, org_id, "Admin")
    return {"message": f"You are an Admin of {org.org_name}"}

require_org_member_with_permission

Similar to require_org_member, but will also verify that the user has the specified permission in the organization.

Permissions are arbitrary strings associated with a role. For example, can_view_billing, ProductA::CanCreate, and ReadOnly are all valid permissions. You can create these permissions in the PropelAuth dashboard.

@app.get("/api/org/{org_id}/billing")
async def billing(org_id: str, current_user: User = Depends(auth.require_user)):
    org = auth.require_org_member_with_permission(current_user, org_id, "can_view_billing")
    pass

require_org_member_with_all_permissions

The batch version of require_org_member_with_permission, which will verify that the user has all of the specified permissions in the organization.

@app.get("/api/org/{org_id}/billing")
async def billing(org_id: str, current_user: User = Depends(auth.require_user)):
    org = auth.require_org_member_with_all_permissions(current_user, org_id, ["can_view_billing", "can_view_reports"])
    pass

User

The User object contains information about the user that made the request.

OrgMemberInfo

The OrgMemberInfo object contains information about the user's membership in an organization.

Usage with API Docs

FastAPIs built in documentation will automatically add this button when you are using either require_user or optional_user.

You can obtain the access token via the Create Access Token API.

Calling Backend APIs

You can also use the library to call the PropelAuth APIs directly, allowing you to fetch users, create orgs, and a lot more. See the API Reference for more information.