FastAPI Library Reference

from propelauth_fastapi import init_auth

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

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}"}

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 {}

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}"}

## 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}"}

@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}"}

@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

# auth object somes from init_auth
auth.fetch_user_metadata_by_user_id(user_id, include_orgs=False)

{
    "user_id":            "e9d3520f-836e-403c-82c2-09843517e1ce",
    "email":              "user@example.com",
    "email_confirmed":    true,
    "has_password":       true,

    "username":           "example",
    "first_name":         "first",
    "last_name":          "last",
    "picture_url":        "https://...",

    // True if the user's account is locked for security purposes.
    "locked":             false,
    "enabled":            true,
    "mfa_enabled":        false,

    "created_at":         1645131680,
    "last_active_at":     1650654711,

    // Only returned if include_orgs = true
    "org_id_to_org_info": {
        "2ef0e1fc-234f-4dc0-a50c-35adb1bbb7e4": {
            "org_id": "2ef0e1fc-234f-4dc0-a50c-35adb1bbb7e4",
            "org_name": "ExampleOrganization",
            "user_role": "Owner"
        }
    },

    // Only returned if user was migrated from an external system
    "legacy_user_id":    "507f191e810c19729de860ea"
}

# auth object somes from init_auth
auth.fetch_user_metadata_by_email(email, include_orgs=False)

# auth object somes from init_auth
auth.fetch_user_metadata_by_username(email, include_orgs=False)

# auth object somes from init_auth
user_id_to_metadata = auth.fetch_batch_user_metadata_by_user_ids([
    "1be238f3-5908-4c51-b3bf-e53dd763047e",
    "beb00acf-6e48-435d-8388-3758607ec01b",
    "941c99e5-3530-4475-bd0f-bbc5d06603c3"
], include_orgs=False)

{
    "1be238f3-5908-4c51-b3bf-e53dd763047e": {
        "user_id": "e9d3520f-836e-403c-82c2-09843517e1ce",
        "email": "user@example.com",
        "email_confirmed": true,
        "has_password": true,

        "username": "example",
        "first_name": "first",
        "last_name": "last",
        "picture_url": "https://...",

        // True if the user's account is locked for security purposes.
        "locked": false,
        "enabled": true,
        "mfa_enabled": false,

        "created_at": 1645131680,
        "last_active_at": 1650654711,

        // Only returned if include_orgs = true
        "org_id_to_org_info": {
            "2ef0e1fc-234f-4dc0-a50c-35adb1bbb7e4": {
                "org_id": "2ef0e1fc-234f-4dc0-a50c-35adb1bbb7e4",
                "org_name": "ExampleOrganization",
                "user_role": "Owner",
            }
        },

        // Only returned if user was migrated from an external system
        "legacy_user_id":    "507f191e810c19729de860ea"
    },
    "beb00acf-6e48-435d-8388-3758607ec01b": {
        //...
    }
}

# auth object somes from init_auth
auth.fetch_batch_user_metadata_by_emails(["a@example.com", "b@example.com"], include_orgs=True)

# auth object somes from init_auth
auth.fetch_batch_user_metadata_by_usernames(["usera", "userb", "userc"], include_orgs=True)

# auth object somes from init_auth
auth.fetch_users_by_query(page_size=10, page_number=0, order_by=UserQueryOrderBy.CREATED_AT_ASC,
                          email_or_username=None, include_orgs=False)

{
    "total_users": 103,
    "current_page": 0,
    "page_size": 10,
    "has_more_results": true,
    "users": [{
        // See (1) for example users
    }, {
        // There will be 10 users in this response
    }]
}

# auth object somes from init_auth
auth.fetch_users_in_org(org_id, page_size=10, page_number=0, include_orgs=False)

{
    "total_users": 43,
    "current_page": 0,
    "page_size": 10,
    "has_more_results": true,
    "users": [{
        // See (1) for example users
    }, {
        // There will be 10 users in this response, all in the specified organization
    }]
}

# auth object somes from init_auth
auth.create_user(email, email_confirmed=False, send_email_to_confirm_email_address=True,
                 password=None, username=None, first_name=None, last_name=None)

{
    "user_id": "b5f667fb-e51a-49c6-a396-711e62948689"
}

# auth object somes from init_auth
auth.migrate_user_from_external_source(email, email_confirmed,
                                       existing_user_id=None, existing_password_hash=None,
                                       existing_mfa_base32_encoded_secret=None,
                                       enabled=None, first_name=None, last_name=None, username=None)

{
    "user_id": "b5f667fb-e51a-49c6-a396-711e62948689"
}

# auth object somes from init_auth
auth.create_magic_link(email, redirect_to_url=None, expires_in_hours=None, create_new_user_if_one_doesnt_exist=None)

{
    "url": "https://auth.yourdomain.com/..."
}

# auth object somes from init_auth
# Returns true if it was successful, false if the user was not found
auth.update_user_email(user_id, new_email, require_email_confirmation)

# auth object somes from init_auth
# Returns true if it was successful, false if the user was not found
auth.update_user_metadata(user_id, username=None, first_name=None, last_name=None)

# auth object somes from init_auth
# Returns true if it was successful, false if the user was not found
auth.delete_user(user_id)

# auth object somes from init_auth
# Returns true if it was successful, false if the user was not found
auth.disable_user(user_id)

# auth object somes from init_auth
# Returns true if it was successful, false if the user was not found
auth.enable_user(user_id)

# auth object somes from init_auth
org = auth.fetch_org(org_id)

{
    "org_id": "d488996d-8ccc-4101-b5f2-131f5f09ddb6"
    "name": "OneOfYourCustomers"
}

# auth object somes from init_auth
auth.fetch_org_by_query(page_size=10, page_number=0, order_by=OrgQueryOrderBy.CREATED_AT_ASC)

{
    "total_orgs": 21,
    "current_page": 0,
    "page_size": 10,
    "has_more_results": true,
    "orgs": [{
        "org_id": "d488996d-8ccc-4101-b5f2-131f5f09ddb6",
        "name": "OneOfYourCustomers"
    }, {
        // There will be 10 orgs in this response
    }]
}

# auth object somes from init_auth
auth.create_org(name)

{
    "org_id": "d488996d-8ccc-4101-b5f2-131f5f09ddb6"
}

# auth object somes from init_auth
auth.add_user_to_org(user_id, org_id, role)

{}

# auth object somes from init_auth
# Returns true if it was successful, false if the user was not found
auth.delete_user(user_id)

# auth object somes from init_auth
# Returns true if it was successful, false if the user was not found
auth.disable_user(user_id)

# auth object somes from init_auth
# Returns true if it was successful, false if the user was not found
auth.enable_user(user_id)