使用 API 管理组织

LangSmith 的 API 支持通过 API 密钥以编程方式访问 UI 中提供的所有操作，仅有少数例外情况在仅限用户的端点中注明。

在深入阅读本内容之前，建议先阅读以下内容：

• 关于组织和工作空间的概念指南
• 组织设置操作指南

目前存在一些限制，这些限制将很快被解除：

• LangSmith SDK 目前尚不支持这些组织管理操作。
• 具有组织管理员权限的组织范围服务密钥可用于这些操作。

使用 X-Tenant-Id 标头来指定目标工作空间。如果未提供此标头，操作将默认使用密钥最初创建时所在的工作空间（如果该密钥不是组织范围的）。

如果使用组织范围的服务密钥访问工作空间范围的资源时未指定 X-Tenant-Id，请求将失败并返回 403 Forbidden。

下面列出了一些常用的端点和用例。有关可用端点的完整列表，请参阅 API 文档。所有请求都应包含 X-Organization-Id 标头，而针对特定工作空间的请求则应包含 X-Tenant-Id 标头。

工作空间

• 列出工作空间
• 创建工作空间
• 更新工作空间名称

用户管理

RBAC（基于角色的访问控制）

• 列出角色
• 列出权限
• 创建角色
• 更新角色

成员管理

这些操作中应使用 RBAC 下的 列出角色 来获取角色 ID。以下 列出 [组织|工作空间] 成员 端点响应中的 "id" 应作为这些操作中的 identity_id 使用。

组织级别：

• 列出活跃组织成员
• 列出待处理组织成员
• 邀请用户加入组织及一个或多个工作空间。当用户尚未成为组织成员时，应使用此端点。
• 更新用户的组织角色
• 从组织中移除成员

工作空间级别：

• 列出工作空间成员
• 将已是组织成员的用户添加到工作空间
• 更新用户的工作空间角色
• 从工作空间中移除成员

以下参数应省略：read_only（已弃用）、password 和 full_name（仅限基本身份验证）

API 密钥

• 创建服务密钥
• 删除服务密钥

安全设置

进行这些更改需要组织管理员权限。

此上下文中的“共享资源”指的是公共提示词、共享运行记录和共享数据集。

更新这些设置会影响组织中的所有资源。

您可以在工作空间的 设置 > 共享 标签页下更新这些设置，或通过 API 更新：

• 更新组织共享设置
  • 使用 unshare_all 取消共享所选工作空间的所有共享资源 - 使用 disable_public_sharing 阻止未来资源的共享

这些设置仅能通过 API 编辑：

• 禁用/启用 PAT 创建（对于自托管版本，适用于 Helm chart 版本 0.11.25+）
  • 使用 pat_creation_disabled 为整个组织禁用 PAT 创建。
  • 有关组织查看者角色（无法创建 PAT）的信息，请参阅管理员指南。
  • 对于自托管部署，您还可以使用环境变量全局禁用所有组织的 PAT 创建。

仅限用户的端点

这些端点是用户范围的，需要已登录用户的 JWT，因此应仅通过 UI 执行。

• /api-key/current 端点：这些与用户的 PAT 相关
• /sso/email-verification/send（仅限云版）：此端点与 SAML SSO 相关

示例代码

下面的示例代码演示了几个与组织管理相关的常见工作流程。请确保替换代码中所有 <replace_me> 占位符。

import os
import requests

def main():
    api_key = os.environ["LANGSMITH_API_KEY"]
    # LANGSMITH_ORGANIZATION_ID 不是 SDK 中的标准环境变量，仅在此示例中使用
    organization_id = os.environ["LANGSMITH_ORGANIZATION_ID"]
    base_url = os.environ.get("LANGSMITH_ENDPOINT")  # 或 "https://api.smith.langchain.com"。请根据自托管安装或欧盟区域进行适当更新
    headers = {
        "Content-Type": "application/json",
        "X-API-Key": api_key,
        "X-Organization-Id": organization_id,
    }
    session = requests.Session()
    session.headers.update(headers)
    workspaces_path = f"{base_url}/api/v1/workspaces"
    orgs_path = f"{base_url}/api/v1/orgs/current"
    api_keys_path = f"{base_url}/api/v1/api-key"

    # 创建工作空间
    workspace_res = session.post(workspaces_path, json={"display_name": "My Workspace"})
    workspace_res.raise_for_status()
    workspace = workspace_res.json()
    workspace_id = workspace["id"]
    new_workspace_headers = {
        "X-Tenant-Id": workspace_id,
    }

    # 获取角色 - 包括组织和工作空间角色
    roles_res = session.get(f"{orgs_path}/roles")
    roles_res.raise_for_status()
    roles = roles_res.json()
    # 系统组织角色有 'Organization Admin', 'Organization User'
    # 系统工作空间角色有 'Admin', 'Editor', 'Viewer'
    org_roles_by_name = {role["display_name"]: role for role in roles if role["access_scope"] == "organization"}
    ws_roles_by_name = {role["display_name"]: role for role in roles if role["access_scope"] == "workspace"}

    # 邀请用户加入组织和新工作空间，角色为 Editor。
    # 仅当启用 RBAC（企业功能）时，才允许使用 workspace_role_id。
    new_user_email = "<replace_me>"
    new_user_res = session.post(
        f"{orgs_path}/members",
        json={
            "email": new_user_email,
            "role_id": org_roles_by_name["Organization User"]["id"],
            "workspace_ids": [workspace_id],
            "workspace_role_id": ws_roles_by_name["Editor"]["id"],
        },
    )
    new_user_res.raise_for_status()

    # 将组织中已存在的用户添加到新工作空间，角色为 Viewer。
    # 仅当启用 RBAC（企业功能）时，才允许使用 workspace_role_id。
    existing_user_email = "<replace_me>"
    org_members_res = session.get(f"{orgs_path}/members")
    org_members_res.raise_for_status()
    org_members = org_members_res.json()
    existing_org_member = next(
        (member for member in org_members["members"] if member["email"] == existing_user_email), None
    )
    existing_user_res = session.post(
        f"{workspaces_path}/current/members",
        json={
            "user_id": existing_org_member["user_id"],
            "workspace_ids": [workspace_id],
            "workspace_role_id": ws_roles_by_name["Viewer"]["id"],
        },
        headers=new_workspace_headers,
    )
    existing_user_res.raise_for_status()

    # 列出工作空间的所有成员
    members_res = session.get(f"{workspaces_path}/current/members", headers=new_workspace_headers)
    members_res.raise_for_status()
    members = members_res.json()
    workspace_member = next(
        (member for member in members["members"] if member["email"] == existing_user_email), None
    )

    # 将用户的工作空间角色更新为 Admin（仅限企业版）
    existing_user_id = workspace_member["id"]
    update_res = session.patch(
        f"{workspaces_path}/current/members/{existing_user_id}",
        json={"role_id": ws_roles_by_name["Admin"]["id"]},
        headers=new_workspace_headers,
    )
    update_res.raise_for_status()

    # 将用户的组织角色更新为 Organization Admin
    update_res = session.patch(
        f"{orgs_path}/members/{existing_org_member['id']}",
        json={"role_id": org_roles_by_name["Organization Admin"]["id"]},
    )
    update_res.raise_for_status()

    # 创建新的服务密钥
    api_key_res = session.post(
        api_keys_path,
        json={"description": "my key"},
        headers=new_workspace_headers,
    )
    api_key_res.raise_for_status()
    api_key_json = api_key_res.json()
    api_key = api_key_json["key"]

if __name__ == "__main__":
    main()

---

Edit this page on GitHub or file an issue.

Connect these docs to Claude, VSCode, and more via MCP for real-time answers.