- Development Integration
- /
- SDK
- /
- Python
- /
Management Module
- /
Resource and Permission Management
- /
- Get Resource List by Page
¶ Get resource list by page
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 the description of this document is incorrect, please refer to V3 API.
Get the resource details list by page according to the filter conditions.
¶ Method name
ManagementClient.list_resources
¶ Request parameters
| Name | Type | Required | Default value | Description | Sample value |
|---|---|---|---|---|---|
| namespace | string | No | - | Code of the permission group (permission space). Do not pass to obtain the default permission group. | default |
| type | string | No | - | Resource type | DATA |
| page | number | No | 1 | Current page number, starting from 1 | 1 |
| limit | number | No | 10 | Number per page, maximum cannot exceed 50, default is 10 | 10 |
¶ Request Response
Type: ResourcePaginatedRespDto
| 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 | ResourcePagingDto | Response data |
Example results:
{
"statusCode": 200,
"message": "Success",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"statusCode": 200,
"message": "Success",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"list": {
"code": "ecs",
"description": "Server",
"name": "Server",
"type": "API",
"actions": "[{\"name\":\"ecs:Start\",\"description\":\"Start ECS server\"},{\"name\":\"ecs:Stop\",\"description\":\"Stop ECS server\"}]",
"apiIdentifier": "https://my-awesome-api.com/api",
"namespace": "default"
}
}
}
¶ Data Structure
¶ ResourcePagingDto
| Name | Type | Required | Description | Sample value |
|---|---|---|---|---|
| statusCode | number | Yes | Business status code, which can be used to determine whether the operation is successful. 200 means success. | 200 |
| message | string | Yes | Description | Success |
| apiCode | number | No | Segmented error code, which can be used to get the specific error type (not returned for successful requests). For a detailed list of error codes, see: API Code List (opens new window) | |
| requestId | string | No | Request ID. Returned when the request fails. | 934108e5-9fbf-4d24-8da1-c330328abd6c |
| totalCount | number | yes | total number of records | |
| list | array | yes | data Nested type: ResourceDto. |
¶ ResourceDto
| name | type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| code | string | yes | Resource unique identifier | ecs |
| description | string | no | Resource description | Server |
| name | string | no | Resource name | Server |
| type | string | yes | Resource type, such as data, API, button, menu | DATA |
| actions | array | no | Action type defined by the resource Nested type: ResourceAction. Array length limit: 100. | [{"name":"ecs:Start","description":"Start ECS server"},{"name":"ecs:Stop","description":"Stop ECS server"}] |
| apiIdentifier | string | No | URL identifier of API resource | https://my-awesome-api.com/api |
| namespace | string | No | Code of the permission group (permission space). If not passed, the default permission group will be obtained. | default |
| linkedToTenant | boolean | no | Whether the tenant application is associated with the self-built application resource |
¶ ResourceAction
| Name | Type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| name | string | yes | Resource operation name | ecs:Start |
| description | string | yes | Resource operation description | ecs:Start |