身份验证与访问控制¶

LangGraph 平台提供了一个灵活的身份验证和授权系统，该系统可以与大多数身份验证方案集成。

仅适用于 Python

目前，我们仅支持在使用 langgraph-api>=0.0.11 的 Python 部署中进行自定义身份验证和授权。很快将添加对 LangGraph.JS 的支持。

核心概念¶

认证与授权¶

虽然这两个术语经常互换使用，但它们代表着不同的安全概念：

认证（“AuthN”）验证你是谁。这会作为每个请求的中间件运行。
授权（“AuthZ”）确定你 可以做什么。这会基于每个资源验证用户的权限和角色。

在 LangGraph 平台中，认证由你的 @auth.authenticate 处理程序处理，授权由你的 @auth.on 处理程序处理。

默认安全模型¶

LangGraph 平台提供不同的默认安全设置：

LangGraph 云服务¶

默认使用 LangSmith API 密钥
需要在 x-api-key 请求头中提供有效的 API 密钥
可以使用自定义的身份验证处理程序进行定制

自定义身份验证

LangGraph 云服务的所有套餐均**支持**自定义身份验证。

自托管部署¶

无默认身份验证机制
可完全灵活地实现您自己的安全模型
您可以控制身份验证和授权的各个方面

自定义身份验证

**企业版**自托管套餐支持自定义身份验证。自托管精简版套餐原生不支持自定义身份验证。

系统架构¶

一个典型的身份验证设置涉及三个主要组件：

身份验证提供者（身份提供者/IdP）
- 一个专门管理用户身份和凭证的服务
- 处理用户注册、登录、密码重置等操作
- 在身份验证成功后颁发令牌（JWT、会话令牌等）
- 示例：Auth0、Supabase Auth、Okta 或你自己的身份验证服务器
LangGraph 后端（资源服务器）
- 包含业务逻辑和受保护资源的 LangGraph 应用程序
- 与身份验证提供者验证令牌
- 根据用户身份和权限实施访问控制
- 不直接存储用户凭证
客户端应用程序（前端）
- 网页应用、移动应用或 API 客户端
- 收集对时间敏感的用户凭证并发送给身份验证提供者
- 从身份验证提供者接收令牌
- 在向 LangGraph 后端的请求中包含这些令牌

以下是这些组件通常的交互方式：

sequenceDiagram
    participant Client as Client App
    participant Auth as Auth Provider
    participant LG as LangGraph Backend

    Client->>Auth: 1. Login (username/password)
    Auth-->>Client: 2. Return token
    Client->>LG: 3. Request with token
    Note over LG: 4. Validate token (@auth.authenticate)
    LG-->>Auth:  5. Fetch user info
    Auth-->>LG: 6. Confirm validity
    Note over LG: 7. Apply access control (@auth.on.*)
    LG-->>Client: 8. Return resources

你在 LangGraph 中的 @auth.authenticate 处理程序负责处理步骤 4 - 6，而你的 @auth.on 处理程序实现步骤 7。

身份验证¶

LangGraph 中的身份验证作为中间件在每个请求上运行。你的 @auth.authenticate 处理程序会接收请求信息，并且应该：

验证凭证
如果凭证有效，则返回包含用户身份和用户信息的用户信息
如果凭证无效，则抛出一个HTTP 异常或 AssertionError

from langgraph_sdk import Auth

auth = Auth()

@auth.authenticate
async def authenticate(headers: dict) -> Auth.types.MinimalUserDict:
    # Validate credentials (e.g., API key, JWT token)
    api_key = headers.get("x-api-key")
    if not api_key or not is_valid_key(api_key):
        raise Auth.exceptions.HTTPException(
            status_code=401,
            detail="Invalid API key"
        )

    # Return user info - only identity and is_authenticated are required
    # Add any additional fields you need for authorization
    return {
        "identity": "user-123",        # Required: unique user identifier
        "is_authenticated": True,      # Optional: assumed True by default
        "permissions": ["read", "write"] # Optional: for permission-based auth
        # You can add more custom fields if you want to implement other auth patterns
        "role": "admin",
        "org_id": "org-456"

    }

返回的用户信息可用于：

通过 ctx.user 供你的授权处理程序使用
通过 config["configuration"]["langgraph_auth_user"] 在你的应用程序中使用

支持的参数

@auth.authenticate 处理程序可以按名称接受以下任何参数：

request (Request)：原始 ASGI 请求对象
body (dict)：解析后的请求体
path (str)：请求路径，例如 "/threads/abcd-1234-abcd-1234/runs/abcd-1234-abcd-1234/stream"
method (str)：HTTP 方法，例如 "GET"
path_params (dict[str, str])：URL 路径参数，例如 {"thread_id": "abcd-1234-abcd-1234", "run_id": "abcd-1234-abcd-1234"}
query_params (dict[str, str])：URL 查询参数，例如 {"stream": "true"}
headers (dict[bytes, bytes])：请求头
authorization (str | None)：Authorization 请求头的值（例如 "Bearer "）

在我们的许多教程中，为了简洁起见，我们只会展示 "authorization" 参数，但你可以根据需要选择接受更多信息，以实现自定义的身份验证方案。

授权¶

身份验证完成后，LangGraph 会调用您的 @auth.on 处理程序，以控制对特定资源（例如线程、助手、定时任务）的访问。这些处理程序可以：

通过直接修改 value["metadata"] 字典，在资源创建期间添加要保存的元数据。有关每个操作中该值可以采用的类型列表，请参阅支持的操作表。
在搜索/列表或读取操作期间，通过返回过滤字典按元数据过滤资源。
如果访问被拒绝，则抛出一个 HTTP 异常。

如果您只想实现简单的用户范围访问控制，可以对所有资源和操作使用单个 @auth.on 处理程序。如果您想根据资源和操作进行不同的控制，可以使用特定资源处理程序。有关支持访问控制的资源的完整列表，请参阅支持的资源部分。

@auth.on
async def add_owner(
    ctx: Auth.types.AuthContext,
    value: dict  # 发送到此访问方法的有效负载
) -> dict:  # 返回一个过滤字典，用于限制对资源的访问
    """授权对线程、运行、定时任务和助手的所有访问。

    此处理程序执行两件事：
        - 向资源元数据添加一个值（以便与资源一起持久化，以便稍后进行过滤）
        - 返回一个过滤器（以限制对现有资源的访问）

    参数:
        ctx: 包含用户信息、权限、路径的身份验证上下文
        value: 发送到端点的请求有效负载。对于创建操作，这包含资源参数。对于读取操作，这包含正在访问的资源。

    返回:
        一个过滤字典，LangGraph 使用它来限制对资源的访问。
        有关支持的运算符，请参阅[过滤操作](#filter-operations)。
    """
    # 创建过滤器，将访问限制为仅该用户的资源
    filters = {"owner": ctx.user.identity}

    # 获取或创建有效负载中的元数据字典
    # 这是我们存储有关资源的持久信息的地方
    metadata = value.setdefault("metadata", {})

    # 将所有者添加到元数据中 - 如果这是创建或更新操作，
    # 此信息将与资源一起保存
    # 这样我们就可以在读取操作中按此进行过滤
    metadata.update(filters)

    # 返回过滤器以限制访问
    # 这些过滤器应用于所有操作（创建、读取、更新、搜索等）
    # 以确保用户只能访问自己的资源
    return filters

特定资源处理程序¶

您可以通过将资源和操作名称与 @auth.on 装饰器链接在一起来为特定资源和操作注册处理程序。当发出请求时，将调用与该资源和操作匹配的最具体的处理程序。以下是如何为特定资源和操作注册处理程序的示例。对于以下设置：

经过身份验证的用户能够创建线程、读取线程、在线程上创建运行
只有具有 "assistants:create" 权限的用户才允许创建新助手
所有其他端点（例如，删除助手、定时任务、存储）对所有用户禁用。

支持的处理程序

有关支持的资源和操作的完整列表，请参阅下面的支持的资源部分。

# 通用/全局处理程序捕获未由更具体的处理程序处理的调用
@auth.on
async def reject_unhandled_requests(ctx: Auth.types.AuthContext, value: Any) -> False:
    print(f"Request to {ctx.path} by {ctx.user.identity}")
    raise Auth.exceptions.HTTPException(
        status_code=403,
        detail="Forbidden"
    )

# 匹配 "thread" 资源和所有操作 - 创建、读取、更新、删除、搜索
# 由于这比通用的 @auth.on 处理程序 **更具体**，因此它将优先于
# 通用处理程序对 "threads" 资源的所有操作
@auth.on.threads
async def on_thread_create(
    ctx: Auth.types.AuthContext,
    value: Auth.types.threads.create.value
):
    if "write" not in ctx.permissions:
        raise Auth.exceptions.HTTPException(
            status_code=403,
            detail="User lacks the required permissions."
        )
    # 在正在创建的线程上设置元数据
    # 将确保资源包含一个 "owner" 字段
    # 然后，每当用户尝试访问此线程或线程内的运行时，
    # 我们可以按所有者进行过滤
    metadata = value.setdefault("metadata", {})
    metadata["owner"] = ctx.user.identity
    return {"owner": ctx.user.identity}

# 线程创建。这将仅匹配线程创建操作
# 由于这比通用的 @auth.on 处理程序和 @auth.on.threads 处理程序 **更具体**，
# 因此它将优先于 "threads" 资源的任何 "create" 操作
@auth.on.threads.create
async def on_thread_create(
    ctx: Auth.types.AuthContext,
    value: Auth.types.threads.create.value
):
    # 在正在创建的线程上设置元数据
    # 将确保资源包含一个 "owner" 字段
    # 然后，每当用户尝试访问此线程或线程内的运行时，
    # 我们可以按所有者进行过滤
    metadata = value.setdefault("metadata", {})
    metadata["owner"] = ctx.user.identity
    return {"owner": ctx.user.identity}

# 读取线程。由于这也比通用的 @auth.on 处理程序和 @auth.on.threads 处理程序更具体，
# 因此它将优先于 "threads" 资源的任何 "read" 操作
@auth.on.threads.read
async def on_thread_read(
    ctx: Auth.types.AuthContext,
    value: Auth.types.threads.read.value
):
    # 由于我们正在读取（而不是创建）线程，
    # 我们不需要设置元数据。我们只需要
    # 返回一个过滤器，以确保用户只能看到自己的线程
    return {"owner": ctx.user.identity}

# 运行创建、流式传输、更新等。
# 这优先于通用的 @auth.on 处理程序和 @auth.on.threads 处理程序
@auth.on.threads.create_run
async def on_run_create(
    ctx: Auth.types.AuthContext,
    value: Auth.types.threads.create_run.value
):
    metadata = value.setdefault("metadata", {})
    metadata["owner"] = ctx.user.identity
    # 继承线程的访问控制
    return {"owner": ctx.user.identity}

# 助手创建
@auth.on.assistants.create
async def on_assistant_create(
    ctx: Auth.types.AuthContext,
    value: Auth.types.assistants.create.value
):
    if "assistants:create" not in ctx.permissions:
        raise Auth.exceptions.HTTPException(
            status_code=403,
            detail="User lacks the required permissions."
        )

请注意，在上述示例中，我们混合使用了全局和特定资源处理程序。由于每个请求都由最具体的处理程序处理，因此创建 thread 的请求将匹配 on_thread_create 处理程序，但不匹配 reject_unhandled_requests 处理程序。但是，更新线程的请求将由全局处理程序处理，因为我们没有针对该资源和操作的更具体的处理程序。创建、更新的请求，

过滤操作¶

授权处理程序可以返回 None、布尔值或过滤字典。 - None 和 True 表示“授权访问所有底层资源” - False 表示“拒绝访问所有底层资源（抛出 403 异常）” - 元数据过滤字典将限制对资源的访问

过滤字典是一个键与资源元数据匹配的字典。它支持三种运算符：

默认值是精确匹配（即下面的 "$eq"）的简写。例如，{"owner": user_id} 仅包含元数据中包含 {"owner": user_id} 的资源
$eq：精确匹配（例如，{"owner": {"$eq": user_id}}） - 这等同于上面的简写 {"owner": user_id}
$contains：列表成员关系（例如，{"allowed_users": {"$contains": user_id}}）此处的值必须是列表的一个元素。存储资源中的元数据必须是列表/容器类型。

包含多个键的字典将使用逻辑 AND 过滤器进行处理。例如，{"owner": org_id, "allowed_users": {"$contains": user_id}} 仅匹配元数据中“owner”为 org_id 且“allowed_users”列表包含 user_id 的资源。有关更多信息，请参阅此处的参考文档。

常见访问模式¶

以下是一些典型的授权模式：

单所有者资源¶

这种常见模式允许你将所有线程、助手、定时任务和运行实例限定于单个用户。对于像常规聊天机器人风格应用这样的常见单用户用例很有用。

@auth.on
async def owner_only(ctx: Auth.types.AuthContext, value: dict):
    metadata = value.setdefault("metadata", {})
    metadata["owner"] = ctx.user.identity
    return {"owner": ctx.user.identity}

基于权限的访问¶

这种模式允许你基于**权限**来控制访问。如果你希望某些角色对资源拥有更广泛或更受限的访问权限，这种模式就很有用。

# 在你的认证处理程序中：
@auth.authenticate
async def authenticate(headers: dict) -> Auth.types.MinimalUserDict:
    ...
    return {
        "identity": "user-123",
        "is_authenticated": True,
        "permissions": ["threads:write", "threads:read"]  # 在认证中定义权限
    }

def _default(ctx: Auth.types.AuthContext, value: dict):
    metadata = value.setdefault("metadata", {})
    metadata["owner"] = ctx.user.identity
    return {"owner": ctx.user.identity}

@auth.on.threads.create
async def create_thread(ctx: Auth.types.AuthContext, value: dict):
    if "threads:write" not in ctx.permissions:
        raise Auth.exceptions.HTTPException(
            status_code=403,
            detail="Unauthorized"
        )
    return _default(ctx, value)


@auth.on.threads.read
async def rbac_create(ctx: Auth.types.AuthContext, value: dict):
    if "threads:read" not in ctx.permissions and "threads:write" not in ctx.permissions:
        raise Auth.exceptions.HTTPException(
            status_code=403,
            detail="Unauthorized"
        )
    return _default(ctx, value)

支持的资源¶

LangGraph 提供了三个级别的授权处理程序，从最通用到最具体依次为：

全局处理程序 (@auth.on)：匹配所有资源和操作
资源处理程序（例如，@auth.on.threads、@auth.on.assistants、@auth.on.crons）：匹配特定资源的所有操作
操作处理程序（例如，@auth.on.threads.create、@auth.on.threads.read）：匹配特定资源上的特定操作

将使用最具体的匹配处理程序。例如，在创建线程时，@auth.on.threads.create 优先于 @auth.on.threads。如果注册了更具体的处理程序，则对于该资源和操作，不会调用更通用的处理程序。

类型安全

每个处理程序的 value 参数在 Auth.types.on.<资源>.<操作>.value 处都有类型提示。例如：

@auth.on.threads.create
async def on_thread_create(
    ctx: Auth.types.AuthContext,
    value: Auth.types.on.threads.create.value  # 线程创建的特定类型
):
    ...

@auth.on.threads
async def on_threads(
    ctx: Auth.types.AuthContext,
    value: Auth.types.on.threads.value  # 所有线程操作的联合类型
):
    ...

@auth.on
async def on_all(
    ctx: Auth.types.AuthContext,
    value: dict  # 所有可能操作的联合类型
):
    ...

更具体的处理程序提供更好的类型提示，因为它们处理的操作类型更少。

支持的操作和类型¶

以下是所有支持的操作处理程序：

资源	处理程序	描述	值类型
线程	`@auth.on.threads.create`	创建线程	`ThreadsCreate`
	`@auth.on.threads.read`	获取线程	`ThreadsRead`
	`@auth.on.threads.update`	更新线程	`ThreadsUpdate`
	`@auth.on.threads.delete`	删除线程	`ThreadsDelete`
	`@auth.on.threads.search`	列出线程	`ThreadsSearch`
	`@auth.on.threads.create_run`	创建或更新运行	`RunsCreate`
助手	`@auth.on.assistants.create`	创建助手	`AssistantsCreate`
	`@auth.on.assistants.read`	获取助手	`AssistantsRead`
	`@auth.on.assistants.update`	更新助手	`AssistantsUpdate`
	`@auth.on.assistants.delete`	删除助手	`AssistantsDelete`
	`@auth.on.assistants.search`	列出助手	`AssistantsSearch`
定时任务	`@auth.on.crons.create`	创建定时任务	`CronsCreate`
	`@auth.on.crons.read`	获取定时任务	`CronsRead`
	`@auth.on.crons.update`	更新定时任务	`CronsUpdate`
	`@auth.on.crons.delete`	删除定时任务	`CronsDelete`
	`@auth.on.crons.search`	列出定时任务	`CronsSearch`

关于运行

运行在访问控制方面以其父线程为作用域。这意味着权限通常从线程继承，反映了数据模型的对话性质。除创建之外的所有运行操作（读取、列出）都由线程的处理程序控制。有一个特定的 create_run 处理程序用于创建新的运行，因为它有更多参数，你可以在处理程序中查看。

后续步骤¶

有关实现细节：

查看关于设置身份验证的入门教程
查看关于实现自定义身份验证处理程序的操作指南