1. 开发集成
  2. /
  3. 标准 Web 应用
  4. /
  5. PHP
  6. /

  7. 管理模块

  8. /

  9. 用户管理

  10. /
  11. 获取已归档的用户列表

获取已归档的用户列表

更新时间: 2024-10-10 07:28:40
编辑

获取已归档的用户列表，支持分页，可以筛选开始时间等。

请求参数

名称类型必填默认值描述示例值
pagenumber否1当前页数，从 1 开始。1
limitnumber否10每页数目，最大不能超过 50，默认为 10。10
startAtnumber否-开始时间，为精确到秒的 UNIX 时间戳，默认不指定。1655714763890

示例代码

<?php

require 'vendor/autoload.php';

use Authing\ManagementClient;

$management = new ManagementClient(
    "AUTHING_USERPOOL_ID",
    "AUTHING_USERPOOL_SECRET"
);

$data = $management->listArchivedUsers(array(
  
    "page" => 1,

    "limit" => 10,

    "startAt" => 1655714763890,

));

请求响应

类型： ListArchivedUsersSingleRespDto

名称类型描述
statusCodenumber业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
messagestring描述信息
apiCodenumber细分错误码，可通过此错误码得到具体的错误类型。
dataArchivedUsersListPagingDto数据

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "list": {
      "userId": "userId",
      "archivedAt": "2022-07-03T02:20:30.000Z"
    }
  }
}

数据结构

ArchivedUsersListPagingDto

名称类型必填描述
totalCountnumber是记录总数。
listarray是响应数据。嵌套类型：ListArchivedUsersRespDto。

ListArchivedUsersRespDto

名称类型必填描述
userIdstring是用户 ID。 示例值： userId
archivedAtstring是归档时间。 示例值： 2022-07-03T02:20:30.000Z