查询单点登录企业员工信息

1. 接口描述

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

此接口（DescribeSingleSignOnEmployees）用于查询单点登录企业员工。

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSingleSignOnEmployees。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
SsoApplicationId	是	String	单点登录应用号的id,获取位置如下图 示例值：yDtrTUUckp94bix0UEbASLp1TuHxTYTS
OpenIds.N	否	Array of String	需要删除的单点登录员工的唯一Id 值.不能超过 200 个。 如果传递了 openIds，limit 和 offset 参数无效， 示例值：["rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0"]
Agent	否	Agent	代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
Limit	否	Integer	指定分页每页返回的数据条数，单页最大支持 200。如果不传， 则默认是 20. 示例值：200
Offset	否	Integer	OFFSET 用于指定查询结果的偏移量，如果不传默认偏移为0,最大20000。 分页参数, 需要limit, offset 配合使用 例如: 您希望得到第三页的数据, 且每页限制最多10条 您可以使用 LIMIT 10 OFFSET 20 示例值：0

3. 输出参数

4. 示例

示例1 查询单点登录企业员工信息

查询单点登录员工账号信息
应用号：yDtrTUUckp94bix0UEbASLp1TuHxTYTS
OpenId： rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0
当前 OpenId 还没有在腾讯电子签实名。

输入示例

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

{
    "Operator": {
        "UserId": "yDwf3UUckps8dvypUEfH3DjwIpMfa0uw",
        "ClientIp": "8.8.8.8"
    },
    "SsoApplicationId": "yDtrTUUckp94bix0UEbASLp1TuHxTYTS",
    "OpenIds": [
        "rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0"
    ]
}

输出示例

{
    "Response": {
        "Employees": [
            {
                "CreatedOn": 1758717608,
                "Email": "",
                "IsVerified": false,
                "Mobile": "138****8888",
                "Name": "典*谦",
                "OpenId": "rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0",
                "RoleIds": [
                    "32bd40938602d1ee5f7735ee84af5785",
                    "yDCHgUUckpbubr9cUxrnpngClLR5YIkR"
                ],
                "UserId": ""
            }
        ],
        "RequestId": "s1758723951932552989"
    }
}

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: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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