认证 (OAuth)场景说明

身份认证(OAuth)

概述

Tencent eSign OAuth 2.0 授权服务,为第三方集成提供安全的 API 访问能力。

根据集成场景,支持两种授权模式:

模式授权类型适用场景
开放模式authorization_code + PKCE终端用户授权。用户在授权页登录、选择 Space 并授权。
指定 Space 模式authorization_code + PKCE + space_id企业场景。Space 由集成方预先指定;需通过 /members/add 预添加用户后再发起 OAuth。
服务端对服务端client_credentials后端服务代表 Space 发起调用,无需用户参与。

授权码流程(PKCE)

适用于需要终端用户授权的第三方集成。

流程说明:

  1. 生成 PKCE code_verifier / code_challenge
  2. 在 WebView 中打开 GET /openapi/v1/oauth/auth — 用户登录、选择 Space 并点击同意
  3. WebView 被重定向到 redirect_uri 并携带 auth_code;拦截该回调
  4. auth_code 换取 access_token + refresh_token
  5. 使用 access_token 调用业务 API

redirect_uri: 支持自定义协议(如 myapp://oauth-callback)和 HTTPS URL,不支持 HTTP 明文。

客户端凭据流程

适用于服务端对服务端集成,无需用户参与。

Token 生命周期

Token 类型有效期适用流程说明
access_token1 小时两种流程均适用JWT,无状态
refresh_token永久有效仅授权码流程滚动刷新 — 每次使用后签发新 refresh_token,旧值立即失效

Scope 格式

Scope 以空格分隔:envelope:create envelope:read

当前支持的 scope:

  • envelope:create — 创建并发送信封
  • envelope:read — 读取信封状态和详情
  • envelope:manage — 管理信封(创建、发送、下载、查看等),envelope:create + envelope:read 的超集,新集成方推荐使用
  • stamp:manage — 管理印章(创建、编辑、删除、查看等)
  • template:manage — 管理模板(创建、编辑、删除、使用等)
  • member:manage — 管理成员(预添加、激活等)