角色关联的用户列表

最近更新时间:2025-09-16 01:55:44

我的收藏

1. 接口描述

接口请求域名: lowcode.tencentcloudapi.com 。

获取角色关联的用户列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRelatedUsers。
Version String 公共参数,本接口取值:2021-01-08。
Region String 公共参数,本接口不需要传递此参数。
RoleId Integer 角色id
示例值:""
EnvId String 环境id
示例值:""
PageNo Integer 页码
示例值:""
PageSize Integer 页面含量
示例值:""
EnvType String 环境类型
示例值:""

3. 输出参数

参数名称 类型 描述
Data Array of WedaUser 关联的用户列表
Total Integer 总数
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取关联用户

输入示例

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

{
    "RoleId": 0,
    "EnvId": "abc",
    "PageNo": 0,
    "PageSize": 0,
    "EnvType": "abc"
}

输出示例

{
    "Response": {
        "Data": [
            {
                "Uin": 0,
                "Name": "abc",
                "Env": 0,
                "Type": 0,
                "NickName": "abc",
                "Email": "abc",
                "Phone": "abc",
                "ProjectId": 0,
                "Uuid": "abc",
                "Source": 0,
                "OpenId": "abc",
                "RelatedRoles": [
                    {
                        "Name": "abc",
                        "RoleIdentity": "abc",
                        "Id": 0,
                        "ParentRoleId": 0,
                        "ChildRoleId": 0,
                        "EnvIdentity": "abc",
                        "IsReleased": true
                    }
                ],
                "WechatUserId": "abc",
                "InternalUserType": 0,
                "UserId": 0,
                "OrgName": "abc",
                "UserSchema": "abc",
                "UserExtend": "abc",
                "IsLicensed": true,
                "RelatedRoleGroups": [
                    {
                        "Id": 0,
                        "Name": "abc",
                        "GroupIdentity": "abc",
                        "GroupDesc": "abc",
                        "CreateTime": "abc",
                        "UpdateTime": "abc",
                        "RoleList": [
                            {
                                "Name": "abc",
                                "RoleIdentity": "abc",
                                "Id": 0,
                                "ParentRoleId": 0,
                                "ChildRoleId": 0,
                                "EnvIdentity": "abc",
                                "IsReleased": true
                            }
                        ]
                    }
                ],
                "Orgs": [
                    {
                        "OrgId": "abc",
                        "OrgName": "abc",
                        "OrgIdentity": "abc",
                        "Level": "abc",
                        "PrimaryColumn": "abc"
                    }
                ],
                "MainOrg": [
                    {
                        "OrgId": "abc",
                        "OrgName": "abc",
                        "OrgIdentity": "abc",
                        "Level": "abc",
                        "PrimaryColumn": "abc"
                    }
                ],
                "ParentUserId": 0,
                "PrimaryColumn": "abc",
                "AvatarUrl": "abc"
            }
        ],
        "Total": 0,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.FlexdbResourceOverdue 数据库资源到期或者超过套餐包限制。
InternalError 内部错误。
ResourceNotFound 资源不存在。