- Development Integration
- /
- SDK
- /
- Python
- /
Management Module
- /
Role Management
- /
- Create Role
¶ Create a role
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 document description is incorrect, please refer to V3 API.
Create a role through the role code in the permission group (permission space), and you can select the permission group, role description, role name, etc.
¶ Method name
ManagementClient.create_role
¶ Request parameters
| Name | Type | Required | Default value | Description | Sample value |
|---|---|---|---|---|---|
| code | string | yes | - | Unique identifier of the role in the permission group (permission space) | manager |
| name | string | no | - | Name of the role in the permission group (permission space) | manager |
| namespace | string | no | default | Code of the permission group (permission space) to which the user belongs. If the code is not passed, the default permission group will be obtained. | default |
| description | string | No | - | Role description | this is role manager description |
| disableTime | string | No | - | Role automatic ban time, in milliseconds, if null is passed, it means permanent | 1669881887852 |
¶ Request Response
Type: RoleSingleRespDto
| 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, see: API Code List (opens new window) |
| requestId | string | Request ID. Returned when the request fails. |
| data | RoleDto | Response data |
Example results:
{
"statusCode": 200,
"message": "Success",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"id": "60b49eb83fd80adb96f26e68",
"code": "role1",
"name": "role1",
"description": "this is role description",
"namespace": "default",
"namespaceName": "Example 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 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 |