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

修改企业员工的角色

修改企业员工的角色。
企业员工角色包括企业管理员和企业普通成员,你可以通过本 API 修改企业员工的角色。

接口限制

不能修改访客的角色。

基础信息

请求方式

PUT

请求地址

https://api.coze.cn/v1/enterprises/:enterprise_id/members/:user_id

权限

Enterprise.updatePeople
确保调用该接口使用的访问令牌开通了企业特权应用中的 Enterprise.updatePeople 权限,详细信息参考OAuth JWT 授权(企业特权应用)

接口说明

修改企业员工的角色。

请求参数

参数

取值

说明

Authorization

Bearer $Access_Token

用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌,详细信息参考OAuth JWT 授权(企业特权应用)

Content-Type

application/json

解释请求正文的方式。

Path

参数

类型

是否必选

示例

说明

enterprise_id

String

必选

volcano_210195***

企业 ID,待修改的员工所属的企业。
你可以在组织管理 > 组织设置页面查看企业 ID。
Image

user_id

String

必选

247877439325****

待修改员工的扣子用户 UID。
你可以调用火山引擎的 ListCozeUser-成员列表 API,其中 CozeUserId的值即为扣子用户 UID。

Body

参数

类型

是否必选

示例

说明

role

String

必选

enterprise_member

设置成员在企业中的角色,枚举值:

  • enterprise_admin:企业管理员。
  • enterprise_member:企业普通成员。

返回参数

参数

类型

示例

说明

code

Long

0

调用状态码。0 表示调用成功,其他值表示调用失败,你可以通过 msg 字段判断详细的错误原因。

msg

String

""

状态信息。API 调用失败时可通过此字段查看详细错误信息。
状态码为 0 时,msg 默认为空。

detail

Object of ResponseDetail

{"logid":"20241210152726467C48D89D6DB2****"}

包含请求的详细信息的对象,主要用于记录请求的日志 ID,便于在异常情况下进行问题排查。

ResponseDetail

参数

类型

示例

说明

logid

String

20241210152726467C48D89D6DB2****

本次请求的日志 ID。如果遇到异常报错场景,且反复重试仍然报错,可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持

示例

请求示例

curl --location --request PUT 'https://api.coze.cn/v1/enterprises/volcano_210195***/members/247877439325****' \
--header 'Authorization : Bearer pat_O******' \
--header 'Content-Type : application/json' \
--data-raw '{
    "role": "enterprise_member"
}'

返回示例

{
    "code": 0,
    "msg": "",
    "detail": {
        "logid": "20241210152726467C48D89D6DB2****"
    }
}

错误码

如果成功调用扣子编程的 API,返回信息中 code 字段为 0。如果状态码为其他值,则表示接口调用失败。此时 msg 字段中包含详细错误信息,你可以参考错误码文档查看对应的解决方法。