分页列出当前账号下的 Forward Identity。
GET /api/v1/forward/identities
返回当前鉴权账号拥有的 Identity 记录。
请求头
| Header | 是否必填 | 说明 |
|---|---|---|
| Authorization | 是 | Bearer <PAT 或 SAT> |
查询参数
| 参数 | 类型 | 是否必填 | 默认值 | 说明 |
|---|---|---|---|---|
| external_id | string | 否 | - | 按集成方终端用户 ID 过滤。 |
| identity_ids | string | string[] | 否 | - |
| search | string | 否 | - | 匹配 Identity ID、名称或外部 ID。 |
| enabled | boolean | 否 | - | 按是否启用过滤;非布尔值返回 400。 |
| limit | integer | 否 | 20 | 分页大小,最大 100;超过上限时按最大值处理。 |
| after_id | string | 否 | - | 向后翻页游标,不能与 before_id 同用。 |
| before_id | string | 否 | - | 向前翻页游标,不能与 after_id 同用。 |
示例请求
示例响应
HTTP 200 OK
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 当前页的 Identity 对象。 |
| first_id | string | null |
| last_id | string | null |
| has_more | boolean | 是否还有更多记录。 |
| data[].id | string | Forward Identity ID。 |
| data[].external_id | string | 集成方系统中的终端用户 ID。 |
| data[].name | string | Identity 展示名。 |
| data[].identity_type | string | Identity 类型。普通 Identity 返回 normal。 |
| data[].enabled | boolean | 是否允许继续使用该 Identity。 |
| data[].metadata | object | 业务元数据。 |
| data[].created_at | string | 创建时间,RFC 3339 格式。 |
| data[].updated_at | string | 最近更新时间,RFC 3339 格式。 |
错误
| HTTP | Type | Code | 触发条件 |
|---|---|---|---|
| 400 | - | - | limit 不合法、同时传入 after_id 和 before_id、enabled 不是布尔值,或 identity_ids 不合法。 |
| 401 | authentication_error | authentication_required | PAT 或 SAT 无效或已过期。 |
| 403 | permission_error | - | 当前调用方无权访问该资源。 |
备注
after_id和before_id不能同时传入。limit超过 100 时按 100 处理,不会返回 400。search匹配 Identity ID、名称和外部 ID。- 已删除的 Identity 不应继续用于正常业务。