- Development Integration
- /
- SDK
- /
- Python
- /
Management Module
- /
User Management
- /
- Get Archived User List
¶ Get the archived user list
Update time: 2025-07-23 07:34:21
This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If this document description is incorrect, please refer to V3 API.
Get the archived user list, support paging, can filter start time, etc.
¶ Method name
ManagementClient.list_archived_users
¶ 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 |
¶ 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 (successful request does not return). For a detailed list of error codes, please see: API Code List (opens new window) |
| requestId | string | Request ID. Returned when the request fails. |
| data | ArchivedUsersListPagingDto | Data |
Example results:
{
"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: 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 |