跳转到主要内容
GET
curl

概览

返回当前已认证应用的用户实体分页列表。可用于将用户同步到您的数据仓库、找出需要分析人员关注的用户,或按显示名称搜索。

适用场景

  • 定期同步:将您的用户表同步到外部 BI 或数据仓库。
  • 分析人员队列:按 status=FLAGGED 或长时间未活动的 last_activity_at 筛选,以生成审核收件箱。
  • 搜索用户,可按 display_name、full_name 或 vendor_data。

筛选与分页

注意事项

  • 每个响应条目都包含 didit_internal_id。当原始会话或交易未提供 vendor_data 时,它可能为 null。
  • 此 endpoint 通过游标分页:在两次调用之间保存 next 游标,当 next 为空时停止。
  • 有关用户记录的所有字段,请参阅用户数据模型。

权限

应用的任意有效 API 密钥均可调用此 endpoint。Didit 的 API 密钥是按应用划分的,而非按角色划分的:控制台的角色与权限(list:users 及其他权限)决定的是人员可以在控制台中做什么,对 Management API 流量则不做评估。请通过控制谁能读取应用的 API 密钥,来控制谁可以调用此 endpoint。

相关内容

授权

x-api-key
string
header
必填

您的应用 API 密钥,可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域:针对每个资源设为无权限、只读或读写,限定于特定工作流或已通过的会话、限定于 IP 地址列表,以及设置到期日期。401 表示密钥错误、已撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或操作,或请求来自其 IP 列表之外的地址;在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null;没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。

查询参数

limit
integer
默认值:50

页面大小。省略时默认为 50。虽无强制上限,但为降低延迟建议保持较小的页面大小。

必填范围: 1 <= x <= 1000000
offset
integer
默认值:0

要返回的第一条记录的从零开始的偏移量。建议跟随上一页的 next URL,而不是手动计算。

必填范围: 0 <= x <= 1000000

响应

分页的用户列表,包含验证状态、会话计数和功能明细。

count
integer

匹配行数,出于性能考虑,不超过 100 时为精确值,超过 100 时上限为 100。请勿使用它来检测最后一页;应依靠 next 为 null 进行判断。

next
string | null

下一页的绝对 URL,最后一页则为 null。

previous
string | null

上一页的绝对 URL,第一页则为 null。

results
object[]
最后修改于 2026年11月7日