读取节点下用户

最近更新时间：2024-03-12 01:29:47

我的收藏

本页目录：

1. 接口描述

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

根据机构节点ID读取节点下用户

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ListUsersInOrgNode。
Version	是	String	公共参数，本接口取值：2021-04-20。
Region	否	String	公共参数，本接口不需要传递此参数。
OrgNodeId	否	String	机构节点ID，是机构节点全局唯一标识，长度限制：64个字符。如果为空默认读取机构根节点下用户信息。示例值：id
IncludeOrgNodeChildInfo	否	Boolean	是否读取其子节点信息。当其为空或false时，默认仅读取当前机构节点信息。当其为true时，读取本机构节点以及其第一层子节点信息。
SearchCondition	否	ListUsersInOrgNodeSearchCriteria	用户属性搜索条件，可查询条件包括：用户名、手机号码，邮箱、用户锁定状态、用户冻结状态、创建时间、上次修改时间，支持多种属性组合作为查询条件。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式，具体查询方式为：双引号（“”）表示全匹配、以星号（）结尾表示字段部分匹配、中括号以逗号分隔（[Min，Max]）表示闭区间查询、大括号以逗号分隔（{Min，Max}）表示开区间查询，中括号与大括号可以配合使用（例如：{Min，Max]表示最小值开区间，最大值闭区间查询）。范围匹配支持使用星号（例如{20,]表示查询范围为大于20的所有数据）。范围查询同时支持时间段查询，支持的属性包括创建时间（CreationTime）、上次修改时间（LastUpdateTime），查询的时间格式遵循 ISO 8601 标准，例如：2021-01-13T09:44:07.182+0000。
Sort	否	SortCondition	排序条件集合。可排序的属性支持：用户名字（UserName）、手机号（Phone）、邮箱（Email）、用户状态（Status）、创建时间（CreatedDate）、上次更新时间（LastModifiedDate）。如果不指定，则默认按照用户昵称（DisplayName）正向排序。
Offset	否	Integer	分页偏移量，默认为0。Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。如果不指定以上参数，则表示不进行分页查询，即只返回最多50个用户。
Limit	否	Integer	分页读取数量，默认为50，最大值为100。 Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。如果不指定以上参数，则表示不进行分页查询，即只返回最多50个用户。

3. 输出参数

参数名称	类型	描述
OrgNodeChildUserInfo	Array of OrgNodeChildUserInfo	机构子节点下的用户信息列表。注意：此字段可能返回 null，表示取不到有效值。
OrgNodeId	String	机构ID，是机构节点全局唯一标识，长度限制：64个字符。注意：此字段可能返回 null，表示取不到有效值。示例值：id
UserInfo	Array of UserInfo	用户信息列表。注意：此字段可能返回 null，表示取不到有效值。
TotalUserNum	Integer	当前机构节点下的用户总数。注意：此字段可能返回 null，表示取不到有效值。
OrgNodeIdPath	String	组织机构ID路径。注意：此字段可能返回 null，表示取不到有效值。
OrgNodeNamePath	String	组织机构名称路径。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

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

{
    "OrgNodeId": "7999987a-c9dc-4dd2-b3e2-b52f53317aa6",
    "IncludeOrgNodeChildInfo": "true"
}

输出示例

{
    "Response": {
        "RequestId": "123",
        "OrgNodeIdPath": "acbe4ea1-ea82-****-b979-c3b8be5c08d1",
        "OrgNodeChildUserInfo": [
            {
                "OrgNodeIdPath": "acbe4ea1-ea82-****-b979-c3b8be5c08d1/45892fcd-578e-43c1-a4e3-3f0ca9782fe4",
                "OrgNodeId": "45892fcd-578e-****-a4e3-3f0ca9782fe4",
                "UserInfo": [
                    {
                        "Status": "NOT_ENABLED",
                        "UserName": "3",
                        "Email": null,
                        "UserId": "e8cc68ca-****-492e-8770-b44d05111058",
                        "Phone": "+86-178****78787",
                        "DisplayName": "t1",
                        "DataSource": "SELF_CREATE"
                    }
                ],
                "TotalUserNum": 1,
                "OrgNodeNamePath": "根节点/企业1"
            },
            {
                "OrgNodeIdPath": "acbe4ea1-ea82-****-b979-c3b8be5c08d1/e161551b-2100-49f6-adf9-def5987ea8d9",
                "OrgNodeId": "e161551b-2100-49f6-adf9-def5987ea8d9",
                "UserInfo": [
                    {
                        "Status": "NOT_ENABLED",
                        "UserName": "1111111111111111111111111111111111111111",
                        "Email": "11884244298@qq.com",
                        "UserId": "29a94c4d-****-4352-82c0-1ac1cb546220",
                        "Phone": "+86-16****62134",
                        "DisplayName": "开发人员",
                        "DataSource": "SELF_CREATE"
                    },
                    {
                        "Status": "NOT_ENABLED",
                        "UserName": "reset",
                        "Email": "11****44298@qq.com",
                        "UserId": "c6762eef-a0dd-****-bff3-b2842da10089",
                        "Phone": "+86-134****2134",
                        "DisplayName": "开发人员x",
                        "DataSource": "SELF_CREATE"
                    }
                ],
                "TotalUserNum": 2,
                "OrgNodeNamePath": "根节点/组织2"
            }
        ],
        "OrgNodeId": "acbe4ea1-****-4d35-b979-c3b8be5c08d1",
        "UserInfo": [
            {
                "Status": "NOT_ENABLED",
                "UserName": "1",
                "Email": null,
                "UserId": "6138bb2c-****-4bf4-b617-ddf0a0ac14d8",
                "Phone": "+86-15****45454",
                "DisplayName": "aldenli",
                "DataSource": "SELF_CREATE"
            },
            {
                "Status": "NOT_ENABLED",
                "UserName": "11",
                "Email": "118****4298@qq.com",
                "UserId": "5c834ac5-****-47a3-a26a-e0a37a7f7306",
                "Phone": "+86-67464512134",
                "DisplayName": "开发人员",
                "DataSource": "SELF_CREATE"
            },
            {
                "Status": "NOT_ENABLED",
                "UserName": "re2",
                "Email": "11****44298@qq.com",
                "UserId": "70496920-f4de-****-9e16-a2b99c632753",
                "Phone": "+86-13****512566",
                "DisplayName": "开发人员x",
                "DataSource": "SELF_CREATE"
            }
        ],
        "TotalUserNum": 3,
        "OrgNodeNamePath": "根节点"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.DescribeOrgNodeRootError	读取根机构节点信息失败。
FailedOperation.ListUsersInOrgNodeError	读取节点下用户失败。
FailedOperation.OperationError	操作失败。
FailedOperation.OrgNodeIdNotExist	机构节点ID不存在。
InvalidParameter.SearchCriteriaIllegal	列表搜索条件不合法。
InvalidParameterValue.ParameterIllegal	参数不合法。

上一篇: 读取机构节点信息下一篇: 更新机构节点