跳到主要内容

创建单点登录企业员工信息

1. 接口描述​

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

此接口（CreateSingleSignOnEmployees）用于创建单点登录企业员工。 创建好的员工，可以通过腾讯电子签提供的链接， 如下图位置，进行登录。 此操作的功能：

  1. 可以绑定已经实名的员工，然后 sso 登录实名绑定。
  2. 可以提前导入员工，在 sso 登录的时候进行实名。
  3. 如果已经绑定过，可以直接通过 sso 链接登录腾讯电子签。

image

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：CreateSingleSignOnEmployees。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，此参数为可选参数。
Operator是UserInfo执行本接口操作的员工信息。使用此接口时，必须填写userId。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
Employees.N是Array of SingleSignOnEmployees待创建员工的信息最多不超过200个。

注意：
1. 传递的 openId 不能重复， 且字符不能超过64位。
2. 传递的手机号不能重复。
3. 绑定的角色必须存在且不能超过 10 个。
SsoApplicationId是String单点登录应用号的id,获取位置如下图image
示例值：yDtrTUUckp94bix0UEbASLp1TuHxTYTS
Agent否Agent代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数​

参数名称类型描述
ErrorMessagesArray of String导入员工返回的错误信息，信息数组的顺序跟导入的保持一致
示例值：["导入员工失败，错误信息:[当前openId[rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0]已经被绑定了，请更换openId进行绑定]"]
StatusInteger导入员工返回的状态码
0-全部成功
1-部分成功
2-全部失败
示例值：0
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 创建一个单点登录的员工成功示例​

创建单点登录员工账号成功 应用号：yDtrTUUckp94bix0UEbASLp1TuHxTYTS OpenId：OpenId [rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0] 姓名：电子签 手机号：18888888888 角色：合同管理员和印章管理员的 roleId

输入示例​

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

{
    "Operator": {
        "UserId": "yDwf3UUckps8dvypUEfH3DjwIpMfa0uw",
        "ClientIp": "8.8.8.8"
    },
    "SsoApplicationId": "yDtrTUUckp94bix0UEbASLp1TuHxTYTS",
    "Employees": [
        {
            "OpenId": "rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0",
            "Name": "典子谦",
            "Mobile": "18888888888",
            "RoleIds": [
                "32bd40938602d1ee5f7735ee84af5785",
                "yDCHgUUckpbubr9cUxrnpngClLR5YIkR"
            ]
        }
    ]
}

输出示例​

{
    "Response": {
        "ErrorMessages": [
            ""
        ],
        "RequestId": "s1758723146173417020",
        "Status": 0
    }
}

示例2 创建一个单点登录的员工失败示例​

创建单点登录员工账号失败 应用号：yDtrTUUckp94bix0UEbASLp1TuHxTYTS 原因：OpenId [rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0] 已存在于系统中 建议：请检查当前员工是否已经导入，如果确定没有被导入使用其他OpenId。

输入示例​

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

{
    "Operator": {
        "UserId": "yDwf3UUckps8dvypUEfH3DjwIpMfa0uw",
        "ClientIp": "8.8.8.8"
    },
    "SsoApplicationId": "yDtrTUUckp94bix0UEbASLp1TuHxTYTS",
    "Employees": [
        {
            "OpenId": "rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0",
            "Name": "典子谦",
            "Mobile": "18888888888",
            "RoleIds": [
                "32bd40938602d1ee5f7735ee84af5785",
                "yDCHgUUckpbubr9cUxrnpngClLR5YIkR"
            ]
        }
    ]
}

输出示例​

{
    "Response": {
        "ErrorMessages": [
            "导入员工失败，错误信息:[当前openId[rUHYMgaz8aNm2IP3Pn8m5q6I3yJDojClFl555uLyeM0]已经被绑定了，请更换openId进行绑定]"
        ],
        "RequestId": "s1758723146173417020",
        "Status": 2
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError.System系统错误，请稍后重试。
InvalidParameter参数错误。
InvalidParameter.Email邮箱格式不正确
InvalidParameter.EmptyParams参数为空，请检查参数修改后重试。
InvalidParameter.InvalidChannelChannel不正确。
InvalidParameter.InvalidOpenIdOpenId不正确。
InvalidParameter.InvalidOperatorId操作人ID不正确。
InvalidParameter.InvalidOrganizationId机构ID不正确。
InvalidParameter.Name不合法的用户名称，请修改后重试。
InvalidParameter.RoleId角色ID不正确
LimitExceeded.ProxyOrganizationOperator导入的员工数量超过最大限制。
MissingParameter缺少参数错误。
OperationDenied.Forbid禁止此项操作。
OperationDenied.NoIdentityVerify未通过个人实名认证。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈