PropelAuth Python 版本

php中文网 2024-11-28 14:13:58

今天，我们很高兴发布基础 python 库的新版本，以及针对 fastapi、flask 和 django rest framework 的框架特定库的版本。

让我们来看看一些较大的变化！

更好的打字支持（重大变更）

如果您之前使用过我们的 python 库，那么类型提示还有很多不足之处。在我们的最新版本中，我们现在为所有请求提供了类型提示，并为所有响应提供了数据类型。

立即学习“Python免费学习笔记（深入）”；

注意：如果您之前对响应进行解包（使用 ** 运算符），这将特别中断。响应以前是字典，现在是显式数据类型。

我们已经实现了常用的功能，例如键查找（response[“user_id”]仍然有效，但现在首选response.user_id）。我们通常会尽力避免重大变更（这是 3 年来的第二次变更），但这感觉像是一个非常狭窄的问题。

用户等级改进

为了更简单的权限检查，您现在可以直接在 user 对象上调用函数，例如：

user.has_permission_in_org(orgid, 'can_export_reports')
user.is_role(orgid, 'admin')
user.get_active_org().has_permission('api_key::write')

这些允许您传递 user 对象，而无需引用 auth 对象，并且还可以更轻松地进行模拟/测试。

新 api

这并不是我们的 python 库特有的，但我们已经发布了许多新的 api，例如：

强制注销所有用户会话
为您的客户创建 saml 设置链接（这将让他们自行管理 saml）
获取和撤销待处理的邀请
支持legacy_org_id，可以帮助您从现有设置迁移

请在此处查看我们的参考文档中的完整列表。

示例 - 通过定价计划轻松进行功能门控

在 propelauth，我们很幸运能够亲眼目睹许多 b2b saas 公司的成长。身份验证提供商在公司历史上的关键时刻最为重要（初始启动、吸引第一个客户、关闭第一个企业客户等）。随着你的成长，我们能做的最重要的事情就是让开。

这就是为什么我们对这个 fastapi 路线非常满意：

@app.post("/api/expensive-action")
async def do_expensive_action(user: user = depends(auth.require_user)):
    org = user.get_active_org()

    if org == none or 
       not org.user_has_permission("can_do_expensive_action"):
        raise httpexception(status_code=403, detail="forbidden")

    return do_expensive_action_inner(user, org)

乍一看，这似乎是一条非常简单的路线，但它有一些重要的部分：

依赖注入的 user 适用于任何类型的经过身份验证的用户 - 无论是密码、sso、saml 等。
通过角色映射，我们可以让免费计划中的组织管理员不执行昂贵的功能，但付费计划中的组织管理员可以采取昂贵的行动。
我们可以通过处理来自我们的支付提供商的 webhook 并设置其角色映射来以编程方式强制执行此操作，如下所示：

@app.post("/stripe/webhook")
def stripe_webhook(request):
    event = parse_and_validate_stripe_webhook(request)
    org_id = event["org_id"]

    if event["type"] == Events.CUSTOMER_SUBSCRIBED:
        # This can give the users in this organization access to increased
        # permissions, additional roles, and access to more features
        auth.subscribe_org_to_role_mapping(org_id, "Paid Plan")

    elif event["type"] == Events.CUSTOMER_UNSUBSCRIBED:
        auth.subscribe_org_to_role_mapping(org_id, "Free Plan")

    # ...