AI 助手
扣子 AI 帮助与支持
你好,我是 扣子 文档问答助手 🎉 你在阅读当前文档的过程中,无论对文档概念的解释,还是文档内容方面的疑问,都可以随时向我提问,我会全力为你解答
推荐问题
扣子 3.0 都有什么新特性?
扣子和扣子编程有什么区别?
扣子如何收费?
文档反馈
低代码项目
动态
快速开始
智能体
工作流
应用
资源
发布
模型
多人协作
开发工具
SDK 参考
音视频
推广与变现

成员管理(火山 API)

将员工添加到扣子编程之前,需要先在火山引擎创建成员(即火山子用户)。本文介绍如何调用火山引擎 API 创建成员、授权成员访问扣子编程和查看成员列表。

背景信息

扣子编程的成员管理依赖火山引擎访问控制(IAM)产品,相关 API 均由火山引擎提供,与扣子编程业务 API 分属不同体系。开发者在调用前需注意以下方面:

  • 鉴权方式:仅支持火山引擎的鉴权方式,需使用火山账号的 AccessKeySecretKey,不支持扣子编程的访问令牌。
  • 调用方法:成员管理使用火山引擎 OpenAPI 的请求结构和返回结构,具体请参见请求结构返回结构
  • 在线调用工具:你可以通过火山引擎 API Explorer 快速发起 API 调用,获取响应结果和代码示例。扣子编程 Playground 不支持调用本文所列的 API。
  • SDK :你可以使用火山引擎提供的 Volcengine SDK 实现成员管理,该 SDK 已内置 AK/SK 签名逻辑,无需自行实现,SDK 接入方法请参见 Volcengine SDK 接入指南。扣子编程自身的 SDK 不含成员管理相关接口。

流控限制

主账号内的所有AccessKey共享同一 API 的流控额度,单个 API 的流控限制为 5 QPS。

准备工作

已获取火山引擎 API 访问令牌

火山引擎的访问令牌和扣子编程的访问令牌不通用,调用火山引擎 API 之前,你需要获取火山账号的 AccessKeySecretKey,具体请参见获取AccessKey、SecretKey

说明

为了账号安全,建议使用子用户密钥,为应用程序创建独立的 IAM 用户,并为 IAM 用户分配 CozeFullAccessCloudIdentityFullAccess 权限。
Image

步骤一:创建成员

调用火山引擎的 CreateUser-新建成员 API,创建扣子成员(火山子用户)。

说明

  • 每次请求只能新增一位成员。如需添加多位,请依次发送请求。
  • 该 API 不支持并发请求。
  • 创建成员后,会自动将其加入扣子编程的团队/企业中。

请求示例

POST /?Action=CreateUser&Version=2025-06-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250605T145232Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250605/cn-beijing/coze/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "UserName": "username",
  "SecurePhone": "+861112225***5",
  "SecureEmail": "test@email.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250605225240127115***E6E58",
    "Action": "CreateUser",
    "Version": "2025-06-01",
    "Service": "coze",
    "Region": "cn-beijing"
  },
  "Result": {
    "UserID": "123****4"
  }
}

说明

你需要保存返回的 UserID,后续授权时需要使用。

步骤二:授权成员访问扣子编程

调用火山引擎的 AuthorizeCozeToUser-授权成员访问扣子 API,给目标成员授权访问扣子编程。
授权成功后,系统会自动激活该成员。
请求示例

POST /?Action=AuthorizeCozeToUser&Version=2025-06-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250604T100255Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250604/cn-beijing/coze/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "UserId": "t3HTsg"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250604180259120150106074E7FD18",
    "Action": "AuthorizeCozeToUser",
    "Version": "2025-06-01",
    "Service": "coze",
    "Region": "cn-beijing"
  },
  "Result": {}
}

步骤三:(可选)授权访问火山引擎控制台

若要允许成员以 IAM 子用户身份访问火山引擎控制台,你可以调用火山引擎的 AuthorizeVolcToUser-授权访问火山引擎控制台 API,给对应的成员授权,否则该成员只能使用扣子编程,无法访问火山引擎控制台。
请求示例

POST /?Action=AuthorizeVolcToUser&Version=2025-06-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250605T145209Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250605/cn-beijing/coze/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "UserId": "123"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2025060420393105323013214***",
    "Action": "AuthorizeVolcToUser",
    "Version": "2025-06-01",
    "Service": "coze",
    "Region": "cn-beijing"
  },
  "Result": {}
}

相关操作

查看成员列表

调用火山引擎的 ListCozeUser-成员列表 API,查看已创建的成员信息,包括火山引擎账号 ID、用户名、扣子用户 UID、是否已激活等。
请求示例

POST /?Action=ListCozeUser&Version=2025-06-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250605T145044Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250605/cn-beijing/coze/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "QueryString": "user",
  "PageNumber": 1,
  "PageSize": 10,
  "UserName": "username"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250605225102135200***07",
    "Action": "ListCozeUser",
    "Version": "2025-06-01",
    "Service": "coze",
    "Region": "cn-beijing"
  },
  "Result": {
    "PageNumber": 1,
    "PageSize": 10,
    "Total": 10,
    "Users": [
      {
        "CozeUserInEnterprise": "true",
        "CreatedTime": "2025-02-25T19:21:15+08:00",
        "UpdatedTime": "2025-02-25T19:21:15+08:00",
        "UserId": "1234",
        "UserName": "username",
        "CozeUserId": "1888000022***3",
        "CozeUserName": "用户111222"
      }
    ]
  }
}