跳到主要内容

创建企业扩展服务授权

1. 接口描述

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

创建企业扩展服务授权,当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。 该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同,可通过该接口授权给企业员工。

注:“企业自动签授权”支持集团代子企业操作,请联系运营开通此功能。

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:CreateExtendedServiceAuthInfos。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
示例值:yD****oimj
UserIds.NArray of String本企业员工的id,需要已实名,正常在职员工
ExtendServiceTypeString取值
  • OPEN_SERVER_SIGN:企业自动签
  • BATCH_SIGN:批量签署


示例值:OPEN_SERVER_SIGN
AgentAgent代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

3. 输出参数

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

4. 示例

示例1 创建企业扩展服务授权-主代子

集团主企业代子企业操作

输入示例

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

{
"Operator": {
"UserId": "yDxlzUxxxxxxxxxxxxxxxxPNG1SC2"
},
"ExtendServiceType": "OPEN_SERVER_SIGN",
"Agent": {
"ProxyOrganizationId": "yDxlzUxxxxxxxxxxxxxxxxskenibR"
},
"UserIds": [
"yDxlzUxxxxxxxxxxxxxxxxPNG1SC2"
]
}

输出示例

{
"Response": {
"RequestId": "s169xxxxxxxx6107"
}
}

示例2 创建企业扩展服务授权-自动签

创建企业扩展服务授权

输入示例

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

{
"Operator": {
"UserId": "yDxlzUxxxxxxxxxxxxxxxxPNG1SC2"
},
"ExtendServiceType": "OPEN_SERVER_SIGN",
"Agent": {},
"UserIds": [
"yDxlzUxxxxxxxxxxxxxxxxPNG1SC2"
]
}

输出示例

{
"Response": {
"RequestId": "s169xxxxxxxx6107"
}
}

示例3 创建企业自动签授权-类型错误

输入示例

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

{
"Operator": {
"UserId": "yDxlzUxxxxxxxxxxxxxxxxPNG1SC2"
},
"ExtendServiceType": "",
"Agent": {},
"UserIds": [
"yDxlzUxxxxxxxxxxxxxxxxPNG1SC2"
]
}

输出示例

{
"Response": {
"Error": {
"Code": "OperationDenied",
"Message": "不支持的扩展类型"
},
"RequestId": "s1697xxxxxxxxx107"
}
}

示例4 创建企业扩展服务授权- 批量签署

输入示例

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

{
"Operator": {
"UserId": "yDxlzUxxxxxxxxxxxxxxxxPNG1SC2"
},
"ExtendServiceType": "BATCH_SIGN",
"Agent": {},
"UserIds": [
"yDxlzUxxxxxxxxxxxxxxxxPNG1SC2"
]
}

输出示例

{
"Response": {
"RequestId": "s169xxxxxxxx6107"
}
}

5. 错误码

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

错误码描述
FailedOperation操作失败。
OperationDenied操作被拒绝。
ResourceUnavailable资源不可用。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062