自定义登录

POST 
/auth/v1/signin/custom

适用场景

• 企业自有账号体系与 CloudBase 账号体系的一对一映射
• 需要完全自定义鉴权流程的业务场景
• 需要实现自有账号系统与云开发服务的无缝集成

功能说明

1.服务端签发 Ticket

开发者需在服务端使用 CloudBase SDK 签发登录凭证(Ticket)，该凭证用于后续客户端认证

• 参考自定义登录文档，获取ticket前的部分

代码示例：

  const cloudbase = require("@cloudbase/node-sdk");

  // 1. 初始化 SDK
  const app = cloudbase.init({
  env: "your-env-id",
    // 传入自定义登录私钥
  credentials: require("/path/to/your/tcb_custom_login.json")
  });
    
  // 2. 开发者自定义的用户唯一身份标识
  const customUserId = "your-customUserId";
  
  // 3. 创建ticket
  const ticket = app.auth().createTicket(customUserId);
  
  // 4. 将ticket返回至客户端
  return ticket;

2.客户端自定义登录

接口说明

客户端使用服务端签发的 Ticket 获取访问凭证

请求示例：

  {
    "provider_id": "custom",
    "ticket": "cd7382ee-2f2f-4edf-831e-2f7c68ed3b43/@@/eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhbGciOiJSUzI1NiIsImVudiI6ImJlZ2luZ3JvdXAtMWc2czgyZTIwNWY5ODNjMCIsImlhdCI6MTc1ODU5NzQ4NzY5MSwiZXhwIjo"
  }

关键特性：

• access_token 有效期为 7200 秒（2小时）
• refresh_token 有效期为 2592000 秒（30天）
• 建议实现 token 自动刷新机制

Request

Query Parameters

client_id string

应用对应的客户端id，默认为环境id，可以不传

Header Parameters

x-device-id string

设备id

application/json

Body

provider_id 身份源id，自定义登录时固定传custom (string)required
ticket 自定义登录ticket (string)required

Responses

200

Response Headers

application/json

Schema

Schema

token_type 访问令牌类型 (string)

统一返回 Bearer

access_token 用户的访问令牌 (string)

用于访问云开发HTTP API的令牌，长度4096位以内

refresh_token 用户的刷新令牌 (string)

access_token过期可通过refresh_token刷新获取新的access_token，过期时间默认为31天。长度128位以内

expires_in int32

access_token的过期时间，单位为秒

scope 授权范围 (string)
sub 用户的唯一id (string)
groups string[]

Example (from schema)

{
  "token_type": "string",
  "access_token": "string",
  "refresh_token": "string",
  "expires_in": 0,
  "scope": "string",
  "sub": "string",
  "groups": [
    "string"
  ]
}

Loading...