添加自定义身份验证

​

为部署添加自定义身份验证

1. 实现身份验证：
   如果没有自定义的 @auth.authenticate 处理程序，LangGraph 只能识别 API 密钥所有者（通常是开发者），因此请求不会限定到单个最终用户。要传递自定义令牌，必须实现自己的处理程序。
   from langgraph_sdk import Auth
   import requests
   
   auth = Auth()
   
   def is_valid_key(api_key: str) -> bool:
       is_valid = # 你的 API 密钥验证逻辑
       return is_valid
   
   @auth.authenticate # (1)!
   async def authenticate(headers: dict) -> Auth.types.MinimalUserDict:
       api_key = headers.get(b"x-api-key")
       if not api_key or not is_valid_key(api_key):
           raise Auth.exceptions.HTTPException(status_code=401, detail="无效的 API 密钥")
   
       # 从你的机密存储中获取特定于用户的令牌
       user_tokens = await fetch_user_tokens(api_key)
   
       return { # (2)!
           "identity": api_key,  #  从 LangSmith 获取用户 ID
           "github_token" : user_tokens.github_token
           "jira_token" : user_tokens.jira_token
           # ... 在此处添加自定义字段/机密信息
       }
   

• 此处理程序接收请求（标头等），验证用户身份，并返回一个至少包含 identity 字段的字典。
• 你可以添加所需的任何自定义字段（例如 OAuth 令牌、角色、组织 ID 等）。

2. 在你的 langgraph.json 中添加身份验证文件的路径：
   {
       "dependencies": ["."],
       "graphs": {
       "agent": "./agent.py:graph"
       },
       "env": ".env",
       "auth": {
           "path": "./auth.py:my_auth"
       }
   }
   

3. 在服务器中设置身份验证后，请求必须根据你选择的方案包含所需的授权信息。假设你使用的是 JWT 令牌身份验证，可以通过以下任一方式访问部署：
   • Python Client
   • Python RemoteGraph
   • JavaScript Client
   • JavaScript RemoteGraph
   • cURL

   from langgraph_sdk import get_client
   
   my_token = "your-token" # 实际使用时，你应通过身份验证提供商生成签名令牌
   client = get_client(
       url="http://localhost:2024",
       headers={"Authorization": f"Bearer {my_token}"}
   )
   threads = await client.threads.search()
   

   from langgraph.pregel.remote import RemoteGraph
   
   my_token = "your-token" # 实际使用时，你应通过身份验证提供商生成签名令牌
   remote-graph = RemoteGraph(
       "agent",
       url="http://localhost:2024",
       headers={"Authorization": f"Bearer {my_token}"}
   )
   threads = await remote-graph.ainvoke(...)
   

   import { Client } from "@langchain/langgraph-sdk";
   
   const my_token = "your-token"; // 实际使用时，你应通过身份验证提供商生成签名令牌
   const client = new Client({
   apiUrl: "http://localhost:2024",
   defaultHeaders: { Authorization: `Bearer ${my_token}` },
   });
   const threads = await client.threads.search();
   

   import { RemoteGraph } from "@langchain/langgraph/remote";
   
   const my_token = "your-token"; // 实际使用时，你应通过身份验证提供商生成签名令牌
   const remoteGraph = new RemoteGraph({
   graphId: "agent",
   url: "http://localhost:2024",
   headers: { Authorization: `Bearer ${my_token}` },
   });
   const threads = await remoteGraph.invoke(...);
   

   curl -H "Authorization: Bearer ${your-token}" http://localhost:2024/threads
   
   如需详细了解 RemoteGraph，请参阅使用 RemoteGraph 指南。

​

启用代理身份验证

def my_node(state, config):
    user_config = config["configurable"].get("langgraph_auth_user")
    # 令牌已在 @auth.authenticate 函数中解析
    token = user_config.get("github_token","")
    ...

​

为 Studio 中的用户授权

from langgraph_sdk.auth import is_studio_user, Auth
auth = Auth()

# ... 设置 authenticate 等

@auth.on
async def add_owner(
    ctx: Auth.types.AuthContext,
    value: dict  # 发送到此访问方法的有效载荷
) -> dict:  # 返回用于限制资源访问的过滤器字典
    if is_studio_user(ctx.user):
        return {}

    filters = {"owner": ctx.user.identity}
    metadata = value.setdefault("metadata", {})
    metadata.update(filters)
    return filters

​

了解更多

• 身份验证与访问控制
• 设置自定义身份验证教程