- Development Integration
- /
- SDK
- /
- Python
- /
Authentication Module
- /
User Related Resources
- /
- 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 role list
¶ Method name
AuthenticationClient.get_role_list
¶ Request parameters
| Name | Type | Required | Default value | Description | Sample value |
|---|---|---|---|---|---|
| namespace | string | No | - | Code of the permission group (permission space). Do not pass to get the default permission group. | default |
¶ Request response
Type: RoleListRespDto
| Name | Type | Description |
|---|---|---|
| statusCode | number | Business status code. This status code 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 (not returned for successful requests). For a detailed list of error codes, see: API Code List (opens new window) |
| requestId | string | Request ID. Returned when the request fails. |
| data | array | response data |
Sample result:
{
"statusCode": 200,
"message": "Operation successful",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"id": "60b49eb83fd80adb96f26e68",
"code": "role1",
"name": "role1",
"description": "this is role description",
"namespace": "default",
"namespaceName": "Sample permission name",
"status": "ENABLE",
"disableTime": "1669881887852"
}
}
¶ Data structure
¶ 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 | Code of the permission group (permission space). If it is not passed, the default permission group will be 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 |