tencent cloud

腾讯云 BI

修改用户角色信息

下载
聚焦模式
字号
最后更新时间: 2026-06-16 17:22:15

1. 接口描述

接口请求域名: bi.intl.tencentcloudapi.com 。

修改用户角色信息

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:ModifyUserRole。
Version 是 String 公共参数,本接口取值:2022-01-05。
Region 否 String 公共参数,此参数为可选参数。
UserId 否 String 用户ID
RoleIdList.N 否 Array of Integer 角色ID 列表
Email 否 String 邮箱
UserName 否 String 用户名
PhoneNumber 否 String 手机号
AreaCode 否 String 手机区号
AppUserId 否 String 企业微信应用用户id
LoginSecurityStatus 否 Integer 是否开启手机验证码登录(0 关闭,1 开启)
ResetPassWordTip 否 Integer 是否开启密码过期提醒(0 关闭,1 开启
ForceResetPassWord 否 Integer 强制修改密码(0 关闭,1 开启)
PasswordExpired 否 Integer 密码过期提醒时间,30、60、90(默认)、180天

3. 输出参数

参数名称 类型 描述
ErrorInfo ErrorInfo 自定义错误信息对象
注意:此字段可能返回 null,表示取不到有效值。
Extra String 扩展
注意:此字段可能返回 null,表示取不到有效值。
Msg String 消息
注意:此字段可能返回 null,表示取不到有效值。
Data String 数据
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改用户角色信息

修改用户角色信息

输入示例

POST / HTTP/1.1
Host: bi.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyUserRole
<公共请求参数>

{
    "UserId": "UserId",
    "RoleIdList": [
        1982493789748932
    ],
    "Email": "123***@qq.com",
    "UserName": "zhangsan",
    "PhoneNumber": "PhoneNumber",
    "AreaCode": "AreaCode",
    "AppUserId": "AppUserId",
    "LoginSecurityStatus": 1982493789748932,
    "ResetPassWordTip": 1982493789748932,
    "ForceResetPassWord": 1982493789748932,
    "PasswordExpired": 1982493789748932
}

输出示例

{
    "Response": {
        "Msg": "success",
        "RequestId": "9478b0d0-1e95-4d12-88a6-db36fb27a12b",
        "Extra": "Extra",
        "Data": "Data"
    }
}

5. 开发者资源

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
InternalError.Internal 内部错误。
MissingParameter.MissingParam 必填参数缺失。
UnauthorizedOperation.Authorize 权限错误。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈