修改他方企业授权的第三方应用配置
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
管理他方企业授权的第三方应用
注:
- BusinessId “集成方业务标记”需要与“第三方应用id”一致
- 不支持客户自己创建“已有第三方应用id”进行变更。(即“已有第三方应用id”的集成方业务标记为空,不能进行变更)。
- 当前仅支持修改回调地址和加密key。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyPartnerAuthorization。 |
| Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
| BusinessId | 是 | String | 腾讯电子签平台分配的生态集成业务的业务标识,需要联系接入产品经理提供。 示例值:jdyxk |
| PartnerApplicationId | 是 | String | 合作方企业通过集成方创建的应用id, 必须与业务标记(Business)保持对应。![]() 示例值:yD3nh*pfu*k*BN50TJsNwY |
| ApplicationInfo | 是 | CallbackInfo | 第三方应用的配置信息。其中包括 回调地址,加密KEY等信息。 执行成功后会覆盖掉对应的第三方应用的回调相关配置。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改他方企业授权的第三方应用配置,仅能修改回调地址和key
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPartnerAuthorization
<公共请求参数>
{
"Operator": {
"UserId": "yDwf3U*c*p*8dv**UE*******pMfa0uw"
},
"BusinessId": "jdyxk",
"PartnerApplicationId": "yD3nh****pf*u*k*******BN50TJsNwY",
"ApplicationInfo": {
"CallbackUrl": "https://v.qq.com",
"CallbackKey": "yDxjsU**yd**3*5*U********ko0F1BB"
}
}
输出示例
{
"Response": {
"RequestId": "a0fbfba2-fb8f-43d9-bc74-87a0a63bda0a"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |
