- Development Integration
- /
- SDK
- /
- Python
- /
Management Module
- /
Role Management
- /
- Get Role List
¶ Get the role 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 the description of this document is incorrect, please refer to the V3 API.
Get the role list, support paging, support filtering by permission group (permission space)
¶ Method name
ManagementClient.list_roles
¶ 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 per page, maximum cannot exceed 50, default is 10 | 10 |
| keywords | string | No | - | Used for fuzzy search based on role code or name, optional. | admin |
| namespace | string | No | default | The code of the permission group (permission space). If it is not passed, the default permission group will be obtained. | default |
¶ Request Response
Type: RolePaginatedRespDto
| Name | Type | Description |
|---|---|---|
| statusCode | number | Business status code. This status code can be used to determine whether the operation is successful. 200 indicates success. |
| message | string | Description |
| apiCode | number | Segmented error code. This error code can be used to get the specific error type (not returned for successful requests). 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 | RolePagingDto | Response data |
Example results:
{
"statusCode": 200,
"message": "Success",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"list": {
"id": "60b49eb83fd80adb96f26e68",
"code": "role1",
"name": "role1",
"description": "this is role description",
"namespace": "default",
"namespaceName": "demo",
"status": "ENABLE",
"disableTime": "1669881887852"
}
}
}
¶ Data Structure
¶ RolePagingDto
| Name | Type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| totalCount | number | Yes | Total number of records | |
| list | array | Yes | Response data Nested type: RoleDto. |
¶ RoleDto
| Name | Type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| id | string | Yes | Role ID | 60b49eb83fd80adb96f26e68 |
| code | string | Yes | Unique identifier of the role in the permission group (permission space) Code | role1 |
| name | string | Yes | Role name in the permission group (permission space) | role1 |
| description | string | Yes | Role description | this is role description |
| namespace | string | Yes | The name of the permission group (permission space) to which it belongs Code, if not passed, the default permission group is obtained. | default |
| namespaceName | string | yes | The name of the permission group (permission space) | Sample permission name |
| status | string | no | Role status, ENABLE- means normal, DISABLE- means disabled | ENABLE |
| disableTime | number | no | Role automatic disable time, in milliseconds, if null is passed, it means permanent | 1669881887852 |