- Development Integration
- /
- SDK
- /
- Python
- /
Management Module
- /
Role Management
- /
- Update Role
¶ Modify roles
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.
Modify the role through the old and new role codes in the permission group (permission space), and you can select the role name, role description, etc.
¶ Method name
ManagementClient.update_role
¶ Request parameters
| Name | Type | Is it required? | Default value | Description | Sample value |
|---|---|---|---|---|---|
| name | string | Yes | - | Permission group (permission space) role name | name |
| newCode | string | Yes | - | Unique identification code of the role in the new permission group (permission space) | code2 |
| code | string | Yes | - | Unique identifier of the role in the permission group (permission space) | code1 |
| namespace | string | No | default | The code of the permission group (permission space) to which it belongs. If it is not passed, the default permission group is obtained. | default |
| description | string | No | - | Role description | this is description |
| status | string | No | - | Role status, ENABLE- means normal, DISABLE- means disabled | enable |
| disableTime | string | No | - | Role automatic disable time, in milliseconds, if null is passed, it means permanent | 1669881887852 |
¶ Request Response
Type: IsSuccessRespDto
| 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 | IsSuccessDto | Whether the operation is successful |
Example results:
{
"statusCode": 200,
"message": "Success",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"success": true
}
}
¶ Data Structure
¶ IsSuccessDto
| Name | Type | Is this field required? | Description | Sample value |
|---|---|---|---|---|
| success | boolean | yes | Whether the operation was successful | true |