Get the archived user list

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on the https://api-explorer.genauth.ai V3 API, and is consistent with the API parameters and return results. If this document description is incorrect, please refer to the V3 API.

Get the archived user list, support paging, can filter the start time, etc.

Method name

ManagementClient.listArchivedUsers

Request Parameters

Name	Type	Required	Default value	Description	Sample value
page	number	No	1	Current page number, starting from 1	1
limit	number	No	10	Number of pages per page, maximum cannot exceed 50, default is 10	10
startAt	number	No	-	Start time, UNIX timestamp accurate to seconds, unspecified by default	1655714763890

Example Code

import { ManagementClient, Models } from "authing-node-sdk";

// Init ManagementClient
const managementClient = new ManagementClient({
  // Need to be replaced with your GenAuth Access Key ID
  accessKeyId: "GEN_AUTH_ACCESS_KEY_ID",
  // Need to be replaced with your GenAuth Access Key Secret
  accessKeySecret: "GEN_AUTH_ACCESS_KEY_SECRET",
  // If you are a private deployment customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.listArchivedUsers({
    page: 1,
    limit: 10,
    startAt: 1655714763890,
  });

  console.log(JSON.stringify(result, null, 2));
})();

Request Response

type: ListArchivedUsersSingleRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type (no return for successful requests). For a detailed list of error codes, please see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	<a ArchivedUsersListPagingDto	Data

Sample result:

{
  "statusCode": 200,
  "message": "Success",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "list": {
      "userId": "userId",
      "archivedAt": "2022-07-03T03:20:30.000Z"
    }
  }
}

Data Structure

ArchivedUsersListPagingDto

Name	Type	Required	Description	Sample value
totalCount	number	Yes	Total number of records
list	array	Yes	Response data Nested type: <a ListArchivedUsersRespDto.

ListArchivedUsersRespDto

Name	Type	Required	Description	Sample value
userId	string	yes	User ID	userId
archivedAt	string	yes	Archived at	2022-07-03T03:20:30.000Z