跳转到主要内容
POST /api/v1/forward/identities Identity 表示集成方产品中的一个 C 端用户,Forward 用它来收敛 Session、配置、资源和审计上下文。

请求头

Header是否必填说明
AuthorizationBearer <PAT>
Content-Typeapplication/json
Idempotency-Key有副作用请求可选的幂等键。

请求体参数

参数类型是否必填说明
external_idstring集成方系统中的终端用户 ID,不能是空串或纯空白。
namestring展示名,传入时不能是空串或纯空白。
enabledboolean是否启用该 Identity,默认 true
metadataobject业务元数据,建议最多 16 个 key。

示例请求

curl -s -X POST 'https://api.qoder.com/api/v1/forward/identities' \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
  "external_id": "user_456",
  "name": "Example User",
  "metadata": {
    "channel": "web"
  }
}'

示例响应

HTTP 200 OK
{
  "id": "idn_019eabc123",
  "external_id": "user_456",
  "name": "Example User",
  "enabled": true,
  "metadata": {
    "channel": "web"
  },
  "created_at": "2026-06-18T10:00:00Z",
  "updated_at": "2026-06-18T10:00:00Z"
}

响应字段

字段类型说明
idstringForward Identity ID,建议前缀 idn_
external_idstring集成方系统中的终端用户 ID。
enabledboolean是否允许继续使用该 Identity。
metadataobject业务元数据。

错误

HTTPTypeCode触发条件
400invalid_request_error-external_idname 或 metadata 不合法。
409conflict_error-Identity 与已有记录冲突。
401authentication_errorauthentication_requiredPAT 无效或已过期。

注意事项

  • Identity 不是 Qoder 登录账号,也不是 IAM user。
  • 真实终端用户认证仍由集成方负责。

相关

列出 Identities

创建 Session