跳到主要内容

修改单点登录企业员工信息

1. 接口描述​

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

此接口（ModifySingleSignOnEmployees）用于修改单点登录企业员工。 注意： 此接口只能修改未跟腾讯电子签绑定的单点登录企业员工， 如果企业员工的单点登录信息已经和腾讯电子签里面的企业员工绑定，需要在腾讯电子签小程序进行个人信息变更操作。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ModifySingleSignOnEmployees。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，此参数为可选参数。
Operator是UserInfo执行本接口操作的员工信息。使用此接口时，必须填写userId。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
SsoApplicationId是String单点登录应用号的id,获取位置如下图image
示例值：yDtrTUUckp94bix0UEbASLp1TuHxTYTS
Employee是SingleSignOnEmployees待修改员工的信息。
Agent否Agent代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数​

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

4. 示例​

示例1 修改单点登录企业员工​

修改单点登录应用号为【yDtrTUUckp94bix0UEbASLp1TuHxTYTS】下面OpenId 为【rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0】的员工。 当前员工仅做过导入，并没有跟腾讯电子签里面的企业员工进行绑定， 修改姓名和手机号成功。

输入示例​

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

{
    "Operator": {
        "UserId": "yDwf3UUckps8dvypUEfH3DjwIpMfa0uw",
        "ClientIp": "8.8.8.8"
    },
    "SsoApplicationId": "yDtrTUUckp94bix0UEbASLp1TuHxTYTS",
    "Employee": {
        "OpenId": "rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0",
        "Name": "典子谦",
        "Mobile": "13200000008"
    }
}

输出示例​

{
    "Response": {
        "RequestId": "s1758722757358561301"
    }
}

5. 错误码​

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

错误码描述
AuthFailureCAM签名/鉴权错误。
FailedOperation操作失败。
InternalError.Db数据库异常。
InternalError.System系统错误，请稍后重试。
InvalidParameter参数错误。
InvalidParameter.Email邮箱格式不正确
InvalidParameter.EmptyParams参数为空，请检查参数修改后重试。
InvalidParameter.InvalidChannelChannel不正确。
InvalidParameter.InvalidOpenIdOpenId不正确。
InvalidParameter.InvalidOperatorId操作人ID不正确。
InvalidParameter.InvalidOrganizationId机构ID不正确。
InvalidParameter.Mobile不合法的手机号，请检查后重试。
InvalidParameter.Name不合法的用户名称，请修改后重试。
InvalidParameter.OpenIdOpenId不正确。
InvalidParameter.RoleId角色ID不正确
InvalidParameterValue参数取值错误。
MissingParameter缺少参数错误。
OperationDenied.Forbid禁止此项操作。
OperationDenied.NoIdentityVerify未通过个人实名认证。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈