跳到主要内容

租户运营

网关前缀：${API_BASE}/metadata/ops/tenants/...

请求发送邮箱验证码​

  • POST /ops/tenants/email/verify/request
  • 请求体：
    • email 字符串，必填，接收验证码的邮箱地址
  • 示例请求：
curl -X POST \
  "${API_BASE}/metadata/ops/tenants/email/verify/request" \
  -H "Content-Type: application/json" \
  -d '{"email":"user@example.com"}'
  • 示例响应：
{
  "success": true,
  "message": "OK",
  "data": null
}

新租户注册​

  • POST /ops/tenants/seed-admin
  • 请求体：CreateTenantAdminRequest
    • username 字符串，必填，管理员用户名
    • email 字符串（Email），必填，管理员邮箱
    • code 字符串，必填，邮箱验证码（6位）
    • password 字符串，可选，Keycloak 管理员用户密码（不提供则系统生成）
    • dbPassword 字符串，可选，自托管数据库密码（不提供则系统生成）
    • initSample 布尔，可选，默认 true，是否初始化示例数据与元数据
  • 响应：ApiResponse<String>，data 为系统生成的 tenantId
  • 常见参数组合：
    • 最简注册（系统生成密码，仅含示例数据）：username + email + code + initSample=true
    • 自定义管理员密码：额外提供 password
    • 自定义数据库密码：额外提供 dbPassword
    • 跳过示例数据：initSample=false
  • 示例请求：
curl -X POST \
  "${API_BASE}/metadata/ops/tenants/seed-admin" \
  -H "Content-Type: application/json" \
  -d '{
    "username":"alice",
    "email":"user@example.com",
    "code":"123456",
    "initSample": true
  }'
  • 示例响应：
{
  "success": true,
  "message": "Tenant <tenantId> admin user <username> scheduled. Password sent to <email>.",
  "data": "abc12345"
}
  • 错误示例：验证码错误或已过期
{
  "success": false,
  "message": "验证码错误或已过期",
  "errorCode": "EMAIL_VERIFY_FAILED"
}

手机号快速创建租户（免验证码）​

  • POST /ops/tenants/seed-admin/phone
  • 请求体：CreateTenantByPhoneRequest
    • username 字符串，必填，建议使用手机号作为管理员用户名
    • initSample 布尔，可选，默认 true
  • 响应：ApiResponse<Map>，data 内包含 tenantId 等信息（以实际返回为准）

示例：

curl -X POST \
  "${API_BASE}/metadata/ops/tenants/seed-admin/phone" \
  -H "Content-Type: application/json" \
  -d '{
    "username":"13800138000",
    "initSample": true
  }'

根据手机号查询绑定租户列表​

  • GET /ops/tenants/by-phone?phone=<phone>
  • 响应：ApiResponse<List<{id,name}>>

示例：

curl -X GET \
  "${API_BASE}/metadata/ops/tenants/by-phone?phone=13800138000"