跳到主要内容

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

1. 接口描述​

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

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

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

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

2. 输入参数​

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

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

3. 输出参数​

参数名称类型描述
EmployeesArray of SingleSignOnEmployees单点登录企业员工信息
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

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. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError.System系统错误，请稍后重试。
InvalidParameter参数错误。
InvalidParameter.InvalidChannelChannel不正确。
InvalidParameter.InvalidOperatorId操作人ID不正确。
InvalidParameter.InvalidOrganizationId机构ID不正确。
MissingParameter缺少参数错误。
OperationDenied.Forbid禁止此项操作。
OperationDenied.NoIdentityVerify未通过个人实名认证。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈