必须确保企业用户已授予平台appId获取其印章资源管理的权限,点击查看如何授权
- manage_org_seal - 授权允许获取企业/组织用户的印章的查询、新增、编辑、授权、删除权限
接口描述
用于查询对外部企业的印章授权信息。
- 指定企业印章(
sealId
)查询时,可查询该印章所有的跨企业授权信息; - 指定被授权机构账号ID(
authorizedOrgId
)查询时,可查询对该企业的所有印章授权信息; - 同时指定
sealId
、authorizedOrgId
时,则查询该印章对某企业的授权详情。
【注】默认查询通过API接口发起的印章授权记录。
接口地址&请求方法
接口地址:
https://{host}/v3/seals/org-seals/external-auth?orgId=xx&pageNum=1&pageSize=20&sealId=xx
请求方法:GET
请求头格式
具体请求头参数,请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
orgId | string | 是 | query | 机构账号ID(委托单位) 【注】用户在e签宝注册实名后才有账号ID,账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询 |
sealId | string | 否 | query | 印章ID(印章编号)
|
authorizedOrgId | string | 否 | query | 被授权机构账号ID(受托单位)
【注】用户在e签宝注册实名后才有账号ID,账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询 |
pageNum | int32 | 是 | query | 查询页码 |
pageSize | int32 | 是 | query | 每页显示的数量,最大值:20 |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | ||||
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | ||||
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整。 | ||||
data(点击“+”展开详情) | object | 否 | 业务数据 | ||||
total | int32 | 否 | 授权记录总数 | ||||
sealAuthorizedInfos(点击“+”展开详情) | array | 否 | 印章跨企业授权信息 | ||||
sealId | string | 否 | 印章ID(印章编号) | ||||
authorizerPsnId | string | 否 | 授权操作人账号ID(委托人) | ||||
authorizedOrgId | string | 否 | 被授权机构账号ID(受托单位) | ||||
sealAuthBizId | string | 否 | 授权业务流程编号 | ||||
authorizeStatus | int32 | 否 | 当前授权状态 0 - 失效,1 - 正常,3 - 待生效 | ||||
statusDescription | string | 否 | 授权状态对应的解释说明 | ||||
expireReason | string | 否 | 过期原因 NOT_EXPIRE - 未失效(授权状态正常时,默认返回此值) NOT_SIGN - 保存授权成功,但未进行签署授权 WAIT_EFFECTIVE - 还未到开始日期 EXPIRED - 超过有效期 GRANT_ORG_ACCOUNT_UPDATE- 授权企业账号更新 GRANTER_ACCOUNT_UPDATE - 授权人账号更新 GRANTED_ACCOUNT_UPDATE - 被授权方账号更新 | ||||
expireReasonDescription | string | 否 | 过期原因对应的解释说明 | ||||
longTermEffective | boolean | 否 | 印章授权是否长期有效(不限制授权时间),默认false true - 是 false - 否 | ||||
effectiveTime | int64 | 否 | 印章授权生效时间,Unix时间戳格式,单位毫秒。 | ||||
expireTime | int64 | 否 | 印章授权失效时间,Unix时间戳格式,单位毫秒。 | ||||
signFlowId | string | 否 | 授权书签署流程ID | ||||
authorizedType | int32 | 否 | 授权印章使用对象,默认:0 0 - 被授权企业的管理员/法人(不限被授权方企业下的开发者应用ID) 1 - 被授权企业下的应用(仅限被授权企业下的某个指定应用ID使用) | ||||
authorizedApplication | string | 否 | 被授权企业下的开发者应用ID(appId),为null即不限被授权方企业下的应用ID。 |
请求示例
GET https://openapi.esign.cn/v3/seals/org-seals/external-auth?orgId=0c5bd***48bfbf&pageNum=1&pageSize=20&sealId=xxx
响应示例
{
"message": "成功",
"code": 0,
"data": {
"total": 1,
"sealAuthorizedInfos": [
{
"sealId": "02590082-**-**-**-2138db4d7b73",
"authorizerPsnId": "c7e002***10541e7",
"authorizeStatus": 1,
"statusDescription": "正常",
"effectiveTime": 1636473600000,
"expireTime": 1668095999000,
"expireReason": "NOT_EXPIRE",
"expireReasonDescription": "未失效",
"signFlowId": "4e8de6e**396bda63",
"sealAuthBizId": "7327fd33-xx-xx-xx-494f313340aa",
"authorizedOrgId": "a3d101cc***d28582e",
"authorizedType": 0,
"authorizedApplication": null
}
]
}
}