API 中心
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > API 中心 > 微瓴同业开放平台 > 孪生门户相关接口 > 查询租户人员列表

查询租户人员列表

最近更新时间：2024-03-12 02:07:45

我的收藏

本页目录：

1. 接口描述

接口请求域名： weilingwith.tencentcloudapi.com 。

查询租户人员列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTenantUserList。
Version 是 String 公共参数，本接口取值：2023-04-27。
Region 是 String 公共参数，详见产品支持的 地域列表。
Offset 是 Integer 翻页页码
示例值：1
Limit 是 Integer 翻页大小
示例值：10
ApplicationToken 是 String token
示例值：xxx
TenantId 否 String 租户ID
示例值：10001
UpdateAt 否 Integer 更新时间戳，单位秒
示例值：1681314106
DepartmentId 否 String 部门ID
示例值：12
Cursor 否 String 用户id
示例值：0d0a98561b3c4f72963eba5c5fcf56e1
Status 否 Integer 状态，0，获取所有数据，1正常启用，2禁用
示例值：1
WorkspaceId 否 String 项目空间id
示例值：1016
Keyword 否 String 关键词
示例值：test
NoRecursive 否 String 是否递归获取子级数据，0需要，1不需要，默认为0
示例值：1

3. 输出参数

参数名称 类型 描述
Result SsoUserResult 返回数据
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询租户人员列表

查询租户人员列表

输入示例

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

{
    "Offset": 1,
    "Limit": 1,
    "TenantId": "1",
    "ApplicationToken": "Z2GWsZyAcnKt1zIK65FQz5XsFk5nTKqx"
}

输出示例

{
    "Response": {
        "RequestId": "2a9b97e6-3f19-43ea-9ec6-37985e4eac99",
        "Result": {
            "Total": 28,
            "Users": [
                {
                    "BelongTeam": 0,
                    "CreateAt": 1691565476,
                    "DepartmentId": "6",
                    "DepartmentName": "产品部",
                    "DepartmentUserId": 431,
                    "Email": "test@tencent.com",
                    "Password": "",
                    "Phone": "159****6666",
                    "RealName": "test",
                    "Status": 1,
                    "TenantId": "100055",
                    "UpdateAt": 1691745205,
                    "UserGroup": "",
                    "UserId": "0d0a98561b3c4f72963eba5c5fcf56e1",
                    "UserName": "",
                    "UserType": "99"
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.TokenNotFound 未找到该token信息
InternalError.ApiGatewayInternalError API网关内部错误
InternalError.UnknownError 未知错误
InvalidParameter 参数错误。
中国站