Skip to content

禁用委托人 ​

POST
/openapi/v3/esign/delegates/:delegateId/disable

发起停用某委托人的意愿,由授权主体(经办人)单方在意愿页确认即可生效——与新增委托人的双向意愿不同,本接口只需一条 confirmUrl。

停用非删除

本接口语义是停用:该委托人此前在各证书上的委托授权记录不会被物理删除,但停用后不再允许其代签。停用完成后可经查询委托授权记录确认对应记录的 status 已转为 REVOKED。

X-ES-Request-ID 必填

本接口为幂等创建类接口,请求头必须携带 X-ES-Request-ID 作为幂等键,规则见通用说明。

路径参数 ​

参数类型必填说明
delegateIdstring是委托人人员 ID,取自新增委托人响应的 delegateId

Body 参数 ​

参数类型必填说明
certIdstring是云签证书 ID,仅作归属校验锚点(该企业下任一证书均可,不影响停用范围——停用是按委托人生效,不区分证书)
grantorPersonIdstring是发起停用的企业经办人 ID(personType=ENTERPRISE_PERSON),取自证书标识映射查询响应的 managerId,须与 certId 锚定的企业一致

响应字段 ​

字段类型说明
willIdstring意愿 ID,用于经查询意愿结果按 willId 轮询确认与生效进度
confirmUrlstring转发给授权主体(经办人)打开确认的一次性链接,规则同意愿模型说明
expireAtstring意愿过期时间(毫秒时间戳字符串)
willStatusstring意愿当前状态

停用生效的判定

经办人在意愿页完成确认后(willStatus=CONFIRMED),停用在云签侧异步生效——CONFIRMED 不代表已停用。以查询意愿结果返回的 businessStatus=SUCCEEDED 作为停用完成的判定依据(FAILED 时 failReason 给出原因),期间应继续轮询。

请求示例 ​

bash
curl -X POST 'https://api.certcloud.cn/openapi/v3/esign/delegates/delegate-xxx/disable' \
  -H 'Content-Type: application/json' \
  -H 'X-CC-Auth-Key: your-auth-key' \
  -H 'X-CC-Key-ID: your-key-id' \
  -H 'X-ES-Request-ID: 7a1c4e6b-2d9f-4c3a-8b5e-0f2a6c8d1e3f' \
  -d '{
    "certId": "esign-cert-xxx",
    "grantorPersonId": "manager-xxx"
  }'

响应示例 ​

200成功
json
{
  "code": "0",
  "data": {
    "willId": "will-xxx",
    "confirmUrl": "https://esign.example.com/wills/portal/eyJ0eXAiOiJKV1Qi",
    "expireAt": "1730000000000",
    "willStatus": "PENDING"
  }
}

错误码 ​

HTTP 状态码code说明
400esign_request_id_requiredX-ES-Request-ID 缺失或不合规,规则见通用说明
400esign_invalid_body请求体非法:JSON 语法错误或字段类型不符(整数字段传字符串、字符串字段传数字等),请求体未被解析
400esign_invalid_requestcertId / delegateId / grantorPersonId 缺失
404esign_cert_not_foundcertId 不存在
403esign_cross_account_deniedcertId 不属于当前账户
403esign_person_not_in_scopegrantorPersonId 与该企业的经办人不符(授权主体只能是经办人,不能是委托人本人)
409esign_idempotency_conflict复用同一 X-ES-Request-ID 但请求体与首次发起不一致;请改用新的 X-ES-Request-ID。见X-ES-Request-ID 幂等键
409esign_upstream_rejected当前请求被云签终态拒绝;error 为 [上游码] 文案,仅供人工排查、不可据其编程。修正输入或状态后,使用新的 X-ES-Request-ID 再发起。见上游错误响应与重试
409esign_upstream_error云签暂时性失败,可使用相同 X-ES-Request-ID 稍后安全重试。见上游错误响应与重试