跳转到主要内容
POST /api/v1/forward/identities/{identity_id} 只更新请求体中出现的字段。metadata 为合并更新，空字符串 value 表示删除对应 key。

​
请求头

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

​
路径参数

参数类型是否必填说明
identity_idstring是Forward Identity ID。

​
请求体参数

参数类型是否必填说明
external_idstring否替换原有终端用户 ID。
namestring否替换展示名。
enabledboolean否更新 Identity 是否可用。
metadataobject否合并更新业务元数据；空字符串 value 删除对应 key。

​
示例请求

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

​
示例响应

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

​
响应字段

字段类型说明
返回值object更新后的 Identity 对象。

​
错误

HTTPTypeCode触发条件
400invalid_request_error-请求体不合法。
404not_found_error-Identity 不存在。
409conflict_error-Identity 与已有记录冲突。
401authentication_errorauthentication_requiredPAT 无效或已过期。

​
注意事项

  • enabled=false 会阻止后续需要 active Identity 的新操作。
  • 历史 Session 和审计记录不会被修改。

​
相关

获取 Identity

删除 Identity