Skip to main content
Identities

更新 Identity

更新 Forward Identity 基础信息。

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

请求头

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

路径参数

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

请求体参数

参数类型是否必填说明
external_idstring否替换原有终端用户 ID。
namestring否替换展示名。
enabledboolean否更新 Identity 是否可用。
auto_memory_storeboolean|null否是否在创建 Session 时按需自动创建默认 Memory Store。省略或 null 保留原值。
metadataobject否合并更新业务元数据；空字符串 value 删除对应 key。

示例请求

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

示例响应

HTTP 200 OK 
{
  "id": "idn_019eabc123",
  "external_id": "user_456",
  "name": "Example User",
  "enabled": false,
  "auto_memory_store": 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_error-PAT 或 SAT 无效或已过期。

备注

  • auto_memory_store=false 只停止后续默认 Memory Store 自动创建；已有默认库及显式挂载的绑定、权限不变，仍用于后续新 Session，已有 Session 也不受影响。
  • 设回 true 允许后续按需自动创建，但不会清除解绑默认库产生的当前 (identity, template) 自动创建停用状态。
  • 更新 enabled 与调用停用或启用 Identity具有相同的执行和恢复语义；已接受的执行会自然完成。
  • 历史 Session 和审计记录不会被修改。

相关

获取 Identity

删除 Identity