Skip to main content
Identities

列出 Identities

分页列出当前账号下的 Forward Identity。

GET /api/v1/forward/identities 返回当前鉴权账号拥有的 Identity 记录。

请求头

Header是否必填说明
AuthorizationBearer <PAT 或 SAT>

查询参数

参数类型是否必填默认值说明
external_idstring-按集成方终端用户 ID 过滤。
identity_idsstringstring[]-
searchstring-匹配 Identity ID、名称或外部 ID。
enabledboolean-按是否启用过滤;非布尔值返回 400。
limitinteger20分页大小,最大 100;超过上限时按最大值处理。
after_idstring-向后翻页游标,不能与 before_id 同用。
before_idstring-向前翻页游标,不能与 after_id 同用。

示例请求

curl -s -X GET 'https://api.qoder.com/api/v1/forward/identities' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

示例响应

HTTP 200 OK
{
  "data": [
    {
      "id": "idn_019eabc123",
      "external_id": "user_456",
      "name": "Example User",
      "identity_type": "normal",
      "enabled": true,
      "metadata": {},
      "created_at": "2026-06-18T10:00:00Z",
      "updated_at": "2026-06-18T10:00:00Z"
    }
  ],
  "first_id": "idn_019eabc123",
  "last_id": "idn_019eabc123",
  "has_more": false
}

响应字段

字段类型说明
dataarray当前页的 Identity 对象。
first_idstringnull
last_idstringnull
has_moreboolean是否还有更多记录。
data[].idstringForward Identity ID。
data[].external_idstring集成方系统中的终端用户 ID。
data[].namestringIdentity 展示名。
data[].identity_typestringIdentity 类型。普通 Identity 返回 normal
data[].enabledboolean是否允许继续使用该 Identity。
data[].metadataobject业务元数据。
data[].created_atstring创建时间,RFC 3339 格式。
data[].updated_atstring最近更新时间,RFC 3339 格式。

错误

HTTPTypeCode触发条件
400--limit 不合法、同时传入 after_idbefore_idenabled 不是布尔值,或 identity_ids 不合法。
401authentication_errorauthentication_requiredPAT 或 SAT 无效或已过期。
403permission_error-当前调用方无权访问该资源。

备注

  • after_idbefore_id 不能同时传入。
  • limit 超过 100 时按 100 处理,不会返回 400。
  • search 匹配 Identity ID、名称和外部 ID。
  • 已删除的 Identity 不应继续用于正常业务。

相关

列出 Identities - Qoder