跳到主要内容

查询企业扩展服务授权详情

1. 接口描述

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

查询企业扩展服务的授权详情(列表),当前支持查询以下内容:

  1. 企业自动签(本企业授权、集团企业授权、合作企业授权)
  2. 批量签署能力

注: 所在企业的超管、法人才有权限调用此接口(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:DescribeExtendedServiceAuthDetail。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
示例值:yD****oimj
ExtendServiceTypeString要查询的扩展服务类型。
如下所示:
  • OPEN_SERVER_SIGN:企业静默签署
  • BATCH_SIGN:批量签署



示例值:""
AgentAgent代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
LimitInteger指定每页返回的数据条数,和Offset参数配合使用。 注:1.默认值为20,单页做大值为200。
OffsetInteger查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。 注:1.offset从0开始,即第一页为0。 2.默认从第一页返回。

3. 输出参数

参数名称类型描述
AuthInfoDetailAuthInfoDetail服务授权的信息列表,根据查询类型返回特定扩展服务的授权状况。
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询企业扩展服务授权详情-自动签

输入示例

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

{
"Operator": {
"UserId": "yDwf3UUckps8dvveUEfH3DjvMmg3ZkjQ"
},
"ExtendServiceType": "OPEN_SERVER_SIGN",
"Agent": {},
"Limit": 10,
"Offset": 0
}

输出示例

{
"Response": {
"AuthInfoDetail": {
"AuthOrganizationTotal": 1,
"AuthUserTotal": 1,
"HasAuthOrganizationList": [
{
"AuthorizeTime": 1689129513,
"AuthorizedOrganizationId": "yDwf3xxxxxxxxxxxFOE0qLixm",
"AuthorizedOrganizationName": "xxxxx有限责任公司",
"OrganizationId": "yDR0MUxxxxxxxxxxxxxxJAuJ4xN",
"OrganizationName": "xxx公司",
"TemplateId": "yDwxxxxxxxxtSqKhFvy",
"TemplateName": "B2B 双方静默签署"
}
],
"HasAuthUserList": [
{
"BelongTo": "CurrentOrg",
"MainOrganizationId": "",
"UserId": "yDxjKxxxxxxxx4zjESzn1dvkm5"
}
],
"Name": "企业静默签(自动签署)",
"Type": "OPEN_SERVER_SIGN"
},
"RequestId": "d03c95cb-82f4-488a-a832-4ced6e367a54"
}
}

示例2 查询企业扩展服务授权详情-批量签署

输入示例

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

{
"Operator": {
"UserId": "yDwf3UUckps8dvveUEfH3DjvMmg3ZkjQ"
},
"ExtendServiceType": "OPEN_SERVER_SIGN",
"Agent": {},
"Limit": 10,
"Offset": 0
}

输出示例

{
"Response": {
"AuthInfoDetail": {
"AuthOrganizationTotal": 0,
"AuthUserTotal": 1,
"HasAuthOrganizationList": [],
"HasAuthUserList": [
{
"BelongTo": "CurrentOrg",
"MainOrganizationId": "",
"UserId": "yDxjKxxxxxxxx4zjESzn1dvkm5"
}
],
"Name": "批量签署",
"Type": "BATCH_SIGN"
},
"RequestId": "d03c95cb-82f4-488a-a832-4ced6e367a54"
}
}

5. 错误码

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

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