使用 API 管理你的组织

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

TIP

更喜欢基础设施即代码？使用 LangSmith Terraform provider 以声明方式管理工作区、角色、成员、评估器和警报。

TIP

在深入本内容之前，阅读以下内容可能会有所帮助：

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

NOTE

有一些限制将很快解除：

• LangSmith SDK 尚不支持这些组织管理操作。
• 具有 Organization Admin 权限的组织作用域服务密钥可用于这些操作。

WARNING

使用 X-Tenant-Id header 指定要目标的工作区。如果未提供该 header，且密钥不是组织作用域的，操作将默认使用密钥最初创建时所在的工作区。

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

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

工作区

• 列出工作区
• 创建工作区
• 更新工作区名称

用户管理

RBAC

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

成员资格管理

RBAC 下的 List roles 应用于检索这些操作的角色 ID。下面 List [organization|workspace] members 端点响应中的 "id" 应用作这些操作中的 identity_id。

组织级别：

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

工作区级别：

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

NOTE

应省略这些参数：read_only（已弃用）、password 和 full_name（仅基本身份验证）。

API 密钥

• 创建服务密钥
• 更新服务密钥角色
• 删除服务密钥

安全设置

NOTE

需要 Organization Admin 权限才能进行这些更改。

NOTE

此上下文中的「共享资源」指公开提示、共享运行和共享数据集。

WARNING

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

你可以在工作区的 Settings > Shared 选项卡下更新这些设置，或通过 API 更新：

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

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

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

仅用户端点

这些端点是用户作用域的，需要已登录用户的 JWT，因此只能通过 UI 执行。

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

示例代码

下面的示例代码介绍了与组织管理相关的几个常见工作流。请确保在代码中任何 <replace_me> 处进行必要的替换。

import os
import requests

def main():
    api_key = os.environ["LANGSMITH_API_KEY"]
    # LANGSMITH_ORGANIZATION_ID is not a standard environment variable in the SDK, just used for this example
    organization_id = os.environ["LANGSMITH_ORGANIZATION_ID"]
    base_url = os.environ.get("LANGSMITH_ENDPOINT")  # or "https://api.smith.langchain.com". Update appropriately for self-hosted installations or regional SaaS
    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"

    # Create a workspace
    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,
    }

    # Grab roles - this includes both organization and workspace roles
    roles_res = session.get(f"{orgs_path}/roles")
    roles_res.raise_for_status()
    roles = roles_res.json()
    # system org roles are 'Organization Admin', 'Organization User'
    # system workspace roles are '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"}

    # Invite a user to the org and the new workspace, as an Editor.
    # workspace_role_id is only allowed if RBAC is enabled (an enterprise feature).
    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()

    # Add a user that already exists in the org to the new workspace, as a Viewer.
    # workspace_role_id is only allowed if RBAC is enabled (an enterprise feature).
    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()

    # List all members of the workspace
    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
    )

    # Update the user's workspace role to Admin (enterprise-only)
    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()

    # Update the user's organization role to 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()

    # Create a new Service key
    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()

---